Retrieve subscriptions

PreviousPending actions NextSubscription billing and shipping addresses

Last updated 8 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": [
    {
      "id": "text",
      "billingAgreementId": "text",
      "externalReferenceId": "text",
      "creationDate": "2025-02-21T18:22:38.034Z",
      "activationDate": "2025-02-21T18:22:38.034Z",
      "nextRenewalDate": "2025-02-21T18:22:38.034Z",
      "nextBillingDate": "2025-02-21T18:22:38.034Z",
      "expirationDate": "2025-02-21T18:22:38.034Z",
      "graceDate": "2025-02-21T18:22:38.034Z",
      "cancellationDate": "2025-02-21T18:22:38.034Z",
      "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 subscription details by subscription Id

get

/v1/subscriptions/{subId}

Path parameters

subIdstringrequired

Subscription Id