Differences

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

--- developer_guide:call_reference:getsubscriptionsrequest [2012/02/18 00:42] – created matt
+++ developer_guide:call_reference:getsubscriptionsrequest [2012/02/25 23:37] (current) – [GetSubscriptionsRequest] matt
@@ Line 1: / Line 1: @@
-====== GetSubscriptionsRequest Call Reference ======
+====== GetSubscriptionsRequest ======
-GetSubscriptionsRequest will return a list of all subscriptions associated with the store.
+==== Overview ====
+**GetSubscriptionsRequest** will return a list of all subscriptions associated with the store.
-**View:**
+**Learn More:**
   * [[:developer_guide:developer_guide#using-the-apis|Using the APIs]]
@@ Line 9: / Line 11: @@
   * [[:developer_guide:developer_guide#error-codes|Error Codes]]
   * [[:developer_guide:developer_guide#troubleshooting|Troubleshooting]]
 ===== GetSubscriptionsRequest =====
-==== 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.
@@ Line 36: / Line 33: @@
 ^ Name ^ Type ^ Occurrence  ^ Meaning ^
-| GetSubscriptionsRequest | container | required | Parent Element |
+| **GetSubscriptionsRequest** | 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]] |
-| LinkID | string | required | The Package Unique ID |
+| LinkID | string | required | The Subscription Package ID [[:developer_guide:developer_guide:LinkID|Learn More]] |
 ===== GetSubscriptionsResponse =====
-==== 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 95: / Line 86: @@
 ^ Name ^ Type ^ Occurrence  ^ Meaning ^
-| GetSubscriptionsResponse | container | required | Parent Element |
+| **GetSubscriptionsResponse** | container | required | Parent Element |
-| Subscriptions | container | conditional | Parent Element |
+| **Subscriptions** | container | conditional | Parent Element |
-| Subscription | container | conditional | Parent Element |
+| **Subscription** | container | conditional | Parent Element |
-| Identifiers | container | conditional | Parent Element |
+| **Identifiers** | container | conditional | Parent Element |
-| Guid | string | always | Unique Subscription ID or Order ID |
+| Identifiers/Guid | string | always | Unique Subscription ID or Order ID |
-| BillingDetails | container| conditional | Parent Element |
+| **BillingDetails** | container| conditional | Parent Element |
-| StartDate | datetime | always | Date subscription started |
+| BillingDetails/StartDate | datetime | always | Date subscription started |
-| EndDate | datetime | conditional | Date subscription ends |
+| BillingDetails/EndDate | datetime | conditional | Date subscription ends |
-| BillingPeriod | string | conditional | Day, Month, or Year |
+| BillingDetails/BillingPeriod | string | conditional | Day, Month, or Year |
-| BillingFrequency | integer | conditional | rate at which subscription renews |
+| BillingDetails/BillingFrequency | integer | conditional | rate at which subscription renews |
-| TrialBillingFrequency | integer | conditional | rate at which trial subscription renews |
+| BillingDetails/TrialBillingFrequency | integer | conditional | rate at which trial subscription renews |
-| TrialEndDate | datetime | conditional | Date trial ends |
+| BillingDetails/TrialEndDate | datetime | conditional | Date trial ends |
-| Amount | currency | conditional | recurring price |
+| BillingDetails/Amount | currency | conditional | recurring price |
-| ShipAmount | currency | conditional | recurring shipping fees |
+| BillingDetails/ShipAmount | currency | conditional | recurring shipping fees |
-| TaxAmount | currency | conditional | recurring tax fees |
+| BillingDetails/TaxAmount | currency | conditional | recurring tax fees |
-| NextBillingDate | datetime | conditional | next date subscription will charge |
+| BillingDetails/NextBillingDate | datetime | conditional | next date subscription will charge |
-| NumCyclesCompleted | integer | conditional | number of recurring charges completed |
+| BillingDetails/NumCyclesCompleted | integer | conditional | number of recurring charges completed |
-| LastPaymentDate | datetime | conditional | date of the previous (not final) charge |
+| BillingDetails/LastPaymentDate | datetime | conditional | date of the previous (not final) charge |
-| LastPaymentAmount | currency | conditional | amount of the previous (not final) charge |
+| BillingDetails/LastPaymentAmount | currency | conditional | amount of the previous (not final) charge |
-| CurrencyCode | string | conditional | valid ISO Currency Code |
+| BillingDetails/CurrencyCode | string | conditional | valid ISO Currency Code |
+| **SubscriptionDetails** | container | conditional | Parent Element |
+| SubscriptionDetails/Description | string | required | Package Description |
 | Ack | string | always | Success, Error, or Warning |
 | Timestamp | string | always | All responses return the official SB time stamp in UTC/GMT |