Operator

Refund a paid invoice (all or part) with a credit note. Fresh operator session, reason required, idempotent per requestId

post/operator/billing/accounts/{organizationId}/refund

Request

  • Base URL: https://hostingsurge.com/api/v1
  • URL: https://hostingsurge.com/api/v1/operator/billing/accounts/{organizationId}/refund
  • Auth: one of:
    • HTTP bearer
    • API key in cookie __Host-hs_session

Path parameters

organizationIdstring uuid required

Request body

invoiceIdstring required
amountinteger

cents; default: everything still refundable on the invoice

reasonstring required

required: shown in the audit log verbatim

requestIdstring uuid required

generated once per confirmation dialog: repeating the request (double click, retry) never repeats the money movement

Response

Refunded

status'ok' required
referencestring nullable required

the Stripe object created (credit note, balance transaction) when any

replayboolean

Changes

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