GET /invoices

The device from which the customer has made the request

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.

The email address of your customer/user. Use this when the email address has only ASCII characters.

The IP address of the customer where the request originated

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.

optional, in cents filter

Total credits applied against this invoice. Supported operators : is, is_not, lt, lte, gt, gte, between

Example → credits_applied[lte] = "100"

optional, in cents filter

Total adjustments made against this invoice. Supported operators : is, is_not, lt, lte, gt, gte, between

Example → amount_adjusted[gte] = "100"

optional, boolean filter

Boolean indicating whether this invoice belongs to a subscription. Possible values are : true, false

Supported operators : is

Example → recurring[is] = "true"

optional, enumerated string filter

Current dunning status of the invoice. Possible values are : in_progress, exhausted, stopped, success.

Supported operators : is, is_not, in, not_in, is_present

Example → dunning_status[is] = "in_progress"

optional, enumerated string filter

Current status of this invoice. Possible values are : paid, posted, payment_due, not_paid, voided, pending.

Supported operators : is, is_not, in, not_in

Example → status[is] = "paid"

optional, timestamp(UTC) in seconds filter

Timestamp indicating the date & time this invoice got voided. Supported operators : after, before, on, between

Example → voided_at[on] = "1394532759"

optional, string filter

Payment owner of an invoice. Supported operators : is, is_not, starts_with, in, not_in

Example → payment_owner[is] = "payment_customer"

optional, enumerated string filter

The price type of the invoice. Possible values are : tax_exclusive, tax_inclusive.

Supported operators : is, is_not, in, not_in

Example → price_type[is] = "tax_exclusive"

optional, timestamp(UTC) in seconds filter

The document date displayed on the invoice PDF. Supported operators : after, before, on, between

Example → date[on] = "1394532759"

optional, timestamp(UTC) in seconds filter

Timestamp indicating the date & time this invoice got paid. Supported operators : after, before, on, between

Example → paid_at[before] = "1394532759"

If set to true, includes the deleted resources in the response. For the deleted resources in the response, the 'deleted ' attribute will be 'true '.

Default value: false

optional, in cents filter

Invoiced amount displayed in cents; that is, a decimal point is not present between the whole number and the decimal part. For example, $499.99 is displayed as 49999, and so on. Supported operators : is, is_not, lt, lte, gt, gte, between

Example → total[gt] = "1000"

optional, timestamp(UTC) in seconds filter

To filter based on updated_at. This attribute will be present only if the resource has been updated after 2016-09-28. It is advisable when using this filter, to pass the sort_by input parameter as updated_at for a faster response. Supported operators : after, before, on, between

Example → updated_at[after] = "1243545465"

optional, string filter

The invoice number. Acts as a identifier for invoice and typically generated sequentially. Supported operators : is, is_not, starts_with, in, not_in

Example → id[is] = "INVOICE_654"

optional, string filter

The identifier of the customer this invoice belongs to. Supported operators : is, is_not, starts_with, in, not_in

Example → customer_id[is] = "3bdjnDnsdQn"

Parameters for einvoice

The number of resources to be returned.

Default value: 10

optional, enumerated string filter

The subscription channel this object originated from and is maintained in. Possible values are : web, app_store, play_store.

Supported operators : is, is_not, in, not_in

Example → channel[is] = "APP STORE"

optional, in cents filter

The unpaid amount that is due on the invoice. This is calculated as: total

• amount_paid
• sum of applied_credits.applied_amount
• sum of adjustment_credit_notes.cn_total
• sum of linked_taxes_withheld.amount. Supported operators : is, is_not, lt, lte, gt, gte, between

Example → amount_due[lt] = "200"

optional, string filter

Reason code for voiding the invoice. Select from a list of reason codes set in the Chargebee app in Settings > Configure Chargebee > Reason Codes > Invoices > Void invoice . Must be passed if set as mandatory in the app. The codes are case-sensitive. Supported operators : is, is_not, starts_with, in, not_in

Example → void_reason_code[is_not] = "Other"

optional, in cents filter

Payments collected successfully for the invoice. This is the sum of linked_payments[].txn_amount for all linked_payments[] that have txn_status as success. Supported operators : is, is_not, lt, lte, gt, gte, between

Example → amount_paid[lt] = "800"

optional, string filter

Sorts based on the specified attribute. Supported attributes : date, updated_at

Supported sort-orders : asc, desc

Example → sort_by[asc] = "date"

This will sort the result based on the 'date' attribute in ascending(earliest first) order.

Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset to the value of next_offset obtained in the previous iteration of the API call.

optional, string filter

To filter based on subscription_id. NOTE: Not to be used if consolidated invoicing is enabled. Supported operators : is, is_not, starts_with, is_present, in, not_in

Example → subscription_id[is] = "3bdjnDnsdQn"