Execute a scheduled payment now

Charges one scheduled payment now, instead of on its scheduled date.

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.

  • You can execute a payment that is scheduled, failed (soft declined) or rejected (hard declined). Any other status returns 403.
  • It charges the payment even if it has used all its automatic retries. Use it to retry a declined payment by hand.
  • A declined charge still returns 200. Read result to tell success from declined.
  • Sending the same request twice doesn't charge the customer twice.
  • A 502 means the charge failed partway, so it isn't known whether the card was charged. Show the scheduled payment to check its state before you try again.
  • Send no body.

A successful charge can't be undone here. To return the money, refund 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