Settings
Configure SDK
Hosted pages
Hosted pages are the easiest way to integrate Chargebee with your website. For card payment methods, they help meet most of your PCI DSS compliance requirements. Chargebee offers hosted pages where your customers can perform the following actions:
- Checkout a new subscription
- Checkout changes to an existing subscription
- Update a payment method
- Make payments for all due invoices
- Extending a subscription
When you create a hosted page, it is available at a secure and unique URL. This URL can then be provided to your customer on your website or by other means such as email. On successful completion of the hosted page workflow by the customer, they are redirected to the
redirect_urlwith the hosted pageidandstatepassed as query string parameters. As soon as the redirection happens, retrieve the hosted page to get details of the customer, subscription, invoice etc.
Sample hosted page [ JSON ]
{
"created_at": 1517464663,
"embed": false,
"expires_at": 1517468263,
"id": "__one_time_checkout___test__cdqM9MLUubELMycut0Cr9sHq8gOTKEZSdcu",
"object": "hosted_page",
"resource_version": 1517444863979,
"state": "created",
"type": "checkout_one_time",
"updated_at": 1517444863,
"url": "https://yourapp.chargebee.com/pages/v3/__one_time_checkout___test__cdqM9MLUubELMycut0Cr9sHq8gOTKEZSdcu/"
} This attribute allows you to store custom information with the hosted_page object. You can use it to associate specific data with a hosted page session.
For example, you can store the ID of the marketing campaign that initiated the user session. After a successful checkout, when the customer is redirected, you can retrieve the hosted page ID from the redirect URL's query parameters. Using this ID, you can fetch the hosted page and perform actions related to the success of the marketing campaign.
The date and time when the hosted page URL expires. After this timestamp, the page can no longer be accessed.
The expiration period depends on the type of hosted page:
- For
checkout_new,checkout_existing, andcheckout_one_time, the URL expires 3 hours after the page is created. - For
collect_nowandmanage_payment_sources, the URL expires 5 days after creation.
This attribute will be returned only during retrieve hosted page API call and also the retrieved hosted page resource state should be either in "succeeded" or "cancelled" state.
If hosted page state is "succeeded", then the subscription, customer, card & invoice(optional) resources during checkout can be obtained.
If hosted page is state is "cancelled", then it will be empty i.e no information about checkout.
Customer Info (email, first name and last name) given in the checkout page used for tracking abandoned carts.
Learn more
Checkout charge-items and one-time charges ¶
Create a Chargebee hosted page to accept payment details from a customer and checkout charge-items and one-time charges.
The following steps describe how best to use this API:
- Call this endpoint, providing item prices, charges, coupons and a host of other details such as billing and shipping addresses of the customer, to be prefilled on the checkout page. You may also provide
pass_thru_contentcontaining information and IDs from your systems that must be associated with the checkout page. - Send the customer to the Checkout
urlreceived in the response. - Once they complete checkout, the set of charge-items and one-time charges are automatically invoiced against the respective
customerrecord in Chargebee, and they are redirected to theredirect_urlwith theidandstateattributes passed as query string parameters. - Retrieve the hosted page at this stage to get the invoice details.
Customer resource lookup and creation
When customer[id] is provided for this operation, it is looked up by Chargebee, and if found, the hosted_page is created for it. If not found, a new customer resource is created with an autogenarated ID, and the hosted_page is created.
Multiple business entities
If multiple business entities are created for the site, the customer resource lookup and creation happen within the context of the business entity specified in this API call. If no business entity is specified, the customer resource lookup is performed within the site context , and if not found, the resource is created for the default business entity of the site.
Sample Response [ JSON ]
URL Format POST
Input Parameters
Sets the context for this operation to the business entity specified. Applicable only when multiple business entities have been created for the site. When this parameter is provided, the operation is able to read/write data associated only to the business entity specified. When not provided, the operation can read/write data for the entire site.
An alternative way of passing this parameter is by means of a custom HTTP header.
A note for this particular invoice. This, and all other notes for the invoice are displayed on the PDF invoice sent to the customer.
Note :
- Although the customer will be redirected to the
redirect_urlafter successful checkout, we do not recommend relying on it for completing critical post-checkout actions. This is because redirection may not happen due to unforeseen reasons such as user closing the tab, or exiting the browser, and so on. If there is any synchronization that you are doing after the redirection, you will have to have a backup. Chargebee recommends listening to appropriate webhooks such assubscription_createdorinvoice_generatedto verify a successful checkout. - Redirect URL configured in Settings > Hosted Pages Settings would be overriden by this redirect URL.
- Eg : http://yoursite.com?id=<hosted_page_id>&state=succeeded
- This parameter is not applicable for iframe messaging.
The customers will be redirected to this URL upon canceling checkout. The hosted page id and state will be passed as parameters to this URL.
Note :
- Cancel URL configured in Settings > Hosted Pages Settings would be overriden by this cancel URL.
Eg : http://yoursite.com?id=<hosted_page_id>&state=cancelled - This parameter is not applicable for iframe messaging and in-app checkout.
This attribute allows you to store custom information with the hosted_page object. You can use it to associate specific data with a hosted page session.
For example, you can store the ID of the marketing campaign that initiated the user session. After a successful checkout, when the customer is redirected, you can retrieve the hosted page ID from the redirect URL's query parameters. Using this ID, you can fetch the hosted page and perform actions related to the success of the marketing campaign.
pass parameters as customer[<param name>]
pass parameters as billing_address[<param name>]
pass parameters as shipping_address[<param name>]
pass parameters as item_prices[<param name>][<idx:0..n>]
pass parameters as item_tiers[<param name>][<idx:0..n>]
pass parameters as charges[<param name>][<idx:0..n>]
pass parameters as discounts[<param name>][<idx:0..n>]
pass parameters as entity_identifiers[<param name>][<idx:0..n>]
Returns
Resource object representing hosted_page
Create checkout for a new subscription ¶
Create a Chargebee hosted page to accept payment details from a customer and checkout a new subscription.
The following steps describe how best to use this API:
Call this endpoint, providing item prices, coupons and a host of other details such as billing and shipping addresses to be prefilled for the customer on the checkout page. You may also provide pass_thru_content containing information and IDs from your systems that must be associated with the checkout page.
Warning
The first item price in the list (parameter subscription_items[item_price_id][0]) must be an item_price of item_type plan.
- Send the customer to the Checkout
urlreceived in the response. - Once they complete checkout, a new subscription is automatically created and the customer is redirected to the
redirect_urlwith theidandstateattributes passed as query string parameters.
Although the customer will be redirected to theredirect_urlafter successful checkout, we do not recommend relying on it for completing critical post-checkout actions. This is because redirection may not happen due to unforeseen reasons. Chargebee recommends listening to appropriate webhooks such assubscription_createdorinvoice_generatedto verify a successful checkout. - Retrieve the hosted page at this stage to get the subscription and invoice details.
Customer resource lookup and creation
When the customer[id] parameter is provided and if a customer resource with the ID is found to be already created in Chargebee, the subscription is created under that customer resource. If not found, then a new customer resource is created with an autogenarated ID and the subscription is created under it.
Multiple business entities
If multiple business entities are created for the site, the customer resource lookup and creation happen within the context of the business entity specified in this API call. If no business entity is specified, the customer resource lookup is performed within the site context, and if not found, the resource is created for the default business entity of the site.
Sample Response [ JSON ]
URL Format POST
Input Parameters
Sets the context for this operation to the business entity specified. Applicable only when multiple business entities have been created for the site. When this parameter is provided, the operation is able to read/write data associated only to the business entity specified. When not provided, the operation can read/write data for the entire site.
An alternative way of passing this parameter is by means of a custom HTTP header.
The number of billing cycles the subscription runs before canceling. If not provided, then the billing cycles set for the plan-item price is used.
Item ids of mandatorily attached addons that are to be removed from the subscription.
The number of subscription billing cycles (including the first one) to invoice in advance.
Override the billing alignment mode for Calendar Billing. Only applicable when using Calendar Billing. The default value is that which has been configured for the site.
List of coupons to be applied to this subscription. You can provide coupon ids or coupon codes.
Note :
- Although the customer will be redirected to the
redirect_urlafter successful checkout, we do not recommend relying on it for completing critical post-checkout actions. This is because redirection may not happen due to unforeseen reasons such as user closing the tab, or exiting the browser, and so on. If there is any synchronization that you are doing after the redirection, you will have to have a backup. Chargebee recommends listening to appropriate webhooks such assubscription_createdorinvoice_generatedto verify a successful checkout. - Redirect URL configured in Settings > Hosted Pages Settings would be overriden by this redirect URL.
- Eg : http://yoursite.com?id=<hosted_page_id>&state=succeeded
- This parameter is not applicable for iframe messaging.
The customers will be redirected to this URL upon canceling checkout. The hosted page id and state will be passed as parameters to this URL.
Note :
- Cancel URL configured in Settings > Hosted Pages Settings would be overriden by this cancel URL.
Eg : http://yoursite.com?id=<hosted_page_id>&state=cancelled - This parameter is not applicable for iframe messaging and in-app checkout.
This attribute allows you to store custom information with the hosted_page object. You can use it to associate specific data with a hosted page session.
For example, you can store the ID of the marketing campaign that initiated the user session. After a successful checkout, when the customer is redirected, you can retrieve the hosted page ID from the redirect URL's query parameters. Using this ID, you can fetch the hosted page and perform actions related to the success of the marketing campaign.
pass parameters as subscription[<param name>]
pass parameters as customer[<param name>]
pass parameters as billing_address[<param name>]
pass parameters as shipping_address[<param name>]
pass parameters as subscription_items[<param name>][<idx:0..n>]
pass parameters as discounts[<param name>][<idx:0..n>]
pass parameters as item_tiers[<param name>][<idx:0..n>]
pass parameters as entity_identifiers[<param name>][<idx:0..n>]
Returns
Resource object representing hosted_page
Create checkout to update a subscription ¶
Create a Chargebee hosted page to accept payment details from a customer and checkout to update the subscription.
The following steps describe how best to use this API:
Provide item prices, coupons and a host of other details such as billing and shipping addresses to be prefilled for the customer on the checkout page. You may also provide pass_thru_content containing information and IDs from your systems that must be associated with the checkout page.
Warning
The first item price in the list (parameter subscription_items[item_price_id][0]) must be an item_price of item_type plan.
-
Send the customer to the Checkout
urlreceived in the response. They can now add a payment method or use an existing one, to complete the checkout. -
The subscription is updated and the customer is redirected to the
redirect_urlwith theidandstateattributes passed as query string parameters.
Although the customer will be redirected to theredirect_urlafter successful checkout, we do not recommend relying on it for completing critical post-checkout actions. This is because redirection may not happen due to unforeseen reasons. Chargebee recommends listening to appropriate webhooks such assubscription_createdorinvoice_generatedto verify a successful checkout. -
Retrieve the hosted page at this stage to get the subscription and invoice details.
Sample Response [ JSON ]
URL Format POST
Input Parameters
Item ids of mandatorily attached addons that are to be removed from the subscription.
The document date displayed on the invoice PDF. The default value is the current date. Provide this value to backdate the invoice. Backdating an invoice is done for reasons such as booking revenue for a previous date or when the subscription is effective as of a past date. Moreover, if
create_pending_invoices is set to true, and if the site is configured to set invoice dates to date of closing, then upon invoice closure, this date is changed to the invoice closing date. taxes and line_item_taxes are computed based on the tax configuration as of invoice_date. When passing this parameter, the following prerequisites must be met:
invoice_datemust be in the past.invoice_dateis not more than one calendar month into the past. For example, if today is 13th January, then you cannot pass a value that is earlier than 13th December.- It is not earlier than
changes_scheduled_at,reactivate_from, ortrial_end. invoice_immediatelyistrue.
The number of subscription billing cycles to invoice in advance. If a new term is started for the subscription due to this API call, then
terms_to_charge is inclusive of this new term. See description for the force_term_reset parameter to learn more about when a subscription term is reset. If the subscription
status is cancelled and it is being reactivated via this operation, this is the date/time at which the subscription should be reactivated.Note: It is recommended not to pass this parameter along with
changed_scheduled_at. reactivate_from can be backdated (set to a value in the past). Use backdating when the subscription has been reactivated already but its billing has been delayed. Backdating is allowed only when the following prerequisites are met:
- Backdating must be enabled for subscription reactivation operations.
- The current day of the month does not exceed the limit set in Chargebee for backdating subscription change. This limit is the day of the month by which the accounting for the previous month must be closed.
- The date is on or after the last date/time any of the product catalog items of the subscription were changed.
- The date is not more than duration X into the past where X is the billing period of the plan. For example, if the period of the plan in the subscription is 2 months and today is 14th April,
changes_scheduled_atcannot be earlier than 14th February.
Override the billing alignment mode chosen for the site for calendar billing. Only applicable when using calendar billing.
List of coupons to be applied to this subscription. You can provide coupon ids or coupon codes.
This parameter is only relevant for
cancelled subscriptions. When set to true, it activates the canceled subscription; otherwise, subscription changes are applied without altering its status. Additionally, if not explicitly set and the subscription_items provided in the API differ from the existing items, the subscription will still be reactivated. Note: This parameter is relevant only for subscriptions with status of active, non_renewing, or cancelled.
When you set this parameter to true, the subscription term resets to the date of the subscription change.
By default, if you change the plan-item price to another with the same billing period, the subscription term remains unchanged. For example, if the subscription renews on the 28th of every month, it will continue to renew on the 28th after the change.
Note: If the new plan-item price has a different billing period from the current plan-item price, the subscription term resets automatically, regardless of the value of force_term_reset.
When
change_option is set to specific_date, specify the date and time for the subscription change to occur or to reflect a past change. - It is recommended not to use this parameter alongside
reactivate_from. - The
changes_scheduled_atvalue cannot be set to a past date.
Note :
- Although the customer will be redirected to the
redirect_urlafter successful checkout, we do not recommend relying on it for completing critical post-checkout actions. This is because redirection may not happen due to unforeseen reasons such as user closing the tab, or exiting the browser, and so on. If there is any synchronization that you are doing after the redirection, you will have to have a backup. Chargebee recommends listening to appropriate webhooks such assubscription_createdorinvoice_generatedto verify a successful checkout. - Redirect URL configured in Settings > Hosted Pages Settings would be overriden by this redirect URL.
- Eg : http://yoursite.com?id=<hosted_page_id>&state=succeeded
- This parameter is not applicable for iframe messaging.
The customers will be redirected to this URL upon canceling checkout. The hosted page id and state will be passed as parameters to this URL.
Note :
- Cancel URL configured in Settings > Hosted Pages Settings would be overriden by this cancel URL.
Eg : http://yoursite.com?id=<hosted_page_id>&state=cancelled - This parameter is not applicable for iframe messaging and in-app checkout.
This attribute allows you to store custom information with the hosted_page object. You can use it to associate specific data with a hosted page session.
For example, you can store the ID of the marketing campaign that initiated the user session. After a successful checkout, when the customer is redirected, you can retrieve the hosted page ID from the redirect URL's query parameters. Using this ID, you can fetch the hosted page and perform actions related to the success of the marketing campaign.
pass parameters as subscription[<param name>]
pass parameters as customer[<param name>]
pass parameters as subscription_items[<param name>][<idx:0..n>]
pass parameters as discounts[<param name>][<idx:0..n>]
pass parameters as item_tiers[<param name>][<idx:0..n>]
pass parameters as entity_identifiers[<param name>][<idx:0..n>]
Returns
Resource object representing hosted_page
Update payment method ¶
Note: If you're using In-App Checkout , use Manage Payment Sources API to request your customers to update their payment method details or change their payment method.
Using this API, you can request your customers to update their payment method details or change their payment method. This is used in scenarios like customers updating their payment methods before the end of trial or customers switching among payment methods.
When this API is invoked, it returns a hosted page URL. When the customers are directed to this URL, they will be able to change/update their payment methods.
Depending on the payment methods (Card, PayPal Express Checkout, Amazon Payments) that you offer your customers, they will find options to switch among the various methods of payment. Note:
- If the card[gateway] parameter is passed, and the customer chooses Card as a payment method, then the card details are stored in the gateway which is passed. However, if the card[gateway] parameter is passed and the customer chooses PayPal Express Checkout/Amazon Payments as a payment method, the gateway passed will be ignored.
- The option of embedding into an iframe is not supported for PayPal Express Checkout and Amazon Payments as customers are redirected to the respective website pages. Hence if you have PayPal Express Checkout/Amazon Payments configured and pass the parameter embed=true, this will result in an unsuccessful API request. Also, if you have all the three payment methods (Card, Paypal Express Checkout and Amazon Payments) configured and pass the parameter embed=true, the returned hosted page URL will show only Card Payment as a payment method.
Sample Response [ JSON ]
URL Format POST
Input Parameters
Note :
- Although the customer will be redirected to the
redirect_urlafter successful checkout, we do not recommend relying on it for completing critical post-checkout actions. This is because redirection may not happen due to unforeseen reasons such as user closing the tab, or exiting the browser, and so on. If there is any synchronization that you are doing after the redirection, you will have to have a backup. Chargebee recommends listening to appropriate webhooks such assubscription_createdorinvoice_generatedto verify a successful checkout. - Redirect URL configured in Settings > Hosted Pages Settings would be overriden by this redirect URL.
- Eg : http://yoursite.com?id=<hosted_page_id>&state=succeeded
- This parameter is not applicable for iframe messaging.
The customers will be redirected to this URL upon canceling checkout. The hosted page id and state will be passed as parameters to this URL.
Note :
- Cancel URL configured in Settings > Hosted Pages Settings would be overriden by this cancel URL.
Eg : http://yoursite.com?id=<hosted_page_id>&state=cancelled - This parameter is not applicable for iframe messaging and in-app checkout.
This attribute allows you to store custom information with the hosted_page object. You can use it to associate specific data with a hosted page session.
For example, you can store the ID of the marketing campaign that initiated the user session. After a successful session, when the customer is redirected, you can retrieve the hosted page ID from the redirect URL's query parameters. Using this ID, you can fetch the hosted page and perform actions related to the success of the marketing campaign.
If true then iframe will communicate with the parent window. Applicable only for embedded(iframe) hosted pages. If you're using iframe_messaging you need to implement onSuccess & onCancel callbacks.
Note : This parameter is not applicable for in-app checkout.
Returns
Resource object representing hosted_page
Manage Payment Sources ¶
This API generates a hosted page URL to add new or update existing payment sources for the customer.
Sample Response [ JSON ]
URL Format POST
Input Parameters
Returns
Resource object representing hosted_page
Collect Now ¶
This API generates a hosted page URL to collect due payments for the customer.
Sample Response [ JSON ]
URL Format POST
Input Parameters
Used to specify the destination URL to which a user is redirected after invoices are paid. The transaction ID of the transactions made through the Pay Now hosted page will be sent as return variables along with the URL.
Returns
Resource object representing hosted_page
Accept a quote ¶
This API generates a hosted page URL for the customer to accept a quote. If the hosted page URL has expired, a new URL will be generated automatically.
- Hosted page URL to accept a quote cannot be generated for one-time charges.
- Customers with existing subscriptions can generate a quote for new subscriptions. However, Hosted page URL to accept a quote cannot be generated for new subscriptions in V1 and V2 hosted pages.
Sample Response [ JSON ]
URL Format POST
Input Parameters
Note :
- Although the customer will be redirected to the
redirect_urlafter successful checkout, we do not recommend relying on it for completing critical post-checkout actions. This is because redirection may not happen due to unforeseen reasons such as user closing the tab, or exiting the browser, and so on. If there is any synchronization that you are doing after the redirection, you will have to have a backup. Chargebee recommends listening to appropriate webhooks such assubscription_createdorinvoice_generatedto verify a successful checkout. - Redirect URL configured in Settings > Hosted Pages Settings would be overriden by this redirect URL.
- Eg : http://yoursite.com?id=<hosted_page_id>&state=succeeded
- This parameter is not applicable for iframe messaging.
Returns
Resource object representing hosted_page
Extend Subscription ¶
This API generates a hosted page URL to extend the billing cycle of a subscription.
Sample Response [ JSON ]
URL Format POST
Input Parameters
Returns
Resource object representing hosted_page
Checkout Gift subscription for Items ¶
Creates a hosted page for a customer (called the gifter) to gift a subscription to another customer (called the receiver).
Gifter customer resource lookup and creation
When gifter[customer_id] is provided, it is looked up in Chargebee when the gifter completes the hosted page checkout. If not found, a new customer resource is created with this ID.
Multiple business entities
If multiple business entities are created for the site, the lookup and creation of the gifter customer resource happen within the context of the business entity specified in this API call. If no business entity is specified, the customer resource lookup is performed within the site context, and if not found, the resource is created for the default business entity of the site.
Gift receiver customer resource lookup and creation
Once the gifter checks out using the hosted page returned by this endpoint, Chargebee checks if a customer resource with the receiver's email address exists. The first such customer record is considered the receiver's customer resource. A new customer resource is created for the receiver if none are found.
Multiple business entities
If multiple business entities are created for the site, the lookup and creation of the gift receiver's customer resource happen within the context of the business entity of the gifter
Sample Response [ JSON ]
URL Format POST
Input Parameters
Sets the context for this operation to the business entity specified. Applicable only when multiple business entities have been created for the site. When this parameter is provided, the operation is able to read/write data associated only to the business entity specified. When not provided, the operation can read/write data for the entire site.
An alternative way of passing this parameter is by means of a custom HTTP header.
Note :
- Although the customer will be redirected to the
redirect_urlafter successful checkout, we do not recommend relying on it for completing critical post-checkout actions. This is because redirection may not happen due to unforeseen reasons such as user closing the tab, or exiting the browser, and so on. If there is any synchronization that you are doing after the redirection, you will have to have a backup. Chargebee recommends listening to appropriate webhooks such assubscription_createdorinvoice_generatedto verify a successful checkout. - Redirect URL configured in Settings > Hosted Pages Settings would be overriden by this redirect URL.
- Eg : http://yoursite.com?id=<hosted_page_id>&state=succeeded
- This parameter is not applicable for iframe messaging.
List of coupons to be applied to this subscription. You can provide coupon ids or coupon codes.
pass parameters as subscription_items[<param name>][<idx:0..n>]
Returns
Resource object representing hosted_page
Claim a Gift subscription ¶
This API generates a hosted page URL to claim a gifted subscription.
Sample Response [ JSON ]
URL Format POST
Input Parameters
Note :
- Although the customer will be redirected to the
redirect_urlafter successful checkout, we do not recommend relying on it for completing critical post-checkout actions. This is because redirection may not happen due to unforeseen reasons such as user closing the tab, or exiting the browser, and so on. If there is any synchronization that you are doing after the redirection, you will have to have a backup. Chargebee recommends listening to appropriate webhooks such assubscription_createdorinvoice_generatedto verify a successful checkout. - Redirect URL configured in Settings > Hosted Pages Settings would be overriden by this redirect URL.
- Eg : http://yoursite.com?id=<hosted_page_id>&state=succeeded
- This parameter is not applicable for iframe messaging.
Returns
Resource object representing hosted_page
Retrieve Direct Debit Agreement PDF ¶
This is applicable only for Direct Debit via SEPA, Bacs, Bg Autogiro, BECS (for both Australia and New Zealand) and PAD. For Direct Debit, the customer needs to accept an agreement that allows the merchant to debit their bank account. This agreement PDF allows you to easily display scheme-rules compliant Direct Debit mandates to your customers.
This API retrieves the redirect link to the corresponding agreement for customers. The agreement PDF can be your "Thank You" page or sent by email to customers. Communicating this PDF to your customers is mandatory.
Customer locale is used to generate the PDF in the required language. If a customer language is not supported, the PDF is generated in English. Checkout the list of languages supported by GoCardless.
Sample Response [ JSON ]
URL Format POST
Input Parameters
Returns
Resource object representing hosted_page
Acknowledge a hosted page ¶
When a hosted page is successfully completed by the user and processed by Chargebee, its state
is automatically changed to succeeded
. Acknowledging a hosted page confirms that you have moved the customer details from Chargebee into your system and are ready to fulfill it. This API is used to acknowledge the hosted page in succeeded
state and change its state to acknowledged
.
Note: The hosted page status must be succeeded for this API call to be allowed.
Sample Response [ JSON ]
URL Format POST
Returns
Resource object representing hosted_page
Retrieve a hosted page ¶
When you retrieve a hosted page whose status is successful, the content attribute has the following objects based on the type of the hosted page.
type of hosted page | content attribute constituents |
checkout_new |
|
checkout_existing |
|
update_payment_method |
|
pre_cancel |
|
collect_now |
|
Sample Response [ JSON ]
URL Format GET
Returns
Resource object representing hosted_page
List hosted pages ¶
This API retrieves the list of hosted page resources.
Sample Response [ JSON ]
URL Format GET
Input Parameters
Filter Params
For operator usages, see the Pagination and Filtering section.
Type of the requested hosted page. Possible values are : checkout_new, checkout_existing, update_payment_method, manage_payment_sources, collect_now, extend_subscription, checkout_one_time, pre_cancel, view_voucher, accept_quote
Supported operators : is, is_not, in, not_in
Example → type[is] = "checkout_new"
Returns
Resource object representing hosted_page
This attribute is returned only if more resources are present. To fetch the next set of resources use this value for the input parameter `offset`.
Create a pre-cancel hosted page ¶
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 Response [ JSON ]
URL Format POST
Input Parameters
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.
Returns
Resource object representing hosted_page
Notify an event ¶
Use this API to notify Chargebee about important events that occur on your web pages, such as subscription cancellations. An event contains data about affected resources and additional details such as when the change occurred.
Sample Response [ JSON ]
URL Format POST
Input Parameters
Returns
Create a hosted page to view Boleto vouchers ¶
Creates a hosted_page
resource of type, view_voucher
. When your end customers choose the Boleto payment method, you can generate a voucher for their pending invoice. Using this API, you can create a voucher_detail hosted page for your customers and email them a link to this hosted page. Your customers can review the voucher details on the page by clicking the link in the email.
Sample Response [ JSON ]
URL Format POST
Input Parameters
Returns
Resource object representing hosted_page