Subscription management and recurring billing solutions
SubscriptionBridge
 

Differences

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

Link to this comparison view

developer_guide:call_reference:getsubscriptiondetailsrequest [2012/09/26 14:55]
mebstein [Elements]
developer_guide:call_reference:getsubscriptiondetailsrequest [2012/09/26 00:00] (current)
Line 1: Line 1:
-====== GetSubscriptionDetailsRequest ====== +====== GetSubscriptionDetailsRequest ======  
- +  
-==== Overview ==== +==== 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.  
- +  
-**Learn More:** +**Learn More:**  
- +  
-  * [[:developer_guide:developer_guide#using-the-apis|Using the APIs]]   +  * [[:developer_guide:developer_guide#using-the-apis|Using the APIs]]    
-  * [[:developer_guide:developer_guide#http-status-code|HTTP Status Codes]]   +  * [[:developer_guide:developer_guide#http-status-code|HTTP Status Codes]]    
-  * [[: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]]   
- +  
- +  
-===== GetSubscriptionDetailsRequest ===== +===== GetSubscriptionDetailsRequest =====  
- +  
- +  
-==== XML ==== +==== XML ====  
- +  
-<code> +<code>  
- +  
-<?xml version="1.0" encoding="utf-8"?> +<?xml version="1.0" encoding="utf-8"?>  
-    <GetSubscriptionDetailsRequest> +    <GetSubscriptionDetailsRequest>  
- <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>  
- +  
-</code> +</code>  
- +  
- +  
- +  
-==== Elements ==== +==== Elements ====  
- +  
- +  
-^ Name ^ Type ^ Occurrence  ^ Meaning ^ +^ Name ^ Type ^ Occurrence  ^ Meaning ^  
-| **GetSubscriptionDetailsRequest** | container | required | Parent Element | +| **GetSubscriptionDetailsRequest** | container | required | Parent Element |  
-| Username | string | required | Merchant API Username (Not your Merchant Center login) | +| Username | string | required | Merchant API Username (Not your Merchant Center login) |  
-| Token| string | required | Hash of API Username and Password. [[:developer_guide:developer_guide:LinkID|Creating a Token]] | +| Token| string | required | Hash of API Username and Password. [[:developer_guide:developer_guide:LinkID|Creating a Token]] |  
-| 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 |  
-| LanguageCode | string | required | ISO Language Code (e.g. en-US). [[:developer_guide:developer_guide:Language_Code|Learn More]] | +| LanguageCode | string | required | ISO Language Code (e.g. en-US). [[:developer_guide:developer_guide:Language_Code|Learn More]] |  
- +  
- +  
- +  
-===== GetSubscriptionDetailsResponse ===== +===== GetSubscriptionDetailsResponse =====  
- +  
- +  
-==== XML ==== +==== XML ====  
- +  
-<code> +<code>  
- +  
-<?xml version="1.0" encoding="utf-8"?> +<?xml version="1.0" encoding="utf-8"?>  
-    <GetSubscriptionDetailsResponse>  +    <GetSubscriptionDetailsResponse>  
-        <Ack>string</Ack> +        <Ack>string</Ack>  
- <Timestamp>timestamp</Timestamp> + <Timestamp>timestamp</Timestamp>  
-        <Subscription> +        <Subscription>  
-            <Identifiers> +            <Identifiers>  
-                <GUID>string</GUID> +                <GUID>string</GUID>  
-            </Identifiers> +            </Identifiers>  
-            <BillingDetails> +            <BillingDetails>  
-                <StartDate>timestamp</StartDate> +                <StartDate>timestamp</StartDate>  
-                <EndDate>timestamp</EndDate> +                <EndDate>timestamp</EndDate>  
-                <BillingPeriod>string</BillingPeriod> +                <BillingPeriod>string</BillingPeriod>  
-                <BillingFrequency>integer</BillingFrequency> +                <BillingFrequency>integer</BillingFrequency>  
-                <TotalBillingCycles>integer</TotalBillingCycles> +                <TotalBillingCycles>integer</TotalBillingCycles>  
-                <TrialBillingPeriod>string</TrialBillingPeriod> +                <TrialBillingPeriod>string</TrialBillingPeriod>  
-                <TrialTotalBillingCycles>integer</TrialTotalBillingCycles> +                <TrialTotalBillingCycles>integer</TrialTotalBillingCycles>  
-                <TrialEndDate>timestamp</TrialEndDate> +                <TrialEndDate>timestamp</TrialEndDate>  
-                <Amount>currency</Amount> +                <Amount>currency</Amount>  
-                <ShipAmount>currency</ShipAmount> +                <ShipAmount>currency</ShipAmount>  
-                <TaxAmount>currency</TaxAmount> +                <TaxAmount>currency</TaxAmount>  
-                <NextBillingDate>timestamp</NextBillingDate> +                <NextBillingDate>timestamp</NextBillingDate>  
-                <NextBillingAmt>currency</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>currency</LastPaymentAmount> +                <LastPaymentAmount>currency</LastPaymentAmount>  
-                <CurrencyCode>string</CurrencyCode> +                <CurrencyCode>string</CurrencyCode>  
-                <TrialShippingAmt>currency</TrialShippingAmt> +                <TrialShippingAmt>currency</TrialShippingAmt>  
-                <TrialTaxAmt>currency</TrialTaxAmt> +                <TrialTaxAmt>currency</TrialTaxAmt>  
-                <TrialAmount>currency</TrialAmount> +                <TrialAmount>currency</TrialAmount>  
-            </BillingDetails> +            </BillingDetails>  
-            <SubscriptionDetails> +            <SubscriptionDetails>  
-                <Description>string</Description> +                <Description>string</Description>  
-            </SubscriptionDetails> +            </SubscriptionDetails>  
-            <BalanceTotal></BalanceTotal> +            <BalanceTotal></BalanceTotal>  
-            <BalanceDetails> +            <BalanceDetails>  
-                <Balance> +                <Balance>  
-                    <Balance>currency</Balance> +                    <Balance>currency</Balance>  
-                    <Reason>string</Reason> +                    <Reason>string</Reason>  
-                    <IsPaid>boolean</IsPaid> +                    <IsPaid>boolean</IsPaid>  
-                    <DtPaid>timestamp</DtPaid> +                    <DtPaid>timestamp</DtPaid>  
-                </Balance> +                </Balance>  
-            </BalanceDetails> +            </BalanceDetails>  
-            <Terms>string</Terms> +            <Terms>string</Terms>  
-            <Customer> +            <Customer>  
-                <FullName>string</FullName> +                <FullName>string</FullName>  
-                <Account>string</Account> +                <Account>string</Account>  
-                <FirstName>string</FirstName> +                <FirstName>string</FirstName>  
-                <LastName>string</LastName> +                <LastName>string</LastName>  
-                <Email>string</Email> +                <Email>string</Email>  
-                <BillingAddress> +                <BillingAddress>  
-                    <FirstName>string</FirstName> +                    <FirstName>string</FirstName>  
-                    <LastName>string</LastName> +                    <LastName>string</LastName>  
-                    <Company>string</LastName> +                    <Company>string</LastName>  
-                    <Address>string</Address> +                    <Address>string</Address>  
-                    <Address2>string</Address2> +                    <Address2>string</Address2>  
-                    <City>string</City> +                    <City>string</City>  
-                    <Region>string</Region> +                    <Region>string</Region>  
-                    <PostalCode>string</PostalCode> +                    <PostalCode>string</PostalCode>  
-                    <Country>string</Country> +                    <Country>string</Country>  
-                    <Phone>string</Phone> +                    <Phone>string</Phone>  
-                </BillingAddress> +                </BillingAddress>  
-                <ShippingAddress /> +                <ShippingAddress />  
-            </Customer> +            </Customer>  
-        </Subscription> +        </Subscription>  
-    </GetSubscriptionDetailsResponse> +    </GetSubscriptionDetailsResponse>  
- +  
-</code> +</code>  
- +  
- +  
-==== Elements ==== +==== Elements ====  
- +  
- +  
-^ Name ^ Type ^ Occurrence  ^ Meaning ^ +^ Name ^ Type ^ Occurrence  ^ Meaning ^  
-| **GetSubscriptionDetailsResponse** | container | required | Parent Element | +| **GetSubscriptionDetailsResponse** | container | required | Parent Element |  
-| **Subscription** | container | conditional | Parent Element | +| **Subscription** | container | conditional | Parent Element |  
-| **Identifiers** | container | conditional | Parent Element | +| **Identifiers** | container | conditional | Parent Element |  
-| Identifiers/Guid | string | always | Unique Subscription ID or Order ID | +| Identifiers/Guid | string | always | Unique Subscription ID or Order ID |  
-| **BillingDetails** | container| conditional | Parent Element | +| **BillingDetails** | container| conditional | Parent Element |  
-| BillingDetails/StartDate | datetime | always | Date subscription started | +| BillingDetails/StartDate | datetime | always | Date subscription started |  
-| BillingDetails/EndDate | datetime | conditional | Date subscription ends | +| BillingDetails/EndDate | datetime | conditional | Date subscription ends |  
-| BillingDetails/BillingPeriod | string | conditional | Day, Month, or Year | +| BillingDetails/BillingPeriod | string | conditional | Day, Month, or Year |  
-| BillingDetails/BillingFrequency | integer | conditional | rate at which subscription renews |   +| BillingDetails/BillingFrequency | integer | conditional | rate at which subscription renews |    
-| BillingDetails/TrialBillingFrequency | integer | conditional | rate at which trial subscription renews |         +| BillingDetails/TrialBillingFrequency | integer | conditional | rate at which trial subscription renews |          
-| BillingDetails/TrialEndDate | datetime | conditional | Date trial ends |             +| BillingDetails/TrialEndDate | datetime | conditional | Date trial ends |              
-| BillingDetails/Amount | currency | conditional | recurring price |      +| BillingDetails/Amount | currency | conditional | recurring price |      
-| BillingDetails/ShipAmount | currency | conditional | recurring shipping fees |   +| BillingDetails/ShipAmount | currency | conditional | recurring shipping fees |    
-| BillingDetails/TaxAmount | currency | conditional | recurring tax fees |              +| BillingDetails/TaxAmount | currency | conditional | recurring tax fees |              
-| BillingDetails/NextBillingDate | datetime | conditional | next date subscription will charge |                  +| BillingDetails/NextBillingDate | datetime | conditional | next date subscription will charge |                  
-| BillingDetails/NumCyclesCompleted | integer | conditional | number of recurring charges completed |                  +| BillingDetails/NumCyclesCompleted | integer | conditional | number of recurring charges completed |                  
-| BillingDetails/LastPaymentDate | datetime | conditional | date of the previous (not final) charge |              +| BillingDetails/LastPaymentDate | datetime | conditional | date of the previous (not final) charge |              
-| BillingDetails/LastPaymentAmount | currency | conditional | amount of the previous (not final) charge |       +| BillingDetails/LastPaymentAmount | currency | conditional | amount of the previous (not final) charge |        
-| BillingDetails/CurrencyCode | string | conditional | valid ISO Currency Code |  +| BillingDetails/CurrencyCode | string | conditional | valid ISO Currency Code |   
-| **SubscriptionDetails** | container | conditional | Parent Element |  +| **SubscriptionDetails** | container | conditional | Parent Element |   
-| SubscriptionDetails/Description | string | required | Package Description |   +| SubscriptionDetails/Description | string | required | Package Description |    
-| BalanceTotal | currency | conditional | Total outstanding balance |  +| BalanceTotal | currency | conditional | Total outstanding balance |   
-| **BalanceDetails** | container | required | Parent Element | +| **BalanceDetails** | container | required | Parent Element |  
-| **Balance** | container | required | Parent Element | +| **Balance** | container | required | Parent Element |  
-| Balance/Balance | currency | required | Balance Amount |  +| Balance/Balance | currency | required | Balance Amount |   
-| Balance/IsPaid | boolean | required | True or False if balance is paid |  +| Balance/IsPaid | boolean | required | True or False if balance is paid |   
-| Balance/DtPaid | datetime | required | Date balance was paid |  +| Balance/DtPaid | datetime | required | Date balance was paid |   
-| **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 |  
-| Customer/BillingAddress/Company | string | optional | billing company | +| Customer/BillingAddress/Company | string | optional | billing company |  
-| Customer/BillingAddress/Address | string | required | billing address | +| Customer/BillingAddress/Address | string | required | billing address |  
-| Customer/BillingAddress/Address2 | string | optional | billing address line 2 | +| Customer/BillingAddress/Address2 | string | optional | billing address line 2 |  
-| Customer/BillingAddress/City | string | required | billing city | +| Customer/BillingAddress/City | string | required | billing city |  
-| Customer/BillingAddress/Region | string | conditional | billing state code or province | +| Customer/BillingAddress/Region | string | conditional | billing state code or province |  
-| Customer/BillingAddress/PostalCode | string | conditional | billing postal code | +| Customer/BillingAddress/PostalCode | string | conditional | billing postal code |  
-| 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 - if shipping is not associated with the subscription, the ShippingAddress element will be empty | +| **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/FirstName | string | required | shipping first name |  
-| Customer/ShippingAddress/LastName | string | required | shipping last name | +| Customer/ShippingAddress/LastName | string | required | shipping last name |  
-| Customer/ShippingAddress/Company | optional | required | shipping company | +| Customer/ShippingAddress/Company | optional | required | shipping company |  
-| Customer/ShippingAddress/Address | string | required | shipping address | +| Customer/ShippingAddress/Address | string | required | shipping address |  
-| Customer/ShippingAddress/Address2 | optional | required | shipping address line 2 | +| Customer/ShippingAddress/Address2 | optional | required | shipping address line 2 |  
-| Customer/ShippingAddress/City | string | required | shipping city | +| Customer/ShippingAddress/City | string | required | shipping city |  
-| Customer/ShippingAddress/Region | conditional | required | shipping state code or province | +| Customer/ShippingAddress/Region | conditional | required | shipping state code or province |  
-| Customer/ShippingAddress/PostalCode | conditional | required | shipping postal code | +| Customer/ShippingAddress/PostalCode | conditional | required | shipping postal code |  
-| 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 |  
-| 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 |
C:/Domains/subscrip/wiki.subscriptionbridge.com/wwwroot/sbdata10/attic/developer_guide/call_reference/getsubscriptiondetailsrequest.1348685702.txt.gz · Last modified: 2012/09/26 00:00 (external edit)
 


Contact us for more information, or head over to the free trial sign-up form to give SubscriptionBridge a try!   Sign Up Free