SubscriptionBridge: recurring billing and subscription management system - Documentation

User Tools

Site Tools

You are here: SubscriptionBridge Documentation » API Documentation: Getting Started » API Call Reference » GetSubscriptionDetailsRequest
Trace: • GetSubscriptionDetailsRequest
developer_guide:call_reference:getsubscriptiondetailsrequest

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:getsubscriptiondetailsrequest [2010/05/20 02:20] – external edit 127.0.0.1developer_guide:call_reference:getsubscriptiondetailsrequest [2012/09/26 14:55] (current) – [Elements] mebstein
Line 1: Line 1:
-====== GetSubscriptionDetailsRequest Call Reference ======+====== GetSubscriptionDetailsRequest ======
  
-===== What it does =====+==== Overview ====
  
-//GetSubscriptionDetailsRequest// will **return details about an existing Subscription** in the SubscriptionBridge system.+**GetSubscriptionDetailsRequest** will **return details about an existing Subscription** in the SubscriptionBridge system.
  
-==== Related articles ====+**Learn More:**
  
   * [[:developer_guide:developer_guide#using-the-apis|Using the APIs]]     * [[:developer_guide:developer_guide#using-the-apis|Using the APIs]]  
Line 15: Line 15:
 ===== GetSubscriptionDetailsRequest ===== ===== GetSubscriptionDetailsRequest =====
  
-==== 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 27: Line 24:
  <Username>string</Username>  <Username>string</Username>
         <Token>string</Token>         <Token>string</Token>
-        <Guid>string</Guid>+        <GUID>string</GUID>
         <LanguageCode>string</LanguageCode>         <LanguageCode>string</LanguageCode>
     </GetSubscriptionDetailsRequest>     </GetSubscriptionDetailsRequest>
Line 39: Line 36:
  
 ^ Name ^ Type ^ Occurrence  ^ Meaning ^ ^ Name ^ Type ^ Occurrence  ^ Meaning ^
-| GetSubscriptionDetailsRequest | container | required | Parent Element | +| **GetSubscriptionDetailsRequest** | 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 unique Subscription ID | +| GUID | string | always | This is the identifier for the subscription and should be referenced in future management requests | 
-| LanguageCode | string | required | The language your details will be returned. Requires that the language be enabled in the Merchant Center. |+| LanguageCode | string | required | ISO Language Code (e.g. en-US). [[:developer_guide:developer_guide:Language_Code|Learn More]] |
  
  
  
 ===== GetSubscriptionDetailsResponse ===== ===== GetSubscriptionDetailsResponse =====
- 
- 
-==== 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 66: Line 57:
         <Subscription>         <Subscription>
             <Identifiers>             <Identifiers>
-                <Guid>string</Guid>+                <GUID>string</GUID>
             </Identifiers>             </Identifiers>
             <BillingDetails>             <BillingDetails>
Line 77: Line 68:
                 <TrialTotalBillingCycles>integer</TrialTotalBillingCycles>                 <TrialTotalBillingCycles>integer</TrialTotalBillingCycles>
                 <TrialEndDate>timestamp</TrialEndDate>                 <TrialEndDate>timestamp</TrialEndDate>
-                <Amount>double</Amount> +                <Amount>currency</Amount> 
-                <ShipAmount>double</ShipAmount> +                <ShipAmount>currency</ShipAmount> 
-                <TaxAmount>double</TaxAmount>+                <TaxAmount>currency</TaxAmount>
                 <NextBillingDate>timestamp</NextBillingDate>                 <NextBillingDate>timestamp</NextBillingDate>
-                <NextBillingAmt>double</NextBillingAmt>+                <NextBillingAmt>currency</NextBillingAmt>
                 <NumCyclesCompleted>integer</NumCyclesCompleted>                 <NumCyclesCompleted>integer</NumCyclesCompleted>
                 <NumCyclesRemaining>integer</NumCyclesRemaining>                 <NumCyclesRemaining>integer</NumCyclesRemaining>
                 <OutstandingBalance>integer</OutstandingBalance>                 <OutstandingBalance>integer</OutstandingBalance>
                 <LastPaymentDate>timestamp</LastPaymentDate>                 <LastPaymentDate>timestamp</LastPaymentDate>
-                <LastPaymentAmount>double</LastPaymentAmount>+                <LastPaymentAmount>currency</LastPaymentAmount>
                 <CurrencyCode>string</CurrencyCode>                 <CurrencyCode>string</CurrencyCode>
-                <TrialShippingAmt>double</TrialShippingAmt> +                <TrialShippingAmt>currency</TrialShippingAmt> 
-                <TrialTaxAmt>double</TrialTaxAmt> +                <TrialTaxAmt>currency</TrialTaxAmt> 
-                <TrialAmount>double</TrialAmount>+                <TrialAmount>currency</TrialAmount>
             </BillingDetails>             </BillingDetails>
-            <OutstandingBalance> +            <SubscriptionDetails> 
-                <Balance>double</Balance> +                <Description>string</Description> 
-                <Reason>string</Reason> +            </SubscriptionDetails> 
-                <IsPaid>boolean</IsPaid> +            <BalanceTotal></BalanceTotal> 
-                <DtPaid>timestamp</DtPaid> +            <BalanceDetails> 
-            </OutstandingBalance>+                <Balance> 
 +                    <Balance>currency</Balance> 
 +                    <Reason>string</Reason> 
 +                    <IsPaid>boolean</IsPaid> 
 +                    <DtPaid>timestamp</DtPaid> 
 +                </Balance> 
 +            </BalanceDetails>
             <Terms>string</Terms>             <Terms>string</Terms>
 +            <Customer>
 +                <FullName>string</FullName>
 +                <Account>string</Account>
 +                <FirstName>string</FirstName>
 +                <LastName>string</LastName>
 +                <Email>string</Email>
 +                <BillingAddress>
 +                    <FirstName>string</FirstName>
 +                    <LastName>string</LastName>
 +                    <Company>string</LastName>
 +                    <Address>string</Address>
 +                    <Address2>string</Address2>
 +                    <City>string</City>
 +                    <Region>string</Region>
 +                    <PostalCode>string</PostalCode>
 +                    <Country>string</Country>
 +                    <Phone>string</Phone>
 +                </BillingAddress>
 +                <ShippingAddress />
 +            </Customer>
         </Subscription>         </Subscription>
     </GetSubscriptionDetailsResponse>     </GetSubscriptionDetailsResponse>
  
 </code> </code>
- 
  
  
Line 110: Line 126:
  
 ^ Name ^ Type ^ Occurrence  ^ Meaning ^ ^ Name ^ Type ^ Occurrence  ^ Meaning ^
-| GetSubscriptionDetailsResponse| container | required | Parent Element | +| **GetSubscriptionDetailsResponse** | container | required | Parent Element | 
-| Ack | string | always | Success, Error, or Warning | +| **Subscription** | container | conditional | Parent Element | 
-| Timestamp | string | always | All responses return the official SB time stamp in UTC/GMT | +| **Identifiers** | container | conditional | Parent Element | 
-| Subscription | container | always | A container element that contains the Subscription elements | +| Identifiers/Guid | string | always | Unique Subscription ID or Order ID | 
-| Identifiers | container | always | A container element that contains the Identifiers elements | +| **BillingDetails** | container| conditional | Parent Element | 
-| Guid | string | always | The unique Subscription ID | +| BillingDetails/StartDate | datetime | always | Date subscription started | 
-| BillingDetails | container | always | A container element that contains the BillingDetails elements | +| BillingDetails/EndDate | datetime | conditional | Date subscription ends | 
-| StartDate | timestamp | always | The date the Subscription begins | +| BillingDetails/BillingPeriod | string | conditional | Day, Month, or Year | 
-| EndDate | timestamp | always | The date the Subscription begins | +| BillingDetails/BillingFrequency | integer | conditional | rate at which subscription renews |   
-| BillingPeriod | string | always | Day, Week, or Month | +| BillingDetails/TrialBillingFrequency | integer | conditional | rate at which trial subscription renews |         
-| BillingFrequency | integer | always | The Subscription's Frequency | +| BillingDetails/TrialEndDate | datetime | conditional | Date trial ends |             
-| TotalBillingCycles | integer | always | The number of billing cycles (0=Until Canceled) | +| BillingDetails/Amount | currency | conditional | recurring price |      
-| TrialBillingPeriod | string | always | Day, Week, or Month | +| BillingDetails/ShipAmount | currency | conditional | recurring shipping fees |   
-| TrialTotalBillingCycles | integer | always | The number of trial billing cycles (0=Until Canceled) | +| BillingDetails/TaxAmount | currency | conditional | recurring tax fees |              
-| TrialEndDate | timestamp | always | The date the Subscription begins | +| BillingDetails/NextBillingDate | datetime | conditional | next date subscription will charge |                  
-| Amount | double | always | The Subscription total, less tax and shipping | +| BillingDetails/NumCyclesCompleted | integer | conditional | number of recurring charges completed |                  
-| ShipAmount | double | always | The Subscription tax | +| BillingDetails/LastPaymentDate | datetime | conditional | date of the previous (not final) charge |              
-| TaxAmount | double | always | The Subscription shipping | +| BillingDetails/LastPaymentAmount | currency | conditional | amount of the previous (not final) charge |       
-| NextBillingDate| timestamp | always | The date of the next recurring payment |              +| BillingDetails/CurrencyCode | string | conditional | valid ISO Currency Code |  
-| NextBillingAmt | double | always | The amount that will be captured on the NextBillingDate |   +| **SubscriptionDetails** | container | conditional | Parent Element |  
-| NumCyclesCompleted | integer | always | The number of billing cycles completed | +| SubscriptionDetails/Description | string | required | Package Description |   
-| NumCyclesRemaining | integer | always | The number of billing cycles remaining  +| BalanceTotal | currency | conditional | Total outstanding balance |  
-| LastPaymentDate | timestamp | always | The date of the final payment |  +| **BalanceDetails** | container | required | Parent Element | 
-| LastPaymentAmount | double | always | The amount that will be captured on the LastPaymentDate |  +| **Balance** | container | required | Parent Element | 
-| CurrencyCode | string | always | a valid currency code e.g. USD |             +| Balance/Balance | currency | required | Balance Amount |  
-| TrialShippingAmt | double | always | The trial shipping charge |  +| Balance/IsPaid | boolean | required | True or False if balance is paid |  
-| TrialTaxAmt | double | always | The trial tax charge |  +| Balance/DtPaid | datetime | required | Date balance was paid |  
-| TrialAmount | double | always | The trial total, less tax and shipping charges |  +| **Customer** | container | required | Parent Element | 
-| OutstandingBalance | container | always | A container element that contains the OutstandingBalance elements | +| Customer/Email | string | required | customer email address | 
-| Balance | double | always | The amount of the outstanding balance | +| Customer/FirstName | string | required | customer first name | 
-| Reason | string | always | A description of the outstanding balance | +| Customer/LastName | string | required | customer last name | 
-| IsPaid | boolean | always | true if the balance is paid | +| **Customer/BillingAddress** | container | required | Parent Element | 
-| DtPaid | timestamp | always | The date the balance was paid |  +| Customer/BillingAddress/FirstName | string | required | billing first name | 
-| Terms | string | always | The terms for the subscription (e.g. Free for 2 Months) |+| 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 - if shipping is not associated with the subscription, the ShippingAddress element will be empty | 
 +| 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 |
developer_guide/call_reference/getsubscriptiondetailsrequest.1274336428.txt.gz · Last modified: 2010/09/17 00:00 (external edit)