# List your credit notes

> The portal.credit_notes.list operation: GET /api/v1/portal/me/credit_notes in the REST API and the portal_credit_notes_list tool in the MCP server.

Lists the signed-in customer's credit notes (issued for refunds), newest first, each with the invoice it
corrects and a download link of its PDF (`pdfPath`; null for a moment after issue).

Paginate with `limit` (default 20) and `starting_after`. Customer portal only (`portal:read`).

## At a glance

- **REST:** `GET /api/v1/portal/me/credit_notes`
- **MCP tool:** `portal_credit_notes_list`
- **Operation ID:** `portal.credit_notes.list`
- **Scope:** Brand
- **Permission:** `portal:read`
- **Risk tier:** `read`
- **Dry run:** Not supported
- **Idempotency:** Not needed (read only)
- **Modes:** Test and live
- **Pagination:** `limit` (at most 100) and `starting_after`
- **Authentication:** A customer signed in to the customer portal (API keys can't call it)
- **Since:** M9

## Request

### Query parameters

| Field            | Type               | Required | Description                             |
| ---------------- | ------------------ | -------- | --------------------------------------- |
| `limit`          | integer (1 to 100) | No       | Page size, 1 to 100 (default 20).       |
| `starting_after` | string             | No       | The `next_cursor` of the previous page. |

## Response

`200 OK` with a JSON object, a page of the list (newest first):

| Field                  | Type                   | Description                                                |
| ---------------------- | ---------------------- | ---------------------------------------------------------- |
| `object`               | `"list"`               |                                                            |
| `data`                 | array of object        |                                                            |
| `data[].id`            | `cn_…` ID              |                                                            |
| `data[].object`        | `"portal_credit_note"` |                                                            |
| `data[].number`        | string                 |                                                            |
| `data[].issueDate`     | string                 |                                                            |
| `data[].currency`      | string                 |                                                            |
| `data[].total`         | money                  |                                                            |
| `data[].invoiceId`     | `inv_…` ID             |                                                            |
| `data[].invoiceNumber` | string                 |                                                            |
| `data[].pdfPath`       | string or null         | The PDF's download link (null while it is being prepared). |
| `has_more`             | boolean                |                                                            |
| `next_cursor`          | string or null         |                                                            |

## Examples

### Your credit notes

```http
GET /api/v1/portal/me/credit_notes
Authorization: Bearer or_test_…
```

Response (`200`):

```json
{
  "object": "list",
  "data": [
    {
      "id": "cn_01m4tx5nj8emwbyf7y9vcf48b4",
      "object": "portal_credit_note",
      "number": "GEN-CN-2026-000003",
      "issueDate": "2026-10-22",
      "currency": "EUR",
      "total": {
        "amount": "30000000",
        "currency": "EUR"
      },
      "invoiceId": "inv_01m4tx5nj8emwbyf7y9vcf48b3",
      "invoiceNumber": "GEN-2026-000042",
      "pdfPath": "/api/v1/credit_notes/cn_01m4tx5nj8emwbyf7y9vcf48b4/pdf?token=eyJ…"
    }
  ],
  "has_more": false,
  "next_cursor": null
}
```

## Errors

| Code                                                                                         | HTTP status | When                                                                                                               | What to do                                                                                                                  |
| -------------------------------------------------------------------------------------------- | ----------- | ------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------- |
| [`validation_failed`](https://ownrecord.io/docs/reference/errors.md#validation_failed)       | 400         | A field or pagination value is malformed.                                                                          | Fix the fields listed in `details.issues` and send the request again.                                                       |
| [`livemode_not_allowed`](https://ownrecord.io/docs/reference/errors.md#livemode_not_allowed) | 403         | The portal session is in the other mode than the request.                                                          | Use test mode, or credentials for the target's mode. Developers need live access granted by an organization owner or admin. |
| [`permission_denied`](https://ownrecord.io/docs/reference/errors.md#permission_denied)       | 403         | The caller isn't a customer signed in to this brand's portal (operators and API keys use the customer operations). | Ask an organization owner or admin for a role or scope that allows this action.                                             |

It can also return these [common errors](https://ownrecord.io/docs/reference.md#common-errors): [`api_version_unsupported`](https://ownrecord.io/docs/reference/errors.md#api_version_unsupported), [`authentication_required`](https://ownrecord.io/docs/reference/errors.md#authentication_required), [`api_key_invalid`](https://ownrecord.io/docs/reference/errors.md#api_key_invalid), [`scope_required`](https://ownrecord.io/docs/reference/errors.md#scope_required), [`resource_not_found`](https://ownrecord.io/docs/reference/errors.md#resource_not_found), [`dry_run_not_supported`](https://ownrecord.io/docs/reference/errors.md#dry_run_not_supported), [`rate_limited`](https://ownrecord.io/docs/reference/errors.md#rate_limited), [`internal_error`](https://ownrecord.io/docs/reference/errors.md#internal_error).