Skip to main content

​
Before you begin

Before you can cancel a subscription bundle, you must have:
  • Successfully provisioned a Consumer Offer for the consumer
  • Retrieved and stored the Consumer Offer ID you want to cancel

​
Cancellation method overview

Subscription Bundles in the DVM support three cancellation methods. Each method is designed for a different commercial or customer-experience scenario.
Immediate cancellation terminates the subscription bundle straight away.
Use this method when you want to…
  • Instantly remove access to all bundled services
  • Stop all further renewal events to occur
  • You wish to trigger a refund for the period the user has already paid for

​
How to Cancel

1

Identify the consumer

Locate the consumer in your own system (for example using your internal customerId, email, or account identifier).
2

Identify the Consumer Offer to cancel

Retrieve the Consumer Offer identifier that represents the consumer’s live subscription bundle in the DVM.This is typically:
  • Stored from when you originally provisioned the subscription bundle, or
  • Retrieved using your Consumer Offer search/retrieve flow
3

Submit a cancellation request to the DVM

Call the DVM to cancel the subscription bundle by sending a cancellation request for that Consumer Offer.In your request you must specify the cancellation type:
  • IMMEDIATE — cancel straight away
  • END_OF_TERM — cancel at the next renewal point
  • DEFERRED — cancel at a specific future timestamp
4

Receive acknowledgement of cancellation request

The DVM responds immediately to confirm the request has been received and is being actioned.At this stage:
  • The bundle might not yet be fully canceled
  • The cancellation is processed asynchronously
5

Receive a cancellation notification when complete

Once the bundle has been canceled, you receive a notification from the DVM confirming completion.Use this notification to:
  • Update your internal subscription state
  • Confirm the end date (if End of Term / Deferred)
  • Trigger any customer messaging or downstream actions