List

GET

https://restapi.ordergroove.com/subscriptions/

GET

/subscriptions/

curl https://restapi.ordergroove.com/subscriptions/ \
     -H "x-api-key: <apiKey>"

{
  "count": 1,
  "next": "https://restapi.ordergroove.com/subscriptions/?page=1",
  "previous": "https://restapi.ordergroove.com/subscriptions/?page=3",
  "results": [
    {
      "public_id": "f9cb2f93e1c845eb9de9eff46ddb3cbf",
      "price": "12.99",
      "frequency_days": 42,
      "reminder_days": 42,
      "start_date": "2017-02-29 12:00:00",
      "cancel_reason_code": "4|",
      "cancel_reason": "4|Overstocked",
      "merchant_order_id": "301617",
      "subscription_type": "Replenish",
      "components": [
        {
          "public_id": "79d2dc76245111eeb185acde48001122",
          "quantity": 1,
          "product": "0070067690"
        },
        {
          "public_id": "7eeaa504245111eeb185acde48001122",
          "quantity": 3,
          "product": "0070067691"
        }
      ],
      "created": "2017-02-29 12:00:00",
      "updated": "2017-02-29 12:00:00",
      "extra_data": "{\"some\": \"extra\", \"fields\": \"here\"}",
      "live": "True"
    }
  ]
}

Returns a list all of customer subscriptions for a merchant, or a list of subscriptions for an individual customer. Listing subscriptions for more than one customer requires Application API Scope with the Bulk Operations permission.

Authentication

x-api-keystring

Application API Scope — server-to-server, sent in the x-api-key header. See Authentication.

authorizationstring

Storefront API Scope — client-side, scoped to one customer, sent as a signature in the authorization header. See Authentication.

Query parameters

livelist of booleansOptional

Subscription status: active (True) or inactive (False)

productstringOptional

Unique product identifier

shipping_addressstringOptional

Address ID

customerstringOptional

Customer ID (only available in API user scope)

createddateOptional

Subscription’s created date exact match (yyyy-mm-dd)

created_startdateOptional

Subscription’s created date later or equal than parameter (yyyy-mm-dd)

created_endstringOptional

Subscription’s created date sooner or equal than parameter (yyyy-mm-dd)

updateddateOptional

Subscription’s updated date exact match (yyyy-mm-dd). On subscription creation is populated with same value as created field.

updated_startdateOptional

Subscription’s updated datetime later or equal than parameter (yyyy-mm-ddThh:mm:ss)

updated_enddateOptional

Subscription’s updated date time is sooner or equal than parameter (yyyy-mm-ddThh:mm:ss)

Response

200

countintegerOptionalDefaults to 0

nextstringOptional

previousstringOptional

resultslist of objectsOptional

Errors

403

Forbidden Error