Manage a subscription

Update Subscription Expiration Date

post

This will update subscription expiration date

Path parameters
subIdstringRequired

Subscription Id

Header parameters
tokenstringRequired

Basic authorization (dispatch Key and Secret)

Body
expirationDatestring · date-timeRequired

The subscription expiration date in "2020-10-11T01:23:48.000Z", "2020-10-11T01:23:48.000-0500", "2020-10-11T01:23:48.000+1100".

Responses
202
Accepted
post
POST /v1/subscriptions/{subId}/expiration-date HTTP/1.1
Host: api.digitalriver.com
token: text
Content-Type: application/json
Accept: */*
Content-Length: 45

{
  "expirationDate": "2025-06-25T05:56:21.734Z"
}

No content

Cancel Subscription

post

This will cancel the subscription by subscription Id and Subscription state changes to Cancelled

Path parameters
subIdstringRequired

Subscription Id

Header parameters
tokenstringRequired

Basic authorization (dispatch Key and Secret) or Full access token

Body
suppressCancelNotificationbooleanOptional

The clients can use this element to suppress cancel notification email.By default this is false.

cancelReasonCodestringOptional

Optional, you can specify the codes used to categorize the reason for the subscription cancellation. This field can contain up to 64 characters.

cancelCommentstringOptional

An optional comment provided by the shopper detailing additional information or context regarding the subscription cancellation. This field can contain up to 255 characters.

Responses
202
Accepted
post
POST /v1/subscriptions/{subId}/cancel HTTP/1.1
Host: api.digitalriver.com
token: text
Content-Type: application/json
Accept: */*
Content-Length: 84

{
  "suppressCancelNotification": true,
  "cancelReasonCode": "text",
  "cancelComment": "text"
}

No content

Activate Subscription

post

This will activate the subscription.The subscription state changes from PendingActivation to Subscribed

Path parameters
subIdstringRequired

Subscription Id

Header parameters
tokenstringRequired

Basic authorization (dispatch Key and Secret)

Body
activationKeystringRequired

The subscription activation key

activationDatestring · date-timeOptional

The subscription activation date in "2020-10-11T01:23:48.000Z", "2020-10-11T01:23:48.000-0500", "2020-10-11T01:23:48.000+1100".

expirationDatestring · date-timeOptional

The subscription expiration date in "2020-10-11T01:23:48.000Z", "2020-10-11T01:23:48.000-0500", "2020-10-11T01:23:48.000+1100".

Responses
202
Accepted
post
POST /v1/subscriptions/{subId}/activate HTTP/1.1
Host: api.digitalriver.com
token: text
Content-Type: application/json
Accept: */*
Content-Length: 112

{
  "activationKey": "text",
  "activationDate": "2025-06-25T05:56:21.734Z",
  "expirationDate": "2025-06-25T05:56:21.734Z"
}

No content

Last updated