ChargebeeAPI

Create invoice for items estimate

Try in API Explorer

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

Sample Request

URL Format

POST https://[site].chargebee.com/api/v2/estimates/create_invoice_for_items

Input Parameters

currency_code
required if Multicurrency is enabled, string, max chars=3

The currency code (ISO 4217 format) of the invoice amount.

invoice_note
optional, string, max chars=2000

A note for this particular invoice. This, and all other notes for the invoice are displayed on the PDF invoice sent to the customer.

remove_general_note
optional, boolean, default=false

Set as true to remove the general note from this invoice.

coupon_ids
optional, string, max chars=100

List of Coupons to be added.

authorization_transaction_id
optional, string, max chars=40

Authorization transaction to be captured.

payment_source_id
optional, string, max chars=40

Payment source to be used for this payment.

auto_collection
optional, enumerated string

The customer level auto collection will be override if specified.

Possible Enum Values
on

Whenever an invoice is created, an automatic attempt will be made to charge.

off

Whenever an invoice is created as payment due.

invoice_date
optional, timestamp(UTC) in seconds

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.

invoice

Object of parameters for invoice

shipping_address

Object of parameters for shipping_address

billing_address

Object of parameters for billing_address

item_prices

Array containing object of parameters for item_prices

item_tiers

Array containing object of parameters for item_tiers

charges

Array containing object of parameters for charges

notes_to_remove

Array containing object of parameters for notes_to_remove

discounts

Array containing object of parameters for discounts

tax_providers_fields

Array containing object of parameters for tax_providers_fields

Returns

estimateEstimate object

Resource object representing estimate