POST /hosted_pages/checkout_new

The device from which the customer has made the request

Default value: "application/x-www-form-urlencoded"

skip only webhooks

Possible values:

• "all-disabled"

skip all actions to be done on the events

Possible values:

• "all-disabled"

The email address of your customer/user. Use this when the email address has only ASCII characters.

The IP address of the customer where the request originated

The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.

skip only emails

Possible values:

• "all-disabled"

Parameters for customer

The unique ID of the customer for which this hosted_page should be created. When not provided, a new customer is created with the ID set to the value provided for subscription[id]. If subscription[id] is unavailable, then the customer ID is autogenerated.

Specifies if the customer is liable for tax * exempt -

• Customer is exempted from tax. When using Chargebee's native Taxes feature or when using the TaxJar integration, no other action is needed.
• However, when using our Avalara integration, optionally, specify entity_code or exempt_number attributes if you use Chargebee's AvaTax for Sales or specify exemption_details attribute if you use Chargebee's AvaTax for Communications integration. Tax may still be applied by Avalara for certain values of entity_code/exempt_number/exemption_details based on the state/region/province of the taxable address.

* taxable - Computes tax for the customer based on the site configuration. In some cases, depending on the region, shipping_address is needed. If not provided, then billing_address is used to compute tax. If that's not available either, the tax is taken as zero.

Possible values:

• "exempt"
• "taxable"

Default value: "taxable"

Email of the customer. Configured email notifications will be sent to this email.

Last name of the customer. If not provided it will be got from contact information entered in the hosted page

Company name of the customer.

First name of the customer. If not provided it will be got from contact information entered in the hosted page

Phone number of the customer

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. 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. Chargebee recommends listening to appropriate webhooks such as subscription_created or invoice_generated to verify a successful checkout.

Note :

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

Parameters for subscription

A unique and immutable identifier for the subscription. If not provided, it is autogenerated.

The date/time at which the subscription is to start. If not provided, the subscription starts immediately. You can provide a value in the past as well. This is called backdating the subscription creation and is done when the subscription has already been provisioned but its billing has been delayed. Backdating is allowed only when the following prerequisites are met:

• Backdating is enabled for subscription creation operations.
• The current day of the month does not exceed the limit set in Chargebee for backdating such operations. This day is typically the day of the month by which the accounting for the previous month must be closed.
• 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, start_date cannot be earlier than 14th February.

Identifier of the plan for this subscription

The id of the coupon. For validating the coupon code provided by the user , use the following codes in combination with the param attribute in the error response.

• resource_not_found : Returned if the coupon is not present.
• resource_limit_exhausted : Returned if the coupon has expired or the maximum redemption for the coupon has already been reached.
• invalid_request : Returned if the coupon is not applicable for the particular plan/addon.

The time at which the trial ends for this subscription. Can be specified to override the default trial period.If '0' is passed, the subscription will be activated immediately.

Plan quantity for this subscription

Default value: 1

You can pass through any content specific to the hosted page request and get it back after user had submitted the hosted page.

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.

Parameters for card

Name of the gateway this payment source is stored with. * sage_pay - Sage Pay is a payment gateway. * wirecard - WireCard Account is a payment service provider. * balanced_payments - Balanced is a payment gateway * migs - MasterCard Internet Gateway Service payment gateway. * paymill - PAYMILL is a payment gateway. * first_data_global - First Data Global Gateway Virtual Terminal Account * ogone - Ingenico ePayments (formerly known as Ogone) is a payment gateway. * chargebee - Chargebee test gateway. * braintree - Braintree is a payment gateway. * pin - Pin is a payment gateway * authorize_net - Authorize.net is a payment gateway * worldpay - WorldPay is a payment gateway * nmi - NMI is a payment gateway. * hdfc - HDFC Account is a payment gateway. * elavon - Elavon Virtual Merchant is a payment solution. * not_applicable - Indicates that payment gateway is not applicable for this resource. * eway_rapid - eWAY Rapid is a payment gateway. * beanstream - Bambora(formerly known as Beanstream) is a payment gateway. * tco - 2Checkout is a payment gateway. * bluepay - BluePay is a payment gateway. * paypal_payflow_pro - PayPal Payflow Pro is a payment gateway. * eway - eWAY Account is a payment gateway. * paypal_pro - PayPal Pro Account is a payment gateway. * stripe - Stripe is a payment gateway.

Possible values:

• "balanced_payments"
• "first_data_global"
• "paymill"
• "bluepay"
• "paypal_payflow_pro"
• "wirecard"
• "nmi"
• "hdfc"
• "ogone"
• "stripe"
• "migs"
• "eway_rapid"
• "worldpay"
• "sage_pay"
• "beanstream"
• "tco"
• "paypal_pro"
• "braintree"
• "elavon"
• "chargebee"
• "pin"
• "eway"
• "authorize_net"

If true then hosted page formatted to be shown in iframe. If false, it is formatted to be shown as a separate page.

Note : For in-app checkout, default is false.

Default value: true

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.

Default value: false

Parameters for addons

Identifier of the addon. Multiple addons can be passed.

Quantity of the addon. Applicable for addons with pricing_model other than flat_fee.

Number of cycles(plan interval) this subscription should be charged. After the billing cycles exhausted, the subscription will be cancelled.