ChargebeeAPI

Create a pre-cancel hosted page

Idempotency Supported
Try in API Explorer

Creates a hosted_page resource of type pre_cancel . Route canceling users to this page to provide them a retention experience and start saving revenue. The hosted page is created in accordance with the retention experience configured in the Chargebee Retention app , along with the data provided as input to this endpoint. Call the endpoint before your customer clicks the Cancel button, and when they do, route them to the url in the endpoint response.

Sample Request

URL Format

POST https://[site].chargebee.com/api/v2/hosted_pages/pre_cancel

Input Parameters

pass_thru_content
optional, string, max chars=2048

Additional data to be passed to Chargebee Retention. Only the value of pass_thru_content.custom is sent to Chargebee Retention. It is sent as the value of the custom property. The fields provided in pass_thru_content.custom must be preconfigured in Chargebee Retention.

Although only pass_thru_content.custom is sent to Chargebee Retention, all of pass_thru_content is stored by Chargebee billing and is retrievable as an attribute of the hosted_page. .

cancel_url
optional, string, max chars=250

The customer is sent to this URL if they finally decide to cancel the subscription, despite the attempt to retain them.

redirect_url
optional, string, max chars=250

The customer is sent to this URL upon successful retention. In other words, this is the page to which the customer is sent when they decide not to cancel the subscription.

subscription[0..n]
Parameters for subscription
pass parameters as subscription[<param name>]

Returns

hosted_pageHosted page object
Resource object representing hosted_page