developer_guide:call_reference:getsubscriptionsrequest
Table of Contents
GetSubscriptionsRequest
Overview
GetSubscriptionsRequest will return a list of all subscriptions associated with the store.
Learn More:
GetSubscriptionsRequest
XML
<?xml version="1.0" encoding="utf-8"?> <GetSubscriptionsRequest> <Username>string</Username> <Token>string</Token> </GetSubscriptionsRequest>
Elements
Name | Type | Occurrence | Meaning |
---|---|---|---|
GetSubscriptionsRequest | container | required | Parent Element |
Username | string | required | Merchant API Username (Not your Merchant Center login) |
Token | string | required | Hash of API Username and Password. Creating a Token |
LinkID | string | required | The Subscription Package ID Learn More |
GetSubscriptionsResponse
XML
<?xml version="1.0" encoding="utf-8"?> <GetSubscriptionsResponse> <Ack>string</Ack> <Subscriptions> <Subscription> <Identifiers> <Guid>string</Guid> </Identifiers> <BillingDetails> <StartDate>datetime</StartDate> <EndDate>datetime</EndDate> <BillingPeriod>string</BillingPeriod> <BillingFrequency>integer</BillingFrequency> <TrialBillingFrequency>integer</TrialBillingFrequency> <TrialEndDate>datetime</TrialEndDate> <Amount>currency</Amount> <ShipAmount>currency</ShipAmount> <TaxAmount>currency</TaxAmount> <NextBillingDate>datetime</NextBillingDate> <NumCyclesCompleted>integer</NumCyclesCompleted> <LastPaymentDate>datetime</LastPaymentDate> <LastPaymentAmount>currency</LastPaymentAmount> <CurrencyCode>string</CurrencyCode> </BillingDetails> <SubscriptionDetails> <Description>string</Description> </SubscriptionDetails> </Subscription> </Subscriptions> <Timestamp>timestamp</Timestamp> </GetSubscriptionsResponse>
Elements
Name | Type | Occurrence | Meaning |
---|---|---|---|
GetSubscriptionsResponse | container | required | Parent Element |
Subscriptions | container | conditional | 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 |
Ack | string | always | Success, Error, or Warning |
Timestamp | string | always | All responses return the official SB time stamp in UTC/GMT |
developer_guide/call_reference/getsubscriptionsrequest.txt · Last modified: 2012/02/25 23:37 by matt