Renew a subscription | Commerce API references

Update Subscription Renewal Type

post

This API will convert subscription renewal type. The renewal type change allowed only for subscription states - Subscribed, Pending activation and Trial.

Path parameters

subIdstringRequired

Subscription Id

Header parameters

tokenstringRequired

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

Body

autoRenewalbooleanRequired

Auto renewal type boolean

Responses

202

Accepted

400

* Bad request

application/json

401

Please verify your API key and secret (if applicable) is correct.

403

* Access Denied

application/json

404

* Not found

application/json

post

POST /v1/subscriptions/{subId}/renewal-type HTTP/1.1
Host: api.digitalriver.com
token: text
Content-Type: application/json
Accept: */*
Content-Length: 20

{
  "autoRenewal": true
}

No content

Update Subscription Renewal Product

post

This will change the subscription renewal product.

Path parameters

subIdstringRequired

Header parameters

tokenstringRequired

Basic authorization (dispatch Key and Secret)

Body

renewalProductIdstringRequired

Renewal product id

Responses

202

Accepted

400

* Bad request

application/json

401

Please verify your API key and secret (if applicable) is correct.

403

* Access Denied

application/json

404

* Not found

application/json

post

POST /v1/subscriptions/{subId}/renewal-product HTTP/1.1
Host: api.digitalriver.com
token: text
Content-Type: application/json
Accept: */*
Content-Length: 27

{
  "renewalProductId": "text"
}

No content

Change Subscription Renewal Quantity

post

This will change the subscription renewal quantity.

Path parameters

subIdstringRequired

Subscription Id

Header parameters

tokenstringRequired

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

Body

renewalQuantityinteger · int32Required

Renewal quantity

Responses

202

Accepted

400

* Bad request

application/json

401

Please verify your API key and secret (if applicable) is correct.

403

* Access Denied

application/json

404

* Not found

application/json

post

POST /v1/subscriptions/{subId}/renewal-quantity HTTP/1.1
Host: api.digitalriver.com
token: text
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "renewalQuantity": 1
}

No content

Change Subscription Renewal Price

post

This will change the subscription renewal price.

Path parameters

subIdstringRequired

Subscription Id

Header parameters

tokenstringRequired

Basic authorization (dispatch Key and Secret)

Body

renewalUnitPricenumber · doubleRequired

Renewal unit price

Responses

202

Accepted

400

* Bad request

application/json

401

Please verify your API key and secret (if applicable) is correct.

403

* Access Denied

application/json

404

* Not found

application/json

post

POST /v1/subscriptions/{subId}/renewal-price HTTP/1.1
Host: api.digitalriver.com
token: text
Content-Type: application/json
Accept: */*
Content-Length: 22

{
  "renewalUnitPrice": 1
}

No content