List credit notes

Try in API Explorer

Lists all the Credit Notes.

Sample Request

URL Format

GET https://[site].chargebee.com/api/v2/credit_notes

Input Parameters

limit

optional, integer, default=10, min=1, max=100

The number of resources to be returned.

offset

optional, string, max chars=1000

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.

include_deleted

optional, boolean, default=false

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

einvoice

optional, object

Parameters for einvoice

sort_by

optional, object

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.

Filter Params

For operator usages, see the Pagination and Filtering section.

id[<operator>]

optional, string filter

Credit-note id. Supported operators : is, is_not, starts_with, in, not_in

Example → id[is] = "CN_123"

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

customer_id[<operator>]

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"

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

subscription_id[<operator>]

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"

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

reference_invoice_id[<operator>]

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"

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

type[<operator>]

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"

Supported operators: is, is_not, in, not_in

reason_code[<operator>]

optional, enumerated string filter

The reason for issuing this Credit Note. The following reason codes are supported now[Deprecated; use the 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"

Supported operators: is, is_not, in, not_in

create_reason_code[<operator>]

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"

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

status[<operator>]

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"

Supported operators: is, is_not, in, not_in

date[<operator>]

optional, timestamp(UTC) in seconds filter

The date the Credit Note is issued. Supported operators : after, before, on, between

Example → date[on] = "1435054328"

Supported operators: after, before, on, between

total[<operator>]

optional, in cents filter

Credit Note amount in cents. Supported operators : is, is_not, lt, lte, gt, gte, between

Example → total[is] = "1200"

Supported operators: is, is_not, lt, lte, gt, gte, between

price_type[<operator>]

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"

Supported operators: is, is_not, in, not_in

amount_allocated[<operator>]

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"

Supported operators: is, is_not, lt, lte, gt, gte, between

amount_refunded[<operator>]

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"

Supported operators: is, is_not, lt, lte, gt, gte, between

amount_available[<operator>]

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"

Supported operators: is, is_not, lt, lte, gt, gte, between

voided_at[<operator>]

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"

Supported operators: after, before, on, between

updated_at[<operator>]

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-11-09. Supported operators : after, before, on, between

Example → updated_at[on] = "1243545465"

Supported operators: after, before, on, between

channel[<operator>]

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"

Supported operators: is, is_not, in, not_in

Returns

next_offsetoptional, string, max chars=1000

This attribute is returned only if more resources are present. To fetch the next set of resources use this value for the input parameter offset.

credit_noteCredit note object

Resource object representing credit_note