Retrieve subscriptions
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-06-24T16:25:52.109Z",
"activationDate": "2025-06-24T16:25:52.109Z",
"nextRenewalDate": "2025-06-24T16:25:52.109Z",
"nextBillingDate": "2025-06-24T16:25:52.109Z",
"expirationDate": "2025-06-24T16:25:52.109Z",
"graceDate": "2025-06-24T16:25:52.109Z",
"cancellationDate": "2025-06-24T16:25:52.109Z",
"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 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-06-24T16:25:52.109Z",
"activationDate": "2025-06-24T16:25:52.109Z",
"nextRenewalDate": "2025-06-24T16:25:52.109Z",
"nextBillingDate": "2025-06-24T16:25:52.109Z",
"expirationDate": "2025-06-24T16:25:52.109Z",
"graceDate": "2025-06-24T16:25:52.109Z",
"cancellationDate": "2025-06-24T16:25:52.109Z",
"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"
}
}
]
}Last updated