Billing
List credit notes
AuthorizationBearer <token>
Present an API key (sb_live_… / sb_test_…), an OAuth2 access token, or a static token as a Bearer credential. The operator is implied by the credential; it is never in the path. Only a SHA-256 hash of an API key is stored server-side.
In: header
Query Parameters
cursor?string
Opaque pagination cursor from meta.cursor.next of the previous page. Do not construct or parse it.
limit?integer
Page size. Values above the maximum are clamped.
Range
1 <= value <= 100Default
25invoice_id?string
Filter by invoice.
Format
uuidcontact_id?string
Filter by contact.
Format
uuidstatus?string
Filter by status.
Value in
- "draft"
- "issued"
- "applied"
- "void"
q?string
Free-text match on the credit-note number.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/credit-notes"{ "data": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "object": "credit_note", "contact_id": "f245e2a3-e141-4d41-912c-b1c1f5bd5598", "invoice_id": "f4c4edb8-11e0-4b33-bcc1-482dc59ebb32", "number": "string", "status": "draft", "reason": "string", "subtotal_minor": 0, "tax_minor": 0, "total_minor": 0, "currency": "str", "issued_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" } ], "meta": { "limit": 0, "cursor": { "next": "string", "has_more": true } }}{ "error": { "code": "unauthorized", "message": "Missing or invalid credential." }}{ "error": { "code": "insufficient_scope", "message": "The credential lacks a scope required by this endpoint." }}{ "error": { "code": "rate_limited", "message": "Rate limit exceeded. Retry after 7s." }}{ "error": { "code": "validation_error", "message": "string", "details": [ { "field": "string", "issue": "string" } ] }}