# Checkout charge-items and one-time charges > For the complete machine-readable documentation index, see [llms.txt](https://apidocs.chargebee.com/llms.txt). [Idempotency Supported](/docs/api/idempotency) Create a Chargebee hosted page to accept payment details from a customer and checkout [charge-items](/docs/api/items) and [one-time charges](/docs/api/invoices/create-invoice-for-items-and-one-time-charges). The following steps describe how best to use this API: 1. Call this endpoint, providing [item prices](/docs/api/item_prices), [charges](/docs/api/items), [coupons](/docs/api/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_content` containing information and IDs from your systems that must be associated with the checkout page. 2. Send the customer to the Checkout `url` received in the response. 3. Once they complete checkout, the set of charge-items and one-time charges are automatically invoiced against the respective `customer` record in Chargebee, and they are redirected to the `redirect_url` with the `id` and `state` attributes passed as query string parameters. 4. [Retrieve the hosted page](/docs/api/hosted_pages/retrieve-a-hosted-page) at this stage to get the invoice details. #### Customer resource lookup and creation[](#customer-resource-lookup-and-creation) When `[customer[id]](/docs/api/hosted_pages/checkout-charge-items-and-one-time-charges)` 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[](#multiple-business-entities) If multiple [business entities](/docs/api/advanced-features) are created for the site, the customer resource lookup and creation happen within the [context](/docs/api/advanced-features) of the business entity [specified](/docs/api/advanced-features#mbe-header-main) in this API call. If no business entity is specified, the customer resource lookup is performed within the [site context](/docs/api/advanced-features) , and if not found, the resource is created for the [default business entity](/docs/api/advanced-features) of the site. ## Sample Request #### cURL ```bash curl https://{site}.chargebee.com/api/v2/hosted_pages/checkout_one_time_for_items \ -u {site_api_key}:\ -d "customer[id]"="__test__XpbXKKYSOUtL5p2E" \ -d "item_prices[item_price_id][0]"="ssl-charge-USD" \ -d "item_prices[unit_price][0]"=2000 \ -d "shipping_address[first_name]"="John" \ -d "shipping_address[last_name]"="Mathew" \ -d "shipping_address[city]"="Walnut" \ -d "shipping_address[state]"="California" \ -d "shipping_address[zip]"="91789" \ -d "shipping_address[country]"="US" ``` #### .NET ```dotnet using ChargeBee.Api; using ChargeBee.Models; ApiConfig.Configure("{site}","{site_api_key}"); EntityResult result = HostedPage.CheckoutOneTimeForItems() .CustomerId("__test__XpbXKKYSOUtL5p2E") .ItemPriceItemPriceId(0, "ssl-charge-USD") .ItemPriceUnitPrice(0, 2000) .ShippingAddressFirstName("John") .ShippingAddressLastName("Mathew") .ShippingAddressCity("Walnut") .ShippingAddressState("California") .ShippingAddressZip("91789") .ShippingAddressCountry("US") .Request(); HostedPage hostedPage = result.HostedPage; ``` #### Go ```go package main import ( "fmt" "github.com/chargebee/chargebee-go/v3" hostedpageAction "github.com/chargebee/chargebee-go/v3/actions/hostedpage" "github.com/chargebee/chargebee-go/v3/models/hostedpage" ) func main() { chargebee.Configure("{site_api_key}","{site}"); res,err := hostedpageAction.CheckoutOneTimeForItems(&hostedpage.CheckoutOneTimeForItemsRequestParams{ ItemPrices : []*hostedpage.CheckoutOneTimeForItemsItemPriceParams{ { ItemPriceId : "ssl-charge-USD", UnitPrice : chargebee.Int64(2000), }, }, Customer : &hostedpage.CheckoutOneTimeForItemsCustomerParams{ Id : "__test__XpbXKKYSOUtL5p2E", }, ShippingAddress : &hostedpage.CheckoutOneTimeForItemsShippingAddressParams{ FirstName : "John", LastName : "Mathew", City : "Walnut", State : "California", Zip : "91789", Country : "US", }, }).Request() if err != nil { fmt.Println(err) } else { HostedPage := res.HostedPage } } ``` #### Go ```go package main import ( "fmt" "github.com/chargebee/chargebee-go/v4" ) func main() { config := &chargebee.ClientConfig{ SiteName: "{site}", ApiKey: "{site_api_key}", } client := chargebee.NewClient(config) req := &chargebee.HostedPageCheckoutOneTimeForItemsRequest{ ItemPrices : []*chargebee.HostedPageCheckoutOneTimeForItemsItemPrice{ { ItemPriceId : "ssl-charge-USD", UnitPrice : chargebee.Int64(2000), }, }, Customer : &chargebee.HostedPageCheckoutOneTimeForItemsCustomer{ Id : "__test__XpbXKKYSOUtL5p2E", }, ShippingAddress : &chargebee.HostedPageCheckoutOneTimeForItemsShippingAddress{ FirstName : "John", LastName : "Mathew", City : "Walnut", State : "California", Zip : "91789", Country : "US", }, } res, err := client.HostedPage.CheckoutOneTimeForItems(req) if err != nil { fmt.Println(err) } else { HostedPage := res.HostedPage } } ``` #### Java ```java import com.chargebee.*; import com.chargebee.ListResult; import com.chargebee.models.*; import com.chargebee.models.enums.*; import java.io.IOException; public class Sample { public static void main(String args[]) throws IOException, Exception { Environment.configure("{site}", "{site_api_key}"); Result result = HostedPage.checkoutOneTimeForItems() .customerId("__test__XpbXKKYSOUtL5p2E") .itemPriceItemPriceId(0, "ssl-charge-USD") .itemPriceUnitPrice(0, 2000L) .shippingAddressFirstName("John") .shippingAddressLastName("Mathew") .shippingAddressCity("Walnut") .shippingAddressState("California") .shippingAddressZip("91789") .shippingAddressCountry("US") .request(); HostedPage hostedPage = result.hostedPage(); } } ``` #### Java ```java import com.chargebee.v4.client.ChargebeeClient; import com.chargebee.v4.models.hostedPage.HostedPage; import com.chargebee.v4.models.hostedPage.params.HostedPageCheckoutOneTimeForItemsParams; import com.chargebee.v4.models.hostedPage.responses.HostedPageCheckoutOneTimeForItemsResponse; import java.util.List; public class HostedPageCheckoutOneTimeForItems { public static void main(String[] args) { ChargebeeClient client = ChargebeeClient.builder() .apiKey("{site_api_key}") .siteName("{site}") .build(); HostedPageCheckoutOneTimeForItemsParams.CustomerParams customerParams = HostedPageCheckoutOneTimeForItemsParams.CustomerParams.builder() .id("__test__XpbXKKYSOUtL5p2E") .build(); HostedPageCheckoutOneTimeForItemsParams.ShippingAddressParams shippingAddressParams = HostedPageCheckoutOneTimeForItemsParams.ShippingAddressParams.builder() .firstName("John") .lastName("Mathew") .city("Walnut") .state("California") .zip("91789") .country("US") .build(); HostedPageCheckoutOneTimeForItemsParams.ItemPricesParams itemPrice0 = HostedPageCheckoutOneTimeForItemsParams.ItemPricesParams.builder() .itemPriceId("ssl-charge-USD") .unitPrice(2000L) .build(); List itemPricesList = List.of(itemPrice0); HostedPageCheckoutOneTimeForItemsParams params = HostedPageCheckoutOneTimeForItemsParams.builder() .customer(customerParams) .itemPrices(itemPricesList) .shippingAddress(shippingAddressParams) .build(); HostedPageCheckoutOneTimeForItemsResponse response = client.hostedPages().checkoutOneTimeForItems(params); HostedPage hostedPage = response.getHostedPage(); } } ``` #### Node.js ```node import Chargebee from "chargebee"; const chargebee = new Chargebee({ site: "{site}", apiKey: "{site_api_key}", }); try { const result = await chargebee.hostedPage.checkoutOneTimeForItems({ item_prices: [ { item_price_id: "ssl-charge-USD", unit_price: 2000 } ], customer: { id: "__test__XpbXKKYSOUtL5p2E" }, shipping_address: { first_name: "John", last_name: "Mathew", city: "Walnut", state: "California", zip: 91789, country: "US" } }); console.log(result); const hostedPage = result.hosted_page; } catch (err) { console.log(err); } ``` #### PHP ```php "{site}", "apiKey" => "{site_api_key}", ]); $result = $chargebee->hostedPage()->checkoutOneTimeForItems([ "item_prices" => [ [ "item_price_id" => "ssl-charge-USD", "unit_price" => 2000 ] ], "customer" => [ "id" => "__test__XpbXKKYSOUtL5p2E" ], "shipping_address" => [ "first_name" => "John", "last_name" => "Mathew", "city" => "Walnut", "state" => "California", "zip" => "91789", "country" => "US" ] ]); $hostedPage = $result->hosted_page; ``` #### Python ```python from chargebee import Chargebee cb_client = Chargebee(api_key="{site_api_key}", site="{site}") response = cb_client.HostedPage.checkout_one_time_for_items( cb_client.HostedPage.CheckoutOneTimeForItemsParams( item_prices=[ cb_client.HostedPage.CheckoutOneTimeForItemsItemPriceParams( item_price_id="ssl-charge-USD", unit_price=2000 ) ], customer=cb_client.HostedPage.CheckoutOneTimeForItemsCustomerParams( id="__test__XpbXKKYSOUtL5p2E" ), shipping_address=cb_client.HostedPage.CheckoutOneTimeForItemsShippingAddressParams( first_name="John", last_name="Mathew", city="Walnut", state="California", zip="91789", country="US" ) ) ) hosted_page = response.hosted_page ``` #### Ruby ```ruby require 'chargebee' ChargeBee.configure(:site => "{site}", :api_key => "{site_api_key}") result = ChargeBee::HostedPage.checkout_one_time_for_items({ :customer => { :id => "__test__XpbXKKYSOUtL5p2E" }, :item_prices => [ { :item_price_id => "ssl-charge-USD", :unit_price => 2000 } ], :shipping_address => { :first_name => "John", :last_name => "Mathew", :city => "Walnut", :state => "California", :zip => "91789", :country => "US" } }) hosted_page = result.hosted_page ``` ## Sample Response ```json { "hosted_page": { "created_at": 1517464663, "embed": false, "expires_at": 1517468263, "id": "__one_time_checkout___test__cdqM9MLUubELMycut0Cr9sHq8gOTKEZSdcu", "layout": "in_app", "object": "hosted_page", "resource_version": 1517444863979, "state": "created", "type": "checkout_one_time", "updated_at": 1517444863, "url": "https://yourapp.chargebee.com/pages/v4/__one_time_checkout___test__cdqM9MLUubELMycut0Cr9sHq8gOTKEZSdcu/" } } ``` ## URL Format **POST** https://[site].chargebee.com/api/v2/hosted_pages/checkout_one_time_for_items ## Input Parameters - `business_entity_id` (optional, string, max chars=50) Sets the context for this operation to the [business entity](/docs/api/advanced-features) 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](/docs/api/advanced-features). **See also** [Customer resource lookup and creation.](/docs/api/hosted_pages) - `brand_id` (optional, string, max chars=50) The unique ID of the [brand](/docs/api/brands) this hosted page should be linked to. Applicable only when multiple brands have been created for the site. Resources created through the hosted page, such as the customer and the subscription, are linked to the same brand. 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 brand of the customer or subscription referenced in the request is used, or the default brand defined for the site when the request references neither. - `layout` (optional, enumerated string) Specifies the UI layout for the hosted page. This overrides [the layout](https://www.chargebee.com/docs/billing/2.0/hosted-capabilities/hosted-checkout#ui-layout-options) configured in Chargebee Billing. Possible enum values: - `in_app` Renders the hosted page in an in-app layout. - `full_page` Renders the hosted page in a full-page layout. - `invoice_note` (optional, string, max chars=2000) A note for this particular invoice. This, and [all other notes](/docs/api/invoices/invoice-object#notes) for the invoice are displayed on the PDF invoice sent to the customer. - `coupon_ids` (optional, string, max chars=100) List of Coupons to be added. - `currency_code` (required if Multicurrency is enabled, string, max chars=3) The currency code (ISO 4217 format) of the invoice amount. - `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`](/docs/api/events) or [`invoice_generated`](/docs/api/events) 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. - `cancel_url` (optional, string, max chars=250) 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=&state=cancelled_ - This parameter is not applicable for iframe messaging and [in-app](https://www.chargebee.com/docs/2.0/checkout.html) checkout. - `pass_thru_content` (optional, string, max chars=2048) 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](/docs/api/hosted_pages/checkout-charge-items-and-one-time-charges)'s query parameters. Using this ID, you can fetch the hosted page and perform actions related to the success of the marketing campaign. - `customer` (optional, string) Parameters for customer - `id` (optional, string, max chars=50) The unique ID of the customer for which this `hosted_page` should be created. If not provided, the ID of the newly created customer resource is autogenerated. **See also** [Customer resource lookup and creation.](/docs/api/hosted_pages) - `email` (optional, string, max chars=70) Email of the customer. Configured email notifications will be sent to this email. - `first_name` (optional, string, max chars=150) First name of the customer. If not provided it will be got from contact information entered in the hosted page - `last_name` (optional, string, max chars=150) Last name of the customer. If not provided it will be got from contact information entered in the hosted page - `company` (optional, string, max chars=250) Company name of the customer. - `phone` (optional, string, max chars=50) Phone number of the customer - `locale` (optional, string, max chars=50) 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. - `taxability` (optional, enumerated string, default=taxable) Specifies if the customer is liable for tax Possible enum values: - `taxable` Computes tax for the customer based on the [site configuration](https://www.chargebee.com/docs/tax.html). 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. - `exempt` - Customer is exempted from tax. When using Chargebee's native [Taxes](https://www.chargebee.com/docs/tax.html) feature or when using the [TaxJar integration](https://www.chargebee.com/docs/taxjar.html), no other action is needed. - However, when using our [Avalara integration](https://www.chargebee.com/docs/avalara.html), optionally, specify `entity_code` or `exempt_number` attributes if you use Chargebee's [AvaTax for Sales](https://www.chargebee.com/docs/avalara.html#configuring-tax-exemption) or specify `exemption_details` attribute if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html) 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. - `vat_number` (optional, string, max chars=20) The VAT/tax registration number for the customer. For customers with `[billing_address](/docs/api/customers/customer-object#billing_address)` `country` as `XI` (which is **United Kingdom - Northern Ireland** ), the first two characters of the [full VAT number](https://en.wikipedia.org/wiki/VAT_identification_number) can be overridden by setting `[vat_number_prefix](/docs/api/customers/customer-object#vat_number_prefix)` . - `vat_number_prefix` (optional, string, max chars=10) An overridden value for the first two characters of the [full VAT number](https://en.wikipedia.org/wiki/VAT_identification_number). Only applicable specifically for customers with `[billing_address](/docs/api/customers/customer-object#billing_address)` `country` as `XI` (which is **United Kingdom - Northern Ireland** ). When you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html) in 2021 or have [manually enabled](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee) the Brexit configuration, you have the option of setting `[billing_address](/docs/api/customers/customer-object#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. - `einvoicing_method` (optional, enumerated string) Determines whether e-invoices are sent manually or automatically. Possible enum values: - `automatic` Use this value to send an e-invoice every time an invoice or credit note is created. - `manual` When `manual` is selected, automatic e-invoice sending is disabled. Use this value to send e-invoices manually through the UI or the API. - `site_default` The default value of the site, which can be overridden at the customer level. - `is_einvoice_enabled` (optional, boolean) 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. - `entity_identifier_scheme` (optional, string, max chars=50) The Peppol BIS scheme associated with the `[vat_number](/docs/api/customers/customer-object#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](https://www.chargebee.com/docs/e-invoicing.html#supported-countries) . **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. - `entity_identifier_standard` (optional, string, default=iso6523-actorid-upis, max chars=50) 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. - `consolidated_invoicing` (optional, boolean) Indicates whether invoices raised on the same day for the `customer` are consolidated. When provided, this overrides the default configuration at the [site-level](https://www.chargebee.com/docs/consolidated-invoicing.html#configuring-consolidated-invoicing). This parameter can be provided only when [Consolidated Invoicing](https://www.chargebee.com/docs/consolidated-invoicing.html) is enabled. **Note:** Any invoices raised when a subscription activates from `in_trial` or `future` `status`, are not consolidated by default. [Contact Support](https://www.chargebee.com/docs/billing/2.0/kb/getting-started/how-to-contact-chargebees-support-team?utm_source=docs_api&utm_medium=content&utm_campaign=support) to enable consolidation for such invoices. - `invoice` (optional, string) Parameters for invoice - `po_number` (optional, string, max chars=100) Purchase Order Number for this invoice. - `card` (optional, string) Parameters for card - `gateway_account_id` (optional, string, max chars=50) The gateway account in which this payment source is stored. - `billing_address` (optional, string) Parameters for billing\_address - `first_name` (optional, string, max chars=150) The first name of the billing contact. - `last_name` (optional, string, max chars=150) The last name of the billing contact. - `email` (optional, string, max chars=70) The email address. - `company` (optional, string, max chars=250) The company name. - `phone` (optional, string, max chars=50) The phone number. - `line1` (optional, string, max chars=150) Address line 1 - `line2` (optional, string, max chars=150) Address line 2 - `line3` (optional, string, max chars=150) Address line 3 - `city` (optional, string, max chars=50) The name of the city. - `state_code` (optional, string, max chars=50) The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search/code) without the country prefix. Currently supported for USA, Canada, India and UAE. 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` ). For Dubai (UAE), set as `DU` (not `AE-DU` ). - `state` (optional, string, max chars=50) The state/province name. Is set by Chargebee automatically for US, Canada, India and UAE, if `state_code` is provided. - `zip` (optional, string, max chars=20) Zip or postal code. The number of characters is validated according to the rules [specified here](https://chromium-i18n.appspot.com/ssl-address) . - `country` (optional, string, max chars=50) The billing address country of the customer. Must be one of [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html) . **Note**: If you enter an invalid country code, the system will return an error. **Brexit** If you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html) in 2021 or later, or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee) the Brexit configuration, then `XI` (the code for **United Kingdom - Northern Ireland**) is available as an option. - `validation_status` (optional, enumerated string, default=not_validated) The address verification status. Possible enum values: - `not_validated` Address is not yet validated. - `valid` Address was validated successfully. - `partially_valid` The address is valid for taxability but has not been validated for shipping. - `invalid` Address is invalid. - `shipping_address` (optional, string) Parameters for shipping\_address - `first_name` (optional, string, max chars=150) The first name of the contact. - `last_name` (optional, string, max chars=150) The last name of the contact. - `email` (optional, string, max chars=70) The email address. - `company` (optional, string, max chars=250) The company name. - `phone` (optional, string, max chars=50) The phone number. - `line1` (optional, string, max chars=150) Address line 1 - `line2` (optional, string, max chars=150) Address line 2 - `line3` (optional, string, max chars=150) Address line 3 - `city` (optional, string, max chars=50) The name of the city. - `state_code` (optional, string, max chars=50) The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search/code) without the country prefix. Currently supported for USA, Canada, India and UAE. 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` ). For Dubai (UAE), set as `DU` (not `AE-DU` ). - `state` (optional, string, max chars=50) The state/province name. Is set by Chargebee automatically for US, Canada, India and UAE, if `state_code` is provided. - `zip` (optional, string, max chars=20) Zip or postal code. The number of characters is validated according to the rules [specified here](https://chromium-i18n.appspot.com/ssl-address) . - `country` (optional, string, max chars=50) The billing address country of the customer. Must be one of [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html) . **Note**: If you enter an invalid country code, the system will return an error. **Brexit** If you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html) in 2021 or later, or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee) the Brexit configuration, then `XI` (the code for **United Kingdom - Northern Ireland**) is available as an option. - `validation_status` (optional, enumerated string, default=not_validated) The address verification status. Possible enum values: - `not_validated` Address is not yet validated. - `valid` Address was validated successfully. - `partially_valid` The address is valid for taxability but has not been validated for shipping. - `invalid` Address is invalid. - `item_prices` (optional, array) Parameters for item\_prices - `item_price_id` (optional, string, max chars=100) A unique ID of the [item price](/docs/api/item_prices/item_price-object) to be added to the invoice. **Constraints** The item price must have `item_type` set to `charge`. - `quantity` (optional, integer) Item price quantity - `quantity_in_decimal` (optional, string, max chars=33) The decimal representation of the quantity of the item purchased. Can be provided for quantity-based item prices and only when [multi-decimal pricing](/docs/api/currencies) is enabled. - `unit_price` (optional, in cents) The price or per-unit-price of the item price. By default, it is the [value set](/docs/api/item_prices/item_price-object#price) for the `item_price`. This is only applicable when the `pricing_model` of the `item_price` is `flat_fee` or `per_unit`. The value depends on the [type of currency](/docs/api/currencies) . - `unit_price_in_decimal` (optional, string, max chars=39) The decimal representation of the price or per-unit price of the plan. The value is in major units of the currency. Always returned when [multi-decimal pricing](/docs/api/currencies) is enabled. - `date_from` (optional, timestamp(UTC) in seconds) The time when the service period for the item starts. - `date_to` (optional, timestamp(UTC) in seconds) The time when the service period for the item ends. - `item_tiers` (optional, array) Parameters for item\_tiers - `item_price_id` (optional, string, max chars=100) The id of the item price to which this tier belongs. - `starting_unit` (optional, integer) The lowest value in the quantity tier. - `ending_unit` (optional, integer) The highest value in the quantity tier. - `price` (optional, in cents) The per-unit price for the tier when the `pricing_model` is `tiered` or `volume`. The total cost for the item price when the `pricing_model` is `stairstep`. The value is in the minor unit of the currency. - `starting_unit_in_decimal` (optional, string, max chars=33) 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](/docs/api/currencies) is enabled. - `ending_unit_in_decimal` (optional, string, max chars=33) 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](/docs/api/currencies) is enabled. - `price_in_decimal` (optional, string, max chars=39) 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](/docs/api/currencies) is enabled. - `pricing_type` (optional, enumerated string) Pricing type for the tier. Possible enum values: - `per_unit` Indicates that the tier pricing is based on individual units. Customers are charged a fixed price per unit. For example, if the price per unit is $2 and the customer consumes 150 units, they will be charged $300 (150 × $2). - `flat_fee` Indicates that the tier pricing is a flat fee, applied to the entire tier regardless of the number of units consumed. For the **stairstep** pricing model, `pricing_type` will be set to `flat_fee` by default. For example, if the flat fee for a tier is $100, the customer pays $100 whether they consume 1 unit or the maximum number of units within that tier. - `package` Indicates that the tier pricing is based on a package of units. Customers are charged for each block or package of units. For example, if the package size is 100 units and the cost per block is $20 consuming 400 units will result in a charge of $80 (4 × $20). - `package_size` (optional, integer) 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. - `charges` (optional, array) Parameters for charges - `amount` (optional, in cents) The amount to be charged. The unit depends on the [type of currency](/docs/api/getting-started) . - `amount_in_decimal` (optional, string, max chars=39) The decimal representation of the amount for the [one-time charge](https://www.chargebee.com/docs/charges.html#one-time-charges ). Provide the value in major units of the currency. Can be provided only when [multi-decimal pricing](/docs/api/currencies) is enabled. - `description` (optional, string, max chars=250) Description for this charge - `taxable` (optional, boolean) The amount to be charged is taxable or not. - `tax_profile_id` (optional, string, max chars=50) Tax profile of the charge. - `avalara_tax_code` (optional, string, max chars=50) The Avalara tax codes to which items are mapped to should be provided here. Applicable only if you use Chargebee's [AvaTax for Sales integration](https://www.chargebee.com/docs/avalara.html) . - `hsn_code` (optional, string, max chars=50) The [HSN code](https://cbic-gst.gov.in/gst-goods-services-rates.html) to which the item is mapped for calculating the customer's tax in India. Applicable only when both of the following conditions are true: - [**India**](https://www.chargebee.com/docs/indian-gst.html#configuring-indian-gst) has been enabled as a **Tax Region**. (An error is returned when this condition is not true.) - The [**AvaTax for Sales** integration](https://www.chargebee.com/docs/avalara.html) has been enabled in Chargebee. - `taxjar_product_code` (optional, string, max chars=50) The TaxJar product codes to which items are mapped to should be provided here. Applicable only if you use Chargebee's [TaxJar integration](https://www.chargebee.com/docs/taxjar.html) . - `avalara_sale_type` (optional, enumerated string) Indicates the type of sale carried out. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html) integration. Possible enum values: - `wholesale` Transaction is a sale to another company that will resell your product or service to another consumer - `retail` Transaction is a sale to an end user - `consumed` Transaction is for an item that is consumed directly - `vendor_use` Transaction is for an item that is subject to vendor use tax - `avalara_transaction_type` (optional, integer) Indicates the type of product to be taxed. Values for this field can be taken from Avalara. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html) integration. - `avalara_service_type` (optional, integer) Indicates the type of service for the product to be taxed. Values for this field can be taken from Avalara. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html) integration. - `date_from` (optional, timestamp(UTC) in seconds) The time when the service period for the charge starts. - `date_to` (optional, timestamp(UTC) in seconds) The time when the service period for the charge ends. - `discounts` (optional, array) Parameters for discounts - `percentage` (optional, double) The percentage of the original amount that should be deducted from it. - `amount` (optional, in cents) The value of the discount. [The format of this value](/docs/api/currencies) depends on the kind of currency. - `quantity` (optional, integer) Specifies the number of free units provided for the item, without affecting the total quantity sold - `apply_on` (required, enumerated string) The amount on the invoice to which the discount is applied. Possible enum values: - `invoice_amount` The discount is applied to the invoice `sub_total` . - `specific_item_price` The discount is applied to the `invoice.line_item.amount` that corresponds to the item price specified by `item_price_id` . - `item_price_id` (optional, string, max chars=100) The [id of the item price](/docs/api/subscriptions/subscription-object#subscription_items_item_price_id) in the subscription to which the discount is to be applied. Relevant only when `apply_on` = `specific_item_price`. - `entity_identifiers` (optional, array) Parameters for entity\_identifiers - `id` (optional, string, max chars=40) The unique id for the `entity_identifier[i]` in Chargebee. This is required when `entity_identifier[operation][i]` is `update` or `delete` . - `scheme` (optional, string, max chars=50) The Peppol BIS scheme associated with the `[vat_number](/docs/api/customers/customer-object#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](https://www.chargebee.com/docs/e-invoicing.html#supported-countries) . **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[]`](/docs/api/customers/customer-object#entity_identifiers). - `value` (optional, string, max chars=50) 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[]`](/docs/api/customers/customer-object#entity_identifiers). - `operation` (optional, enumerated string) The operation to be performed for the `entity_identifier` . Possible enum values: - `create` Creates a new `entity_identifier` for the customer. - `update` Updates an existing `entity_identifier` for the customer. `entity_identifier[id]` must be provided in this case. - `delete` Deletes an existing `entity_identifier` for the customer. `entity_identifier[id]` must be provided in this case. - `standard` (optional, string, max chars=50) 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[]`](/docs/api/customers/customer-object#entity_identifiers). ## Returns - `hosted_page` (Hosted page object) Resource object representing hosted\_page