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

Manage the subscription's renewal plan

PreviousManage a subscriptionNextImmediate midterm change

Last updated 11 months ago

  • POSTChange Subscription Renewal Quantity
  • POSTUpdate Subscription Renewal Type

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

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