---
title: "List credit notes"
method: GET
path: "/credit_notes"
tags: ["Credit note"]
---

# List credit notes

`GET /credit_notes`

Get a paginated list of CreditNotes. Users can also filter by
customer_id, subscription_id, or external_customer_id. The credit notes will be returned
in reverse chronological order by `creation_time`.

## Query parameters

- `limit` integer — The number of items to fetch. Defaults to 20.
- `cursor` string, nullable — Cursor for pagination. This can be populated by the `next_cursor` value returned from the initial request.
- `created_at[gte]` string, date-time, nullable
- `created_at[gt]` string, date-time, nullable
- `created_at[lt]` string, date-time, nullable
- `created_at[lte]` string, date-time, nullable

## Response `200`

OK

- CreditNotes
  - `data` CreditNote[], required
    - `id` string, required — The Orb id of this credit note.
    - `created_at` string, date-time, required — The creation time of the resource in Orb.
    - `voided_at` string, date-time, nullable, required — The time at which the credit note was voided in Orb, if applicable.
    - `credit_note_number` string, required — The unique identifier for credit notes.
    - `invoice_id` string, required — The id of the invoice resource that this credit note is applied to.
    - `memo` string, nullable, required — An optional memo supplied on the credit note.
    - `reason` 'Duplicate' | 'Fraudulent' | 'Order change' | 'Product unsatisfactory', nullable, required
    - `type` 'refund' | 'adjustment', required
    - `subtotal` string, required — The total prior to any creditable invoice-level discounts or minimums.
    - `total` string, required — The total including creditable invoice-level discounts or minimums, and tax.
    - `customer` CustomerMinified, required
      - `id` string, required
      - `external_customer_id` string, nullable, required
    - `credit_note_pdf` string, nullable, required — A URL to a PDF of the credit note.
    - `minimum_amount_refunded` string, nullable, required — Any credited amount from the applied minimum on the invoice.
    - `discounts` CreditNoteDiscount[] — Any discounts applied on the original invoice.
      - `discount_type` 'percentage', required
      - `percentage_discount` number, required
      - `amount_applied` string, required
      - `reason` string, nullable
      - `applies_to_prices` CreditNoteDiscountAppliesToPrice[], nullable
        - `id` string, required
        - `name` string, required
    - `maximum_amount_adjustment` CreditNoteDiscount, required
      - `discount_type` 'percentage', required
      - `percentage_discount` number, required
      - `amount_applied` string, required
      - `reason` string, nullable
      - `applies_to_prices` CreditNoteDiscountAppliesToPrice[], nullable
        - `id` string, required
        - `name` string, required
    - `line_items` CreditNoteLineItem[], required — All of the line items associated with this credit note.
      - `id` string, required — The Orb id of this resource.
      - `name` string, required — The name of the corresponding invoice line item.
      - `subtotal` string, required — The amount of the line item, excluding any line item minimums and discounts.
      - `amount` string, required — The amount of the line item, including any line item minimums and discounts.
      - `quantity` number, nullable, required — An optional quantity credited.
      - `discounts` CreditNoteLineItemDiscount[] — Any line item discounts from the invoice's line item.
        - `id` string, required
        - `discount_type` 'percentage' | 'amount', required
        - `percentage_discount` number, required
        - `amount_discount` string, nullable
        - `amount_applied` string, required
        - `reason` string, nullable
        - `applies_to_price_ids` string[], required
      - `tax_amounts` TaxAmount[], required — Any tax amounts applied onto the line item.
        - `tax_rate_description` string, required — The human-readable description of the applied tax rate.
        - `tax_rate_percentage` string, nullable, required — The tax rate percentage, out of 100.
        - `amount` string, required — The amount of additional tax incurred by this tax rate.
      - `item_id` string, required — The id of the item associated with this line item.
      - `start_time_inclusive` string, date-time, nullable — The start time of the service period for this credit note line item.
      - `end_time_exclusive` string, date-time, nullable — The end time of the service period for this credit note line item.
  - `pagination_metadata` PaginationMetadata, required
    - `has_more` boolean, required
    - `next_cursor` string, nullable, required

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `404` — Not Found
- `409` — Conflict
- `413` — Content Too Large
- `429` — Too Many Requests
- `500` — Internal Server Error

---

[API](https://skmtc.net/withorb/apis/api-reference.md) · [All operations](https://skmtc.net/withorb/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/withorb/api-reference/versions/816dfe734e2e/schema)