Chargebee: Cancel subscription
chargebee_cancel_subscriptionChargebee: Cancel a subscription now, at the end of the term or on a date. Cancels the subscription and returns its new status and any credit notes Chargebee raised. credit_option sets how unused time on an immediate cancellation is credited; leave it out to use your site setting. refundable_credits_handling schedule_refund sends refundable credits back at once, no_action leaves a credit note with refund due. Contract term subscriptions need contract_term_cancel_option. This cancels a customer's service and can move money, so by default you confirm each call; you can switch that off for this tool. Reaches other people: confirm with the user before each call. Needs the user's Cotlet API key with access to this app.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| cancel_at | No | With specific_date: when the cancellation takes effect. | |
| cancel_option | No | immediately, end_of_term, specific_date or end_of_billing_term. For subscriptions without a contract term. Default: immediately. | |
| subscription_id | Yes | Subscription ID from list_subscriptions. | |
| cancel_reason_code | No | A reason code configured in Chargebee, case-sensitive. Required if your site makes reason codes mandatory. | |
| contract_term_cancel_option | No | Required with a contract term: terminate_immediately, end_of_contract_term, specific_date or end_of_subscription_billing_term. The last two need Chargebee Support to enable them. | |
| refundable_credits_handling | No | no_action or schedule_refund. Default: your site setting. | |
| credit_option_for_current_term_charges | No | With immediately: none, prorate, full or consumption_based. Default: your site setting. |