BillKit/DocsConsole
Refunds

Get refund

Retrieve one refund and check whether it has settled.

GET/v1/refunds/{refund_id}
Operation get_refund·Scope refunds:read·OpenAPI v1.1.0

Parameters

ParameterDescription
refund_idstring · pathrequiredId of the refund, which starts re_.

Returns

Returns a RefundResponse 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 refunds: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/refunds/re_9XKp2vQ1 \
  -H "Authorization: Bearer $BILLKIT_API_KEY"
Response · 200 OK
{
  "amount_cents": 1900,
  "created": 1789392000,
  "currency": "EUR",
  "id": "re_9XKp2vQ1",
  "livemode": false,
  "object": "refund",
  "one_shot_payment_id": "osp_9XKp2vQ1",
  "payment_id": "pay_9XKp2vQ1",
  "reason": "string",
  "status": "pending",
  "subscription_id": "sub_9XKp2vQ1"
}