Zuora Orders API
Orders are contractual agreements between merchants and customers. For more information about Orders, see Orders.
Zuora Orders API is one of 80 APIs that Zuora publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Order. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 18 operations across 15 paths, and defines 177 schemas. It is described by OpenAPI 3.2.0, at version 2023-12-15.
Requests are made against a single base URL, https://rest.zuora.com/.
18 operations
15 paths
177 schemas
1 DELETE7 GET4 POST6 PUT
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 18
Across 15 paths, the API surfaces 18 operations — 1 DELETE, 7 GET, 4 POST, 6 PUT. Each is listed below with its method, path, parameters, and response codes.
Orders 18
Orders are contractual agreements between merchants and customers. For more information about Orders, see Orders.
POST
/v1/orders/preview
Preview an order
POST
/v1/async/orders/preview
Preview an order asynchronously
POST
/v1/orders
Create an order
GET
/v1/orders
List orders
POST
/v1/async/orders
Create an order asynchronously
GET
/v1/orders/{orderNumber}
Retrieve an order
DELETE
/v1/orders/{orderNumber}
Delete an order
PUT
/v1/orders/{orderNumber}
Update an order
GET
/v1/async-jobs/{jobId}
Retrieve the status and response of a job
GET
/v1/orders/subscriptionOwner/{accountNumber}
List orders of a subscription owner
GET
/v1/orders/subscription/{subscriptionNumber}
List orders by subscription number
GET
/v1/orders/invoiceOwner/{accountNumber}
List orders of an invoice owner
PUT
/v1/orders/{orderNumber}/customFields
Update order custom fields
PUT
/v1/subscriptions/{subscriptionNumber}/customFields
Update subscription custom fields
PUT
/v1/orders/{orderNumber}/triggerDates
Update order action trigger dates
PUT
/v1/orders/{orderNumber}/activate
Activate an order
PUT
/v1/orders/{orderNumber}/cancel
Cancel an order
GET
/v1/orders/subscription/{subscription-key}/pending
List pending orders by subscription number
Schemas 177
The contract defines 177 schemas that model the data the API accepts and returns. The most detailed are OrderLineItemCommonRetrieveOrder (57 properties), OrderLineItemCommonPostOrder (43 properties), CreateOrderChargeOverride (43 properties), ChargeOverride (43 properties). Each schema is shown below with its type and property counts.
SubscriptionObjectCustomFields
object
Container for custom fields of a Subscription object.
PreviewOrderTriggerParams
object
Specifies when a charge becomes active.
2 properties
OwnerTransfer
object
Information about an order action of type OwnerTransfer. Note: The Owner Transfer feature is in Limited Availability. If you wish to have access to the feature…
12 properties
RemoveProduct
object
Information about an order action of type RemoveProduct. Either a rate plan or offer can be removed from a subscription through one order action, but not both;…
8 properties
RampResponse
object
7 properties
PreviewOrderChargeUpdate
object
8 properties
RecurringTieredPricingUpdate
CreateSubscribeToProduct
object
RatePlanFeatureOverride
object
Information about feature in rate plan.
4 properties
PutOrderCancelResponse
GetOrdersResponse
ChangePlan
object
Information about an order action of type ChangePlan. Note: The change plan type of order action is currently not supported for Billing - Revenue Integration.…
7 properties
CreateOrderChargeUpdate
object
The JSON object containing the information for a charge update in the 'UpdateProduct' type order action.
8 properties
RampIntervalChargeDeltaMetrics
object
11 properties
TriggerParams
object
Specifies when a charge becomes active.
5 properties
CreateOrderUpdateProductTriggerParams
object
Specifies when a charge becomes active.
2 properties
LastTerm
object
The length of the period for the current subscription term.
4 properties
1 required
CreatePMPayPalECPayPalNativeECPayPalCP
object
2 properties
POSTOrderAsyncRequestType
object
12 properties
1 required
JobResult
Note: The schema of the result nested field is the same as the response body schema of either the ["Create an order"](/api-references/api/operation/POSTOrder)…
CreatePaymentMethodACH
object
12 properties
DeliveryScheduleParams
object
8 properties
PaymentMethodObjectCustomFields
object
Container for custom fields of a payment method object.
RecurringDeliveryPricingUpdate
InvoiceItemPreviewResult
object
16 properties
CancelSubscription
object
Information about an order action of type CancelSubscription.
2 properties
1 required
RatePlanOverride
object
Rate plan associated with a subscription.
11 properties
1 required
PreviewContactInfo
object
6 properties
OrderRampIntervalMetrics
object
12 properties
UsageOveragePricingOverride
Pricing information about a usage charge that uses the "overage" charge model. In this charge model, the charge has an allowance of free units and a fixed pric…
PreviewOrderChargeOverride
object
Charge associated with a rate plan.
43 properties
1 required
OrderLineItemCommonRetrieveOrder
object
57 properties
CreateOrderSuspend
object
Information about an order action of type Suspend.
4 properties
1 required
RatePlanUpdate
object
Information about an order action of type UpdateProduct.
11 properties
PreviewOrderRatePlanUpdate
object
Information about an order action of type UpdateProduct.
9 properties
DiscountPricingOverride
object
Pricing information about a discount charge.
10 properties
PreviewOrderRatePlanOverride
object
Rate plan associated with a subscription.
9 properties
1 required
UsagePerUnitPricingOverride
Pricing information about a usage charge that uses the "per unit" charge model. In this charge model, the charge has a fixed price per unit consumed.
GetOrderSuspend
object
Information about an order action of type Suspend.
5 properties
ChargeOverride
object
Charge associated with a rate plan.
43 properties
1 required
RampChargeRequest
object
2 properties
PreviewOptions
object
4 properties
RecurringPerUnitPricingOverride
Pricing information about a recurring charge that uses the "per unit" charge model. In this charge model, the charge has a fixed price per unit purchased.
TaxInfo
object
Information about the tax exempt status of a customer account.
9 properties
GetOfferRatePlanOverride
object
Rate plan associated with a subscription.
10 properties
1 required
QuoteObjectFields
object
The fields populated for a quote when a quote is sent to Zuora Billing from Zuora Quote.
5 properties
RenewalTerm
object
2 properties
InitialTerm
object
The length of the period for the current subscription term.
4 properties
1 required
OneTimeTieredPricingOverride
object
Pricing information about a one-time charge that uses the "tiered pricing" charge model. In this charge model, the charge has cumulative pricing tiers that bec…
2 properties
RampRequest
object
Container of the ramp definitions. It is used to create, update, or remove the ramp definition for the new subscription.
5 properties
Account
TimeSlicedTcbNetMetrics
object
11 properties
ChargeUpdate
object
The JSON object containing the information for a charge update in the 'UpdateProduct' type order action.
7 properties
PriceIntervalWithPrice
object
4 properties
SoldToContact
processingOptionsOrdersAsync
object
The container for billing processing options and payment processing options. Note: This field is not supported in draft orders.
7 properties
POSTOrderPreviewRequestType
object
11 properties
2 required
OneTimeVolumePricingOverride
object
Pricing information about a one-time charge that uses the "volume pricing" charge model. In this charge model, the charge has a variable price per unit, depend…
3 properties
CreatePaymentMethodGooglePayAdyenChase
object
1 property
PreviewResult
object
The result of each type of preview. Returned only when the current request is preview call.
6 properties
RatePlanFeatureOverrideCustomFields
object
A container for custom fields of the feature.
PostOrderAccountPaymentMethod
Payment method to create for this new account. Supports all the payment methods that are supported in the "Create a payment method" operation. See [Create a pa…
OrderLineItemCustomFields
object
Container for custom fields of an Order Line Item object.
CreateOrderRatePlanUpdate
object
Information about an order action of type UpdateProduct.
10 properties
UsageFlatFeePricingUpdate
CreatePaymentMethodCCReferenceTransaction
object
3 properties
OrderObjectCustomFields
object
Container for custom fields of an Order object.
UsageTieredPricingUpdate
RampChargeResponse
object
1 property
OneTimeFlatFeePricingOverride
object
Pricing information about a one-time charge that uses the "flat fee" charge model. In this charge model, the charge has a fixed price.
2 properties
1 required
GetOfferRatePlanUpdate
object
Information about an order action of type UpdateProduct.
11 properties
processingOptionsOrdersWithDelayedCapturePayment
object
The container for billing processing options and payment processing options. Note: - This field is not supported in draft orders. - When you use the "Create an…
12 properties
ChangePlanChargeOverride
object
Charge associated with a rate plan.
43 properties
1 required
CreateOrderChargeOverride
object
Charge associated with a rate plan.
43 properties
1 required
POSTOrderPreviewAsyncRequestType
object
11 properties
2 required
OrdersRatePlanObjectCustomFields
object
Container for custom fields of the Rate Plan or Subscription Offer object. The custom fields of the Rate Plan object are used when rate plans are subscribed, a…
PUTOrderPatchRequestType
object
2 properties
PriceChangeParams
object
2 properties
PreviewOrderCreateSubscription
object
Information about an order action of type CreateSubscription.
13 properties
ChangePlanRatePlanOverride
object
Information about the new product rate plan to add.
8 properties
POSTOrderRequestType
object
14 properties
1 required
CreateOrderOrderLineItem
UsageFlatFeePricingOverride
Pricing information about a usage charge that uses the "flat fee" charge model. In this charge model, the charge has a fixed price.
CreateOrderCreateSubscriptionNewSubscriptionOwnerAccount
PUTOrderActionTriggerDatesRequestType
object
1 property
PreviewAccountInfo
object
Information about the account that will own the order.
5 properties
2 required
RecurringVolumePricingUpdate
CreatePaymentMethodApplePayAdyen
object
1 property
AccountObjectCustomFields
object
Container for custom fields of an Account object.
CreateOrderResume
object
Information about an order action of type Resume.
5 properties
1 required
UsagePerUnitPricingUpdate
CreateOrderCreateSubscription
object
Information about an order action of type CreateSubscription.
14 properties
CreateOrderPricingUpdate
object
13 properties
OrderAction
object
Represents the processed order action.
19 properties
RecurringFlatFeePricingUpdate
OrderItem
object
Represents an order item. An order item is a sales item within an order in the context of the recurring subscription business model. It can be a unit of produc…
6 properties
DiscountApplyDetail
object
2 properties
2 required
CreateOrderChangePlanRatePlanOverride
object
Information about the new product rate plan to add.
11 properties
TimeSlicedMetrics
object
8 properties
EndConditions
object
Specifies when a charge becomes inactive.
5 properties
SoldToContactPostOrder
ContactObjectCustomFields
object
Container for custom fields of a Contact object.
CreateChangePlan
object
Information about an order action of type changePlan. Use the change plan type of order action to replace the existing rate plans in a subscription with other…
9 properties
1 required
TimeSlicedElpNetMetrics
object
10 properties
AccountCreditCardHolder
object
Information about the cardholder of a credit card payment method associated with an account. If you do not provide information about the cardholder, Zuora uses…
9 properties
BillToContactPostOrder
PostOrderResponseType
OrderDeltaMrr
object
Order Delta Mrr. This is a metric that reflects the change to the TCV on rate plan charge object as the result of the order.
OfferOverride
object
Offer associated with a subscription. Note: You must enable the Offers feature to access this field. The Offers feature is in the Early Adopter phase. We are a…
6 properties
PUTOrderRequestType
object
14 properties
1 required
ChargePreviewMetrics
object
8 properties
OrderLineItemRetrieveOrder
RampIntervalRequest
object
Container for the intervals that the ramp is split into in its timeline. Zuora can report metrics for this specific period.
4 properties
2 required
CreateOrderProductOverride
object
Information about the subscribed offer
4 properties
TimeSlicedNetMetrics
object
10 properties
UsageVolumePricingUpdate
ChargeModelDataOverride
object
Container for charge model configuration data. Note: This field is only available if you have the High Water Mark, Pre-Rated Pricing, or Multi-Attribute Pricin…
3 properties
GetOrderResume
object
Information about an order action of type Resume.
6 properties
CreateOrderOrderAction
object
15 properties
1 required
OrderDeltaTcb
object
Order Delta Tcb. This is a metric that reflects the change to the estimated billing on Rate Plan Charge object, or the estimated billing for an Order Line Item…
UsageTieredWithOveragePricingUpdate
RampIntervalChargeMetrics
object
14 properties
OrderDeltaTcv
object
Order Delta Tcv. This is a metric that reflects the change to the TCV on Rate Plan Charge object, or the Total Contracted Value for an Order Line Item as the r…
RecurringFlatFeePricingOverride
Pricing information about a recurring charge that uses the "flat fee" charge model. In this charge model, the charge has a fixed price.
OrderActionObjectCustomFields
object
Container for custom fields of an Order Action object.
CommonResponseType
object
3 properties
CreateOrderTermsAndConditions
object
Information about an order action of type TermsAndConditions.
14 properties
PUTSubscriptionPatchRequestType
object
2 properties
CreateOrderCreateSubscriptionNewSubscriptionOwnerAccountPaymentMethod
Payment method to create for this new account. Supports all the payment methods that are supported in the "Create a payment method" operation. See [Create a pa…
PreviewOrderPricingUpdate
object
12 properties
CreateOrderTriggerParams
object
Specifies when a charge becomes active.
5 properties
OneTimePerUnitPricingOverride
object
Pricing information about a one-time charge that uses the "per unit" charge model. In this charge model, the charge has a fixed price per unit purchased.
4 properties
CreateOrderRatePlanFeatureOverride
object
Information about feature in rate plan.
3 properties
1 required
BillToContact
CreateOrderRatePlanOverride
object
Information about an order action of type addProduct. If you want to create a pending order through the "Add product" order action, and if the charge's trigger…
11 properties
PreviewOrderOrderAction
object
15 properties
1 required
PostOrderPreviewResponseType
TriggerDate
object
2 properties
CreatePaymentMethodCardholderInfo
object
Container for cardholder information. This container field is required for credit card payment methods. The nested cardHolderName field is required.
9 properties
1 required
CreatePaymentMethodCommon
object
4 properties
DiscountPricingUpdate
object
4 properties
DataAccessControlField
object
Container for the data access control field.
RecurringDeliveryPricingOverride
Pricing information about a recurring charge that uses the Delivery Pricing charge model. In this charge model, the charge has a fixed price. This field is onl…
UsageTieredWithOveragePricingOverride
Pricing information about a usage charge that uses the "tiered with overage" charge model. In this charge model, the charge has cumulative pricing tiers that b…
RecurringTieredPricingOverride
Pricing information about a recurring charge that uses the "tiered pricing" charge model. In this charge model, the charge has cumulative pricing tiers that be…
RecurringVolumePricingOverride
Pricing information about a recurring charge that uses the "volume pricing" charge model. In this charge model, the charge has a variable price per unit, depen…
processingOptionsOrders
object
The container for billing processing options and payment processing options. Note: - This field is not supported in draft orders. - When you use the "Create an…
12 properties
OrderRampMetrics
object
10 properties
RenewSubscription
object
Information about an order action of type RenewSubscription.
10 properties
CreateOfferRatePlanOverride
object
Information about an order action of type addProduct.
10 properties
CreatePaymentMethodPayPalAdaptive
object
1 property
UsageVolumePricingOverride
Pricing information about a usage charge that uses the "volume pricing" charge model. In this charge model, the charge has a variable price per unit, depending…
TermsAndConditions
object
Information about an order action of type TermsAndConditions.
14 properties
BillingUpdate
object
1 property
subscribeToProduct
object
creditCard
object
Default payment method associated with an account. Only credit card payment methods are supported.
6 properties
CreateOrderOfferUpdate
object
Information about an order action of type UpdateProduct.
4 properties
GetAllOrdersResponseType
object
3 properties
PUTOrderTriggerDatesResponseType
UsageOveragePricingUpdate
PricingUpdate
object
13 properties
CreateOrderCreateSubscriptionNewSubscriptionOwnerAccountPaymentMethodCreditCard
object
13 properties
RampIntervalResponse
object
4 properties
RatePlanChargeObjectCustomFields
object
Container for custom fields of a Rate Plan Charge object.
RecurringPerUnitPricingUpdate
orderMetric
object
The set of order metrics for an order action.
9 properties
Order
object
Represents the order information that will be returned in the GET call.
18 properties
OfferUpdate
object
Information about an order action of type UpdateProduct.
4 properties
CreateSubscription
object
Information about an order action of type CreateSubscription.
14 properties
OrderDeltaMetric
object
13 properties
GetOrderResponse
CreatePaymentMethodBankTransfer
object
11 properties
OrderLineItemCommonPostOrder
object
43 properties
PriceIntervalWithTiers
object
4 properties
UsageTieredPricingOverride
Pricing information about a usage charge that uses the "tiered pricing" charge model. In this charge model, the charge has cumulative pricing tiers that become…
CreatePaymentMethodCreditCard
object
14 properties
ChargeTier
object
5 properties
4 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Zuora 12
Other APIs Zuora publishes across the network.
Zuora V1 API
Zuora Accounting Codes API
Zuora Accounting Periods API
Zuora Accounts API
Zuora Actions API
Zuora Aggregate Queries API
Zuora API Health API
Zuora Attachments API
Zuora Bill Run API
Zuora Bill Run Health API
Zuora Billing Documents API
Zuora Billing Preview Run API
#Order
Where this information came from
This is an independent, third-party profile of Zuora Orders API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.