This is an old revision of the document!

GetSubscriptionDetailsRequest Call Reference

What it does

GetSubscriptionDetailsRequest will return details about an existing Subscription in the SubscriptionBridge system.

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 version="1.0" encoding="utf-8"?>
    <GetSubscriptionDetailsRequest>
	<Username>string</Username>
        <Token>string</Token>
        <Guid>string</Guid>
        <LanguageCode>string</LanguageCode>
    </GetSubscriptionDetailsRequest>

Elements

Name	Type	Occurrence	Meaning
GetSubscriptionDetailsRequest	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
Guid	string	required	The unique Subscription ID
LanguageCode	string	required	The language your details will be returned. Requires that the language be enabled in the Merchant Center.

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.

XML

<?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>double</Amount>
                <ShipAmount>double</ShipAmount>
                <TaxAmount>double</TaxAmount>
                <NextBillingDate>timestamp</NextBillingDate>
                <NextBillingAmt>double</NextBillingAmt>
                <NumCyclesCompleted>integer</NumCyclesCompleted>
                <NumCyclesRemaining>integer</NumCyclesRemaining>
                <OutstandingBalance>integer</OutstandingBalance>
                <LastPaymentDate>timestamp</LastPaymentDate>
                <LastPaymentAmount>double</LastPaymentAmount>
                <CurrencyCode>string</CurrencyCode>
                <TrialShippingAmt>double</TrialShippingAmt>
                <TrialTaxAmt>double</TrialTaxAmt>
                <TrialAmount>double</TrialAmount>
            </BillingDetails>
            <BalanceTotal></BalanceTotal>
            <BalanceDetails>
                <Balance>
                    <Balance>double</Balance>
                    <Reason>string</Reason>
                    <IsPaid>boolean</IsPaid>
                    <DtPaid>timestamp</DtPaid>
                </Balance>
            </BalanceDetails>
            <Terms>string</Terms>
        </Subscription>
    </GetSubscriptionDetailsResponse>

Elements

Name	Type	Occurrence	Meaning
GetSubscriptionDetailsResponse	container	required	Parent Element
Ack	string	always	Success, Error, or Warning
Timestamp	string	always	All responses return the official SB time stamp in UTC/GMT
Subscription	container	always	A container element that contains the Subscription elements
Identifiers	container	always	A container element that contains the Identifiers elements
Guid	string	always	The unique Subscription ID
BillingDetails	container	always	A container element that contains the BillingDetails elements
StartDate	timestamp	always	The date the Subscription begins
EndDate	timestamp	always	The date the Subscription begins
BillingPeriod	string	always	Day, Week, or Month
BillingFrequency	integer	always	The Subscription's Frequency
TotalBillingCycles	integer	always	The number of billing cycles (0=Until Canceled)
TrialBillingPeriod	string	always	Day, Week, or Month
TrialTotalBillingCycles	integer	always	The number of trial billing cycles (0=Until Canceled)
TrialEndDate	timestamp	always	The date the Subscription begins
Amount	double	always	The Subscription total, less tax and shipping
ShipAmount	double	always	The Subscription tax
TaxAmount	double	always	The Subscription shipping
NextBillingDate	timestamp	always	The date of the next recurring payment
NextBillingAmt	double	always	The amount that will be captured on the NextBillingDate
NumCyclesCompleted	integer	always	The number of billing cycles completed
NumCyclesRemaining	integer	always
LastPaymentDate	timestamp	always	The date of the final payment
LastPaymentAmount	double	always	The amount that will be captured on the LastPaymentDate
CurrencyCode	string	always	a valid currency code e.g. USD
TrialShippingAmt	double	always	The trial shipping charge
TrialTaxAmt	double	always	The trial tax charge
TrialAmount	double	always	The trial total, less tax and shipping charges
BalanceTotal	container	conditional	The total outstanding balance
BalanceDetails	double	conditional	A container element that contains a list outstanding balances
Balance	container	always	A container element that contains the balance elements
Amount	double	always	The amount of the outstanding balance
Reason	string	always	A description of the outstanding balance
Terms	string	always	The terms for the subscription (e.g. Free for 2 Months)

SubscriptionBridge: recurring billing and subscription management system - Documentation

Table of Contents

GetSubscriptionDetailsRequest Call Reference

What it does