Skip scheduled payments

Skips one or more scheduled payments on an order. A skipped payment is never collected.

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 skip payments that are scheduled, failed (soft declined) or rejected (hard declined).
  • IDs that don't belong to this order are ignored.
  • If none of the IDs can be skipped, nothing changes and you get a 422.
  • Skipping the latest payment of a subscription doesn't end it. The next payment is still scheduled.
  • The response is the order's full schedule, oldest first. The skipped payments now have status skipped.

You can't undo a skip. A skipped payment can't be rescheduled, executed or retried.

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 order.

Body Params
scheduled_payment_ids
array of integers
required

IDs of the scheduled payments to skip, such as [5123]. They must be on this order.

scheduled_payment_ids*
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