younifyd
Menu

List Credit Notes

List credit notes

GET/credit_notes

Use it in a workflow

  1. Add a step and choose the Chargebee connector.
  2. Pick the List Credit Notes action (under Chargebee API).
  3. Fill in the fields below, then reference the result from later steps as {{listCreditNotes.response.data}}.

Request

Query parameters

limitinteger (int32)

The number of resources to be returned.

Default 10

offsetstring

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

include_deletedboolean

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

idobject

optional, string filter Credit-note id. **Supported operators :** is, is_not, starts_with, in, not_in **Example →** *id\[is\] = "CN_123"*

isstring
is_notstring
starts_withstring
instring
not_instring
customer_idobject

optional, string filter The identifier of the customer this Credit Note belongs to. **Supported operators :** is, is_not, starts_with, in, not_in **Example →** *customer_id\[is\] = "4gmiXbsjdm"*

isstring
is_notstring
starts_withstring
instring
not_instring
subscription_idobject

optional, string filter To filter based on subscription_id. NOTE: Not to be used if *consolidated invoicing* feature is enabled. **Supported operators :** is, is_not, starts_with, is_present, in, not_in **Example →** *subscription_id\[is\] = "4gmiXbsjdm"*

isstring
is_notstring
starts_withstring
is_presentstring (boolean)

One oftruefalse

instring
not_instring
reference_invoice_idobject

optional, string filter The identifier of the invoice against which this Credit Note is issued. **Supported operators :** is, is_not, starts_with, in, not_in **Example →** *reference_invoice_id\[is\] = "INVOICE_876"*

isstring
is_notstring
starts_withstring
is_presentstring (boolean)

One oftruefalse

instring
not_instring
typeobject

optional, enumerated string filter The credit note type. Possible values are : adjustment, refundable. **Supported operators :** is, is_not, in, not_in **Example →** *type\[is_not\] = "adjustment"*

isstring

