SubscriptionBridge: recurring billing and subscription management system - Documentation

User Tools

Site Tools

You are here: SubscriptionBridge Documentation » API Documentation: Getting Started » API Call Reference » UpdateSubscriptionRequest
Trace: • UpdateCreditCardRequest • CancellationRequest • TrialToFullRequest • GetSubscriptionsRequest • API Field Reference
developer_guide:call_reference:updatesubscriptionrequest

Differences

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

Link to this comparison view

developer_guide:call_reference:updatesubscriptionrequest [2012/02/25 20:26] – created mattdeveloper_guide:call_reference:updatesubscriptionrequest [2012/02/25 23:36] (current) – matt
Line 1: Line 1:
-====== UpdateSubscriptionRequest Call Reference ======+====== UpdateSubscriptionRequest ======
  
-UpdateSubscriptionRequest allows you to update a subscription customer, credit card, billing date, and billing amount.+==== Overview ====
  
-**View:**+**UpdateSubscriptionRequest** allows you to update a subscription customer, credit card, billing date, and billing amount. 
 + 
 +**Learn More:**
  
   * [[:developer_guide:developer_guide#using-the-apis|Using the APIs]]     * [[:developer_guide:developer_guide#using-the-apis|Using the APIs]]  
Line 12: Line 14:
  
 ===== UpdateSubscriptionRequest ===== ===== UpdateSubscriptionRequest =====
- 
-==== 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. 
  
  
Line 75: Line 73:
  
 ^ Name ^ Type ^ Occurrence  ^ Meaning ^ ^ Name ^ Type ^ Occurrence  ^ Meaning ^
-| UpdateSubscriptionRequest | container | required | Parent Element | +| **UpdateSubscriptionRequest** | 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 | 
-| Customer | container | required | Parent Element |+| **Customer** | container | required | Parent Element |
 | Customer/Email | string | required | customer email address | | Customer/Email | string | required | customer email address |
 | Customer/FirstName | string | required | customer first name | | Customer/FirstName | string | required | customer first name |
 | Customer/LastName | string | required | customer last name | | Customer/LastName | string | required | customer last name |
-| Customer/BillingAddress | container | required | Parent Element |+| **Customer/BillingAddress** | container | required | Parent Element |
 | Customer/BillingAddress/FirstName | string | required | billing first name | | Customer/BillingAddress/FirstName | string | required | billing first name |
 | Customer/BillingAddress/LastName | string | required | billing last name | | Customer/BillingAddress/LastName | string | required | billing last name |
Line 94: Line 92:
 | Customer/BillingAddress/Country | string | required | billing country | | Customer/BillingAddress/Country | string | required | billing country |
 | Customer/BillingAddress/Phone | string | required | billing phone | | Customer/BillingAddress/Phone | string | required | billing phone |
-| Customer/ShippingAddress | container | required | Parent Element |+| **Customer/ShippingAddress** | container | required | Parent Element |
 | Customer/ShippingAddress/FirstName | string | required | shipping first name | | Customer/ShippingAddress/FirstName | string | required | shipping first name |
 | Customer/ShippingAddress/LastName | string | required | shipping last name | | Customer/ShippingAddress/LastName | string | required | shipping last name |
Line 107: Line 105:
 | 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/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 | | Customer/Account | string | optional | an account number of the customer in the 3rd party system |
-| CreditCard | container | required | Parent Element |+| **CreditCard** | container | required | Parent Element |
 | CreditCard/CardNumber | string | required | valid credit card number | | CreditCard/CardNumber | string | required | valid credit card number |
 | CreditCard/CardType | string | required | card type (Visa, MasterCard, Discover, Amex)| | CreditCard/CardType | string | required | card type (Visa, MasterCard, Discover, Amex)|
Line 113: Line 111:
 | CreditCard/ExpYear | string | required | expiration year in format "yyyy" | | CreditCard/ExpYear | string | required | expiration year in format "yyyy" |
 | CreditCard/SecureCode | string | required | 3 or 4 digit security code | | CreditCard/SecureCode | string | required | 3 or 4 digit security code |
 +
  
 ===== UpdateSubscriptionResponse ===== ===== UpdateSubscriptionResponse =====
- 
- 
-==== 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. 
  
  
Line 141: Line 135:
  
 ^ Name ^ Type ^ Occurrence  ^ Meaning ^ ^ Name ^ Type ^ Occurrence  ^ Meaning ^
-| UpdateSubscriptionResponse | container | required | Parent Element |      +| **UpdateSubscriptionResponse** | 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/updatesubscriptionrequest.1330219614.txt.gz · Last modified: 2012/02/24 23:00 (external edit)