developer_guide:call_reference:activitysearch
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
developer_guide:call_reference:activitysearch [2011/12/28 01:28] – matt | developer_guide:call_reference:activitysearch [2012/05/01 17:13] (current) – [Elements] mebstein | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== GetSubscriptionHistoryRequest | + | ====== GetSubscriptionHistoryRequest ====== |
- | ===== What it does ===== | + | ==== Overview |
- | //GetSubscriptionHistoryRequest// lets you query **all subscription activity**, such as transactions, | + | **GetSubscriptionHistoryRequest** lets you query **all subscription activity**, such as transactions, |
- | ==== Related articles ==== | + | **Learn More:** |
* [[: | * [[: | ||
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: | ||
< | < | ||
< | < | ||
- | < | + | < |
+ | < | ||
+ | < | ||
< | < | ||
</ | </ | ||
Line 39: | Line 37: | ||
^ Name ^ Type ^ Occurrence | ^ Name ^ Type ^ Occurrence | ||
- | | GetSubscriptionHistoryRequest | container | required | Parent Element | | + | | **GetSubscriptionHistoryRequest** | container | required | Parent Element | |
- | | Username| string | required | Merchant API username | + | | Username | string | required | Merchant API Username |
- | | Token| string | required | Your application' | + | | Token| string | required | Hash of API Username and Password. [[:developer_guide: |
- | | Guid | string | required | The unique Subscription ID | | + | | Guid | string | always |
- | | TransactionID | string | optional | + | | PageSize |
- | | StartDate | + | | PageIndex| integer |
- | | EndDate | + | | LanguageCode | string | required | ISO Language Code (e.g. en-US). [[: |
- | | 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: | ||
< | < | ||
< | < | ||
- | <History> | + | <Count> |
- | <Identifiers> | + | < |
- | <GUID> | + | < |
- | </Identifiers> | + | < |
- | </History> | + | <Transaction> |
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | </ | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | <RefID> | ||
+ | </Transaction> | ||
+ | </Transactions> | ||
</ | </ | ||
Line 82: | Line 88: | ||
^ Name ^ Type ^ Occurrence | ^ Name ^ Type ^ Occurrence | ||
- | | 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 | + | | Count | integer |
- | | Identifiers | + | | PageSize |
- | | GUID | string | + | | PageIndex| integer |
- | | BillingDetails | + | | **Transactions** |
- | | StartDate | + | | **Transaction** |
- | | EndDate | timestamp | always | The date the Subscription begins | | + | | Transaction/ |
- | | BillingPeriod | + | | Transaction/ |
- | | BillingFrequency | + | | Transaction/ |
- | | TotalBillingCycles | integer | always | The number of billing cycles (0=Until Canceled) | | + | | Transaction/ |
- | | TrialBillingPeriod | string | always | Day, Week, or Month | | + | | Transaction/ |
- | | TrialTotalBillingCycles | integer | always | The number of trial billing cycles (0=Until Canceled) | | + | | Transaction/ |
- | | 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 | + | |
- | | NextBillingAmt | + | |
- | | 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 | + | |
- | | CurrencyCode | + | |
- | | 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 | + | |
- | | BalanceDetails | + | |
- | | 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)