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

application/json

objectOptional

application/json

application/json

application/json

get

HTTPcURLJavaScriptPython

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

{
  "subscriptions": [
    {
      "id": "text",
      "billingAgreementId": "text",
      "externalReferenceId": "text",
      "creationDate": "2025-04-18T18:57:17.615Z",
      "activationDate": "2025-04-18T18:57:17.615Z",
      "nextRenewalDate": "2025-04-18T18:57:17.615Z",
      "nextBillingDate": "2025-04-18T18:57:17.615Z",
      "expirationDate": "2025-04-18T18:57:17.615Z",
      "graceDate": "2025-04-18T18:57:17.615Z",
      "cancellationDate": "2025-04-18T18:57:17.615Z",
      "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

application/json

objectOptional

application/json

application/json

application/json

get

HTTPcURLJavaScriptPython

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

{
  "id": "text",
  "billingAgreementId": "text",
  "externalReferenceId": "text",
  "creationDate": "2025-04-18T18:57:17.615Z",
  "activationDate": "2025-04-18T18:57:17.615Z",
  "nextRenewalDate": "2025-04-18T18:57:17.615Z",
  "nextBillingDate": "2025-04-18T18:57:17.615Z",
  "expirationDate": "2025-04-18T18:57:17.615Z",
  "graceDate": "2025-04-18T18:57:17.615Z",
  "cancellationDate": "2025-04-18T18:57:17.615Z",
  "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"
      }
    }
  ]
}