admin

Admin Refund

Record a refund already made externally and audit the original payment.

Real Stripe refunds must be issued in Stripe; its webhook owns their ledger.

post/api/v1/admin/clients/{client_id}/refund

Request

  • Base URL: https://api.nudgelink.co (the document declares no server; this is the origin it was published from)
  • URL: https://api.nudgelink.co/api/v1/admin/clients/{client_id}/refund
  • Auth: HTTP bearer

Path parameters

client_idstring uuid required

Headers

Idempotency-Keystring nullable

Request body

billing_event_idstring uuid nullable

Original BillingEvent to refund (optional, for traceability)

reasonstring required

Response

Successful Response

client_idstring uuid required
refund_billing_event_idstring uuid required
refunded_amountnumber required
stripe_refund_idstring nullable required
original_amountnumber nullable
already_refundednumber nullable
remaining_refundablenumber nullable

Changes

No recorded changes to this operation across all 1 revision of this API.