Skip to main content
POST
Create credit note

Authorizations

x-api-key
string
header
required

Enter your API key in the format x-api-key <api-key>*

Body

application/json

Credit note request

invoice_id
string
required

invoice_id is the unique identifier of the invoice this credit note is applied to

reason
enum<string>
required
Available options:
DUPLICATE,
FRAUDULENT,
ORDER_CHANGE,
UNSATISFACTORY,
SERVICE_ISSUE,
BILLING_ERROR,
SUBSCRIPTION_CANCELLATION
credit_note_number
string

credit_note_number is an optional human-readable identifier for the credit note

idempotency_key
string

idempotency_key is an optional key used to prevent duplicate credit note creation

line_items
object[]

line_items contains the individual line items that make up this credit note (minimum 1 required)

memo
string

memo is an optional free-text field for additional notes about the credit note

metadata
object
process_credit_note
boolean
default:true

process_credit_note is a flag to process the credit note after creation

Response

Created

created_at
string<date-time>
created_by
string
credit_note_number
string

credit_note_number is the unique identifier for credit notes

credit_note_status
enum<string>
Available options:
DRAFT,
FINALIZED,
VOIDED
credit_note_type
enum<string>
Available options:
ADJUSTMENT,
REFUND
currency
string

currency is the three-letter ISO currency code (e.g., USD, EUR) for the credit note

customer
object
customer_id
string

customer_id is the unique identifier of the customer who owns this credit note

environment_id
string

environment_id is the unique identifier of the environment this credit note belongs to

finalized_at
string<date-time>

finalized_at is the timestamp when the credit note was finalized

id
string

id is the unique identifier for the credit note

idempotency_key
string

idempotency_key is an optional key used to prevent duplicate credit note creation

invoice
object
invoice_id
string

invoice_id is the id of the invoice resource that this credit note is applied to

line_items
object[]

line_items contains all of the line items associated with this credit note

memo
string

memo is an optional memo supplied on the credit note

metadata
object
reason
enum<string>
Available options:
DUPLICATE,
FRAUDULENT,
ORDER_CHANGE,
UNSATISFACTORY,
SERVICE_ISSUE,
BILLING_ERROR,
SUBSCRIPTION_CANCELLATION
refund_status
enum<string>
Available options:
INITIATED,
PENDING,
PROCESSING,
SUCCEEDED,
OVERPAID,
FAILED,
REFUNDED,
PARTIALLY_REFUNDED,
VOIDED
status
enum<string>
Available options:
published,
deleted,
archived
subscription
object
subscription_id
string

subscription_id is the optional unique identifier of the subscription related to this credit note

tenant_id
string
total_amount
string

total_amount is the total including creditable invoice-level discounts or minimums, and tax

updated_at
string<date-time>
updated_by
string
voided_at
string<date-time>

voided_at is the timestamp when the credit note was voided