LogoLogo
Shopper APIs reference
Shopper APIs reference
  • Shopper APIs reference
  • OAuth
    • Tokens
    • Access tokens
  • Shoppers
    • Shoppers
    • Addresses
    • Payment options
  • Browse (product discovery)
    • Categories
    • Products
    • Product variations
    • Pricing
    • Inventory status
    • Financing
    • Offers
    • Purchase plan
    • Find a purchase plan
    • Authorize a purchase plan
  • Cart
    • Apply a shopper to a cart
    • Line items
    • Billing address
    • Shipping address
    • Payment methods
    • Shipping options
    • Web checkout
    • Submit a cart
    • Apply or detach payment methods
    • Apply a shipping option
    • Carts
    • Cart offers
    • API trigger offer
    • Resume cart
    • Third-party subscription engine
    • Tax registration
    • Price override
  • Orders
    • Orders
    • Order lookup
    • Order address
    • Returns
  • Subscriptions
    • Manage a subscription
    • Manage the subscription's renewal plan
    • Immediate midterm change
    • Payment
    • Address
    • Orders
    • Pending actions
    • Retrieve subscriptions
    • Subscription billing and shipping addresses
Powered by GitBook
On this page
  1. Subscriptions

Retrieve subscriptions

PreviousPending actionsNextSubscription billing and shipping addresses

Last updated 10 months ago

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
GET /v1/subscriptions HTTP/1.1
Host: api.digitalriver.com
token: text
Accept: */*
{
  "subscriptions": [
    {
      "id": "text",
      "billingAgreementId": "text",
      "externalReferenceId": "text",
      "creationDate": "2025-05-14T18:29:48.407Z",
      "activationDate": "2025-05-14T18:29:48.407Z",
      "nextRenewalDate": "2025-05-14T18:29:48.407Z",
      "nextBillingDate": "2025-05-14T18:29:48.407Z",
      "expirationDate": "2025-05-14T18:29:48.407Z",
      "graceDate": "2025-05-14T18:29:48.407Z",
      "cancellationDate": "2025-05-14T18:29:48.407Z",
      "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
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
GET /v1/subscriptions/{subId} HTTP/1.1
Host: api.digitalriver.com
token: text
Accept: */*
{
  "id": "text",
  "billingAgreementId": "text",
  "externalReferenceId": "text",
  "creationDate": "2025-05-14T18:29:48.407Z",
  "activationDate": "2025-05-14T18:29:48.407Z",
  "nextRenewalDate": "2025-05-14T18:29:48.407Z",
  "nextBillingDate": "2025-05-14T18:29:48.407Z",
  "expirationDate": "2025-05-14T18:29:48.407Z",
  "graceDate": "2025-05-14T18:29:48.407Z",
  "cancellationDate": "2025-05-14T18:29:48.407Z",
  "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"
      }
    }
  ]
}
  • GETGet All Subscription By Shopper Id or External Reference Id
  • GETGet Subscription By Subscription Id