List Invoices

The number of resources to be returned.

Default 10

<p class="mb-2">Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">offset</code> to the value of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">next_offset</code> obtained in the previous iteration of the API call.</p>

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 false

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 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"*

One oftruefalse

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"*

optional, boolean filter Boolean indicating whether this invoice belongs to a subscription. Possible values are : *true, false* **Supported operators :** is **Example →** *recurring\[is\] = "true"*

One oftruefalse

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"*

* `paid` - Indicates a paid invoice. * `posted` - Indicates the payment is not yet collected and will be in this state till the due date to indicate the due period * `payment_due` - Indicates the payment is not yet collected and is being retried as per retry settings. * `not_paid` - Indicates the payment is not made and all attempts to collect is failed. * `voided` - Indicates a voided invoice. * `pending` - <div prod_cat_ver=2>The <a href="/docs/api/invoices?prod_cat_ver=2#invoice_status">invoice</a> is yet to be closed (sent for payment collection). An invoice is generated with this <code>status</code> when it has line items that belong to items that are <code>metered</code> or when the <code>subscription.create_pending_invoices</code>attribute is set to <code>true</code>.</div><div prod_cat_ver=1>The <a href="/docs/api/invoices?prod_cat_ver=1#invoice_status">invoice</a> is yet to be closed (sent for payment collection). All invoices are generated with this <code>status</code> when <a href="https://www.chargebee.com/docs/1.0/metered_billing.html" target="_blank" rel="noreferrer noopener">Metered Billing</a> is enabled for the site.</div>

One ofpaidpostedpayment_duenot_paidvoidedpending

* `paid` - Indicates a paid invoice. * `posted` - Indicates the payment is not yet collected and will be in this state till the due date to indicate the due period * `payment_due` - Indicates the payment is not yet collected and is being retried as per retry settings. * `not_paid` - Indicates the payment is not made and all attempts to collect is failed. * `voided` - Indicates a voided invoice. * `pending` - <div prod_cat_ver=2>The <a href="/docs/api/invoices?prod_cat_ver=2#invoice_status">invoice</a> is yet to be closed (sent for payment collection). An invoice is generated with this <code>status</code> when it has line items that belong to items that are <code>metered</code> or when the <code>subscription.create_pending_invoices</code>attribute is set to <code>true</code>.</div><div prod_cat_ver=1>The <a href="/docs/api/invoices?prod_cat_ver=1#invoice_status">invoice</a> is yet to be closed (sent for payment collection). All invoices are generated with this <code>status</code> when <a href="https://www.chargebee.com/docs/1.0/metered_billing.html" target="_blank" rel="noreferrer noopener">Metered Billing</a> is enabled for the site.</div>

One ofpaidpostedpayment_duenot_paidvoidedpending

* `paid` - Indicates a paid invoice. * `posted` - Indicates the payment is not yet collected and will be in this state till the due date to indicate the due period * `payment_due` - Indicates the payment is not yet collected and is being retried as per retry settings. * `not_paid` - Indicates the payment is not made and all attempts to collect is failed. * `voided` - Indicates a voided invoice. * `pending` - <div prod_cat_ver=2>The <a href="/docs/api/invoices?prod_cat_ver=2#invoice_status">invoice</a> is yet to be closed (sent for payment collection). An invoice is generated with this <code>status</code> when it has line items that belong to items that are <code>metered</code> or when the <code>subscription.create_pending_invoices</code>attribute is set to <code>true</code>.</div><div prod_cat_ver=1>The <a href="/docs/api/invoices?prod_cat_ver=1#invoice_status">invoice</a> is yet to be closed (sent for payment collection). All invoices are generated with this <code>status</code> when <a href="https://www.chargebee.com/docs/1.0/metered_billing.html" target="_blank" rel="noreferrer noopener">Metered Billing</a> is enabled for the site.</div>

One ofpaidpostedpayment_duenot_paidvoidedpending

