get
https://restapi.ordergroove.com/subscriptions/
Returns a list all of customer subscriptions for a merchant, or a list of subscriptions for an individual customer.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Authentication✔️ Application API Scope
✔️ Storefront API Scope
Note: Application API Scope with Bulk Operations permission is required to list subscriptions for more than one customer.
Response Body Definitions
| Name | Type | Description | Example |
|---|---|---|---|
| customer | string | Customer ID | "00026001" |
| merchant | string | Merchant ID | "ac4f7938383a11e89ecbbc764e1107f2" |
| product | string | Product ID | "0070000693" |
| payment | string | Payment record ID | "070001bc02fd11e99542bc764e1043b0" |
| shipping_address | string | Shipping address record ID | "66c25cd0564011e9abc5bc764e107990" |
| offer | string | Offer ID | "a748aa648ac811e8af3bbc764e106cf4" |
| offer_profile_public_id | string | Offer profile ID | "55a13e38981e43a0a59d30391d91d004" |
| subscription_type | string | Subscription Type | "Replenish" |
| components | string | Legacy Bundle components | "product_id_1,product_id_2" |
| components | array of objects | New Bundle components | See example below |
| extra_data | string | Raw JSON string that should be JSON.parse() as key/value store for any extra information. | See example below |
| public_id | string | Subscription ID | "f9cb2f93e1c845eb9de9eff46ddb3cbf" |
| product_attribute | string | "null" | |
| quantity | integer | Number of items | 21 |
| price | string | Price Note: Usually passed as "null" unless you explicitly lock a subscription price | "12.99" |
| frequency_days | integer | Order placement interval in days | 42 |
| reminder_days | integer | Days before order placement to email reminder (minimum of 5) | 42 |
| every | integer | Number of periods | 6 |
| every_period | integer | Type of period | 3 |
| start_date | string | Date of subscription start, in format YYYY-MM-DD | "2019-07-21" |
| cancelled | string | Date of subscription cancellation; null=not cancelled. | "null" |
| cancel_reason | string | Pipe-delimited cancel reason code and cancel reason details | "4|Overstocked" |
| cancel_reason_code | string | Cancel reason code | "4" |
| currency_code | string | Three letter ISO currency code | "USD" |
| string | Deprecated | ||
| string | Deprecated | ||
| session_id | string | Session ID, obtained from og_session_id cookie | "ac4f7938383a11e89ecbbc764e1107f2.896371.1539022086" |
| merchant_order_id | string | Order ID in your system | "301617" |
| string | Deprecated | ||
| string | Deprecated | ||
| created | string | Date created | "2017-02-29 12:00:00" |
| updated | string | Date updated | "2017-02-29 12:00:00" |
| live | boolean | True=active subscription; False=inactive subscription | True |
| prepaid_subscription_context | object | Prepaid information (Returned only if prepaid is enabled) | See example below |
| free_trial_subscription_context | object | Returned only if subscription has free trial | See example below |
| grantees | array | list of grantees that a subscription has | See example below |
JSON Examples
New Bundle Components Example
[
{
"public_id": "79d2dc76245111eeb185acde48001122",
"quantity": 1,
"product": "0070067690"
},
{
"public_id": "7eeaa504245111eeb185acde48001122",
"quantity": 3,
"product": "0070067691"
}
]Extra Data Example
{"some": "extra", "fields": "here"}Prepaid Subscription Context Example
{
"prepaid_orders_remaining": 0,
"prepaid_orders_per_billing": 3,
"renewal_behavior": "autorenew",
"last_renewal_revenue": 100.8,
"prepaid_origin_merchant_order_id": "#3082"
}Free Trial Subscription Context Example
{
"product": "53485191069987",
"days": 15,
"conversion_item": 38998940,
"expiration": "2025-09-23T13:12:22.704013",
"is_in_free_trial": false
}Grantees Example
[
{
"external_id": "abc",
"name": "Grantee 1"
},
{
"external_id": "def",
"name": "Grantee 2"
},
]