This is an old revision of the document!

GetPackagesRequest Call Reference

GetPackagesRequest will return a list of all packages for any given store or language.

View:

GetPackagesRequest

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"?>

    <GetPackagesRequest>
        <Username>string</Username>	
        <Token>string</Token>	
	<LanguageCode>integer</LanguageCode>	
    </GetPackagesRequest>

Elements

Name	Type	Occurrence	Meaning
GetPackagesRequest	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
LanguageCode	string	required	The language your package details will be displayed

GetPackagesResponse

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"?>
    <GetPackagesResponse>	
        <Status>string</Status>
	<Timestamp>timestamp</Timestamp>
        <Packages>
            <Package>
                <LinkID>string</LinkID>
                <PackageName>string</PackageName>
                <Description>string</Description>
                <Price>double</Price>
                <TrialPrice>double</TrialPrice>
                <TrialName>string</TrialName>
                <Disclaimer>string</Disclaimer>
                <TrialDescription>string</TrialDescription>
            </Package>
        </Packages>
    </GetPackagesResponse>

Elements

Name	Type	Occurrence	Meaning
GetPackagesResponse	container	required	Parent Element
Status	string	always	Success, Error, or Warning
Timestamp	string	always	All responses return the official SB time stamp in UTC/GMT
Packages	container	always	A container element that contains a list of repeating package elements
Package	container	always	A container element that contains the package elements
LinkID	string	always	The package LinkID
PackageName	string	always	The name of the package (e.g. XYZ Annual Magazine Subscription)
Price	double	always	The price of the package
TrialPrice	double	always	The trial price of the package
TrialName	string	always	The name of the trial (e.g. Try XYZ Magazine Free for 2 weeks)
Disclaimer	string	always	A custom message that accompanies the pricing terms (e.g. Plus shipping, tax, and handling)
TrialDescription	string	always	A description of the trial. (e.g. You will receive 2 issues of XYZ Magazine completely free of charge. If you don't wish to continue, you can simply cancel your subscription before the end of the trial.)

SubscriptionBridge: recurring billing and subscription management system - Documentation

Table of Contents

GetPackagesRequest Call Reference

GetPackagesRequest

Overview

XML

Elements

GetPackagesResponse

Overview

XML

Elements