POST /estimates/create_invoice_for_items

This endpoint creates an invoice estimate for non-recurring items.

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	Yes
`discounts.percentage[]`	Array	No	The percentage of the original amount that should be deducted from it.
`discounts.amount[]`	Array	No	The value of the discount. The format of this value depends on the kind of currency.
`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`.
`authorization_transaction_id`	String	No	Authorization transaction to be captured.
`currency_code`	String	No	The currency code (ISO 4217 format) of the invoice amount.
`invoice_note`	String	No	A note for this particular invoice. This, and all other notes for the invoice are displayed on the PDF invoice sent to the customer.
`coupon_ids[]`	Array	No	List of Coupons to be added.
`item_prices`	Object	No	Parameters for item_prices
`item_prices.unit_price[]`	Array	No	The price or per-unit-price of the item price. By default, it is the value set 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.
`item_prices.date_from[]`	Array	No	The time when the service period for the item starts.
`item_prices.date_to[]`	Array	No	The time when the service period for the item ends.
`item_prices.unit_price_in_decimal[]`	Array	No	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 is enabled.
`item_prices.item_price_id[]`	Array	No	A unique ID for your system to identify the item price.
`item_prices.quantity[]`	Array	No	Item price quantity
`item_prices.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.
`invoice`	Object	No	Parameters for invoice
`invoice.customer_id`	String	No	Identifier of the customer for which this invoice needs to be created.
`invoice.po_number`	String	No	Purchase Order Number for this invoice.
`invoice.subscription_id`	String	No	Identifier of the subscription for which this invoice needs to be created. Should be specified if 'customer_id' is not specified.(not applicable for consolidated invoice)
`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 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.
`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 to which this tier belongs.
`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.
`tax_providers_fields`	Object	No	Parameters for tax_providers_fields
`tax_providers_fields.field_value[]`	Array	No	The value of the related tax field
`tax_providers_fields.field_id[]`	Array	No	Field id of the attribute which tax vendor has provided while getting onboarded with Chargebee.
`tax_providers_fields.provider_name[]`	Array	No	Name of the tax provider.
`auto_collection`	String	No	The customer level auto collection will be override if specified. * on - Whenever an invoice is created, an automatic attempt will be made to charge. * off - Whenever an invoice is created as payment due. Possible values: `"on"` `"off"`
`charges`	Object	No	Parameters for charges
`charges.description[]`	Array	No	Description for this charge
`charges.date_to[]`	Array	No	The time when the service period for the charge ends.
`charges.avalara_tax_code[]`	Array	No	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.
`charges.avalara_sale_type[]`	Array	No
`charges.avalara_service_type[]`	Array	No	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 integration.
`charges.date_from[]`	Array	No	The time when the service period for the charge starts.
`charges.amount_in_decimal[]`	Array	No	The decimal representation of the amount for the one-time charge. Provide the value in major units of the currency. Can be provided only when multi-decimal pricing is enabled.
`charges.tax_profile_id[]`	Array	No	Tax profile of the charge.
`charges.amount[]`	Array	No	The amount to be charged. The unit depends on the type of currency.
`charges.taxjar_product_code[]`	Array	No	The TaxJar product codes to which items are mapped to should be provided here. Applicable only if you use Chargebee's TaxJar integration.
`charges.taxable[]`	Array	No	The amount to be charged is taxable or not.
`charges.hsn_code[]`	Array	No	The HSN code 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 has been enabled as a Tax Region. (An error is returned when this condition is not true.) The AvaTax for Sales integration has been enabled in Chargebee.
`charges.avalara_transaction_type[]`	Array	No	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 integration.
`invoice_date`	Integer	No	The document date displayed on the invoice PDF. By default, it is the date of creation of the invoice or, when Metered Billing is enabled, it can be the date of closing the invoice. Provide this value to backdate the invoice (set the invoice date to a value in the past). Backdating an invoice is done for reasons such as booking revenue for a previous date or when the non-recurring charge is effective as of a past date. `taxes` and `line_item_taxes` are computed based on the tax configuration as of this date. The date should not be more than one calendar month into the past. For example, if today is 13th January, then you cannot pass a value that is earlier than 13th December.
`remove_general_note`	Boolean	No	Set as `true` to remove the general note from this invoice. Default value: false
`notes_to_remove`	Object	No	Parameters for notes_to_remove
`notes_to_remove.entity_id[]`	Array	No	Unique identifier of the note.
`notes_to_remove.entity_type[]`	Array	No
`payment_source_id`	String	No	Payment source to be used for this payment.
`billing_address`	Object	No	Parameters for billing_address
`billing_address.line2`	String	No	Address line 2
`billing_address.line1`	String	No	Address line 1
`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.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.
`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"

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.