Skip to main content
POST
Create a credit note

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Body

application/json
reason
string
required
Maximum string length: 500
amount
number
required

Positive amount, up to the remaining creditable balance.

metadata
object

Response

The created credit note.

creditNote
object
Last modified on October 4, 2026