no way to compare when less than two revisions

Differences

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

@@ Line 1: / Line 1: @@
+====== GetSubscriptionDetailsRequest ======
+==== Overview ====
+**GetSubscriptionDetailsRequest** will **return details about an existing Subscription** in the SubscriptionBridge system.
+**Learn More:**
+  * [[:developer_guide:developer_guide#using-the-apis|Using the APIs]]
+  * [[:developer_guide:developer_guide#http-status-code|HTTP Status Codes]]
+  * [[:developer_guide:developer_guide#error-codes|Error Codes]]
+  * [[:developer_guide:developer_guide#troubleshooting|Troubleshooting]]
+===== GetSubscriptionDetailsRequest =====
+==== XML ====
+<code>
+<?xml version="1.0" encoding="utf-8"?>
+    <GetSubscriptionDetailsRequest>
+	<Username>string</Username>
+        <Token>string</Token>
+        <GUID>string</GUID>
+        <LanguageCode>string</LanguageCode>
+    </GetSubscriptionDetailsRequest>
+</code>
+==== Elements ====
+^ Name ^ Type ^ Occurrence  ^ Meaning ^
+| **GetSubscriptionDetailsRequest** | container | required | Parent Element |
+| 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]] |
+| 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]] |
+===== GetSubscriptionDetailsResponse =====
+==== XML ====
+<code>
+<?xml version="1.0" encoding="utf-8"?>
+    <GetSubscriptionDetailsResponse>
+        <Ack>string</Ack>
+	<Timestamp>timestamp</Timestamp>
+        <Subscription>
+            <Identifiers>
+                <GUID>string</GUID>
+            </Identifiers>
+            <BillingDetails>
+                <StartDate>timestamp</StartDate>
+                <EndDate>timestamp</EndDate>
+                <BillingPeriod>string</BillingPeriod>
+                <BillingFrequency>integer</BillingFrequency>
+                <TotalBillingCycles>integer</TotalBillingCycles>
+                <TrialBillingPeriod>string</TrialBillingPeriod>
+                <TrialTotalBillingCycles>integer</TrialTotalBillingCycles>
+                <TrialEndDate>timestamp</TrialEndDate>
+                <Amount>currency</Amount>
+                <ShipAmount>currency</ShipAmount>
+                <TaxAmount>currency</TaxAmount>
+                <NextBillingDate>timestamp</NextBillingDate>
+                <NextBillingAmt>currency</NextBillingAmt>
+                <NumCyclesCompleted>integer</NumCyclesCompleted>
+                <NumCyclesRemaining>integer</NumCyclesRemaining>
+                <OutstandingBalance>integer</OutstandingBalance>
+                <LastPaymentDate>timestamp</LastPaymentDate>
+                <LastPaymentAmount>currency</LastPaymentAmount>
+                <CurrencyCode>string</CurrencyCode>
+                <TrialShippingAmt>currency</TrialShippingAmt>
+                <TrialTaxAmt>currency</TrialTaxAmt>
+                <TrialAmount>currency</TrialAmount>
+            </BillingDetails>
+            <SubscriptionDetails>
+                <Description>string</Description>
+            </SubscriptionDetails>
+            <BalanceTotal></BalanceTotal>
+            <BalanceDetails>
+                <Balance>
+                    <Balance>currency</Balance>
+                    <Reason>string</Reason>
+                    <IsPaid>boolean</IsPaid>
+                    <DtPaid>timestamp</DtPaid>
+                </Balance>
+            </BalanceDetails>
+            <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>
+    </GetSubscriptionDetailsResponse>
+</code>
+==== Elements ====
+^ Name ^ Type ^ Occurrence  ^ Meaning ^
+| **GetSubscriptionDetailsResponse** | container | required | Parent Element |
+| **Subscription** | container | conditional | Parent Element |
+| **Identifiers** | container | conditional | Parent Element |
+| Identifiers/Guid | string | always | Unique Subscription ID or Order ID |
+| **BillingDetails** | container| conditional | Parent Element |
+| BillingDetails/StartDate | datetime | always | Date subscription started |
+| BillingDetails/EndDate | datetime | conditional | Date subscription ends |
+| BillingDetails/BillingPeriod | string | conditional | Day, Month, or Year |
+| BillingDetails/BillingFrequency | integer | conditional | rate at which subscription renews |
+| BillingDetails/TrialBillingFrequency | integer | conditional | rate at which trial subscription renews |
+| BillingDetails/TrialEndDate | datetime | conditional | Date trial ends |
+| BillingDetails/Amount | currency | conditional | recurring price |
+| BillingDetails/ShipAmount | currency | conditional | recurring shipping fees |
+| BillingDetails/TaxAmount | currency | conditional | recurring tax fees |
+| BillingDetails/NextBillingDate | datetime | conditional | next date subscription will charge |
+| BillingDetails/NumCyclesCompleted | integer | conditional | number of recurring charges completed |
+| BillingDetails/LastPaymentDate | datetime | conditional | date 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 |
+| **SubscriptionDetails** | container | conditional | Parent Element |
+| SubscriptionDetails/Description | string | required | Package Description |
+| BalanceTotal | currency | conditional | Total outstanding balance |
+| **BalanceDetails** | container | required | Parent Element |
+| **Balance** | container | required | Parent Element |
+| Balance/Balance | currency | required | Balance Amount |
+| Balance/IsPaid | boolean | required | True or False if balance is paid |
+| Balance/DtPaid | datetime | required | Date balance was paid |
+| **Customer** | container | required | Parent Element |
+| Customer/Email | string | required | customer email address |
+| Customer/FirstName | string | required | customer first name |
+| Customer/LastName | string | required | customer last name |
+| **Customer/BillingAddress** | container | required | Parent Element |
+| 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 - 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 |