Reschedule a scheduled payment

Changes the date or the amount of one scheduled payment. No money moves.

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.

  • A new scheduled_at sets the status back to scheduled. A declined payment is then collected on the new date.
  • The date change is recorded on the order. The customer may get an email about the new date.
  • A new amount is used for the next collection, in the payment's own currency. You can't change the currency.
  • Fields you leave out stay as they are. An empty scheduled_payment changes nothing.
  • status and failed_attempts are ignored if you send them. The request still succeeds.

You can change a payment that is scheduled, failed (soft declined) or rejected (hard declined). A payment that is complete, in review, merged, recovered, skipped or cancelled can't be changed.

To change the date or amount again, send another request.

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.

Body Params
scheduled_payment
object
required

The fields to change. Send one or both.

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