GET /credit_notes

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 filterThe yet to be used credits of this Credit Note.Supported operators : is, is_not, lt, lte, gt, gte, betweenExample → amount_available[gt] = "1400"

optional, in cents filterThe refunds issued from this Credit Note.Supported operators : is, is_not, lt, lte, gt, gte, betweenExample → amount_refunded[lte] = "130"

optional, string filterThe identifier of the invoice against which this Credit Note is issued.Supported operators : is, is_not, starts_with, in, not_inExample → reference_invoice_id[is] = "INVOICE_876"

optional, enumerated string filterThe 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_inExample → reason_code[is] = "waiver"

optional, enumerated string filterThe credit note status. Possible values are : adjusted, refunded, refund_due, voided.Supported operators : is, is_not, in, not_inExample → status[is] = "adjusted"

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

optional, enumerated string filterThe price type of the Credit Note. Possible values are : tax_exclusive, tax_inclusive.Supported operators : is, is_not, in, not_inExample → price_type[is_not] = "tax_exclusive"

optional, timestamp(UTC) in seconds filterThe date the Credit Note is issued.Supported operators : after, before, on, betweenExample → date[on] = "1435054328"

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, string filterReason 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_inExample → create_reason_code[is] = "Other"

optional, in cents filterCredit Note amount in cents.Supported operators : is, is_not, lt, lte, gt, gte, betweenExample → total[is] = "1200"

optional, timestamp(UTC) in seconds filterTo 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, betweenExample → updated_at[on] = "1243545465"

optional, string filterCredit-note id.Supported operators : is, is_not, starts_with, in, not_inExample → id[is] = "CN_123"

optional, string filterThe identifier of the customer this Credit Note belongs to.Supported operators : is, is_not, starts_with, in, not_inExample → customer_id[is] = "4gmiXbsjdm"

Parameters for einvoice

The number of resources to be returned.

Default value: 10

optional, enumerated string filterThe 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_inExample → channel[is] = "APP STORE"

optional, in cents filterThe amount allocated to the invoices.Supported operators : is, is_not, lt, lte, gt, gte, betweenExample → amount_allocated[is] = "1200"

optional, enumerated string filterThe credit note type. Possible values are : adjustment, refundable.Supported operators : is, is_not, in, not_inExample → type[is_not] = "adjustment"

optional, string filterSorts based on the specified attribute. Supported attributes : dateSupported sort-orders : asc, descExample → *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 filterTo 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_inExample → subscription_id[is] = "4gmiXbsjdm"