Cancel an active subscription with pending charges through the REST API
This topic explains how to cancel an active subscription with pending charges using the REST API by performing a Cancel Subscription order action.
To cancel an active subscription with pending charges, use the Create an order operation to perform a Cancel Subscription order action as follows:
- Determine the values of the following fields:
Variable
Description
ContractEffectiveThe date of the contract that governs the subscription. To create an active subscription with pending charges, you must specify this field.
ServiceActivationThe date on which the services or products within a subscription have been activated and access has been provided to the customer. To create an active subscription with pending charges, you must specify this field.
CustomerAcceptanceThe date on which the services or products within a subscription have been accepted by the customer. To create an active subscription with pending charges, you must specify this field.
- Use the "Create an order" operation to cancel an active subscription:
Request
POST /v1/orders/Request Body
{ "orderNumber": null, "orderDate": "2024-03-01", "existingAccountNumber": "A00000001", "subscriptions": [ { "subscriptionNumber": "A-S00000016", "orderActions": [ { "type": "CancelSubscription", "triggerDates": [ { "triggerDate": "2024-08-29", "name": "ContractEffective" }, { "name": "ServiceActivation", "triggerDate": "2024-08-29" }, { "name": "CustomerAcceptance", "triggerDate": "2024-08-29" } ], "cancelSubscription": { "cancellationPolicy": "SpecificDate", "cancellationEffectiveDate": "2024-03-01" } } ] } ] }