Resume an order

Restarts payments on a paused subscription. The order's status becomes active.

  • Upcoming scheduled payments go back to scheduled.
  • Payments that fell due while the order was paused are skipped. They aren't collected.
  • unpause_collection_config sets when the next payment is taken. Send update to charge it now and start a new billing cycle from today. Send default, or leave it out, to collect it on its usual date. These match the dashboard's Collect payment now and Collect payment on schedule options.
  • A value you sent when you paused the order only applies when the order resumes by itself on its pause_until_date. When you resume it with this call, only the value sent here counts.

You can resume an order when its available_actions.resume is true. Only paused orders can be resumed.

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
string
enum

Optional. Used only when the subscription has 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.

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