SubscriptionBridge: recurring billing and subscription management system - Documentation

User Tools

Site Tools

You are here: SubscriptionBridge Documentation » API Documentation: Getting Started » API Call Reference » SubscriptionRequest
Trace:
developer_guide:call_reference:subscriptionrequest

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
developer_guide:call_reference:subscriptionrequest [2010/03/18 17:08] – mattdeveloper_guide:call_reference:subscriptionrequest [2012/02/25 22:30] (current) – matt
Line 1: Line 1:
-====== SubscriptionRequest Call Reference ======+====== SubscriptionRequest ======
  
-SubscriptionRequest will generate a new Subscription in the SB system.+==== Overview ====
  
 +**SubscriptionRequest** will **generate a new Subscription** in the SubscriptionBridge system, which will then create a recurring payment profile with the payment gateway associated with the SubscriptionBridge //store//. As part of this process, SubscriptionBridge securely passes payment information (i.e. the credit card details) to the payment gateway.
  
-**View:**+  * Credit card information is never saved by SubscriptionBridge 
 +  * Credit card information __should not__ be saved by your application 
 + 
 +**Learn More:**
  
   * [[:developer_guide:developer_guide#using-the-apis|Using the APIs]]     * [[:developer_guide:developer_guide#using-the-apis|Using the APIs]]  
Line 13: Line 17:
  
 ===== SubscriptionRequest ===== ===== SubscriptionRequest =====
- 
- 
-==== 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 57: Line 55:
                       <Phone>string</Phone>                       <Phone>string</Phone>
                </ShippingAddress>                </ShippingAddress>
 +               <Password>string</Password>
 +               <Account>string</Account>
         </Customer>         </Customer>
         <CreditCard>         <CreditCard>
Line 66: Line 66:
         </CreditCard>         </CreditCard>
         <Cart>         <Cart>
-               <RegularAmt>double</RegularAmt> +               <RegularAmt>currency</RegularAmt> 
-               <TrialAmt>double</TrialAmt> +               <TrialAmt>currency</TrialAmt> 
-               <RegularTax>double</RegularTax> +               <RegularTax>currency</RegularTax> 
-               <TrialTax>double</TrialTax> +               <TrialTax>currency</TrialTax> 
-               <RegularShipping>double</RegularShipping> +               <RegularShipping>currency</RegularShipping> 
-               <TrialShipping>double</TrialShipping>+               <TrialShipping>currency</TrialShipping>
                <IsShippable>boolean</IsShippable>                <IsShippable>boolean</IsShippable>
                <ShipName>string</ShipName>                <ShipName>string</ShipName>
                <TaxName>string</TaxName>                <TaxName>string</TaxName>
                <AgreedToTerms>boolean</AgreedToTerms>                <AgreedToTerms>boolean</AgreedToTerms>
-               <LanguageCode>integer</LanguageCode>+               <LanguageCode>string</LanguageCode>
         </Cart>         </Cart>
         <Package>         <Package>
Line 96: Line 96:
  
 ^ Name ^ Type ^ Occurrence  ^ Meaning ^ ^ Name ^ Type ^ Occurrence  ^ Meaning ^
-| SubscriptionRequest | container | required | Parent Element | +| **SubscriptionRequest** | 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]] | 
-| 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 114: Line 114:
 | 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 125: Line 125:
 | Customer/ShippingAddress/Country | string | required | shipping country | | Customer/ShippingAddress/Country | string | required | shipping country |
 | Customer/ShippingAddress/Phone | optional | required | shipping phone | | Customer/ShippingAddress/Phone | optional | required | shipping phone |
-| CreditCard | container | required | Parent Element |+| 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/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 131: Line 133:
 | 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 |
-| Cart | container | required | Parent Element | +| **Cart** | container | required | Parent Element | 
-| Cart/RegularAmt | double | required | total amount less tax and shipping | +| Cart/RegularAmt | currency | required | total amount less tax and shipping | 
-| Cart/TrialAmt | double | conditional | total trial amount less tax and shipping | +| Cart/TrialAmt | currency | conditional | total trial amount less tax and shipping | 
-| Cart/RegularTax | double | optional | tax amount | +| Cart/RegularTax | currency | optional | tax amount | 
-| Cart/TrialTax | double | optional | trial tax amount | +| Cart/TrialTax | currency | optional | trial tax amount | 
-| Cart/RegularShipping | double | optional | shipping amount | +| Cart/RegularShipping | currency | optional | shipping amount | 
-| Cart/TrialShipping | double | optional | trial shipping amount |+| Cart/TrialShipping | currency | optional | trial shipping amount |
 | Cart/IsShippable | boolean | required | Is the product shipped? (0 = false, 1 = true) | | Cart/IsShippable | boolean | required | Is the product shipped? (0 = false, 1 = true) |
 | Cart/ShipName | string | conditional | name to identify shipping method | | Cart/ShipName | string | conditional | name to identify shipping method |
 | Cart/TaxName | string | conditional | name of tax location or zone | | Cart/TaxName | string | conditional | name of tax location or zone |
 | Cart/AgreedToTerms | boolean | required | Customer has agreed to terms? (0 = false, 1 = true) | | Cart/AgreedToTerms | boolean | required | Customer has agreed to terms? (0 = false, 1 = true) |
-| Cart/LanguageCode | integer | required | valid language code (1 = en-EN, 2 = it-IT) | +| Cart/LanguageCode | string | required | valid language code (en-US, it-IT) | 
-| Package | container | required | Parent Element |+| **Package** | container | required | Parent Element |
 | Package/LinkID | string | required | Package Link ID | | Package/LinkID | string | required | Package Link ID |
-| Package/Plan | container | required | Parent Element |+| **Package/Plan** | container | required | Parent Element |
 | Package/Plan/Profile | container | required | Parent Element | | Package/Plan/Profile | container | required | Parent Element |
 | Package/Plan/Profile/IsTrial | boolean | required | Is there a trial? (0 = false, 1 = true) | | Package/Plan/Profile/IsTrial | boolean | required | Is there a trial? (0 = false, 1 = true) |
Line 152: Line 154:
  
 ===== SubscriptionResponse ===== ===== SubscriptionResponse =====
- 
- 
-==== 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 180: Line 176:
  
 ^ Name ^ Type ^ Occurrence  ^ Meaning ^ ^ Name ^ Type ^ Occurrence  ^ Meaning ^
-| SubscriptionResponse | container | required | Parent Element |+| **SubscriptionResponse** | 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 |
 | Guid | string | always | This is the identifier for the subscription and should be referenced in future management requests | | Guid | string | always | This is the identifier for the subscription and should be referenced in future management requests |
 | Terms | string | always | The terms for the package (e.g. Free for 2 Months) | | Terms | string | always | The terms for the package (e.g. Free for 2 Months) |
developer_guide/call_reference/subscriptionrequest.1268946481.txt.gz · Last modified: 2010/03/18 00:00 (external edit)