developer_guide:call_reference:getsubscriptiondetailsrequest
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
developer_guide:call_reference:getsubscriptiondetailsrequest [2010/12/19 00:53] – matt | developer_guide:call_reference:getsubscriptiondetailsrequest [2012/09/26 14:55] (current) – [Elements] mebstein | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== GetSubscriptionDetailsRequest | + | ====== 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:** |
* [[: | * [[: | ||
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 39: | Line 36: | ||
^ Name ^ Type ^ Occurrence | ^ Name ^ Type ^ Occurrence | ||
- | | GetSubscriptionDetailsRequest | container | required | Parent Element | | + | | **GetSubscriptionDetailsRequest** | container | required | Parent Element | |
- | | Username| string | required | Merchant API username | + | | Username | string | required | Merchant API Username |
- | | Token| string | required | Your application' | + | | Token| string | required | Hash of API Username and Password. [[:developer_guide: |
- | | GUID | string | required | + | | GUID | string | always |
- | | 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). [[: |
===== 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 77: | Line 68: | ||
< | < | ||
< | < | ||
- | < | + | < |
- | < | + | < |
- | < | + | < |
< | < | ||
- | < | + | < |
< | < | ||
< | < | ||
< | < | ||
< | < | ||
- | < | + | < |
< | < | ||
- | < | + | < |
- | < | + | < |
- | < | + | < |
</ | </ | ||
< | < | ||
Line 98: | Line 89: | ||
< | < | ||
< | < | ||
- | < | + | < |
< | < | ||
< | < | ||
Line 123: | Line 114: | ||
< | < | ||
</ | </ | ||
+ | < | ||
</ | </ | ||
</ | </ | ||
Line 128: | Line 120: | ||
</ | </ | ||
- | |||
Line 135: | Line 126: | ||
^ Name ^ Type ^ Occurrence | ^ Name ^ Type ^ Occurrence | ||
- | | GetSubscriptionDetailsResponse| container | required | Parent Element | | + | | **GetSubscriptionDetailsResponse** | container | required | Parent Element | |
- | | Ack | string | always | Success, Error, or Warning | | + | | **Subscription** | container | conditional |
- | | Timestamp | string | always | All responses return the official SB time stamp in UTC/GMT | | + | | **Identifiers** | container | conditional |
- | | Subscription | container | always | + | | Identifiers/ |
- | | Identifiers | container | always | + | | **BillingDetails** | container| |
- | | GUID | string | always | The unique | + | | BillingDetails/ |
- | | BillingDetails | container | always | + | | BillingDetails/ |
- | | StartDate | timestamp | + | | BillingDetails/ |
- | | EndDate | timestamp | + | | BillingDetails/ |
- | | BillingPeriod | string | always | + | | BillingDetails/ |
- | | BillingFrequency | integer | always | + | | BillingDetails/ |
- | | TotalBillingCycles | + | | BillingDetails/ |
- | | TrialBillingPeriod | + | | BillingDetails/ |
- | | TrialTotalBillingCycles | + | | BillingDetails/ |
- | | TrialEndDate | + | | BillingDetails/ |
- | | Amount | + | | BillingDetails/ |
- | | ShipAmount | + | | BillingDetails/ |
- | | TaxAmount | + | | BillingDetails/ |
- | | NextBillingDate| timestamp | + | | BillingDetails/ |
- | | NextBillingAmt | + | | **SubscriptionDetails** | container | conditional | Parent Element | |
- | | NumCyclesCompleted | + | | SubscriptionDetails/ |
- | | NumCyclesRemaining | + | | BalanceTotal |
- | | LastPaymentDate | + | | **BalanceDetails** | container | required | Parent Element | |
- | | LastPaymentAmount | + | | **Balance** | container | required | Parent Element | |
- | | CurrencyCode | + | | Balance/ |
- | | TrialShippingAmt | + | | Balance/ |
- | | TrialTaxAmt | + | | Balance/ |
- | | TrialAmount | + | | **Customer** | container | required | Parent Element | |
- | | BalanceTotal | + | | Customer/ |
- | | BalanceDetails | + | | Customer/ |
- | | Balance | + | | Customer/ |
- | | Amount| double | + | | **Customer/ |
- | | Reason | + | | Customer/ |
- | | Terms | string | always | + | | Customer/ |
+ | | Customer/ | ||
+ | | Customer/ | ||
+ | | Customer/ | ||
+ | | Customer/ | ||
+ | | Customer/ | ||
+ | | Customer/ | ||
+ | | Customer/ | ||
+ | | Customer/ | ||
+ | | **Customer/ | ||
+ | | Customer/ | ||
+ | | Customer/ | ||
+ | | Customer/ | ||
+ | | Customer/ | ||
+ | | Customer/ | ||
+ | | Customer/ | ||
+ | | Customer/ | ||
+ | | Customer/ | ||
+ | | Customer/ | ||
+ | | Customer/ | ||
+ | | Customer/ | ||
+ | | Customer/ |
developer_guide/call_reference/getsubscriptiondetailsrequest.1292737988.txt.gz · Last modified: 2010/12/17 23:00 (external edit)