---
title: "Get a single credit note by ID"
method: GET
path: "/credit-notes/{credit_note_id}"
tags: ["Credit Notes"]
---

# Get a single credit note by ID

`GET /credit-notes/{credit_note_id}`

## Request

- Base URL: `https://api-m.sandbox.paypal.com`
- URL: `https://api-m.sandbox.paypal.com/credit-notes/{credit_note_id}`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `/api/oauth-proxy` scopes: `read`, `write`
- TypeScript: <https://skmtc.dev/paypal/apis/usage-based-billing-api/docs/credit-notes/:credit_note_id/get.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `credit_note_id` string, required

## Response `200`

A single credit note

- CreditNoteWithId
  - `billing_entity_code` string, required: Unique code used to identify the billing entity. Must contain only alphanumeric characters, underscores, and hyphens.
  - `sequential_id` integer, required: The sequential identifier of the credit note, specifically scoped on the associated invoice. It provides a unique numerical identifier for the credit note within the context of the invoice.
  - `number` string, required: The credit note unique number.
  - `invoice_id` string, uuid, required: Unique identifier assigned to the invoice that the credit note belongs to
  - `invoice_number` string, required: The invoice unique number, related to the credit note.
  - `issuing_date` string, date, required: Date in ISO 8601 format (YYYY-MM-DD).
  - `credit_status` 'AVAILABLE' | 'CONSUMED' | 'VOIDED': The status of the credit portion of the credit note
  - `refund_status` 'PENDING' | 'SUCCEEDED' | 'FAILED': The status of the refund portion of the credit note
  - `reason` 'DUPLICATED_CHARGE' | 'PRODUCT_UNSATISFACTORY' | 'ORDER_CHANGE' | 'ORDER_CANCELLATION' | 'FRAUDULENT_CHARGE' | 'OTHER', required: The reason for credit note creation
  - `description` string, nullable: The description of the credit note.
  - `total_amount` Amount, required
    - `value` number, required: The amount value in the corresponding currency unit (e.g., two decimals for USD, no decimals for JPY).
    - `currency_code` string, required: Currency code in ISO 4217 format.
  - `taxes_amount` Amount, required
    - `value` number, required: The amount value in the corresponding currency unit (e.g., two decimals for USD, no decimals for JPY).
    - `currency_code` string, required: Currency code in ISO 4217 format.
  - `taxes_rate` number, required: The tax rate associated with this specific credit note.
  - `sub_total_excluding_taxes_amount` Amount, required
    - `value` number, required: The amount value in the corresponding currency unit (e.g., two decimals for USD, no decimals for JPY).
    - `currency_code` string, required: Currency code in ISO 4217 format.
  - `balance_amount` Amount, required
    - `value` number, required: The amount value in the corresponding currency unit (e.g., two decimals for USD, no decimals for JPY).
    - `currency_code` string, required: Currency code in ISO 4217 format.
  - `credit_amount` Amount, required
    - `value` number, required: The amount value in the corresponding currency unit (e.g., two decimals for USD, no decimals for JPY).
    - `currency_code` string, required: Currency code in ISO 4217 format.
  - `refund_amount` Amount, required
    - `value` number, required: The amount value in the corresponding currency unit (e.g., two decimals for USD, no decimals for JPY).
    - `currency_code` string, required: Currency code in ISO 4217 format.
  - `created_at` string, date-time, required: Date and time in ISO 8601 format.
  - `updated_at` string, date-time, required: Date and time in ISO 8601 format.
  - `items` CreditNoteItemObject[]: Array of credit note's items.
    - `id` string, uuid, required: The credit note's item unique identifier.
    - `amount` Amount, required
      - `value` number, required: The amount value in the corresponding currency unit (e.g., two decimals for USD, no decimals for JPY).
      - `currency_code` string, required: Currency code in ISO 4217 format.
    - `fee` FeeObject, required
      - `id` string, uuid, nullable: Unique identifier assigned to the fee. This ID is exclusively and serves as a unique identifier for the fee's record.
      - `total_amount` Amount
        - `value` number, required: The amount value in the corresponding currency unit (e.g., two decimals for USD, no decimals for JPY).
        - `currency_code` string, required: Currency code in ISO 4217 format.
      - `name` string, nullable: The the name of the fee associated to any one of the charge, the credit, the subscription or the commitment
  - `applied_taxes` CreditNoteAppliedTaxObject[]
    - `id` string, uuid: Unique identifier of the applied tax.
    - `tax_id` string, uuid: Unique identifier of the tax.
    - `tax_name` string: Name of the tax.
    - `tax_code` string: Unique code used to identify the tax associated with the API request.
    - `tax_rate` number: The percentage rate of the tax
    - `tax_description` string: Internal description of the taxes
    - `amount` Amount
      - `value` number, required: The amount value in the corresponding currency unit (e.g., two decimals for USD, no decimals for JPY).
      - `currency_code` string, required: Currency code in ISO 4217 format.
    - `created_at` string, date-time: Date and time in ISO 8601 format.
  - `id` string

## Other responses

- `403`: Authorization failed due to insufficient permissions.
- `404`: Resource Not Found.
- `500`: Internal Server Error - An unexpected error occurred

---

[API](https://skmtc.dev/paypal/apis/usage-based-billing-api.md) - [All operations](https://skmtc.dev/paypal/apis/usage-based-billing-api/llms.txt) - [OpenAPI document](https://skmtc.dev/paypal/apis/usage-based-billing-api/revisions/22fb46514ac4?raw)