Purchases
Cancel subscription
Cancel the subscription associated with a purchase by ID
This endpoint cancels the underlying subscription (Stripe, PayPal, or Kajabi Payments) associated with the purchase. The purchase will be deactivated and the subscription will be cancelled immediately, according to the payment provider's cancellation rules.
If the payment can be cancelled the response will be successful. Otherwise, the response will be an error with validation details.
post/v1/purchases/{id}/cancel_subscription
Request
- Base URLhttps://api.kajabi.com
- AuthHTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
idstring required
Purchase ID
Response
Success, cancelled subscription and deactivated purchase
Changes
No recorded changes to this operation across all 1 revision of this API.