SubscriptionBridge: recurring billing and subscription management system - Documentation

User Tools

Site Tools

You are here: SubscriptionBridge Documentation » API Documentation: Getting Started » API Call Reference » GetSubscriptionHistoryRequest
Trace: • GetSubscriptionHistoryRequest • Shopping Cart Integration: Recommended Specifications
developer_guide:call_reference:activitysearch

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
developer_guide:call_reference:activitysearch [2011/12/28 23:43] – mattdeveloper_guide:call_reference:activitysearch [2012/05/01 17:13] (current) – [Elements] mebstein
Line 1: Line 1:
-====== GetSubscriptionHistoryRequest Call Reference ======+====== GetSubscriptionHistoryRequest ======
  
-===== What it does =====+==== Overview ====
  
-//GetSubscriptionHistoryRequest// lets you query **all subscription activity**, such as transactions, feature changes, upgrades and downgrades, etc.+**GetSubscriptionHistoryRequest** lets you query **all subscription activity**, such as transactions, feature changes, upgrades and downgrades, etc.
  
-==== Related articles ====+**Learn More:**
  
   * [[:developer_guide:developer_guide#using-the-apis|Using the APIs]]     * [[:developer_guide:developer_guide#using-the-apis|Using the APIs]]  
Line 14: Line 14:
  
 ===== GetSubscriptionHistoryRequest ===== ===== 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 ====
Line 41: Line 37:
  
 ^ Name ^ Type ^ Occurrence  ^ Meaning ^ ^ Name ^ Type ^ Occurrence  ^ Meaning ^
-| GetSubscriptionHistoryRequest | container | required | Parent Element | +| **GetSubscriptionHistoryRequest** | container | required | Parent Element | 
-| Username| string | required | Merchant API username (this is not your SubscriptionBridge login id) | +| Username | string | required | Merchant API Username (Not your Merchant Center login) | 
-| Token| string | required | Your application's security token. view also: How to create a token | +| Token| string | required | Hash of API Username and Password. [[:developer_guide:developer_guide:LinkID|Creating a Token]] | 
-| Guid | string | required | The unique Subscription ID | +| 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 | optional | The number of results per page | +| PageSize | integer | always | The number of results per page | 
-| PageIndex| integer | optional | The the current results page | +| PageIndex| integer | always | The the current results page (1 or higher) | 
-| 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. | +| LanguageCode | string | required | ISO Language Code (e.g. en-US). [[:developer_guide:developer_guide:Language_Code|Learn More]] |
  
  
 ===== GetSubscriptionHistoryResponse ===== ===== 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. 
- 
  
  
Line 99: Line 88:
  
 ^ Name ^ Type ^ Occurrence  ^ Meaning ^ ^ Name ^ Type ^ Occurrence  ^ Meaning ^
-| GetSubscriptionHistoryResponse| container | required | Parent Element |+| **GetSubscriptionHistoryResponse** | container | required | Parent Element |
 | Ack | string | always | Success, Error, or Warning | | Ack | string | always | Success, Error, or Warning |
 | Timestamp | string | always | All responses return the official SB time stamp in UTC/GMT | | Timestamp | string | always | All responses return the official SB time stamp in UTC/GMT |
Line 105: Line 94:
 | PageSize | 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 | | PageIndex| integer | always | The the current results page |
-| Transactions | container | conditional | A container element that contains the Subscription elements | +| **Transactions** | container | conditional | A container element that contains the Subscription elements | 
-| Transaction | 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" | +| Transaction/Type | string | always | "Info" or "Payment" | 
-| Date | datetime | always | The date of the transaction | +| Transaction/Date | datetime | always | The date of the transaction | 
-| Description | string | always | A description of the transaction | +| Transaction/Description | string | always | A description of the transaction | 
-| Notes| string | always | Details about the transaction | +| Transaction/Notes| string | always | Details about the transaction | 
-| Amount | currency | conditional | Only displays for type "Payment" | +| Transaction/Amount | currency | conditional | Only displays for type "Payment" | 
-| RefID | string | conditional | Only displays for type "Payment" | +| Transaction/RefID | string | conditional | Only displays for type "Payment" |
developer_guide/call_reference/activitysearch.1325133810.txt.gz · Last modified: 2011/12/27 23:00 (external edit)