Pause an order

Pauses the order's payments. The order's status becomes paused, and nothing is collected until it resumes.

  • To pause until a date, send pause_until_date. The order resumes on that date.
  • To pause with no end date, send an empty body. The order stays paused until you resume it.

You can pause an order when its available_actions.pause is true.

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.

integer
required
≥ 1

ID of the order.

Body Params
date-time

Optional. When the order resumes, in ISO 8601, such as 2026-09-01T00:00:00.000Z. Leave it out to pause with no end date. This also clears a date set by an earlier pause.

string
enum

Optional. When the next payment is taken after the order resumes on pause_until_date. default: on the next scheduled date. update: straight away.

Allowed:
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