BillKit/DocsConsole
Credit notes

Get credit note

Retrieve one credit note.

GET/v1/credit_notes/{credit_note_id}
Operation get_credit_note·Scope credit_notes:read·OpenAPI v1.1.0

Parameters

ParameterDescription
credit_note_idstring · pathrequiredId of the credit note, which starts cn_.

Returns

Returns a CreditNoteResponse object.

Errors

StatusCause
400The request was refused (type: invalid_request_error): a required parameter is missing (parameter_missing), one failed validation (parameter_invalid) or is not one the operation takes (parameter_unknown), and param names it.
401No credential, or one that does not authenticate.
402The account is suspended (tenant_suspended), or the payment provider refused a charge or refund the call made (type: payment_error, code: payment_refused).
403Authenticated, but not allowed: missing scope (insufficient_scope), a key of the wrong mode (mode_mismatch), or a refused origin. Needs the credit_notes:read scope.
404No such object in this account and mode.
429Rate limited. Retry-After says when to try again.
500Something failed on BillKit's side (type: api_error). Retry with the same Idempotency-Key.
503Temporarily unable to serve. reason says whether the request was attempted.
Request · curl
curl -X GET https://api.billkit.eu/v1/credit_notes/cn_9XKp2vQ1 \
  -H "Authorization: Bearer $BILLKIT_API_KEY"
Response · 200 OK
{
  "created": 1789392000,
  "currency": "EUR",
  "customer_id": "cus_9XKp2vQ1",
  "id": "cn_9XKp2vQ1",
  "invoice_id": "inv_9XKp2vQ1",
  "livemode": false,
  "number": "string",
  "object": "credit_note",
  "reason": "string",
  "refund_id": "re_9XKp2vQ1",
  "subtotal_cents": 1900,
  "tax_cents": 1900,
  "tax_country_code": "NL",
  "tax_rate_basis_points": 0,
  "tax_reverse_charged": false,
  "total_cents": 1900
}