SubscriptionBridge: recurring billing and subscription management system - Documentation

User Tools

Site Tools

You are here: SubscriptionBridge Documentation » API Documentation: Getting Started » API Call Reference » TrialToFullRequest
Trace: • UpdateCreditCardRequest • TrialToFullRequest
developer_guide:call_reference:trialtofullrequest

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision		Previous revision
developer_guide:call_reference:trialtofullrequest [2012/02/25 20:16] – created mattdeveloper_guide:call_reference:trialtofullrequest [2012/02/25 23:36] (current) – [TrialToFullRequest] matt
Line 1: Line 1:
-====== TrialToFullRequest Call Reference ======+====== TrialToFullRequest ======
  
-TrialToFullRequest allows you to switch the initial billing phase to the second billing phase.  The initial billing phase is typically used for a Trial or Free Trial, but it could be any billing period that is different than the next billing phase.+==== Overview ==== 
 + 
 +**TrialToFullRequest** allows you to switch the initial billing phase to the second billing phase.  The initial billing phase is typically used for a Trial or Free Trial, but it could be any billing period that is different than the next billing phase.
  
-**View:**+**Learn More:**
  
   * [[:developer_guide:developer_guide#using-the-apis|Using the APIs]]     * [[:developer_guide:developer_guide#using-the-apis|Using the APIs]]  
Line 9: Line 11:
   * [[:developer_guide:developer_guide#error-codes|Error Codes]]    * [[:developer_guide:developer_guide#error-codes|Error Codes]] 
   * [[:developer_guide:developer_guide#troubleshooting|Troubleshooting]]    * [[:developer_guide:developer_guide#troubleshooting|Troubleshooting]] 
- 
  
 ===== TrialToFullRequest ===== ===== TrialToFullRequest =====
- 
-==== Overview ==== 
- 
-The box below lists all fields that could be included in the call request. To learn more about an individual field or its type, scroll down to find it in the table below the box. 
- 
  
 ==== XML ==== ==== XML ====
Line 75: Line 71:
  
 ^ Name ^ Type ^ Occurrence  ^ Meaning ^ ^ Name ^ Type ^ Occurrence  ^ Meaning ^
-| UpdateCreditCardRequest| container | required | Parent Element | +| **UpdateCreditCardRequest** | container | required | Parent Element | 
-| Username | string | required | Merchant API username (this is not your SubscriptionBridge login id) | +| Username | string | required | Merchant API Username (Not your Merchant Center login) | 
-| Token | string | required | Your application's security token. view also: How to create a token | +| Token| string | required | Hash of API Username and Password. [[:developer_guide:developer_guide:LinkID|Creating a Token]] | 
-| Guid | string | required | The Subscription Unique ID | +| Guid | string | always | This is the identifier for the subscription and should be referenced in future management requests | 
-| CreditCard | container | required | Parent Element | +| **Customer** | container | required | Parent Element | 
-| CardNumber | string | required | Credit Card Number | +| Customer/Email | string | required | customer email address | 
-| CardType | string | required | Credit Card Type (e.g. Visa, Amex, Mastcard | +| Customer/FirstName | string | required | customer first name | 
-| ExpMonth | string | required | 2 digit month | +| Customer/LastName | string | required | customer last name | 
-| ExpYear | string | required | 4 digit year | +| **Customer/BillingAddress** | container | required | Parent Element | 
-| SecureCode | string | required | CVV Code on back of card |+| Customer/BillingAddress/FirstName | string | required | billing first name | 
 +| Customer/BillingAddress/LastName | string | required | billing last name | 
 +| Customer/BillingAddress/Company | string | optional | billing company | 
 +| Customer/BillingAddress/Address | string | required | billing address | 
 +| Customer/BillingAddress/Address2 | string | optional | billing address line 2 | 
 +| Customer/BillingAddress/City | string | required | billing city | 
 +| Customer/BillingAddress/Region | string | conditional | billing state code or province | 
 +| Customer/BillingAddress/PostalCode | string | conditional | billing postal code | 
 +| Customer/BillingAddress/Country | string | required | billing country | 
 +| Customer/BillingAddress/Phone | string | required | billing phone | 
 +| **Customer/ShippingAddress** | container | required | Parent Element | 
 +| Customer/ShippingAddress/FirstName | string | required | shipping first name | 
 +| Customer/ShippingAddress/LastName | string | required | shipping last name | 
 +| Customer/ShippingAddress/Company | optional | required | shipping company | 
 +| Customer/ShippingAddress/Address | string | required | shipping address | 
 +| Customer/ShippingAddress/Address2 | optional | required | shipping address line 2 | 
 +| Customer/ShippingAddress/City | string | required | shipping city | 
 +| Customer/ShippingAddress/Region | conditional | required | shipping state code or province | 
 +| Customer/ShippingAddress/PostalCode | conditional | required | shipping postal code | 
 +| Customer/ShippingAddress/Country | string | required | shipping country | 
 +| Customer/ShippingAddress/Phone | optional | required | shipping phone | 
 +| Customer/Password | string | optional | a password for the customer center, which will allow you to use the auto log in feature to avoid double login | 
 +| Customer/Account | string | optional | an account number of the customer in the 3rd party system | 
 +| **CreditCard** | container | required | Parent Element | 
 +| CreditCard/CardNumber | string | required | valid credit card number | 
 +| CreditCard/CardType | string | required | card type (Visa, MasterCard, Discover, Amex)| 
 +| CreditCard/ExpMonth | string | required | expiration month in format "mm" | 
 +| CreditCard/ExpYear | string | required | expiration year in format "yyyy" | 
 +| CreditCard/SecureCode | string | required | 3 or 4 dig
  
  
-===== UpdateCreditCardResponse ===== 
- 
- 
-==== Overview ==== 
  
-The box below lists all fields that could be included in the call response. To learn more about an individual field or its type, scroll down to find it in the table below the box.+===== TrialToFullResponse =====
  
  
Line 101: Line 121:
  
 <?xml version="1.0" encoding="utf-8"?> <?xml version="1.0" encoding="utf-8"?>
-    <UpdateCreditCardResponse>+    <TrialToFullResponse>
         <Ack>string</Ack>          <Ack>string</Ack> 
  <Timestamp>timestamp</Timestamp>  <Timestamp>timestamp</Timestamp>
-    </UpdateCreditCardResponse>+    </TrialToFullResponse>
  
 </code> </code>
Line 114: Line 134:
  
 ^ Name ^ Type ^ Occurrence  ^ Meaning ^ ^ Name ^ Type ^ Occurrence  ^ Meaning ^
-| UpdateCreditCardResponse | container | required | Parent Element |      +| **TrialToFullResponse** | container | required | Parent Element |      
 | Ack | string | always | Success, Error, or Warning | | Ack | string | always | Success, Error, or Warning |
 | Timestamp | string | always | All responses return the official SB time stamp in UTC/GMT | | Timestamp | string | always | All responses return the official SB time stamp in UTC/GMT |
developer_guide/call_reference/trialtofullrequest.1330218961.txt.gz · Last modified: 2012/02/24 23:00 (external edit)