POST /invoices

Note: This operation optionally supports 3DS verification flow. To achieve the same, create the Payment Intent and pass it as input parameter to this API.

Creates a one-off invoice for multiple 'Non Recurring' addon & ad-hoc charges for a customer. If the 'auto collection' has been turned 'on' for that customer then payment will be immediately collected using the payment method associated with the customer. The invoice will be generated only upon successful collection of payments. However if the 'auto collection' is turned 'off', no collection attempt will be made and the invoice generated would have a "Payment Due" status.

The Shipping Address can be passed, which will then be attached to the generated invoice.

A 'One Time' coupon can be explicitly specified while creating this invoice.

Servers

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

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-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.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.
`customer_id`	String	No	Identifier of the customer for which this invoice needs to be created. Should be specified if 'subscription_id' is not specified.
`po_number`	String	No	Purchase Order Number for this invoice.
`payment_intent`	Object	No	Parameters for payment_intent
`payment_intent.id`	String	No	Identifier for PaymentIntent generated by Chargebee.js. Applicable only when you are using Chargebee.js for completing the 3DS flow. The PaymentIntent should be in 'authorized' state while passing it here. You need not pass other PaymentIntent parameters if this is passed.
`payment_intent.gateway_account_id`	String	No	The gateway account used for performing the 3DS flow.
`payment_intent.gw_token`	String	No	Identifier for 3DS transaction/verification object at the gateway. Can be passed only after successfully completing the 3DS flow. Refer 3DS implementation in Chargebee to find out the gateway-specific gw_token format. Applicable when you are using gateway APIs directly for completing the 3DS flow.
`payment_intent.reference_id`	String	No	Identifier for Braintree permanent token. Applicable when you are using Braintree APIs for completing the 3DS flow.
`coupon`	String	No	The 'One Time' coupon to be applied.
`charges`	Object	No	Parameters for charges
`charges.description[]`	Array	No	Description for this charge
`charges.amount[]`	Array	No	The amount to be charged. The unit depends on the type of currency.
`replace_primary_payment_source`	Boolean	No	Indicates whether the primary payment source should be replaced with this payment source. In case of Create Subscription for Customer endpoint, the default value is True. Otherwise, the default value is False. Default value: false
`addons`	Object	No	Parameters for addons
`addons.id[]`	Array	No	Identifier of the addon. Multiple addons can be passed.
`addons.quantity[]`	Array	No	Quantity of the addon. Applicable for addons with `pricing_model` other than `flat_fee`.
`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).

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.