This is an old revision of the document!

GetSubscriptionHistoryRequest Call Reference

What it does

GetSubscriptionHistoryRequest lets you query all subscription activity, such as transactions, feature changes, upgrades and downgrades, etc.

GetSubscriptionHistoryRequest

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"?>
    <GetSubscriptionHistoryRequest>
	<Username>string</Username>
        <Token>string</Token>
        <Guid>string</Guid>        
        <PageSize>integer</PageSize>
        <PageIndex>integer</PageIndex>
        <LanguageCode>string</LanguageCode>
    </GetSubscriptionHistoryRequest>

Elements

Name	Type	Occurrence	Meaning
GetSubscriptionHistoryRequest	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
PageSize	integer	optional	The number of results per page
PageIndex	integer	optional	The the current results page
LanguageCode	string	optional	The language your details will be returned. Requires that the language be enabled in the Merchant Center. This defaults to the customer's default language.

GetSubscriptionHistoryResponse

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"?>
    <GetSubscriptionHistoryResponse>	
        <Ack>string</Ack>
	<Timestamp>timestamp</Timestamp>
        <Count>integer</Count>
        <PageSize>integer</PageSize>
        <PageIndex>integer</PageIndex>
        <Transactions>
            <Transaction>
                <Type>string</Type>
                <Date>datetime</Date>                
                <Description>string</Description>
                <Notes>string</Notes>
                <Amount>double</Amount>
                <RefID>string</RefID>
            </Transaction>
            <Transaction>
                <Type>string</Type>
                <Date>datetime</Date>                
                <Description>string</Description>
                <Notes>string</Notes>
                <Amount>double</Amount>
                <RefID>string</RefID>
            </Transaction>
        </Transactions>
    </GetSubscriptionHistoryResponse>

Elements

Name	Type	Occurrence	Meaning
GetSubscriptionHistoryResponse	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
Count	integer	always	The number of results per page
PageSize	integer	always	The number of results per page
PageIndex	integer	always	The the current results page
Transactions	container	conditional	A container element that contains the Subscription elements
Transaction	container	conditional	A container element that contains the Subscription elements
Type	string	always	“Info” or “Payment”
Date	datetime	always	The date of the transaction
Description	string	always	A description of the transaction
Notes	string	always	Details about the transaction
Amount	currency	conditional	Only displays for type “Payment”
RefID	string	conditional	Only displays for type “Payment”

SubscriptionBridge: recurring billing and subscription management system - Documentation

Table of Contents

GetSubscriptionHistoryRequest Call Reference

What it does