GET /credit_notes
Lists all the Credit Notes.
Servers
- {protocol}://{site}.{environment}:{port}/api/v2
- {protocol}://{site}-test.{environment}:{port}/api/v2
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
chargebee-request-origin-device |
String | No |
The device from which the customer has made the request |
chargebee-business-entity-id |
String | No |
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. |
chargebee-request-origin-user |
String | No |
The email address of your customer/user. Use this when the email address has only ASCII characters. |
chargebee-request-origin-ip |
String | No |
The IP address of the customer where the request originated |
chargebee-request-origin-user-encoded |
String | No |
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. |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
amount_available |
Object | No |
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" |
amount_refunded |
Object | No |
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" |
reference_invoice_id |
Object | No |
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" |
reason_code |
Object | No |
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" |
status |
Object | No |
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" |
voided_at |
Object | No |
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" |
price_type |
Object | No |
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" |
date |
Object | No |
optional, timestamp(UTC) in seconds filter The date the Credit Note is issued. Supported operators : after, before, on, between Example → date[on] = "1435054328" |
include_deleted |
Boolean | No |
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 |
create_reason_code |
Object | No |
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" |
total |
Object | No |
optional, in cents filter Credit Note amount in cents. Supported operators : is, is_not, lt, lte, gt, gte, between Example → total[is] = "1200" |
updated_at |
Object | No |
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" |
id |
Object | No |
optional, string filter Credit-note id. Supported operators : is, is_not, starts_with, in, not_in Example → id[is] = "CN_123" |
customer_id |
Object | No |
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" |
einvoice |
Object | No |
Parameters for einvoice |
limit |
Integer | No |
The number of resources to be returned. Default value: 10 |
channel |
Object | No |
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" |
amount_allocated |
Object | No |
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" |
type |
Object | No |
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" |
sort_by |
Object | No |
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. |
offset |
String | No |
Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set |
subscription_id |
Object | No |
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" |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.