Give a reason when you cancel through the API
When an app cancels a subscription through the Kaching API, it can now send a reason with the cancel and ask us not to email the customer about it. This is for tools that cancel on your behalf, such as a chargeback-alert service that cancels a subscription as soon as a dispute comes in.
- See why it was cancelled. The reason shows on the subscription's timeline under Subscription cancelled via API, in Customer portal → Cancellation reasons with an API badge, and in the Cancellation reasons card on Analytics → Retention analysis. The page's export has a new Source column that says whether the customer or the API gave the reason.
- No email to the customer. When the app asks for it, the customer gets no cancellation email, and no Klaviyo or Omnisend "subscription cancelled" event is sent. You still get your own cancellation notification, and your webhooks and Shopify Flow still run. The timeline shows Email notifications suppressed.
- The reason reaches your tools. Webhooks, Shopify Flow, and Klaviyo and Omnisend when they are not suppressed, receive the reason with the cancellation.
Every cancel made through the API now shows as Subscription cancelled via API on the timeline, so you can tell it apart from one made in the admin.
The API is available on the Advanced plan. For developers, the reason and suppressEmailNotifications fields are described under Cancel a contract.