Retrieve subscriptions

Get all subscriptions by shopper ID or external reference ID

This method gets all subscriptions for the shopper by providing the shopper's ID or external reference ID as a query parameter.

GEThttps://api.digitalriver.com/v1/subscriptions

Query parameters

Header parameters

Response

200400401404

OK

Body

application/json

subscriptionsarray of SubscriptionInfo

Request

JavaScriptCurlPython

const response = await fetch('https://api.digitalriver.com/v1/subscriptions?Shopper+Id=text', {
    method: 'GET',
    headers: {
      "token": "text"
    },
});
const data = await response.json();

Response

200400404

{
  "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": {
            "transitions": [],
            "transitionRules": [],
            "fixedOffset": true
          }
        },
        "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": {
            "transitions": [],
            "transitionRules": [],
            "fixedOffset": true
          }
        },
        "nano": 0,
        "year": 2021,
        "monthValue": 5,
        "dayOfMonth": 20,
        "hour": 11,
        "minute": 59,
        "second": 59,
        "month": "MAY",
        "dayOfWeek": "THURSDAY",
        "dayOfYear": 140
      }
    }
  ]
}

Get the subscription by the subscription ID

This method retrieves a subscription by including the ID in the {subId} URI path parameter.

GEThttps://api.digitalriver.com/v1/subscriptions/{subId}

Path parameters

subId*string

The subscription's ID.

Header parameters

Response

200400401404

OK

Body

application/json

freeTrialboolean

If true, indicates that this is a free trial.

Example: true

autoRenewalboolean

If true, indicates that renewals for this subscription are automatic rather than manual.

Example: true

termsstring

For auto renewal subscriptions, the terms displayed to the customer at acquisition.

Example: "Please accept these terms."

planIdstring

The unique identifier of the plan

Example: "654321"

subscriptionIdstring

The subscription identifier.

Example: "665430999"

billingAgreementIdstring

The Digital River billing agreement identifier.

Example: "cfeba2ac-d532-49e4-99f4-7a433507facf"

startTimestring (date-time)

The start date and time of the subscription.

endTimestring (date-time)

The startTime plus the subscription duration.

Request

JavaScriptCurlPython

const response = await fetch('https://api.digitalriver.com/v1/subscriptions/{subId}', {
    method: 'GET',
    headers: {
      "token": "text"
    },
});
const data = await response.json();

Response

200400404

{
  "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": {
        "transitions": [],
        "transitionRules": [],
        "fixedOffset": true
      }
    },
    "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": {
        "transitions": [],
        "transitionRules": [],
        "fixedOffset": true
      }
    },
    "nano": 0,
    "year": 2021,
    "monthValue": 5,
    "dayOfMonth": 20,
    "hour": 11,
    "minute": 59,
    "second": 59,
    "month": "MAY",
    "dayOfWeek": "THURSDAY",
    "dayOfYear": 140
  }
}