Sign in
latestOpenAPI 3.0.02026-08-1056429755.6 KB

a6efafc1669c

Retrieve Subscription

Get All Subscription By Shopper Id or External Reference Id

Get all subscriptions by shopper id or external reference Id

get/v1/subscriptions

Query parameters

Shopper Idstring required

Shopper Id or External Reference Id

Headers

tokenstring required

Basic authorization (dispatch Key and Secret) or Full access token

Response

OK

Example response

{
  "subscriptions": [
    {
      "freeTrial": true,
      "autoRenewal": true,
      "terms": "Please accept these terms.",
      "planId": "654321",
      "subscriptionId": "665430999",
      "billingAgreementId": "cfeba2ac-d532-49e4-99f4-7a433507facf"
    }
  ]
}