This API generates a hosted page URL to collect due payments for the customer.
Open the hosted page in a new browser tab or window using the url from this API's response. Do not embed it in your own iframe.
openCheckout() not supported
The Chargebee.js openCheckout() function does not support Collect Now hosted pages. To open a Collect Now page, open the url from this API's response in a new browser tab or window (for example, window.open(response.hosted_page.url, '_blank')).
Sample Request
Sample Result[JSON]
URL Format
Input Parameters
The unique ID of the brand this hosted page should be linked to. Applicable only when multiple brands have been created for the site. This need not match the brand of the customer or subscription in the request; when the two differ, the value provided here is used for the hosted page. An alternative way of passing this parameter is by means of the chargebee-brand-id custom HTTP header; when both are provided, they must specify the same brand.
Default behavior
- When not provided, the hosted page is linked to the brand of the customer or subscription in the request.
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.
Determines whether the payment method should be saved to the customer's account.
Automatically save the payment method to the customer's account for future use.
Let the customer choose whether to save the payment method.
Do not save the payment method.
Returns
Resource object representing hosted_page