Activates specific items within an order so they can be fulfilled, billed, and tracked for revenue.

Both the activation date and at least one line item identifier are mandatory; the request is
rejected with 400 Bad Request when either is missing.

The order itself must also be eligible: it must 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 number of line items 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

Your order number or ID - identifies which order contains the items you want to activate

Query Params
boolean

Set to true if you want immediate confirmation without waiting for processing to finish (recommended for large batches). Set to false to wait for complete results, which is honoured only while the line item count stays within the configured synchronous threshold

Body Params

Information about what to activate: the effective date for activation and which specific line items (products/services) to activate

Model for activating selected line items of a single order.

date-time | null

The date from which the selected line items become effective. This value is required; the
activation request is rejected when it is not supplied.

OrderLineItemIds
array of strings | null

Identifiers of the order line items to activate. At least one identifier is required; the
activation request is rejected when the array is null or empty.

OrderLineItemIds
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