Skip to main content
GET
/
credit-notes
Get all credit notes
curl --request GET \
  --url https://api-m.sandbox.paypal.com/v1/commerce/billing/credit-notes \
  --header 'Authorization: Bearer <token>'
{
  "credit_notes": [
    {
      "id": "cn_01H2XT1G7N8E2JHJKBVPDS0TQD",
      "billing_entity_code": "lex_corp",
      "sequential_id": 3,
      "number": "CN-2023-0001",
      "invoice_id": "inv_01H2XT1G7N8E2JHJKBVPDS0TQD",
      "invoice_number": "INV-2023-001",
      "issuing_date": "2023-06-01",
      "credit_status": "AVAILABLE",
      "refund_status": "SUCCEEDED",
      "reason": "ORDER_CANCELLATION",
      "description": "Refund for cancelled subscription",
      "total_amount": {
        "value": 50,
        "currency_code": "USD"
      },
      "credit_amount": {
        "value": 25,
        "currency_code": "USD"
      },
      "refund_amount": {
        "value": 25,
        "currency_code": "USD"
      },
      "balance_amount": {
        "value": 25,
        "currency_code": "USD"
      },
      "taxes_amount": {
        "value": 0,
        "currency_code": "USD"
      },
      "taxes_rate": 0.2,
      "sub_total_excluding_taxes_amount": {
        "value": 0,
        "currency_code": "USD"
      },
      "created_at": "2023-05-10T14:32:18Z",
      "updated_at": "2023-05-10T14:32:18Z"
    }
  ],
  "metadata": {
    "total_count": 1,
    "total_pages": 1,
    "current_page": 1
  }
}

Authorizations

​
Authorization
string
header
required

Use the /v1/oauth2/token endpoint to obtain an access token and pass it as a Bearer token in the Authorization header.

Query Parameters

​
per_page
integer

Number of records per page

​
page
integer

Page number

​
external_customer_id
string

Filter credit notes by external customer ID

​
invoice_id
string

Filter credit notes by invoice ID

​
status
enum<string>

Filter credit notes by status Status values for filtering credit notes

Available options:
DRAFT,
FINALIZED,
VOIDED
Example:

"FINALIZED"

​
credit_status
enum<string>

Filter credit notes by credit status (e.g., available, consumed, voided) The status of the credit portion of the credit note

Available options:
AVAILABLE,
CONSUMED,
VOIDED
Example:

"AVAILABLE"

​
refund_status
enum<string>

Filter credit notes by refund status The status of the refund portion of the credit note

Available options:
PENDING,
SUCCEEDED,
FAILED
Example:

"PENDING"

​
reason
enum<string>

Filter credit notes by reason The reason for credit note creation

Available options:
DUPLICATED_CHARGE,
PRODUCT_UNSATISFACTORY,
ORDER_CHANGE,
ORDER_CANCELLATION,
FRAUDULENT_CHARGE,
OTHER
Example:

"OTHER"

​
id
string

Filter credit notes by ID

​
number
string

Filter credit notes by credit note number

​
issuing_date_from
string<date-time>

Filter credit notes issued on or after this date (ISO 8601 format) Date and time in ISO 8601 format.

Example:

"2023-10-01T12:00:00Z"

​
issuing_date_to
string<date-time>

Filter credit notes issued on or before this date (ISO 8601 format) Date and time in ISO 8601 format.

Example:

"2023-10-01T12:00:00Z"

​
created_at_from
string<date-time>

Filter credit notes created on or after this date (ISO 8601 format) Date and time in ISO 8601 format.

Example:

"2023-10-01T12:00:00Z"

​
created_at_to
string<date-time>

Filter credit notes created on or before this date (ISO 8601 format) Date and time in ISO 8601 format.

Example:

"2023-10-01T12:00:00Z"

​
updated_at_from
string<date-time>

Filter credit notes updated on or after this date (ISO 8601 format) Date and time in ISO 8601 format.

Example:

"2023-10-01T12:00:00Z"

​
updated_at_to
string<date-time>

Filter credit notes updated on or before this date (ISO 8601 format) Date and time in ISO 8601 format.

Example:

"2023-10-01T12:00:00Z"

Response

A list of credit notes.

​
credit_notes
object[]
​
metadata
object