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 (object)

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": [
    {
      "id": "text",
      "billingAgreementId": "text",
      "externalReferenceId": "text",
      "creationDate": "2024-12-04T08:43:37.187Z",
      "activationDate": "2024-12-04T08:43:37.187Z",
      "nextRenewalDate": "2024-12-04T08:43:37.187Z",
      "nextBillingDate": "2024-12-04T08:43:37.187Z",
      "expirationDate": "2024-12-04T08:43:37.187Z",
      "graceDate": "2024-12-04T08:43:37.187Z",
      "cancellationDate": "2024-12-04T08:43:37.187Z",
      "currentQuantity": 0,
      "renewalQuantity": 0,
      "autoRenewal": false,
      "locale": "text",
      "state": {
        "Subscribed": "text",
        "PendingActivation": "text",
        "Cancelled": "text",
        "FreeTrial": "text",
        "PendingRenewal": "text"
      },
      "duration": 0,
      "frequency": 0,
      "currentBillingCycleNumber": 0,
      "totalNumberOfBillingCycle": 0,
      "siteId": "text",
      "shopper": {
        "id": "text",
        "externalReferenceId": "text"
      },
      "renewalPrice": {
        "unitPrice": 0,
        "locked": false,
        "currency": "text"
      },
      "term": {
        "termUnit": "text",
        "termLength": 0
      },
      "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": 0,
          "proratedUnitPrice": 0,
          "renewalPrice": {
            "unitPrice": 0,
            "locked": false,
            "currency": "text"
          }
        }
      ]
    }
  ]
}

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

idstring

The subscription's ID.

billingAgreementIdstring

Billing agreement id

externalReferenceIdstring

External reference id

creationDatestring (date-time)

Subscription creation date

activationDatestring (date-time)

Subscription activation date

nextRenewalDatestring (date-time)

Subscription next renewal date

nextBillingDatestring (date-time)

Subscription next billing date

expirationDatestring (date-time)

Subscription expiration date

graceDatestring (date-time)

Subscription grace date

cancellationDatestring (date-time)

Subscription cancellation date

currentQuantityinteger (int32)

Subscription current quantity

renewalQuantityinteger (int32)

Subscription renewal quantity

autoRenewalboolean

Subscription auto renewal flag

localestring

Subscription locale

stateState (object)

All possible subscription states

durationinteger (int32)

Subscription duration

frequencyinteger (int32)

Subscription frequency

currentBillingCycleNumberinteger (int32)

Subscription current billing cycle

totalNumberOfBillingCycleinteger (int32)

Subscription total billing cycle

siteIdstring

Site id

shopperShopperInfo (object)

renewalPriceProbableRenewalPriceBean (object)

termTerm (object)

productProduct (object)

shipToAddressAddress (object)

paymentOptionPaymentOption (object)

addOnsarray of SubAddOn (object)

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

{
  "id": "text",
  "billingAgreementId": "text",
  "externalReferenceId": "text",
  "creationDate": "2024-12-04T08:43:37.187Z",
  "activationDate": "2024-12-04T08:43:37.187Z",
  "nextRenewalDate": "2024-12-04T08:43:37.187Z",
  "nextBillingDate": "2024-12-04T08:43:37.187Z",
  "expirationDate": "2024-12-04T08:43:37.187Z",
  "graceDate": "2024-12-04T08:43:37.187Z",
  "cancellationDate": "2024-12-04T08:43:37.187Z",
  "currentQuantity": 0,
  "renewalQuantity": 0,
  "autoRenewal": false,
  "locale": "text",
  "state": {
    "Subscribed": "text",
    "PendingActivation": "text",
    "Cancelled": "text",
    "FreeTrial": "text",
    "PendingRenewal": "text"
  },
  "duration": 0,
  "frequency": 0,
  "currentBillingCycleNumber": 0,
  "totalNumberOfBillingCycle": 0,
  "siteId": "text",
  "shopper": {
    "id": "text",
    "externalReferenceId": "text"
  },
  "renewalPrice": {
    "unitPrice": 0,
    "locked": false,
    "currency": "text"
  },
  "term": {
    "termUnit": "text",
    "termLength": 0
  },
  "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": 0,
      "proratedUnitPrice": 0,
      "renewalPrice": {
        "unitPrice": 0,
        "locked": false,
        "currency": "text"
      }
    }
  ]
}