Retrieve subscriptions

Get All Subscription By Shopper Id or External Reference Id

get

Get all subscriptions by shopper id or external reference Id

Query parameters

Shopper IdstringRequired

Shopper Id or External Reference Id

Header parameters

tokenstringRequired

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

Responses

200

OK

application/json

400

* Bad request

application/json

401

* Please verify your API key and secret (if applicable) is correct.

404

* Not found

application/json

409

* Conflict

application/json

get

HTTPcURLJavaScriptPython

GET /v1/subscriptions HTTP/1.1
Host: api.digitalriver.com
token: text
Accept: */*

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

Get Subscription By Subscription Id

get

Get subscription details by subscription Id

Path parameters

subIdstringRequired

Subscription Id

Header parameters

tokenstringRequired

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

Responses

200

OK

application/json

400

* Bad request

application/json

401

* Please verify your API key and secret (if applicable) is correct.

404

* Not found

application/json

409

* Conflict

application/json

get

HTTPcURLJavaScriptPython

GET /v1/subscriptions/{subId} HTTP/1.1
Host: api.digitalriver.com
token: text
Accept: */*

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