developer_guide:call_reference:activitysearch
This is an old revision of the document!
Table of Contents
GetSubscriptionHistoryRequest
Overview
GetSubscriptionHistoryRequest lets you query all subscription activity, such as transactions, feature changes, upgrades and downgrades, etc.
Learn More:
GetSubscriptionHistoryRequest
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 (Not your Merchant Center login) |
Token | string | required | Hash of API Username and Password. Creating a Token |
Guid | string | always | This is the identifier for the subscription and should be referenced in future management requests |
PageSize | integer | optional | The number of results per page |
PageIndex | integer | optional | The the current results page |
LanguageCode | string | required | ISO Language Code (e.g. en-US). Learn More |
GetSubscriptionHistoryResponse
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 |
Transaction/Type | string | always | “Info” or “Payment” |
Transaction/Date | datetime | always | The date of the transaction |
Transaction/Description | string | always | A description of the transaction |
Transaction/Notes | string | always | Details about the transaction |
Transaction/Amount | currency | conditional | Only displays for type “Payment” |
Transaction/RefID | string | conditional | Only displays for type “Payment” |
developer_guide/call_reference/activitysearch.1330231716.txt.gz · Last modified: 2012/02/24 23:00 (external edit)