\* \`adjustment\` - Adjustment Credit Note \* \`refundable\` - Refundable Credit Note \* \`store\` - Store Credit Note

One ofadjustmentrefundablestore

is_notstring

\* \`adjustment\` - Adjustment Credit Note \* \`refundable\` - Refundable Credit Note \* \`store\` - Store Credit Note

One ofadjustmentrefundablestore

instring

\* \`adjustment\` - Adjustment Credit Note \* \`refundable\` - Refundable Credit Note \* \`store\` - Store Credit Note

One ofadjustmentrefundablestore

not_instring

\* \`adjustment\` - Adjustment Credit Note \* \`refundable\` - Refundable Credit Note \* \`store\` - Store Credit Note

One ofadjustmentrefundablestore

reason_codeobject

optional, enumerated string filter The reason for issuing this Credit Note. The following reason codes are supported now\[Deprecated; use the [create_reason_code](/docs/api/credit_notes/credit_note-object#create_reason_code) parameter instead\]. Possible values are : write_off, subscription_change, subscription_cancellation, subscription_pause, chargeback, product_unsatisfactory, service_unsatisfactory, order_change, order_cancellation, waiver, other, fraudulent. **Supported operators :** is, is_not, in, not_in **Example →** *reason_code\[is\] = "waiver"*

isstring

\* \`write_off\` - This reason will be set automatically for the Credit Notes created during invoice [Write Off](https://www.chargebee.com/docs/invoice-operations.html#write-off) operation. \* \`subscription_change\` - This reason will be set automatically for Credit Notes created during Change Subscription operation when [proration](https://www.chargebee.com/docs/proration.html) is enabled \* \`subscription_cancellation\` - This reason will be set automatically for Credit Notes created during cancel subscription operation \* \`subscription_pause\` - This reason will be automatically set to credit notes created during pause/resume subscription operation. \* \`chargeback\` - Can be set when you are recording your customer Chargebacks \* \`product_unsatisfactory\` - Product Unsatisfactory \* \`service_unsatisfactory\` - Service Unsatisfactory \* \`order_change\` - Order Change \* \`order_cancellation\` - Order Cancellation \* \`waiver\` - Waiver \* \`other\` - Can be set when none of the above reason codes are applicable \* \`fraudulent\` - FRAUDULENT

One ofwrite_offsubscription_changesubscription_cancellationsubscription_pausechargebackproduct_unsatisfactoryservice_unsatisfactoryorder_changeorder_cancellationwaiverotherfraudulent

is_notstring

\* \`write_off\` - This reason will be set automatically for the Credit Notes created during invoice [Write Off](https://www.chargebee.com/docs/invoice-operations.html#write-off) operation. \* \`subscription_change\` - This reason will be set automatically for Credit Notes created during Change Subscription operation when [proration](https://www.chargebee.com/docs/proration.html) is enabled \* \`subscription_cancellation\` - This reason will be set automatically for Credit Notes created during cancel subscription operation \* \`subscription_pause\` - This reason will be automatically set to credit notes created during pause/resume subscription operation. \* \`chargeback\` - Can be set when you are recording your customer Chargebacks \* \`product_unsatisfactory\` - Product Unsatisfactory \* \`service_unsatisfactory\` - Service Unsatisfactory \* \`order_change\` - Order Change \* \`order_cancellation\` - Order Cancellation \* \`waiver\` - Waiver \* \`other\` - Can be set when none of the above reason codes are applicable \* \`fraudulent\` - FRAUDULENT

One ofwrite_offsubscription_changesubscription_cancellationsubscription_pausechargebackproduct_unsatisfactoryservice_unsatisfactoryorder_changeorder_cancellationwaiverotherfraudulent

instring

\* \`write_off\` - This reason will be set automatically for the Credit Notes created during invoice [Write Off](https://www.chargebee.com/docs/invoice-operations.html#write-off) operation. \* \`subscription_change\` - This reason will be set automatically for Credit Notes created during Change Subscription operation when [proration](https://www.chargebee.com/docs/proration.html) is enabled \* \`subscription_cancellation\` - This reason will be set automatically for Credit Notes created during cancel subscription operation \* \`subscription_pause\` - This reason will be automatically set to credit notes created during pause/resume subscription operation. \* \`chargeback\` - Can be set when you are recording your customer Chargebacks \* \`product_unsatisfactory\` - Product Unsatisfactory \* \`service_unsatisfactory\` - Service Unsatisfactory \* \`order_change\` - Order Change \* \`order_cancellation\` - Order Cancellation \* \`waiver\` - Waiver \* \`other\` - Can be set when none of the above reason codes are applicable \* \`fraudulent\` - FRAUDULENT

One ofwrite_offsubscription_changesubscription_cancellationsubscription_pausechargebackproduct_unsatisfactoryservice_unsatisfactoryorder_changeorder_cancellationwaiverotherfraudulent

not_instring

\* \`write_off\` - This reason will be set automatically for the Credit Notes created during invoice [Write Off](https://www.chargebee.com/docs/invoice-operations.html#write-off) operation. \* \`subscription_change\` - This reason will be set automatically for Credit Notes created during Change Subscription operation when [proration](https://www.chargebee.com/docs/proration.html) is enabled \* \`subscription_cancellation\` - This reason will be set automatically for Credit Notes created during cancel subscription operation \* \`subscription_pause\` - This reason will be automatically set to credit notes created during pause/resume subscription operation. \* \`chargeback\` - Can be set when you are recording your customer Chargebacks \* \`product_unsatisfactory\` - Product Unsatisfactory \* \`service_unsatisfactory\` - Service Unsatisfactory \* \`order_change\` - Order Change \* \`order_cancellation\` - Order Cancellation \* \`waiver\` - Waiver \* \`other\` - Can be set when none of the above reason codes are applicable \* \`fraudulent\` - FRAUDULENT

One ofwrite_offsubscription_changesubscription_cancellationsubscription_pausechargebackproduct_unsatisfactoryservice_unsatisfactoryorder_changeorder_cancellationwaiverotherfraudulent

create_reason_codeobject

optional, string filter Reason code for creating the credit note. Must be one from a list of reason codes set in the Chargebee app in **Settings \> Configure Chargebee \> Reason Codes \> Credit Notes \> Create Credit Note** . 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 →** *create_reason_code\[is\] = "Other"*

isstring
is_notstring
starts_withstring
instring
not_instring
statusobject

optional, enumerated string filter The credit note status. Possible values are : adjusted, refunded, refund_due, voided. **Supported operators :** is, is_not, in, not_in **Example →** *status\[is\] = "adjusted"*

isstring

\* \`adjusted\` - When the Credit Note has been adjusted against an invoice. \* \`refunded\` - When the entire credits (Credit Note amount) have been used (i.e either allocated to invoices or refunded). \* \`refund_due\` - When the credits are yet to be used, or have been partially used. \* \`voided\` - When the Credit Note has been cancelled.

One ofadjustedrefundedrefund_duevoided

is_notstring

\* \`adjusted\` - When the Credit Note has been adjusted against an invoice. \* \`refunded\` - When the entire credits (Credit Note amount) have been used (i.e either allocated to invoices or refunded). \* \`refund_due\` - When the credits are yet to be used, or have been partially used. \* \`voided\` - When the Credit Note has been cancelled.

One ofadjustedrefundedrefund_duevoided

instring

\* \`adjusted\` - When the Credit Note has been adjusted against an invoice. \* \`refunded\` - When the entire credits (Credit Note amount) have been used (i.e either allocated to invoices or refunded). \* \`refund_due\` - When the credits are yet to be used, or have been partially used. \* \`voided\` - When the Credit Note has been cancelled.

One ofadjustedrefundedrefund_duevoided

not_instring

\* \`adjusted\` - When the Credit Note has been adjusted against an invoice. \* \`refunded\` - When the entire credits (Credit Note amount) have been used (i.e either allocated to invoices or refunded). \* \`refund_due\` - When the credits are yet to be used, or have been partially used. \* \`voided\` - When the Credit Note has been cancelled.

One ofadjustedrefundedrefund_duevoided

dateobject

optional, timestamp(UTC) in seconds filter The date the Credit Note is issued. **Supported operators :** after, before, on, between **Example →** *date\[on\] = "1435054328"*

afterstring (unix-time)
beforestring (unix-time)
onstring (unix-time)
betweenstring
totalobject

optional, in cents filter Credit Note amount in cents. **Supported operators :** is, is_not, lt, lte, gt, gte, between **Example →** *total\[is\] = "1200"*

isstring (number)
is_notstring (number)
ltstring (number)
ltestring (number)
gtstring (number)
gtestring (number)
betweenstring
price_typeobject

optional, enumerated string filter The price type of the Credit Note. Possible values are : tax_exclusive, tax_inclusive. **Supported operators :** is, is_not, in, not_in **Example →** *price_type\[is_not\] = "tax_exclusive"*

isstring

\* \`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

is_notstring

\* \`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

instring

\* \`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

not_instring

\* \`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

amount_allocatedobject

optional, in cents filter The amount allocated to the invoices. **Supported operators :** is, is_not, lt, lte, gt, gte, between **Example →** *amount_allocated\[is\] = "1200"*

isstring (number)
is_notstring (number)
ltstring (number)
ltestring (number)
gtstring (number)
gtestring (number)
betweenstring
amount_refundedobject

optional, in cents filter The refunds issued from this Credit Note. **Supported operators :** is, is_not, lt, lte, gt, gte, between **Example →** *amount_refunded\[lte\] = "130"*

isstring (number)
is_notstring (number)
ltstring (number)
ltestring (number)
gtstring (number)
gtestring (number)
betweenstring
amount_availableobject

optional, in cents filter The yet to be used credits of this Credit Note. **Supported operators :** is, is_not, lt, lte, gt, gte, between **Example →** *amount_available\[gt\] = "1400"*

isstring (number)
is_notstring (number)
ltstring (number)
ltestring (number)
gtstring (number)
gtestring (number)
betweenstring
voided_atobject

optional, timestamp(UTC) in seconds filter Timestamp indicating the date and time this Credit Note gets voided. **Supported operators :** after, before, on, between **Example →** *voided_at\[before\] = "1435054328"*

afterstring (unix-time)
beforestring (unix-time)
onstring (unix-time)
betweenstring
updated_atobject

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. **Supported operators :** after, before, on, between **Example →** *updated_at\[on\] = "1243545465"*

afterstring (unix-time)
beforestring (unix-time)
onstring (unix-time)
betweenstring
sort_byobject

optional, string filter Sorts based on the specified attribute. **Supported attributes :** date **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.

ascstring

One ofdate

descstring

One ofdate

channelobject

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

isstring

\* \`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

is_notstring

\* \`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

instring

\* \`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

not_instring

\* \`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

einvoiceobject

Parameters for einvoice

statusobject4 fields

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

Headers

chargebee-request-origin-devicestring

The device from which the customer has made the request

chargebee-request-origin-userstring (email)

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

chargebee-request-origin-user-encodedstring (email)

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.

chargebee-request-origin-ipstring

The IP address of the customer where the request originated

chargebee-business-entity-idstring

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.

Response

Returns 200 with an object. Read it in later steps with {{listCreditNotes.response.data.<field>}}.

listarray<object>
credit_noteobjectrequired40 fields

<div class="api-description"><p class="mb-2">A <a href="https://www.chargebee.com/docs/credit-notes.html" target="_blank">Credit Note</a> is a document that specifies the money owed by a business to its customer. The seller usually issues a Credit Note for the same or lower amount than the invoice, and then repays the money to the customer or set it off against other &#x27;due&#x27; invoices.</p><h3>Credit Note Types</h3><p class="mb-2">Credit notes in Chargebee are categorized into three types: 1. <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">adjustment</code>: Adjustment credit notes are used to adjust the amount of an existing invoice in 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">payment_due</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">not_paid</code> <a href="/docs/api/invoices/invoice-object#status">status</a>. Use this type of credit note to reduce the invoice amount, typically as a discount to the customer. Adjustment credit notes are automatically created in the following cases:</p><ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed">When an invoice is written off.</li> <li class="text-base leading-relaxed">When a subscription is modified with proration enabled, and the invoice for the current term is in 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">payment_due</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">not_paid</code> <a href="/docs/api/invoices/invoice-object#status">status</a>. 2. <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">refundable</code>: Refundable credit notes allow you to return a certain amount to the customer. These credits can be:</li> <li class="text-base leading-relaxed">Retained for automatic application on future invoices.</li> <li class="text-base leading-relaxed">Applied to existing unpaid invoices.</li> <li class="text-base leading-relaxed">Refunded to the customer. Refundable credit notes are automatically created in the following cases:</li> <li class="text-base leading-relaxed">When an invoice is refunded.</li> <li class="text-base leading-relaxed">When a subscription is changed or canceled with proration enabled, the invoice for the current term is in 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">paid</code> <a href="/docs/api/invoices/invoice-object#status">status</a>. Refundable credits are applied to future invoices or can be refunded to the original payment method. 3. <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">store</code>: Store credit notes are created for <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> 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">partially_paid</code> invoice <a href="/docs/api/invoices/invoice-object#status">status</a> during subscription changes, such as upgrades, downgrades, or cancellations. Key characteristics of store credits:</li> <li class="text-base leading-relaxed">No tax component is included at the time of creation.</li> <li class="text-base leading-relaxed">A credit note document is generated, similar to refundable credits.</li> <li class="text-base leading-relaxed">Store credits are applied before tax calculations on future invoices.</li> </ul><div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note:</strong> If you have enabled <em class="italic">consolidated invoicing</em> , to know the subscriptions attached with a credit note you have to refer <a href="/docs/api/credit_notes/credit_note-object#line_items">line_item&#x27;s</a> <em class="italic">subscription_id</em> . The credit note&#x27;s <em class="italic">subscription_id</em> should <strong class="font-semibold">not</strong> be used (which will be <em class="italic">null</em> if the credit note has lines from multiple subscriptions).</p></div><div id="ref-invoice-impact" class="cb-accordion"><div class="cb-accordion-title collapsed" data-toggle="collapse" data-target="#ref-invoice-impact-content" aria-expanded="false" aria-controls="ref-invoice-impact-content"><p class="mb-2">Impact on reference invoice</p><i class="fa fa-chevron-circle-down fa-lg" aria-hidden="true"></i></div><div class="collapse" id="ref-invoice-impact-content"><p class="mb-2">The following updates are made to the reference invoice when a credit note is created/imported:</p><ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed">If the credit note <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">type</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">adjustment</code>: <ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed">The adjustment credit note details are added to 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">adjustment_credit_notes[]</code> attribute of the invoice.</li> <li class="text-base leading-relaxed">The invoice <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_due</code> is reduced by the credit note <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">total</code>.</li> <li class="text-base leading-relaxed">The invoice <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> is updated 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">paid</code> if the invoice <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_due</code> equals the credit note <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">total</code>.</li> <li class="text-base leading-relaxed">The invoice <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> does not change if the invoice <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_due</code> is greater than credit note <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">total</code>.</li> </ul> </li> <li class="text-base leading-relaxed">If the credit note <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">type</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">refundable</code>: <ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed">The refundable credit note details are added to 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">issued_credit_notes[]</code> attribute of the invoice.</li> <li class="text-base leading-relaxed">The invoice <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> does not change.</li> </ul> </li> <li class="text-base leading-relaxed">If the credit note <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">type</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">store</code>: <ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed">The store credit note details are added to 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">issued_credit_notes[]</code> attribute of the invoice.</li> <li class="text-base leading-relaxed">The invoice <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> does not change.</li> </ul> </li> </ul></div></div></div>

next_offsetstring

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

json
{
  "list": null,
  "next_offset": null
}

Need more? See the Chargebee guide for connection setup and behaviour shared by every action.