---
title: "Activate an order"
method: PUT
path: "/v1/orders/{orderNumber}/activate"
tags: ["Orders"]
---

# Activate an order

`PUT /v1/orders/{orderNumber}/activate`

**Note:** This operation is only available if you have the [Orders](https://docs.zuora.com?resourceId=billing-overview-orders) feature enabled. If you are an existing Zuora <a href="https://docs.zuora.com?resourceId=billing-subscribe-and-amend" target="_blank">Subscribe and Amend</a> customer, we recommend you enable <a href="https://docs.zuora.com?resourceId=billing-overview-orders" target="_blank">Orders Harmonization</a> to access the <a href="https://docs.zuora.com?resourceId=billing-overview-orders" target="_blank">Orders</a> feature. With Orders, you can access both existing functions for subscription and billing management and the <a href="https://docs.zuora.com?resourceId=billing-orders-harmonization" target="_blank">new features</a> on Zuora Billing.

Activate order is only available for draft orders.

## Path parameters

- `orderNumber` string, string, required

## Headers

- `Accept-Encoding` string
- `Content-Encoding` string
- `Zuora-Track-Id` string
- `Zuora-Entity-Ids` string
- `Zuora-Org-Ids` string
- `Zuora-Version` string

## Response `200`

OK

- PostOrderResponseType — Response information of orders.
  - `processId` string — The ID of the process that handles the operation.
  - `reasons` object[] — The container of the error code and message. This field is available only if the `success` field is `false`.
    - `code` string — The error code of response.
    - `message` string — The detail information of the error response
  - `requestId` string, uuid — 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` CommitmentOutput[] — The commitments created by this order request.
    - `id` string — ID of the commitment
    - `commitmentNumber` string — Number of the commitment.
    - `prepaymentType` 'NotPrepaid' | 'FullyPrepaid' — The prepayment type of the commitment.
    - `type` 'MinCommitment' | 'MaxCommitment' — The type of the commitment.
    - `startDate` string, date — The start date of the commitment.
    - `endDate` string, date — The end date of the commitment.
    - `status` 'Cancel1ed' | 'Active' | 'Evaluated' | 'CancelledPendingEvaluation' — The status of the commitment.
    - `totalAmount` number, double — The total amount of the commitment.
    - `schedules` object[] — A list of Commitment schedule objects.
      - `id` string — The ID of the schedule.
      - `startDate` string — The start date of the schedule.
      - `endDate` string — The end date of the schedule.
      - `prepaymentDefinition` PrepaymentDefinition — The prepayment definition for the commitment schedule.
        - `prepaymentFrequency` 'Month' | 'Quarter' | 'Semi_Annual' | 'Annual' | 'Eighteen_Months' | 'Two_Years' | 'Three_Years' | 'Five_Years' | 'Specific_Months' | 'Week' | 'Specific_Weeks' | 'Specific_Days' — The prepayment frequency for the prepayment definition. If the value is `Specific_Months`, `Specific_Weeks`, or `Specific_Days`, use the `specificFrequency` field to specify the duration.
        - `specificFrequency` integer — The specific frequency length. This field is required when `prepaymentFrequency` is `Specific_Months`, `Specific_Weeks`, or `Specific_Days`.
        - `customFields` object — Container for custom fields of a prepayment definition object.
      - `totalAmount` number, double — The total amount of the schedule.
      - `status` 'Active' | 'Evaluated' | 'Cancelled' | 'CancelledPendingEvaluation' — The status of the schedule.
  - `creditMemoIds` string[] — 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` string[] — 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` string[] — 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` string[] — 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` object[] — [Order Line Items](https://docs.zuora.com?resourceId=billing-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://docs.zuora.com?resourceId=billing-order-line-items) feature is now generally available to all Zuora customers. You need to enable the [Orders](https://docs.zuora.com?resourceId=billing-overview-orders) feature to access the [Order Line Items](https://docs.zuora.com?resourceId=billing-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://docs.zuora.com?resourceId=billing-order-line-items) feature enabled by default.
    - `id` string — The sytem generated Id for the Order Line Item.
    - `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.
  - `paymentStatus` 'Error' | 'Processing' | 'Failed' — Specifies the outcome of payment collection for the order. If `collectPayment` is `true` and `allowPaymentFailure` is `true`, the order can still succeed even when payment does not, and this field shows the payment result in the response. The possible values are: * Error: Payment failed with a gateway decline, while the order, subscription, and invoice were still created successfully when `allowPaymentFailure` is `true`. * Processing: Payment was still in progress or not finalized in the response example for a simulated payment timeout, while the order succeeded. * Failed: Payment failed and the response included `paymentErrorCode` and `paymentErrorMessage`, while the order still completed successfully.
  - `ramps` object[] — **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://docs.zuora.com?resourceId=billing-overview-ramp-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.
    - `rampNumber` string — The number of the ramp definition.
    - `subscriptionNumber` string — The number of the subscription that this ramp deal definition is applied to.
  - `refunds` object[] — Container for refunds.
    - `number` string — The refund number.
    - `refundInvoiceNumbers` string[] — An array of the refunded invoice numbers generated in this order request.
    - `status` 'Success' | 'Error' — The status of the refund.
  - `status` 'Draft' | 'Pending' | 'Completed' | 'Scheduled' — Status of the order. `Pending` is only applicable for an order that contains a `CreateSubscription` order action.
  - `subscriptionIds` string[] — 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` object[] — 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.
    - `status` 'Active' | 'Pending Activation' | 'Pending Acceptance' | 'Cancelled' | 'Suspended' — Status of the subscription. `Pending Activation` and `Pending Acceptance` are only applicable for an order that contains a `CreateSubscription` order action.
    - `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`.
    - `subscriptionNumber` string — Subscription number of the subscription included in this order.
    - `subscriptionOwnerId` string — Subscription owner account id of the subscription.
    - `subscriptionOwnerNumber` string — Subscription owner account number of the subscription.
  - `writeOff` object[] — Container for write-offs.
    - `amount` number — The amount written off from the invoice balance.
    - `failedReason` string — The reason of write-off failure.
    - `invoiceNumber` string — The number of the invoice that is written off.
    - `status` 'Success' | 'Failed' — The status of the write-off.
    - `writeOffCreditMemoNumber` string — The number of the credit memo that is written off.

## Other responses

- `500` — Internal Server Error
- `4XX` — Request Errors

---

[API](https://skmtc.dev/zuora/apis/api-reference.md) · [All operations](https://skmtc.dev/zuora/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/zuora/api-reference/revisions/d11e237f3e54/schema)