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

/v1/subscriptions

HTTPcURLJavaScriptPython

GET /v1/subscriptions?Shopper+Id=text HTTP/1.1
Host: api.digitalriver.com
token: text
Accept: */*

{
  "subscriptions": [
    {
      "id": "text",
      "billingAgreementId": "text",
      "externalReferenceId": "text",
      "creationDate": "2026-03-02T22:26:35.854Z",
      "activationDate": "2026-03-02T22:26:35.854Z",
      "nextRenewalDate": "2026-03-02T22:26:35.854Z",
      "nextBillingDate": "2026-03-02T22:26:35.854Z",
      "expirationDate": "2026-03-02T22:26:35.854Z",
      "graceDate": "2026-03-02T22:26:35.854Z",
      "cancellationDate": "2026-03-02T22:26:35.854Z",
      "currentQuantity": 1,
      "renewalQuantity": 1,
      "autoRenewal": true,
      "locale": "text",
      "state": {
        "Subscribed": "text",
        "PendingActivation": "text",
        "Cancelled": "text",
        "FreeTrial": "text",
        "PendingRenewal": "text"
      },
      "duration": 1,
      "frequency": 1,
      "currentBillingCycleNumber": 1,
      "totalNumberOfBillingCycle": 1,
      "siteId": "text",
      "shopper": {
        "id": "text",
        "externalReferenceId": "text"
      },
      "renewalPrice": {
        "unitPrice": 1,
        "locked": true,
        "currency": "text"
      },
      "term": {
        "termUnit": "text",
        "termLength": 1
      },
      "product": {
        "id": "text",
        "externalReferenceId": "text",
        "displayName": "text",
        "sku": "text"
      },
      "shipToAddress": {
        "id": "text",
        "firstName": "text",
        "lastName": "text",
        "companyName": "text",
        "line1": "text",
        "line2": "text",
        "line3": "text",
        "city": "text",
        "postalCode": "text",
        "countrySubdivision": "text",
        "country": "text",
        "countryName": "text",
        "phoneNumber": "text",
        "emailAddress": "text",
        "countyName": "text"
      },
      "paymentOption": {
        "nickName": "text",
        "id": "text",
        "isDefault": "text",
        "type": "text",
        "sourceId": "text",
        "creditCard": {
          "expirationMonth": "text",
          "expirationYear": "text",
          "displayableNumber": "text",
          "type": "text",
          "displayName": "text",
          "brand": "text",
          "lastFourDigits": "text"
        },
        "sourceClientSecret": "text",
        "address": {
          "id": "text",
          "firstName": "text",
          "lastName": "text",
          "companyName": "text",
          "line1": "text",
          "line2": "text",
          "line3": "text",
          "city": "text",
          "postalCode": "text",
          "countrySubdivision": "text",
          "country": "text",
          "countryName": "text",
          "phoneNumber": "text",
          "emailAddress": "text",
          "countyName": "text"
        }
      },
      "addOns": [
        {
          "product": {
            "id": "text",
            "externalReferenceId": "text",
            "displayName": "text",
            "sku": "text"
          },
          "quantity": 1,
          "proratedUnitPrice": 1,
          "renewalPrice": {
            "unitPrice": 1,
            "locked": true,
            "currency": "text"
          }
        }
      ]
    }
  ]
}

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

idstringRead-onlyOptional

Subscription id

billingAgreementIdstringRead-onlyOptional

Billing agreement id

externalReferenceIdstringRead-onlyOptional

External reference id

creationDatestring · date-timeRead-onlyOptional

Subscription creation date

activationDatestring · date-timeRead-onlyOptional

Subscription activation date

nextRenewalDatestring · date-timeRead-onlyOptional

Subscription next renewal date

nextBillingDatestring · date-timeRead-onlyOptional

Subscription next billing date

expirationDatestring · date-timeRead-onlyOptional

Subscription expiration date

graceDatestring · date-timeRead-onlyOptional

Subscription grace date

cancellationDatestring · date-timeRead-onlyOptional

Subscription cancellation date

currentQuantityinteger · int32Read-onlyOptional

Subscription current quantity

renewalQuantityinteger · int32Read-onlyOptional

Subscription renewal quantity

autoRenewalbooleanRead-onlyOptional

Subscription auto renewal flag

localestringRead-onlyOptional

Subscription locale

durationinteger · int32Read-onlyOptional

Subscription duration

frequencyinteger · int32Read-onlyOptional

Subscription frequency

currentBillingCycleNumberinteger · int32Read-onlyOptional

Subscription current billing cycle

totalNumberOfBillingCycleinteger · int32Read-onlyOptional

Subscription total billing cycle

siteIdstringRead-onlyOptional

Site id

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

/v1/subscriptions/{subId}

HTTPcURLJavaScriptPython

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

{
  "id": "text",
  "billingAgreementId": "text",
  "externalReferenceId": "text",
  "creationDate": "2026-03-02T22:26:35.854Z",
  "activationDate": "2026-03-02T22:26:35.854Z",
  "nextRenewalDate": "2026-03-02T22:26:35.854Z",
  "nextBillingDate": "2026-03-02T22:26:35.854Z",
  "expirationDate": "2026-03-02T22:26:35.854Z",
  "graceDate": "2026-03-02T22:26:35.854Z",
  "cancellationDate": "2026-03-02T22:26:35.854Z",
  "currentQuantity": 1,
  "renewalQuantity": 1,
  "autoRenewal": true,
  "locale": "text",
  "state": {
    "Subscribed": "text",
    "PendingActivation": "text",
    "Cancelled": "text",
    "FreeTrial": "text",
    "PendingRenewal": "text"
  },
  "duration": 1,
  "frequency": 1,
  "currentBillingCycleNumber": 1,
  "totalNumberOfBillingCycle": 1,
  "siteId": "text",
  "shopper": {
    "id": "text",
    "externalReferenceId": "text"
  },
  "renewalPrice": {
    "unitPrice": 1,
    "locked": true,
    "currency": "text"
  },
  "term": {
    "termUnit": "text",
    "termLength": 1
  },
  "product": {
    "id": "text",
    "externalReferenceId": "text",
    "displayName": "text",
    "sku": "text"
  },
  "shipToAddress": {
    "id": "text",
    "firstName": "text",
    "lastName": "text",
    "companyName": "text",
    "line1": "text",
    "line2": "text",
    "line3": "text",
    "city": "text",
    "postalCode": "text",
    "countrySubdivision": "text",
    "country": "text",
    "countryName": "text",
    "phoneNumber": "text",
    "emailAddress": "text",
    "countyName": "text"
  },
  "paymentOption": {
    "nickName": "text",
    "id": "text",
    "isDefault": "text",
    "type": "text",
    "sourceId": "text",
    "creditCard": {
      "expirationMonth": "text",
      "expirationYear": "text",
      "displayableNumber": "text",
      "type": "text",
      "displayName": "text",
      "brand": "text",
      "lastFourDigits": "text"
    },
    "sourceClientSecret": "text",
    "address": {
      "id": "text",
      "firstName": "text",
      "lastName": "text",
      "companyName": "text",
      "line1": "text",
      "line2": "text",
      "line3": "text",
      "city": "text",
      "postalCode": "text",
      "countrySubdivision": "text",
      "country": "text",
      "countryName": "text",
      "phoneNumber": "text",
      "emailAddress": "text",
      "countyName": "text"
    }
  },
  "addOns": [
    {
      "product": {
        "id": "text",
        "externalReferenceId": "text",
        "displayName": "text",
        "sku": "text"
      },
      "quantity": 1,
      "proratedUnitPrice": 1,
      "renewalPrice": {
        "unitPrice": 1,
        "locked": true,
        "currency": "text"
      }
    }
  ]
}