CreditNote

Credit notes adjust an invoice amount after it has been finalized. Used to issue credit or refunds.

Name
object
Type
string
Description
Type of object is always creditNote.
Allowed values: creditNote
Name
id
Type
string
Description
Unique identifier for the credit note.
Example: "crn_0SNlurA049MEWV49X25tqzNV2jji"
Name
createdAt
Type
string
Description
Time when the credit note was created.
Example: "2024-06-14T19:38:34Z"
Name
fees
Type
array
Description
The credited fees.
Name
amount
Type
object
Description
The amount of the fee.
Example: {"amount":100,"currency":"USD"}
Optional: This property may not always be included.
Name
name
Type
string
Description
The name of the fee.
Optional: This property may not always be included.
Example: "Recovery Fee"
Name
type
Type
string
Description
The type of the fee.
Optional: This property may not always be included.
Allowed values: recoveryFee
Name
invoice
Type
string
Description
The unique identifier for the invoice that the credit note applies to.
Example: "inv_0SNlurA049MEWV1QTRqvd18YuG25"
Name
lineItems
Type
array
Description
The line items for the credit note.
Name
status
Type
string
Description
The status of the credit note. It can have one of the following values:

issued: The credit note was issued.

voided: The credit note was voided and no longer has any effect.
Allowed values: issued voided
Name
subtotal
Type
object
Description
The total amount credited before any taxes or fees.
Example: {"amount":999,"currency":"USD"}
Name
amount
Type
integer
Description
The price amount in the currency's minor unit, e.g. "cents" for many currencies.
Example: 999
>= 0
Name
currency
Type
string
Description
Three-letter ISO 4217 currency code. Must be a supported currency.
Example: "USD"
Name
tax
Type
object
Description
The sum of the amounts in taxes credited for each line item.
Example: {"amount":200,"currency":"USD"}
Name
amount
Type
integer
Description
The price amount in the currency's minor unit, e.g. "cents" for many currencies.
Example: 999
>= 0
Name
currency
Type
string
Description
Three-letter ISO 4217 currency code. Must be a supported currency.
Example: "USD"
Name
total
Type
object
Description
The total amount credited after taxes and fees.
Example: {"amount":1199,"currency":"USD"}
Name
amount
Type
integer
Description
The price amount in the currency's minor unit, e.g. "cents" for many currencies.
Example: 999
>= 0
Name
currency
Type
string
Description
Three-letter ISO 4217 currency code. Must be a supported currency.
Example: "USD"
Name
voidedAt
Type
nullable string
Description
Time when the credit note was voided.
Example: "2024-06-14T19:38:34Z"

Example

{
  "object": "creditNote",
  "id": "crn_0SNlurA049MEWV49X25tqzNV2jji",
  "createdAt": "2024-06-14T19:38:34.0Z",
  "fees": [
    {
      "amount": {
        "amount": 100,
        "currency": "USD"
      },
      "name": "Recovery Fee",
      "type": "recoveryFee"
    }
  ],
  "invoice": "inv_0SNlurA049MEWV1QTRqvd18YuG25",
  "lineItems": [
    {
      "amount": {
        "amount": 999,
        "currency": "USD"
      },
      "invoiceLineItem": "lin_0SNlurA049MEWV11QUKZGDMxJmKe",
      "tax": {
        "amount": 200,
        "currency": "USD"
      },
      "taxes": [
        {
          "amount": {
            "amount": 200,
            "currency": "USD"
          },
          "inclusive": false,
          "name": "State Sales Tax",
          "invoiceTax": "itx_0SNlurA049MEWV5Mw7cjrxFUo2Y3"
        }
      ],
      "total": {
        "amount": 1199,
        "currency": "USD"
      }
    }
  ],
  "status": "issued",
  "subtotal": {
    "amount": 999,
    "currency": "USD"
  },
  "tax": {
    "amount": 200,
    "currency": "USD"
  },
  "total": {
    "amount": 1199,
    "currency": "USD"
  },
  "voidedAt": "2024-06-14T19:38:34Z"
}