Retry a failed scheduled payment

Puts a declined scheduled payment back into automatic retries. This request doesn't charge the card.

A scheduled payment is a planned future collection on an instalment, subscription or metered order. It shows as one billing event in the order's payment timeline.

  • Use it on a payment that is failed (soft declined) or rejected (hard declined). Its status becomes failed, and automatic retries pick it up again.
  • Automatic retries only charge a payment that has retries left. A payment that has used all its retries isn't charged.
  • To charge the payment now, whatever its retry count, execute it instead.
  • A payment that is complete, in review, merged, recovered, skipped or cancelled can't be retried.
  • Send no body.

To stop the retries, skip the payment.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required
≥ 1

Your merchant profile ID. Required in every request.

Find it in the BillPro dashboard address, after /profiles/. For example, in /profiles/1234/orders the profile ID is 1234.

string
required

ID of the scheduled payment.

Responses

Language
Credentials
Bearer
API token
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json