This is an old revision of the document!

GetSubscriptionsRequest Call Reference

GetSubscriptionsRequest will return a list of all subscriptions associated with the store.

View:

GetSubscriptionsRequest

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 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 (this is not your SubscriptionBridge login id)
Token	string	required	Your application's security token. view also: How to create a token
LinkID	string	required	The Package Unique ID

GetSubscriptionsResponse

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.

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
Guid	string	always	Unique Subscription ID or Order ID
BillingDetails	container	conditional	Parent Element
StartDate	datetime	always	Date subscription started
EndDate	datetime	conditional	Date subscription ends
BillingPeriod	string	conditional	Day, Month, or Year
BillingFrequency	integer	conditional	rate at which subscription renews
TrialBillingFrequency	integer	conditional	rate at which trial subscription renews
TrialEndDate	datetime	conditional	Date trial ends
Amount	currency	conditional	recurring price
ShipAmount	currency	conditional	recurring shipping fees
TaxAmount	currency	conditional	recurring tax fees
NextBillingDate	datetime	conditional	next date subscription will charge
NumCyclesCompleted	integer	conditional	number of recurring charges completed
LastPaymentDate	datetime	conditional	date of the previous (not final) charge
LastPaymentAmount	currency	conditional	amount of the previous (not final) charge
CurrencyCode	string	conditional	valid ISO Currency Code
Ack	string	always	Success, Error, or Warning
Timestamp	string	always	All responses return the official SB time stamp in UTC/GMT

SubscriptionBridge: recurring billing and subscription management system - Documentation

Table of Contents

GetSubscriptionsRequest Call Reference