ChargebeeAPI

Accept a quote

Idempotency Supported
Try in API Explorer

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.

  • 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 Request

URL Format

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

Input Parameters

redirect_url
optional, string, max chars=250

The customers will be redirected to this URL upon successful checkout. The hosted page id and state will be passed as parameters to this URL.

Note :

  • Although the customer will be redirected to the redirect_url after 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 as subscription_created or invoice_generated to verify a successful checkout.
  • Redirect URL configured in Settings > Hosted Pages Settings would be overriden by this redirect URL.
  • Eg : http://yoursite.com?id=**&state=succeeded
  • This parameter is not applicable for iframe messaging.
layout
optional, enumerated string

The layout style for the hosted page.

Possible Enum Values
in_app

Display the hosted page in an in-app layout.

full_page

Display the hosted page in a full page layout.

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

Returns

hosted_pageHosted page object
Resource object representing hosted_page