Sign in

v52

latestOpenAPI 3.0.1AGPL-3.0raw.githubusercontent.com2026-08-01255473862.7 KB
Credit Notes

Get credit note

Use when you need to load a single credit note (e.g. for display or reconciliation).

get/creditnotes/{id}

Path parameters

idstring required

Credit note ID

Response

OK

created_atstring date-time
created_bystring
credit_note_numberstring

credit_note_number is the unique identifier for credit notes

credit_note_status'DRAFT' | 'FINALIZED' | 'VOIDED'
credit_note_type'ADJUSTMENT' | 'REFUND'
currencystring

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

customer_idstring

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

environment_idstring

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

finalized_atstring date-time

finalized_at is the timestamp when the credit note was finalized

idstring

id is the unique identifier for the credit note

idempotency_keystring

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

invoice_idstring

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

memostring

memo is an optional memo supplied on the credit note

metadataTypesMetadata
reason'DUPLICATE' | 'FRAUDULENT' | 'ORDER_CHANGE' | 'UNSATISFACTORY' | 'SERVICE_ISSUE' | 'BILLING_ERROR' | 'SUBSCRIPTION_CANCELLATION'
refund_status'INITIATED' | 'PENDING' | 'PROCESSING' | 'SUCCEEDED' | 'OVERPAID' | 'FAILED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'VOIDED'
status'published' | 'deleted' | 'archived'
subscription_idstring

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

tenant_idstring
total_amountstring

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

updated_atstring date-time
updated_bystring
voided_atstring date-time

voided_at is the timestamp when the credit note was voided