POST /hosted_pages/checkout_new_for_items

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 url received in the response.
Once they complete checkout, a new subscription is automatically created and the customer is redirected to the redirect_url with the id and state attributes passed as query string parameters.
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.
Retrieve the hosted page at this stage to get the subscription and invoice details.

Customer resource lookup and creation {#customer_lookup2}

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.

Servers

{protocol}://{site}.{environment}:{port}/api/v2
{protocol}://{site}-test.{environment}:{port}/api/v2

Request headers

Name	Type	Required	Description
`chargebee-request-origin-device`	String	No	The device from which the customer has made the request
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/x-www-form-urlencoded"
`chargebee-event-webhook`	String	No	skip only webhooks Possible values: `"all-disabled"`
`chargebee-business-entity-id`	String	No	If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.
`chargebee-event-actions`	String	No	skip all actions to be done on the events Possible values: `"all-disabled"`
`chargebee-request-origin-user`	String	No	The email address of your customer/user. Use this when the email address has only ASCII characters.
`chargebee-request-origin-ip`	String	No	The IP address of the customer where the request originated
`chargebee-request-origin-user-encoded`	String	No	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.
`chargebee-event-email`	String	No	skip only emails Possible values: `"all-disabled"`

Request body fields

Name	Type	Required	Description
`shipping_address`	Object	No	Parameters for shipping_address
`shipping_address.first_name`	String	No	The first name of the contact.
`shipping_address.state`	String	No	The state/province name. Is set by Chargebee automatically for US, Canada and India If `state_code` is provided.
`shipping_address.city`	String	No	The name of the city.
`shipping_address.validation_status`	String	No	The address verification status. * partially_valid - The address is valid for taxability but has not been validated for shipping. * invalid - Address is invalid. * not_validated - Address is not yet validated. * valid - Address was validated successfully. Possible values: `"partially_valid"` `"valid"` `"not_validated"` `"invalid"` Default value: "not_validated"
`shipping_address.line2`	String	No	Address line 2
`shipping_address.line1`	String	No	Address line 1
`shipping_address.email`	String	No	The email address.
`shipping_address.last_name`	String	No	The last name of the contact.
`shipping_address.company`	String	No	The company name.
`shipping_address.line3`	String	No	Address line 3
`shipping_address.state_code`	String	No	The ISO 3166-2 state/province code without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set `state_code` as `AZ` (not `US-AZ`). For Tamil Nadu (India), set as `TN` (not `IN-TN`). For British Columbia (Canada), set as `BC` (not `CA-BC`).
`shipping_address.zip`	String	No	Zip or postal code. The number of characters is validated according to the rules specified here.
`shipping_address.phone`	String	No	The phone number.
`shipping_address.country`	String	No	The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code. Note : If you enter an invalid country code, the system will return an error. Brexit If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then `XI` (the code for United Kingdom -- Northern Ireland) is available as an option.
`discounts`	Object	No	Parameters for discounts
`discounts.apply_on[]`	Array	No
`discounts.included_in_mrr[]`	Array	No	The discount is included in MRR calculations for your site. This attribute is only applicable when `duration_type` is `one_time` and when the feature is enabled in Chargebee. Also, If the site-level setting is to exclude one-time discounts from MRR calculations, this value is always returned `false`.
`discounts.period_unit[]`	Array	No
`discounts.percentage[]`	Array	No	The percentage of the original amount that should be deducted from it.
`discounts.period[]`	Array	No	The duration of time for which the discount is attached to the subscription, in `period_units`. Applicable only when `duration_type` is `limited_period`.
`discounts.amount[]`	Array	No	The value of the discount. The format of this value depends on the kind of currency.
`discounts.duration_type[]`	Array	Yes
`discounts.item_price_id[]`	Array	No	The id of the item price in the subscription to which the discount is to be applied. Relevant only when `apply_on` = `specific_item_price`.
`subscription`	Object	No	Parameters for subscription
`subscription.id`	String	No	A unique and immutable identifier for a new subscription. If not provided, it is autogenerated.
`subscription.start_date`	Integer	No	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.
`subscription.po_number`	String	No	Purchase order number for this subscription.
`subscription.coupon`	String	No	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.
`subscription.auto_collection`	String	No	Defines whether payments need to be collected automatically for this subscription. Overrides customer's auto-collection property. * off - Automatic collection of charges will not be made for this subscription. Use this for offline payments. * on - Whenever an invoice is created for this subscription, an automatic charge will be attempted on the payment method available. Possible values: `"on"` `"off"`
`subscription.invoice_notes`	String	No	A customer-facing note added to all invoices associated with this subscription. This note is one among all the notes displayed on the invoice PDF.
`subscription.trial_end`	Integer	No	End of the trial period for the subscription. This overrides the trial period set for the plan-item. The value must be later than `start_date`. Set it to `0` to have no trial period. This parameter overrides the `item_price_trial_period` directly.
`subscription.contract_term_billing_cycle_on_renewal`	Integer	No	Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as `billing_cycles` or a custom value depending on the site configuration.
`layout`	String	No	Specifies the checkout layout that overrides the default checkout layout configured in the Checkout & Self-Serve Portal settings. . * in_app - Indicates in-app checkout version * full_page - Indicates full page checkout version Possible values: `"full_page"` `"in_app"`
`pass_thru_content`	String	No	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.
`terms_to_charge`	Integer	No	The number of subscription billing cycles (including the first one) to invoice in advance.
`cancel_url`	String	No	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.
`business_entity_id`	String	No	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. Note An alternative way of passing this parameter is by means of a custom HTTP header. See also Customer resource lookup and creation.
`mandatory_items_to_remove[]`	Array	No	Item ids of mandatorily attached addons that are to be removed from the subscription.
`entity_identifiers`	Object	No	Parameters for entity_identifiers
`entity_identifiers.id[]`	Array	No	The unique id for the `entity_identifier[i]` in Chargebee. This is required when `entity_identifier[operation][i]` is `update` or `delete`.
`entity_identifiers.operation[]`	Array	No
`entity_identifiers.value[]`	Array	No	The value of the `entity_identifier`. This identifies the customer entity on the Peppol network. For example: `10101010-STO-10`. Tip: If there is only one entity identifier for the customer and the value is the same as `vat_number`, then there is no need to provide the `entity_identifiers[]` array. See description for `entity_identifiers[]`.
`entity_identifiers.scheme[]`	Array	No	The Peppol BIS scheme associated with the vat_number of the customer. This helps identify the specific type of customer entity. For example, `DE:VAT` is used for a German business entity while `DE:LWID45` is used for a German government entity. The value must be from the list of possible values and must correspond to the country provided under `billing_address.country`. See list of possible values. Tip: If there is only one entity identifier for the customer and the value is the same as `vat_number`, then there is no need to provide the `entity_identifiers[]` array. See description for `entity_identifiers[]`.
`entity_identifiers.standard[]`	Array	No	The standard used for specifying the `entity_identifier` `scheme`. Currently, only `iso6523-actorid-upis` is supported and is used by default when not provided. Tip: If there is only one entity identifier for the customer and the value is the same as `vat_number`, then there is no need to provide the `entity_identifiers[]` array. See description for `entity_identifiers[]`.
`card`	Object	No	Parameters for card
`card.gateway_account_id`	String	No	The gateway account in which this payment source is stored.
`subscription_items`	Object	No	Parameters for subscription_items
`subscription_items.charge_on_event[]`	Array	No
`subscription_items.unit_price[]`	Array	No	The price/per unit price of the item. When not provided, the value set for the item price is used. This is only applicable when the `pricing_model` of the item price is `flat_fee` or `per_unit`. Also, it is only allowed when price overriding is enabled for the site. The value depends on the type of currency. If `changes_scheduled_at` is in the past and a `unit_price` is not passed, then the item price's current unit price is considered even if the item price did not exist on the date as of when the change is scheduled.
`subscription_items.charge_once[]`	Array	No	Indicates if the charge-item is to be charged only once or each time the `charge_on_event` occurs. This parameter only applies to charge-items.
`subscription_items.charge_on_option[]`	Array	No
`subscription_items.unit_price_in_decimal[]`	Array	No	When price overriding is enabled for the site, the price or per-unit price of the item can be set here. The value set for the item price is used by default. Provide the value as a decimal string in major units of the currency. Can be provided only when multi-decimal pricing is enabled.
`subscription_items.item_price_id[]`	Array	Yes	The unique identifier of the item price. The first item price in the list (`subscription_items[item_price_id][0]`) must be an `item_price` of item_type `plan`.
`subscription_items.quantity[]`	Array	No	The quantity of the item purchased
`subscription_items.quantity_in_decimal[]`	Array	No	The decimal representation of the quantity of the item purchased. Can be provided for quantity-based item prices and only when multi-decimal pricing is enabled.
`subscription_items.service_period_days[]`	Array	No	Not supported: This parameter is not supported in the API. If included in a request, it will be ignored.
`subscription_items.trial_end[]`	Array	No	The date/time when the trial period of the item ends. This applies to plan-items.
`subscription_items.billing_cycles[]`	Array	No	For the plan-item price: the value determines the number of billing cycles the subscription runs before canceling automatically. If not provided, then the value set for the plan-item price is used. For addon-item prices: If addon billing cycles are enabled then this is the number of subscription billing cycles for which the addon is included. If not provided, then the value set under attached addons is used. Further, if that value is not provided, then the value set for the addon-item price is used.
`billing_cycles`	Integer	No	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.
`coupon_ids[]`	Array	No	List of coupons to be applied to this subscription. You can provide coupon ids or coupon codes.
`allow_offline_payment_methods`	Boolean	No	Allow the customer to select an offline payment method during checkout. The choice of payment methods can be configured via the Chargebee UI.
`customer`	Object	No	Parameters for customer
`customer.taxability`	String	No	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"
`customer.first_name`	String	No	First name of the customer. If not provided it will be got from contact information entered in the hosted page
`customer.entity_identifier_scheme`	String	No	The Peppol BIS scheme associated with the vat_number of the customer. This helps identify the specific type of customer entity. For example, `DE:VAT` is used for a German business entity while `DE:LWID45` is used for a German government entity. The value must be from the list of possible values and must correspond to the country provided under `billing_address.country`. See list of possible values. Tip: If there are additional entity identifiers for the customer not associated with the `vat_number`, they can be provided as the `entity_identifiers[]` array.
`customer.vat_number`	String	No	The VAT/tax registration number for the customer. For customers with billing_address `country` as `XI` (which is United Kingdom - Northern Ireland ), the first two characters of the full VAT number can be overridden by setting vat_number_prefix.
`customer.id`	String	No	The unique identifier for the customer resource for which the subscription should be created. See also Customer resource lookup and creation. 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.
`customer.email`	String	No	Email of the customer. Configured email notifications will be sent to this email.
`customer.last_name`	String	No	Last name of the customer. If not provided it will be got from contact information entered in the hosted page
`customer.company`	String	No	Company name of the customer.
`customer.vat_number_prefix`	String	No	An overridden value for the first two characters of the full VAT number. Only applicable specifically for customers with billing_address `country` as `XI` (which is United Kingdom - Northern Ireland ). When you have enabled EU VAT in 2021 or have manually enabled the Brexit configuration, you have the option of setting billing_address `country` as `XI`. That's the code for United Kingdom - Northern Ireland . The first two characters of the VAT number in such a case is `XI` by default. However, if the VAT number was registered in UK, the value should be `GB`. Set `vat_number_prefix` to `GB` for such cases.
`customer.phone`	String	No	Phone number of the customer
`customer.locale`	String	No	Determines which region-specific language Chargebee uses to communicate with the customer. In the absence of the locale attribute, Chargebee will use your site's default language for customer communication.
`customer.entity_identifier_standard`	String	No	The standard used for specifying the `entity_identifier_scheme`. Currently only `iso6523-actorid-upis` is supported and is used by default when not provided. Tip: If there are additional entity identifiers for the customer not associated with the `vat_number`, they can be provided as the `entity_identifiers[]` array. Default value: "iso6523-actorid-upis"
`customer.is_einvoice_enabled`	Boolean	No	Determines whether the customer is e-invoiced. When set to `true` or not set to any value, the customer is e-invoiced so long as e-invoicing is enabled for their country (`billing_address.country`). When set to `false`, the customer is not e-invoiced even if e-invoicing is enabled for their country. Tip: It is possible to set a value for this flag even when E-Invoicing is disabled. However, it comes into effect only when E-Invoicing is enabled.
`customer.einvoicing_method`	String	No	null Possible values: `"manual"` `"site_default"` `"automatic"`
`redirect_url`	String	No	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= <hosted_page_id>&state=succeeded This parameter is not applicable for iframe messaging.
`billing_alignment_mode`	String	No	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. * immediate - Subscription period will be aligned with the configured billing date immediately, with credits or charges raised accordingly.. * delayed - Subscription period will be aligned with the configured billing date at the next renewal. Possible values: `"immediate"` `"delayed"`
`item_tiers`	Object	No	Parameters for item_tiers
`item_tiers.starting_unit_in_decimal[]`	Array	No	The decimal representation of the lowest value of quantity in this tier. This is zero for the lowest tier. For all other tiers, it is the same as `ending_unit_in_decimal` of the next lower tier. Returned only when the pricing_model is `tiered`, `volume` or `stairstep` and multi-decimal pricing is enabled.
`item_tiers.price_in_decimal[]`	Array	No	The decimal representation of the per-unit price for the tier when the `pricing_model` is `tiered` or `volume`. When the `pricing_model` is `stairstep`, it is the decimal representation of the total price for the item. The value is in major units of the currency. Returned when the plan is quantity-based and multi-decimal pricing is enabled.
`item_tiers.package_size[]`	Array	No	Package size for the tier when pricing type is `package`. Specify the number of units that make up one package. For example, if 1000 API hits are grouped into a single package, set the package size to 1000.
`item_tiers.price[]`	Array	No	The overridden price of the tier. The value depends on the type of currency.
`item_tiers.ending_unit[]`	Array	No	The highest value in the quantity tier.
`item_tiers.item_price_id[]`	Array	No	The id of the item price for which the tier price is being overridden.
`item_tiers.pricing_type[]`	Array	No
`item_tiers.starting_unit[]`	Array	No	The lowest value in the quantity tier.
`item_tiers.ending_unit_in_decimal[]`	Array	No	The decimal representation of the highest value of quantity in this tier. This attribute is not applicable for the highest tier. For all other tiers, it must be equal to the `starting_unit_in_decimal` of the next higher tier. Returned only when the pricing_model is `tiered`, `volume` or `stairstep` and multi-decimal pricing is enabled.
`contract_term`	Object	No	Parameters for contract_term
`contract_term.action_at_term_end`	String	No	Action to be taken when the contract term completes. * evergreen - Contract term completes and the subscription renews. * renew - Contract term completes and a new contract term is started for the number of billing cycles specified in `contract_billing_cycle_on_renewal`. The `action_at_term_end` for the new contract term is set to `renew`. * cancel - Contract term completes and subscription is canceled. Possible values: `"evergreen"` `"cancel"` `"renew"`
`contract_term.cancellation_cutoff_period`	Integer	No	The number of days before `contract_end`, during which the customer is barred from canceling the contract term. The customer is allowed to cancel the contract term via the Self-Serve Portal only before this period. This allows you to have sufficient time for processing the contract term closure Default value: 0
`billing_address`	Object	No	Parameters for billing_address
`billing_address.first_name`	String	No	The first name of the billing contact.
`billing_address.state`	String	No	The state/province name. Is set by Chargebee automatically for US, Canada and India If `state_code` is provided.
`billing_address.city`	String	No	The name of the city.
`billing_address.validation_status`	String	No	The address verification status. * valid - Address was validated successfully. * partially_valid - The address is valid for taxability but has not been validated for shipping. * invalid - Address is invalid. * not_validated - Address is not yet validated. Possible values: `"partially_valid"` `"valid"` `"not_validated"` `"invalid"` Default value: "not_validated"
`billing_address.line2`	String	No	Address line 2
`billing_address.line1`	String	No	Address line 1
`billing_address.email`	String	No	The email address.
`billing_address.last_name`	String	No	The last name of the billing contact.
`billing_address.company`	String	No	The company name.
`billing_address.line3`	String	No	Address line 3
`billing_address.state_code`	String	No	The ISO 3166-2 state/province code without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set `state_code` as `AZ` (not `US-AZ`). For Tamil Nadu (India), set as `TN` (not `IN-TN`). For British Columbia (Canada), set as `BC` (not `CA-BC`).
`billing_address.zip`	String	No	Zip or postal code. The number of characters is validated according to the rules specified here.
`billing_address.phone`	String	No	The phone number.
`billing_address.country`	String	No	The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code. Note : If you enter an invalid country code, the system will return an error. Brexit If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then `XI` (the code for United Kingdom -- Northern Ireland) is available as an option.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.