ChargebeeAPI

Create invoice for items and one-time charges

Idempotency Supported
Try in API Explorer

Creates an invoice for charge-items and one-time charges. The item prices must belong to items of type charge.

One-time charges are represented in an invoice as line_items with entity_type adhoc.

Sample Request

URL Format

POST https://[site].chargebee.com/api/v2/invoices/create_for_charge_items_and_charges

Input Parameters

customer_id
optional, string, max chars=50

Unique ID of the customer this invoice should be created for. Either this or subscription_id must be provided.

Note

The invoice is linked to the same business entity as this customer.

subscription_id
optional, string, max chars=50

Unique ID of the subscription this invoice should be created for. Either this or customer_id must be provided.

Note

The invoice is linked to the same business entity as this subscription.

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.

po_number
optional, string, max chars=100

Purchase Order Number for this invoice.

coupon_ids
optional, string

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

If specified, the customer level auto collection will be overridden.

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.

token_id
optional, string, max chars=40

Token generated by Chargebee JS representing payment method details.

replace_primary_payment_source
optional, boolean, default=false

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.

retain_payment_source
optional, boolean, default=true

Indicates whether the payment source should be retained for the customer.

payment_initiator
optional, enumerated string

The type of initiator to be used for the payment request triggered by this operation.

Possible Enum Values
customer

Pass this value to indicate that the request is initiated by the customer

merchant

Pass this value to indicate that the request is initiated by the merchant

shipping_address
optional, string

Parameters for shipping_address

statement_descriptor
optional, string

Parameters for statement_descriptor

card
optional, string

Parameters for card

bank_account
optional, string

Parameters for bank_account

payment_method
optional, enumerated string

Parameters for payment_method

payment_intent
optional, string

Parameters for payment_intent

item_prices
optional, string

Parameters for item_prices

item_tiers
optional, string

Parameters for item_tiers

charges
optional, in cents

Parameters for charges

notes_to_remove
optional, enumerated string

Parameters for notes_to_remove

tax_providers_fields
optional, string

Parameters for tax_providers_fields

discounts
optional, double

Parameters for discounts

Returns

invoiceInvoice object

Resource object representing invoice