List invoices

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"

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

Example → customer_id[is] = "3bdjnDnsdQn"

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

Supported operators : is

Example → recurring[is] = "true"

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"

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"

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

Example → date[on] = "1394532759"

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

Example → paid_at[before] = "1394532759"

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"

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"

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

Example → amount_adjusted[gte] = "100"

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

Example → credits_applied[lte] = "100"

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"

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"

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

Example → payment_owner[is] = "payment_customer"

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"

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"

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

Example → voided_at[on] = "1394532759"

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"