Cancel a Subscription

Cancel a subscription, with options to select immediate disentitlement versus registering the cancel now to take affect at the end of the current period; to select whether any pre-paid services should get a prorated refund; and to select whether or not an existing minimum commitment should be honored. The reason for the cancellation can also be tracked using Cancel Reason codes (which can use pre-defined codes or codes you’ve designed yourself in advance).

HTTP Request

POST https://api.vindicia.com/subscriptions/:subscription/actions/cancel

Route (URL) Parameters

Parameter	Default	Description	Required
subscription	n/a	The id or the vid of the Subscription to cancel	Yes

Query Parameters

Parameter	Default	Description	Required
disentitle	false	Indicates whether or not to dis-entitle immediately or leave service in effect until the end of the current billing period.	No
force	false	Indicates whether to ignore unsatisfied minimum commitments	No
settle	false	Indicates whether to issue a prorated refund for any pre-paid unconsumed services and to rate unbilled usage.	No
send_cancellation_notice	true	Indicates whether to send a special cancellation notice to the customer	No
reason_code	n/a	The predefined Cancel Reason code for cancelling this subscription.	No
dryrun	false	If true, works as quote, computations are performed, but no result from this operation is recorded in Vindicia’s database. If it did not exist before, it won’t exist afterwards; if it did exist before, it won’t change. This is useful for computing the cost of a Subscription without committing to the change.	No
cancel_policy	`WAIVE_CANCEL_FEE`	Policy for handling the cancel fee. Can be `WAIVE_CANCEL_FEE`, `PRORATE_CANCEL_FEE`, `FULL_CANCEL_FEE`

Accepts

None.

Returns

JSON - A full Subscription object.

Example Request

curl -X POST \
-u acaff38d462f9430d5cbcbaf:a575771fc679b9de \
"https://api.staging.us-west.vindicia.com/subscriptions/sub_1234x/actions/cancel?reason_code=101&settle=false&disentitle=false"

Parent topic:Subscriptions

Home

Guides

APIs

HTTP Request

Route (URL) Parameters

Query Parameters

Accepts

Returns

Example Request

​HTTP Request

​Route (URL) Parameters

​Query Parameters

​Accepts

​Returns

​Example Request

HTTP Request

Route (URL) Parameters

Query Parameters

Accepts

Returns

Example Request