Activate an order

PUT

/v1/orders/:orderNumber/activate

PUT

/v1/orders/:orderNumber/activate

from zuora import ZuoraClient
client = ZuoraClient(
    token="YOUR_TOKEN_HERE",
)
client.orders.put_order_activate(
    order_number="orderNumber",
)

{
  "success": true,
  "accountNumber": "A00000001",
  "invoiceNumbers": [
    "INV00000001"
  ],
  "orderLineItems": [
    {
      "id": "bd78c0522adf42c2aa0fccacc997fa20",
      "itemNumber": "116"
    }
  ],
  "orderNumber": "OM-00002",
  "paidAmount": "300",
  "paymentNumber": "P-00000002",
  "status": "Pending",
  "subscriptions": [
    {
      "status": "Pending Activation",
      "subscriptionNumber": "SM-00001"
    },
    {
      "status": "Pending Acceptance",
      "subscriptionNumber": "SM-00002"
    },
    {
      "status": "Active",
      "subscriptionNumber": "SM-00003"
    },
    {
      "status": "Pending Acceptance",
      "subscriptionNumber": "SM-00004"
    },
    {
      "status": "Suspended",
      "subscriptionNumber": "SM-00005"
    },
    {
      "status": "Active",
      "subscriptionNumber": "SM-00006"
    }
  ]
}

Note: This operation is only available if you have the Orders feature enabled. If you are an existing Zuora Subscribe and Amend customer, we recommend you enable Orders Harmonization to access the Orders feature. With Orders, you can access both existing functions for subscription and billing management and the new features on Zuora Billing.

Activate order is only available for draft orders.

Authentication

AuthorizationBearer

Use Bearer {{token}} in the Authorization header for authentication.

Path parameters

orderNumberstringRequiredformat: "string"

Order number of a order in which you are to activate.

Headers

Content-EncodingstringOptional

Include the Content-Encoding: gzip header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.

Zuora-Org-IdsstringOptional

Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.

The IDs must be a sub-set of the user’s accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user’s accessible orgs.

Response headers

Content-EncodingstringOptional

This header is returned if you specify the Accept-Encoding: gzip request header and the response contains over 1000 bytes of data.

Note that only the following MIME types support gzipped responses:

application/json
application/xml
text/html
text/csv
text/plain

RateLimit-LimitstringOptional

The request limit quota for the time window closest to exhaustion. See rate limits for more information.

RateLimit-Remainingdouble

The number of requests remaining in the time window closest to quota exhaustion. See rate limits for more information.

RateLimit-Resetdouble

The number of seconds until the quota resets for the time window closest to quota exhaustion. See rate limits for more information.

Zuora-Request-IdstringOptional

The Zuora internal identifier of the API call. You cannot control the value of this header.

Zuora-Track-IdstringOptional

A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.

Concurrency-Limit-TypestringOptional

The type of the concurrency limit, which can be Default, High-volume transactions, or Object Query.

For more information, see Concurrent request limits.

Concurrency-Limit-Limitinteger

The total number of the permitted concurrent requests.

For more information, see Concurrent request limits.

Concurrency-Limit-Remaininginteger

The remaining number of the permitted concurrent requests.

For more information, see Concurrent request limits.

Response

processIdstringOptional

The ID of the process that handles the operation.

reasonslist of objectsOptional

The container of the error code and message. This field is available only if the success field is false.

requestIdstringOptionalformat: "uuid"=36 characters

Unique identifier of the request.

successbooleanOptional

Indicates whether the call succeeded.

accountIdstringOptional<=32 characters

The account ID for the order. This field is returned instead of the accountNumber field if the returnIds query parameter is set to true.

accountNumberstringOptional<=50 characters

The account number for the order.

commitmentslist of objectsOptional

The commitments created by this order request.

creditMemoIdslist of stringsOptional

An array of the credit memo IDs generated in this order request. The credit memo is only available if you have the Invoice Settlement feature enabled. This field is returned instead of the creditMemoNumbers field if the returnIds query parameter is set to true.

creditMemoNumberslist of stringsOptional

An array of the credit memo numbers generated in this order request. The credit memo is only available if you have the Invoice Settlement feature enabled.

invoiceIdslist of stringsOptional

An array of the invoice IDs generated in this order request. Normally it includes one invoice ID only, but can include multiple items when a subscription was tagged as invoice separately. This field is returned instead of the invoiceNumbers field if the returnIds query parameter is set to true.

invoiceNumberslist of stringsOptional

An array of the invoice numbers generated in this order request. Normally it includes one invoice number only, but can include multiple items when a subscription was tagged as invoice separately.

orderIdstringOptional<=32 characters

The ID of the order created. This field is returned instead of the orderNumber field if the returnIds query parameter is set to true.

orderLineItemslist of objectsOptional

Order Line Items are non subscription based items created by an Order, representing transactional charges such as one-time fees, physical goods, or professional service charges that are not sold as subscription services.

With the Order Line Items feature enabled, you can now launch non-subscription and unified monetization business models in Zuora, in addition to subscription business models.

Note: The Order Line Items feature is now generally available to all Zuora customers. You need to enable the Orders feature to access the Order Line Items feature. As of Zuora Billing Release 313 (November 2021), new customers who onboard on Orders will have the Order Line Items feature enabled by default.

orderNumberstringOptional<=100 characters

The order number of the order created.

paidAmountstringOptional9-22 characters

The total amount collected in this order request.

paymentIdstringOptional<=32 characters

The payment Id that is collected in this order request. This field is returned instead of the paymentNumber field if the returnIds query parameter is set to true.

paymentNumberstringOptional<=32 characters

The payment number that is collected in this order request.

rampslist of objectsOptional

Note: This field is only available if you have the Ramps feature enabled. The Orders feature must be enabled before you can access the Ramps feature. The Ramps feature is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see Zuora Editions for pricing information coming October 2020.

The ramp definitions created by this order request.

refundslist of objectsOptional

Container for refunds.

statusenumOptional

Status of the order. Pending is only applicable for an order that contains a CreateSubscription order action.

Allowed values:

subscriptionIdslist of stringsOptional

Container for the subscription IDs of the subscriptions in an order. This field is returned if the returnIds query parameter is set to true.

writeOfflist of objectsOptional

Container for write-offs.

Errors

4XX

Client Request Error

500

Internal Server Error