SubscriptionBridge: recurring billing and subscription management system - Documentation

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== GetSubscriptionHistoryRequest ======

==== Overview ====

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

**Learn More:**

  * [[:developer_guide:developer_guide#using-the-apis|Using the APIs]]  
  * [[:developer_guide:developer_guide#http-status-code|HTTP Status Codes]]  
  * [[:developer_guide:developer_guide#error-codes|Error Codes]] 
  * [[:developer_guide:developer_guide#troubleshooting|Troubleshooting]] 


===== GetSubscriptionHistoryRequest =====

==== XML ====

<code>

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

</code>



==== 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. [[:developer_guide:developer_guide:LinkID|Creating a Token]] |
| Guid | string | always | This is the identifier for the subscription and should be referenced in future management requests. Note it is in mixed case unlike GetSubscriptionDetailsRequest |
| PageSize | integer | always | The number of results per page |
| PageIndex| integer | always | The the current results page (1 or higher) |
| LanguageCode | string | required | ISO Language Code (e.g. en-US). [[:developer_guide:developer_guide:Language_Code|Learn More]] |


===== GetSubscriptionHistoryResponse =====


==== XML ====

<code>

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

</code>



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