Billing Runs: Retries a failed recurring charge on a billing run.
POST
/api/billing-runs/{runId}/results/{resultId}/retry-charge
deprecated
Requires: MerchantBilling.BillingRuns, MerchantBilling.BillingRuns.Retry, merchant scope.
Re-publishes the per-merchant fulfillment request with a fresh correlation id and transitions the result back to pending.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
runId
required |
path | string (uuid) | The billing run that owns the result. |
resultId
required |
path | string (uuid) | The per-merchant result to retry. |
suppressNulls
required |
query | boolean | If true, omit properties with null values. |
Request body
application/json
, required
| Field | Type | Description |
|---|
This request body has no documented fields.
Responses
204 The retry was dispatched.
| Field | Type | Description |
|---|
This response has no documented body fields.
400 The result is not a failed recurring charge, or is missing its contract binding.
| Field | Type | Description |
|---|
This response has no documented body fields.
404 No billing run or result exists with the specified ids.
| Field | Type | Description |
|---|
This response has no documented body fields.
403 Forbidden
| Field | Type | Description |
|---|
This response has no documented body fields.
401 Unauthorized
| Field | Type | Description |
|---|
This response has no documented body fields.
501 Not Implemented
| Field | Type | Description |
|---|
This response has no documented body fields.
500 Internal Server Error
| Field | Type | Description |
|---|
This response has no documented body fields.
default The request failed. The body carries the standard error envelope: a machine-readable `error.code`, a human-readable `error.message`, and `error.validationErrors` when the failure was a validation rejection. See the error-code reference in this document's description for the values `error.code` can take.
| Field | Type | Description |
|---|
This response has no documented body fields.
Errors
A failed request returns the platform error envelope. The
error reference lists every value
error.code can carry and shows the four response shapes.