Pause an order

Pauses a subscription's payments. The order's status becomes paused, and so do its upcoming scheduled payments. 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.

Only subscriptions can be paused. The order needs a card on file, and its status can't be complete, cancelled, paused, suspended or rejected. available_actions.pause tells you in advance.

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. The order doesn't return this date, so keep it if you need it.

string
enum

Optional. Used when the order resumes on pause_until_date with no upcoming scheduled payment left. update: the next payment is taken straight away. default: it's taken on the next date the schedule works out. It isn't used when you resume the order yourself.

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