Retrieve subscriptions

PreviousRetrieve subscriptions with pending actions NextManage a perpetual price

Last updated 9 months ago

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 Idstringrequired

Shopper Id or External Reference Id

Header parameters

tokenstringrequired

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.digitalriver.com/v1/subscriptions?Shopper+Id=text' \
  --header 'token: text'

200

400

401

404

409

{
  "subscriptions": [
    {
      "freeTrial": true,
      "autoRenewal": true,
      "terms": "Please accept these terms.",
      "planId": "654321",
      "subscriptionId": "665430999",
      "billingAgreementId": "cfeba2ac-d532-49e4-99f4-7a433507facf",
      "startTime": {
        "nano": 0,
        "year": 2020,
        "monthValue": 5,
        "dayOfMonth": 21,
        "hour": 0,
        "minute": 0,
        "second": 0,
        "month": "MAY",
        "dayOfWeek": "THURSDAY",
        "dayOfYear": 142,
        "offset": {
          "totalSeconds": 0,
          "id": "Z",
          "rules": {
            "fixedOffset": true,
            "transitions": [],
            "transitionRules": []
          }
        }
      },
      "endTime": {
        "nano": 0,
        "year": 2021,
        "monthValue": 5,
        "dayOfMonth": 20,
        "hour": 11,
        "minute": 59,
        "second": 59,
        "month": "MAY",
        "dayOfWeek": "THURSDAY",
        "dayOfYear": 140,
        "offset": {
          "totalSeconds": 0,
          "id": "Z",
          "rules": {
            "fixedOffset": true,
            "transitions": [],
            "transitionRules": []
          }
        }
      }
    }
  ]
}

Get Subscription By Subscription Id

Get subscription details by subscription Id

get

/v1/subscriptions/{subId}

Path parameters

subIdstringrequired

Subscription Id