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
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 01:28] – 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 27: Line 23:
  <Username>string</Username>  <Username>string</Username>
         <Token>string</Token>         <Token>string</Token>
-        <Guid>string</Guid>+        <Guid>string</Guid>         
 +        <PageSize>integer</PageSize> 
 +        <PageIndex>integer</PageIndex>
         <LanguageCode>string</LanguageCode>         <LanguageCode>string</LanguageCode>
     </GetSubscriptionHistoryRequest>     </GetSubscriptionHistoryRequest>
Line 39: 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 | 
-| TransactionID | string | optional | ... | +| PageSize | integer | always | The number of results per page | 
-| StartDate | string | optional | ... | +| PageIndex| integer | always | The the current results page (1 or higher) | 
-| EndDate | string | optional | ... | +| LanguageCode | string | required | ISO Language Code (e.g. en-US). [[:developer_guide:developer_guide:Language_Code|Learn More]] |
-| LanguageCode | string | required | The language your details will be returned. Requires that the language be enabled in the Merchant Center. | +
  
  
 ===== 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 67: Line 57:
         <Ack>string</Ack>         <Ack>string</Ack>
  <Timestamp>timestamp</Timestamp>  <Timestamp>timestamp</Timestamp>
-        <History> +        <Count>integer</Count> 
-            <Identifiers> +        <PageSize>integer</PageSize> 
-                <GUID>string</GUID> +        <PageIndex>integer</PageIndex> 
-            </Identifiers> +        <Transactions> 
-        </History>+            <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>     </GetSubscriptionHistoryResponse>
  
Line 82: 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 |
-| Subscription | container | always | A container element that contains the Subscription elements | +| Count | integer | always | The number of results per page | 
-| Identifiers | container | always | A container element that contains the Identifiers elements | +| PageSize | integer | always | The number of results per page | 
-| GUID | string | always | The unique Subscription ID | +| PageIndex| integer | always | The the current results page | 
-| BillingDetails | container | always | A container element that contains the BillingDetails elements | +| **Transactions** | container | conditional | A container element that contains the Subscription elements | 
-| StartDate | timestamp | always | The date the Subscription begins | +| **Transaction** | container | conditional | A container element that contains the Subscription elements | 
-| EndDate | timestamp | always | The date the Subscription begins | +| Transaction/Type | string | always | "Info" or "Payment" | 
-| BillingPeriod | string | always | Day, Week, or Month | +| Transaction/Date | datetime | always | The date of the transaction | 
-| BillingFrequency | integer | always | The Subscription's Frequency | +| Transaction/Description | string | always | A description of the transaction | 
-| TotalBillingCycles | integer | always | The number of billing cycles (0=Until Canceled) | +| Transaction/Notes| string | always | Details about the transaction | 
-| TrialBillingPeriod | string | always | Day, Week, or Month | +| Transaction/Amount | currency | conditional | Only displays for type "Payment" | 
-| TrialTotalBillingCycles | integer | always | The number of trial billing cycles (0=Until Canceled) | +| Transaction/RefID | string | conditional | Only displays for type "Payment" |
-| TrialEndDate | timestamp | always | The date the Subscription begins | +
-| Amount | double | always | The Subscription total, less tax and shipping | +
-| ShipAmount | double | always | The Subscription tax | +
-| TaxAmount | double | always | The Subscription shipping | +
-| NextBillingDate| timestamp | always | The date of the next recurring payment |              +
-| NextBillingAmt | double | always | The amount that will be captured on the NextBillingDate |   +
-| NumCyclesCompleted | integer | always | The number of billing cycles completed | +
-| NumCyclesRemaining | integer | always | The number of billing cycles remaining  +
-| LastPaymentDate | timestamp | always | The date of the final payment |  +
-| LastPaymentAmount | double | always | The amount that will be captured on the LastPaymentDate |  +
-| CurrencyCode | string | always | a valid currency code e.g. USD |             +
-| TrialShippingAmt | double | always | The trial shipping charge |  +
-| TrialTaxAmt | double | always | The trial tax charge |  +
-| TrialAmount | double | always | The trial total, less tax and shipping charges |  +
-| BalanceTotal | container | conditional| The total outstanding balance | +
-| BalanceDetails | double | conditional| A container element that contains a list outstanding balances | +
-| Balance | container | always | A container element that contains the balance elements | +
-| Amount| double | always | The amount of the outstanding balance | +
-| Reason | string | always | A description of the outstanding balance | +
-| Terms | string | always | The terms for the subscription (e.g. Free for 2 Months) | +
developer_guide/call_reference/activitysearch.1325053726.txt.gz · Last modified: 2011/12/26 23:00 (external edit)