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 a subscription

PreviousReturnsNextManage the subscription's renewal plan

Last updated 11 months ago

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
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
409
* Conflict
application/json
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