Activate an Order

Activates an order, making it live and effective in the system. This typically means the order
starts generating revenue, billing cycles begin, or services/products become available to the customer.
The activation date determines when the order takes effect and influences billing calculations.

The activation date is mandatory; the request is rejected with 400 Bad Request when it is missing.
The order must also exist, must not already be activated, must be in a status that permits
activation, and must be flagged as primary for processing.

Note that isAsync is a request, not a guarantee. Setting it to false only
results in synchronous processing while the order's line item count stays within the configured
threshold for synchronous activation. Above that threshold the work is queued regardless, and
beyond the configured batch size it is split into batches. Whenever the work is queued the
response carries a job identifier that can be polled through the job status endpoints.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The unique identifier of the order to activate

Query Params
boolean

Whether to process the activation asynchronously (true) or wait for completion (false). A value of false is honoured only while the order's line item count stays within the configured synchronous threshold

Body Params

The activation details including the required effective date when the order should become active

Model for activating a single order.

date-time | null

The date from which the order becomes effective. This value is required; the activation request
is rejected when it is not supplied.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

204

No Content

500

Internal Server Error

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json