BillKitRefunds
Create refund
Refund a payment, in full or in part.
POST/v1/refunds
Parameters
| Parameter | Description |
|---|---|
| amount_centsinteger | nulloptional | Amount to refund, in minor units of currency. Omit to refund the whole remaining balance. The refund that brings the total refunded to the full charge cancels the subscription, or marks a one-off payment refunded. Maximum 99999999. |
| one_shot_payment_idstring | nulloptional | The one-off payment to refund. Cannot be combined with payment_id or subscription_id. |
| payment_idstring | nulloptional | The subscription payment to refund. One of payment_id, subscription_id or one_shot_payment_id is required. |
| reasonstring | nulloptional | Why the refund was made. Recorded on the refund and copied to its credit note. At most 500 characters. |
| subscription_idstring | nulloptional | Refund the subscription's most recent payment. Use when payment_id is omitted. |
Returns
Returns a RefundResponse object.
Errors
| Status | Cause |
|---|---|
| 400 | The 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. |
| 401 | No credential, or one that does not authenticate. |
| 402 | The account is suspended (tenant_suspended), or the payment provider refused a charge or refund the call made (type: payment_error, code: payment_refused). |
| 403 | Authenticated, but not allowed: missing scope (insufficient_scope), a key of the wrong mode (mode_mismatch), or a refused origin. Needs the refunds:write scope. |
| 404 | No such object in this account and mode. |
| 409 | Conflicts with the object's current state (state_conflict, or a more specific code), or an operation still in flight (operation_pending). |
| 413 | The request body is larger than the API accepts. |
| 429 | Rate limited. Retry-After says when to try again. |
| 500 | Something failed on BillKit's side (type: api_error). Retry with the same Idempotency-Key. |
| 502 | The payment provider failed or did not answer. |
| 503 | Temporarily unable to serve. reason says whether the request was attempted. |
Other refunds operations
- List refunds GET /v1/refunds
- Get refund GET /v1/refunds/{refund_id}