# Activate an order 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. Endpoint: PUT /v1/orders/{orderNumber}/activate Version: 2026-02-20 Security: bearerAuth ## Header parameters: - `Accept-Encoding` (string) Include the Accept-Encoding: gzip header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a Content-Encoding header with the compression algorithm so that your client can decompress it. - `Content-Encoding` (string) 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-Track-Id` (string) A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote ('). - `Zuora-Entity-Ids` (string) An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header. - `Zuora-Org-Ids` (string) 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. - `Zuora-Version` (string) The minor API version. For a list of available minor versions, see API upgrades. ## Path parameters: - `orderNumber` (string, required) Order number of a order in which you are to activate. ## Response 200 fields (application/json): - `processId` (string) The ID of the process that handles the operation. - `reasons` (array) The container of the error code and message. This field is available only if the success field is false. - `reasons.code` (string) The error code of response. - `reasons.message` (string) The detail information of the error response - `requestId` (string) Unique identifier of the request. - `success` (boolean) Indicates whether the call succeeded. - `accountId` (string) The account ID for the order. This field is returned instead of the accountNumber field if the returnIds query parameter is set to true. - `accountNumber` (string) The account number for the order. - `commitments` (array) The commitments created by this order request. - `commitments.id` (string) ID of the commitment - `commitments.commitmentNumber` (string) Number of the commitment. - `commitments.type` (string) The type of the commitment. Enum: "MinCommitment", "MaxCommitment" - `commitments.startDate` (string) The start date of the commitment. - `commitments.endDate` (string) The end date of the commitment. - `commitments.status` (string) The status of the commitment. Enum: "Canceled", "Active" - `commitments.totalAmount` (number) The total amount of the commitment. - `commitments.schedules` (array) A list of Commitment schedule objects. - `commitments.schedules.id` (string) The ID of the schedule. - `commitments.schedules.startDate` (string) The start date of the schedule. - `commitments.schedules.endDate` (string) The end date of the schedule. - `commitments.schedules.totalAmount` (number) The total amount of the schedule. - `commitments.schedules.status` (string) The status of the schedule. Enum: "Active", "Evaluated", "Canceled" - `creditMemoIds` (array) 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. - `creditMemoNumbers` (array) 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. - `invoiceIds` (array) 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. - `invoiceNumbers` (array) 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. - `orderId` (string) The ID of the order created. This field is returned instead of the orderNumber field if the returnIds query parameter is set to true. - `orderLineItems` (array) [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_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](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature is now generally available to all Zuora customers. You need to enable the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature to access the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature. As of Zuora Billing Release 313 (November 2021), new customers who onboard on [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders) will have the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items) feature enabled by default. - `orderLineItems.id` (string) The sytem generated Id for the Order Line Item. - `orderLineItems.itemNumber` (string) The number for the Order Line Item. - `orderNumber` (string) The order number of the order created. - `paidAmount` (string) The total amount collected in this order request. - `paymentId` (string) 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. - `paymentNumber` (string) The payment number that is collected in this order request. - `ramps` (array) Note: This field is only available if you have the Ramps feature enabled. The [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders) feature must be enabled before you can access the [Ramps](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Ramps_and_Ramp_Metrics/A_Overview_of_Ramps_and_Ramp_Metrics) feature. The Ramps feature is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions) for pricing information coming October 2020. The ramp definitions created by this order request. - `ramps.rampNumber` (string) The number of the ramp definition. - `ramps.subscriptionNumber` (string) The number of the subscription that this ramp deal definition is applied to. - `refunds` (array) Container for refunds. - `refunds.number` (string) The refund number. Example: "R-00009564" - `refunds.refundInvoiceNumbers` (array) An array of the refunded invoice numbers generated in this order request. - `refunds.status` (string) The status of the refund. Enum: "Success", "Error" - `status` (string) Status of the order. Pending is only applicable for an order that contains a CreateSubscription order action. Enum: "Draft", "Pending", "Completed", "Scheduled" - `subscriptionIds` (array) Container for the subscription IDs of the subscriptions in an order. This field is returned if the returnIds query parameter is set to true. - `subscriptions` (array) This field is available only if you are on the latest Zuora API minor version, or you set the Zuora-Version request header to 223.0 or a later available version. To use this field in the method, you must set the Zuora-Version parameter to the minor version number in the request header. Container for the subscription numbers and statuses in an order. - `subscriptions.status` (string) Status of the subscription. Pending Activation and Pending Acceptance are only applicable for an order that contains a CreateSubscription order action. Enum: "Active", "Pending Activation", "Pending Acceptance", "Cancelled", "Suspended" - `subscriptions.subscriptionId` (string) Subscription ID of the subscription included in this order. This field is returned instead of the subscriptionNumber field if the returnIds query parameter is set to true. - `subscriptions.subscriptionNumber` (string) Subscription number of the subscription included in this order. - `subscriptions.subscriptionOwnerId` (string) Subscription owner account id of the subscription. - `subscriptions.subscriptionOwnerNumber` (string) Subscription owner account number of the subscription. - `writeOff` (array) Container for write-offs. - `writeOff.amount` (number) The amount written off from the invoice balance. - `writeOff.failedReason` (string) The reason of write-off failure. - `writeOff.invoiceNumber` (string) The number of the invoice that is written off. Example: "INV00051208" - `writeOff.status` (string) The status of the write-off. Enum: "Success", "Failed" - `writeOff.writeOffCreditMemoNumber` (string) The number of the credit memo that is written off. ## Response 500 fields (application/json): - `reasons` (array) Example: [{"code":"ObjectNotFound","message":"Notification definition with id 6e569e1e05f040eda51a927b140c0ac1 does not exist"}] - `reasons.code` (string) The error code of response. - `reasons.message` (string) The detail information of the error response ## Response 4XX fields (application/json): - `processId` (string) The ID of the process that handles the operation. - `reasons` (array) The container of the error code and message. This field is available only if the success field is false. - `reasons.code` (string) The error code of response. - `reasons.message` (string) The detail information of the error response - `requestId` (string) Unique identifier of the request. - `success` (boolean) Indicates whether the call succeeded.