* `paid` - Indicates a paid invoice. * `posted` - Indicates the payment is not yet collected and will be in this state till the due date to indicate the due period * `payment_due` - Indicates the payment is not yet collected and is being retried as per retry settings. * `not_paid` - Indicates the payment is not made and all attempts to collect is failed. * `voided` - Indicates a voided invoice. * `pending` - <div prod_cat_ver=2>The <a href="/docs/api/invoices?prod_cat_ver=2#invoice_status">invoice</a> is yet to be closed (sent for payment collection). An invoice is generated with this <code>status</code> when it has line items that belong to items that are <code>metered</code> or when the <code>subscription.create_pending_invoices</code>attribute is set to <code>true</code>.</div><div prod_cat_ver=1>The <a href="/docs/api/invoices?prod_cat_ver=1#invoice_status">invoice</a> is yet to be closed (sent for payment collection). All invoices are generated with this <code>status</code> when <a href="https://www.chargebee.com/docs/1.0/metered_billing.html" target="_blank" rel="noreferrer noopener">Metered Billing</a> is enabled for the site.</div>

One ofpaidpostedpayment_duenot_paidvoidedpending

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"*

\* \`tax_exclusive\` - All amounts in the document are exclusive of tax. \* \`tax_inclusive\` - All amounts in the document are inclusive of tax.

One oftax_exclusivetax_inclusive

\* \`tax_exclusive\` - All amounts in the document are exclusive of tax. \* \`tax_inclusive\` - All amounts in the document are inclusive of tax.

One oftax_exclusivetax_inclusive

\* \`tax_exclusive\` - All amounts in the document are exclusive of tax. \* \`tax_inclusive\` - All amounts in the document are inclusive of tax.

One oftax_exclusivetax_inclusive

\* \`tax_exclusive\` - All amounts in the document are exclusive of tax. \* \`tax_inclusive\` - All amounts in the document are inclusive of tax.

One oftax_exclusivetax_inclusive

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"*

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"*

<dfn class="text-muted"><p class="mb-2">optional, in cents filter</p></dfn> <p class="mb-2">Payments collected successfully for the invoice. This is the sum of <code><a href="/docs/api/invoices/invoice-object#linked_payments">linked_payments[]</a>.txn_amount</code> for all <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">linked_payments[]</code> that have <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">txn_status</code> as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">success</code>. <strong class="font-semibold">Supported operators :</strong> is, is_not, lt, lte, gt, gte, between</p> <p class="mb-2"><strong class="font-semibold">Example →</strong> <em class="italic">amount_paid[lt] = &quot;800&quot;</em></p>

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, in cents filter Total credits applied against this invoice. **Supported operators :** is, is_not, lt, lte, gt, gte, between **Example →** *credits_applied\[lte\] = "100"*

<dfn class="text-muted"><p class="mb-2">optional, in cents filter</p></dfn> <p class="mb-2">The unpaid amount that is due on the invoice. This is calculated as: <code><a href="/docs/api/invoices/invoice-object#total">total</a></code></p> <ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed"> <code><a href="/docs/api/invoices/invoice-object#amount_paid">amount_paid</a></code> </li> <li class="text-base leading-relaxed">sum of <code><a href="/docs/api/invoices/invoice-object#applied_credits">applied_credits</a>.applied_amount</code></li> <li class="text-base leading-relaxed">sum of <code><a href="/docs/api/invoices/invoice-object#adjustment_credit_notes">adjustment_credit_notes</a>.cn_total</code></li> <li class="text-base leading-relaxed">sum of <code><a href="/docs/api/invoices/invoice-object#linked_taxes_withheld">linked_taxes_withheld</a>.amount</code>. <strong class="font-semibold">Supported operators :</strong> is, is_not, lt, lte, gt, gte, between</li> </ul> <p class="mb-2"><strong class="font-semibold">Example →</strong> <em class="italic">amount_due[lt] = &quot;200&quot;</em></p>

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"*

\* \`in_progress\` - Dunning is still in progress. \* \`exhausted\` - Maximum number of attempts have been made. \* \`stopped\` - Dunning has stopped for this invoice. \* \`success\` - Payment successfully collected during dunning process.

One ofin_progressexhaustedstoppedsuccess

\* \`in_progress\` - Dunning is still in progress. \* \`exhausted\` - Maximum number of attempts have been made. \* \`stopped\` - Dunning has stopped for this invoice. \* \`success\` - Payment successfully collected during dunning process.

One ofin_progressexhaustedstoppedsuccess

\* \`in_progress\` - Dunning is still in progress. \* \`exhausted\` - Maximum number of attempts have been made. \* \`stopped\` - Dunning has stopped for this invoice. \* \`success\` - Payment successfully collected during dunning process.

One ofin_progressexhaustedstoppedsuccess

\* \`in_progress\` - Dunning is still in progress. \* \`exhausted\` - Maximum number of attempts have been made. \* \`stopped\` - Dunning has stopped for this invoice. \* \`success\` - Payment successfully collected during dunning process.

One ofin_progressexhaustedstoppedsuccess

One oftruefalse

optional, string filter Payment owner of an invoice. **Supported operators :** is, is_not, starts_with, in, not_in **Example →** *payment_owner\[is\] = "payment_customer"*

<dfn class="text-muted"><p class="mb-2">optional, timestamp(UTC) in seconds filter</p></dfn> <p class="mb-2">To filter based on <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">updated_at</code>. 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 <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">sort_by</code> input parameter as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">updated_at</code> for a faster response. <strong class="font-semibold">Supported operators :</strong> after, before, on, between</p> <p class="mb-2"><strong class="font-semibold">Example →</strong> <em class="italic">updated_at[after] = &quot;1243545465&quot;</em></p>

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"*

\* \`web\` - The object was created (and is maintained) for the web channel directly in Chargebee via API or UI. \* \`app_store\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Apple App Store. Direct manipulation of this object via UI or API is disallowed. \* \`play_store\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Google Play Store. Direct manipulation of this object via UI or API is disallowed. In-App Subscriptions is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com) for more information.

One ofwebapp_storeplay_store

\* \`web\` - The object was created (and is maintained) for the web channel directly in Chargebee via API or UI. \* \`app_store\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Apple App Store. Direct manipulation of this object via UI or API is disallowed. \* \`play_store\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Google Play Store. Direct manipulation of this object via UI or API is disallowed. In-App Subscriptions is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com) for more information.

One ofwebapp_storeplay_store

\* \`web\` - The object was created (and is maintained) for the web channel directly in Chargebee via API or UI. \* \`app_store\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Apple App Store. Direct manipulation of this object via UI or API is disallowed. \* \`play_store\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Google Play Store. Direct manipulation of this object via UI or API is disallowed. In-App Subscriptions is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com) for more information.

One ofwebapp_storeplay_store

\* \`web\` - The object was created (and is maintained) for the web channel directly in Chargebee via API or UI. \* \`app_store\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Apple App Store. Direct manipulation of this object via UI or API is disallowed. \* \`play_store\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Google Play Store. Direct manipulation of this object via UI or API is disallowed. In-App Subscriptions is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com) for more information.

One ofwebapp_storeplay_store

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 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, 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.

One ofdateupdated_at

One ofdateupdated_at

Parameters for einvoice

<p class="mb-2">The status of processing the e-invoice. To obtain detailed information about the current <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code> , see <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">message</code> .</p>

The device from which the customer has made the request

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

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.

The IP address of the customer where the request originated

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.

<div class="api-description"><p class="mb-2">An invoice is a commercial document representing a sale of products/services offered by you to a customer. It enumerates all the charges, adjustments, payments, discounts and taxes associated with the sale.</p><p class="mb-2">An invoice is said to be a recurring one when it is has at least one charge for <a href="/docs/api/items">a plan or an addon item price</a>. It is a non-recurring one when it has charges for only charge-item prices or <a href="https://www.chargebee.com/docs/2.0/charges.html" target="_blank">one-time charges</a>.</p><p class="mb-2">The item prices for any given billing term of a subscription are billed via an invoice at the beginning of the term (unless the charges are left unbilled). However, item prices that belong to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">metered</code> items are billed at the end of the term via a <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pending</code> invoice that can <a href="https://www.chargebee.com/docs/billing/2.0/usage-based-billing/metered_billing#configuring-metered-billing" target="_blank">close automatically</a> or via <a href="/docs/api/invoices/close-a-pending-invoice">an API call</a>. Moreover, when there are no <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">metered</code> items in the subscription, the invoices can still be generated as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">pending</code> while <a href="/docs/api/subscriptions/create-subscription-for-items">creating</a> or <a href="/docs/api/subscriptions/update-subscription-for-items">updating</a> a subscription.</p><h4>Auto-collection</h4><p class="mb-2">If <a href="https://www.chargebee.com/docs/2.0/customers.html#auto-collection-status" target="_blank">auto-collection</a> is enabled, then immediately on invoice generation (or, in case of subscriptions that have <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">create_pending_invoices</code> as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>, on <a href="/docs/api/invoices/close-a-pending-invoice">invoice closure</a>), the <a href="/docs/api/customers/customer-object#payment_method">payment method</a> on file is charged:</p><ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed">If the payment succeeds, the invoice is marked as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">paid</code>.</li> <li class="text-base leading-relaxed">On payment failure, the invoice is marked as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payment_due</code> and <a href="https://www.chargebee.com/docs/2.0/dunning-v2.html" target="_blank">dunning settings</a> are taken into account for payment retries.</li> <li class="text-base leading-relaxed">If no retry attempts are configured, or when retries are exhausted, the invoice is marked as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">not_paid</code>.</li> <li class="text-base leading-relaxed">the amount due is zero or negative, the invoice is immediately marked as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">paid</code> and the balance, if any, is added to <a href="https://www.chargebee.com/docs/2.0/customers.html#excess-payments" target="_blank">excess payments</a> for the customer.</li> </ul><div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note:</strong> If <a href="https://www.chargebee.com/docs/2.0/consolidated-invoicing.html" target="_blank">consolidated invoicing</a> is enabled, the attribute <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">subscription_id</code> is unavailable when the invoice has line items from multiple subscriptions. The individual subscription ids are seen under <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_items.subscription_id</code>.</p></div><div id="recurring-invoice" class="cb-accordion"><div class="cb-accordion-title collapsed" data-toggle="collapse" data-target="#recurring-invoice-content" aria-expanded="false" aria-controls="recurring-invoice-content"><h4>Recurring and non-recurring invoices</h4><i class="fa fa-chevron-circle-down fa-lg" aria-hidden="true"></i></div><div class="collapse" id="recurring-invoice-content"><p class="mb-2">A recurring invoice contains at least one line item that is billed on a recurring basis. Specifically, it has at least one <a href="/docs/api/invoices/invoice-object#line_items" class="text-blue-600 hover:text-blue-800 underline"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_items[]</code></a> with <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_type</code> set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">plan_item_price</code> or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">addon_item_price</code>. A non-recurring invoice contains no recurring line items.</p></div></div><div id="refundable-amount" class="cb-accordion"><div class="cb-accordion-title collapsed" data-toggle="collapse" data-target="#refundable-amount-content" aria-expanded="false" aria-controls="refundable-amount-content"><h4>Refundable amount for an invoice</h4><i class="fa fa-chevron-circle-down fa-lg" aria-hidden="true"></i></div><div class="collapse" id="refundable-amount-content"><p class="mb-2">The refundable amount for an invoice is the (amount paid on the invoice + refundable credit applied on the invoice + taxes withheld on the invoice) minus (amount issued as refundable credit notes from the invoice). Each of these amounts is obtained from the invoice resource as follows:</p><ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed">Amount paid on the invoice: <a href="/docs/api/invoices/invoice-object#invoice_amount_paid" class="text-blue-600 hover:text-blue-800 underline"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">amount_paid</code></a></li> <li class="text-base leading-relaxed">Refundable credit applied on the invoice: <a href="/docs/api/invoices/invoice-object#invoice_credits_applied" class="text-blue-600 hover:text-blue-800 underline"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">credits_applied</code></a></li> <li class="text-base leading-relaxed">Taxes withheld on the invoice: Sum of <a href="/docs/api/invoices/invoice-object#invoice_linked_taxes_withheld" class="text-blue-600 hover:text-blue-800 underline"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">linked_taxes_withheld[].amount</code></a></li> <li class="text-base leading-relaxed">Amount issued as refundable credit notes from the invoice: Sum of <a href="/docs/api/invoices/invoice-object#invoice_issued_credit_notes" class="text-blue-600 hover:text-blue-800 underline"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">issued_credit_notes[i].cn_total</code></a> where <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">issued_credit_notes[i].cn_status</code> is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">refunded</code> or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">refund_due</code>.</li> </ul></div></div></div>

<p class="mb-2">This attribute is returned only if more resources are present. To fetch the next set of resources use this value for the input parameter <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">offset</code>.</p>