Accounting Codes7

Accounting Periods9

Accounts9

Actions5

Admin Integrations4

Aggregate Queries4

API Health3

Attachments5

Audit Logs5

Audit Trail5

Bill Run6

Bill Run Health1

Billing Documents4

Billing Preview Run2

Bulk Data8

Catalog2

Catalog Groups5

Commerce13

Commitments7

Configurable Payment Retry18

Configuration Templates9

Contact Snapshots1

Contacts6

Credit Memos31

Custom Event Triggers5

Custom Exchange Rates1

Custom Object Definitions5

Custom Object Jobs6

Custom Object Records7

Custom Payment Method Types5

Custom Scheduled Events5

Data Backfill13

Data Ingestion2

Data Labeling2

Data Queries4

Debit Memos24

Delivery Adjustments5

Describe1

E-Invoicing33

E-Reporting16

Electronic Payments Health2

Event Store5

Files3

Fulfillments8

Hosted Pages1

Imports2

Invoice Schedules9

Invoices22

Journal Runs4

Mass Updater3

Metadata2

Metadata Deployment6

Meters7

Notifications29

OAuth1

Object Queries100

Omnichannel Subscriptions3

Operations5

Order Actions1

Order Line Items3

Orders19

Payment Authorization2

Payment Gateway Reconciliation4

Payment Gateways2

Payment Method Snapshots1

Payment Method Transaction Logs1

Payment Method Updater2

Payment Methods16

Payment Profiles1

Payment Runs7

Payment Schedules16

Payment Transaction Logs1

Payments15

Prepaid with Drawdown3

Product Charge Definitions7

Product Rate Plan Charge Tiers2

Product Rate Plan Charges5

Product Rate Plan Definitions4

Product Rate Plans7

Products4

Ramps5

Rate Plans1

Refunds9

Regenerate4

RSA Signatures2

SCIM23

Sequence Sets5

Settings2

Sign Up1

Subscriptions14

Summary Journal Entries6

Summary Statements2

Tax Health1

Taxation Items4

Test Environment Jobs4

Test Environment Notifications5

Test Environments2

Usage6

Workflows17

Zuora Revenue Integration1

Order Line Items

Update an order line item

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. If you are a new customer who onboard on Orders Harmonization and want to enable the Order Line Items feature, submit a request at Zuora Global Support. If you are an existing Orders or Orders Harmonization customer and want to enable the Order Line Items feature, submit a request at Zuora Global Support. Updates a specified order line item. The following tutorials demonstrate how to use this operation:

put/v1/order-line-items/{itemId}

Path parameters

itemIdstring UUID required

The id of the Order Line Item to update.

Headers

Accept-Encodingstring

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-Encodingstring

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-Idstring

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-Idsstring

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-Idsstring

Comma separated IDs. If you have <a href="https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org" target="_blank">Zuora Multi-Org</a> 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-Versionstring

The minor API version.

For a list of available minor versions, see API upgrades.

Request body

UOMstring

Specifies the units to measure usage.

You can update this field only for a sales OLI and only when the sales OLI is in the Executing state (when the itemState field is set as Executing).

accountingCodestring

The accountingCode for the Order Line Item (OLI).

You can update this field only for a sales OLI and only when the sales OLI is in the Executing state (when the itemState field is set as Executing).

adjustmentLiabilityAccountingCodestring

The accounting code on the Order Line Item object. This field is available only if you have enabled <a href="https://docs.zuora.com?resourceId=billing-order-to-revenue" target="_blank">Order to Revenue</a> or <a href="https://docs.zuora.com?resourceId=revenue-billing-integration" target="_blank">Zuora Billing - Revenue Integration</a> feature.

You can update this field only for a sales OLI and only when the sales OLI is in the Executing state (when the itemState field is set as Executing).

adjustmentRevenueAccountingCodestring

You can update this field only for a sales OLI and only when the sales OLI is in the Executing state (when the itemState field is set as Executing).

amountPerUnitnumber

The actual charged amount per unit for the Order Line Item (OLI).

You can update this field only for a sales OLI and only when the sales OLI is in the Executing state (when the itemState field is set as Executing).

billTargetDatestring date

The target date for the Order Line Item (OLI) to be picked up by bill run for generating billing documents.

To generate billing documents for an OLI, you must set this field and set the itemState field to SentToBilling.

You can update this field for a sales or return OLI only when the OLI is in the Executing or Booked state.

billTostring

The ID of the bill-to contact of an order line item. Specify an existing contact under the billing account as the bill-to contact of the order line item. The billing account is the order account.

You can update this field only for a sales OLI and only when the sales OLI is in the Executing state (when the itemState field is set as Executing).

billingRule'TriggerWithoutFulfillment' | 'TriggerAsFulfillmentOccurs'

The rule for billing of the Order Line Item (OLI).

You can update this field for a sales or return OLI only when it is in the Executing state (when the itemState field is set as Executing).

contractAssetAccountingCodestring

You can update this field only for a sales OLI and only when the sales OLI is in the Executing state (when the itemState field is set as Executing).

contractLiabilityAccountingCodestring

You can update this field only for a sales OLI and only when the sales OLI is in the Executing state (when the itemState field is set as Executing).

contractRecognizedRevenueAccountingCodestring

You can update this field only for a sales OLI and only when the sales OLI is in the Executing state (when the itemState field is set as Executing).

customFieldsOrderLineItemCustomFields

Container for custom fields of an Order Line Item object.

deferredRevenueAccountingCodestring

The deferred revenue accounting code for the Order Line Item (OLI).

You can update this field only for a sales OLI and only when the sales OLI is in the Executing state (when the itemState field is set as Executing).

descriptionstring

The description of the Order Line Item (OLI).

You can update this field for a sales or return OLI only when the OLI is in the Executing state (when the itemState field is set as Executing).

excludeItemBillingFromRevenueAccountingboolean

Indicates whether to exclude the related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting.

Note: This field is only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled.

excludeItemBookingFromRevenueAccountingboolean

Indicates whether to exclude the related rate plan charges and order line items from revenue accounting.

Note: This field is only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled.

inlineDiscountPerUnitnumber

You can update this field only for a sales OLI and only when the sales OLI is in the Executing state (when the itemState field is set as Executing).

Use this field in accordance with the inlineDiscountType field, in the following manner:

If the inlineDiscountType field is set as Percentage, this field specifies the discount percentage for each unit of the order line item. For exmaple, if you specify 5 in this field, the discount percentage is 5%.
If the inlineDiscountType field is set as FixedAmount, this field specifies the discount amount on each unit of the order line item. For exmaple, if you specify 10 in this field, the discount amount on each unit of the order line item is 10.

Once you set the inlineDiscountType, inlineDiscountPerUnit, and listPricePerUnit fields, the system will automatically generate the amountPerUnit field. You shall not set the amountPerUnit field by yourself.

inlineDiscountType'Percentage' | 'FixedAmount' | 'None'

You can update this field only for a sales OLI and only when the sales OLI is in the Executing state (when the itemState field is set as Executing).

Use this field to specify the inline discount type, which can be Percentage, FixedAmount, or None. The default value is Percentage.

Use this field together with the inlineDiscountPerUnit field to specify inline discounts for order line items. The inline discount is applied to the list price of an order line item.

isAllocationEligibleboolean

This field is used to identify if the charge segment is allocation eligible in revenue recognition.

Note: The field is only available if you have the <a href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue" target="_blank">Order to Revenue</a> feature enabled. To enable this field, submit a request at <a href="https://support.zuora.com/" target="_blank">Zuora Global Support</a>.

isUnbilledboolean

This field is used to dictate how to perform the accounting during revenue recognition.

itemNamestring

The name of the Order Line Item (OLI).

You can update this field for a sales or return OLI only when the OLI is in the Executing state (when the itemState field is set as Executing).

itemState'Executing' | 'Booked' | 'SentToBilling' | 'Complete' | 'Canceled'

The state of the Order Line Item (OLI). See State transitions for an order, order line item, and fulfillment for more information.

To generate invoice for an OLI, you must set this field to SentToBilling and set the billTargetDate field .

You can update this field for a sales or return OLI only when the OLI is in the Executing or 'Booked' or SentToBillingstate (when the itemState field is set as Executing or SentToBilling).

itemType'Product' | 'Fee' | 'Services'

The type of the Order Line Item (OLI).

You can update this field only for a sales OLI and only when the sales OLI is in the Executing state (when the itemState field is set as Executing).

listPricePerUnitnumber

The list price per unit for the Order Line Item (OLI).

You can update this field only for a sales OLI and only when the sales OLI is in the Executing state (when the itemState field is set as Executing).

ownerAccountNumberstring

Use this field to assign an existing account as the owner of an order line item.

You can update this field only for a sales OLI and only when the sales OLI is in the Executing state (when the itemState field is set as Executing).

productCodestring

The product code for the Order Line Item (OLI).

You can update this field only for a sales OLI and only when the sales OLI is in the Executing state (when the itemState field is set as Executing).

purchaseOrderNumberstring

Used by customers to specify the Purchase Order Number provided by the buyer.

You can update this field only for a sales OLI and only when the sales OLI is in the Executing state (when the itemState field is set as Executing).

quantitynumber

The quantity of units, such as the number of authors in a hosted wiki service.

You can update this field for a sales or return OLI only when the OLI in the Executing state (when the itemState field is set as Executing).

recognizedRevenueAccountingCodestring

The recognized revenue accounting code for the Order Line Item (OLI).

You can update this field only for a sales OLI and only when the sales OLI is in the Executing state (when the itemState field is set as Executing).

relatedSubscriptionNumberstring

Use this field to relate an order line item to an subscription. Specify this field to the subscription number of the subscription to relate.

You can update this field only for a sales OLI and only when the sales OLI is in the Executing state (when the itemState field is set as Executing).

revenueRecognitionRulestring

The Revenue Recognition rule for the Order Line Item (OLI).

You can update this field only for a sales OLI and only when the sales OLI is in the Executing state (when the itemState field is set as Executing).

revenueRecognitionTiming'Upon Billing Document Posting Date' | 'Upon Order Activation Date'

Specifies the type of revenue recognition timing.

Predefined options are listed as enum values in this API Reference. Other options might also be avaliable depending on the <a href="https://docs.zuora.com?resourceId=billing-configure-revenue-settings" target="_blank">revenue recognition policy configuration</a> in the Zuora Billing UI.

You can update this field only for a sales OLI and only when the sales OLI is in the Executing state (when the itemState field is set as Executing).

Note: This field is only available if you have the Order to Revenue feature enabled.

revenueAmortizationMethod'Immediate' | 'Ratable Using Start And End Dates'

Specifies the type of revenue amortization method.

You can update this field only for a sales OLI and only when the sales OLI is in the Executing state (when the itemState field is set as Executing).

Note: This field is only available if you have the Order to Revenue feature enabled.

invoiceGroupNumberstring nullable

The number of the invoice group associated with the order line item.

After enabling the Invoice Grouping feature, you can specify invoice group numbers to bill subscriptions and order line items based on specific criteria. For the same account, Zuora generates separate invoices for subscriptions and order line items, each identified by unique invoice group numbers. For more information, see Invoice Grouping.

Note:

If you have the <a href="https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is null in the response body.
If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request during subscription creation, the value of this field is automatically set to null in the response body.
You can specify this field on a sales order line item when its state (that is, the itemState field) is Executing, Booked, or SentToBilling.

sequenceSetIdstring

The ID or number of the sequence set associated with the order line item.

Note:

If you have the <a href="https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is null in the response body.
If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request during subscription creation, the value of this field is automatically set to null in the response body.
You can specify this field on a sales order line item when its state (that is, the itemState field) is Executing, Booked, or SentToBilling.

paymentTermstring

The payment term name associated with the order line item.

Note:

If you have the <a href="https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is null in the response body.
If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request during subscription creation, the value of this field is automatically set to null in the response body.
You can specify this field on a sales order line item when its state (that is, the itemState field) is Executing, Booked, or SentToBilling.

invoiceTemplateIdstring

The ID of the invoice template associated with the order line item.

Note:

If you have the <a href="https://docs.zuora.com?resourceId=billing-attributes-for-flexible-billing" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is null in the response body.
If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request during subscription creation, the value of this field is automatically set to null in the response body.
You can specify this field on a sales order line item when its state (that is, the itemState field) is Executing, Booked, or SentToBilling.

shipTostring

Use this field to assign an existing account as the ship-to contact of an order line item, by the following rules:

If the ownerAccountNumber field is set, then this field must be the ID of a contact that belongs to the owner account of the order line item.
If the ownerAccountNumber field is not set, then this field must be the ID of a contact that belongs to the billing account of the order line item. The billing account is the order account.

You can update this field only for a sales OLI and only when the sales OLI is in the Executing state (when the itemState field is set as Executing).

soldTostring

Use this field to assign an existing account as the sold-to contact of an order line item, by the following rules:

If the ownerAccountNumber field is set, then this field must be the ID of a contact that belongs to the owner account of the order line item.
If the ownerAccountNumber field is not set, then this field must be the ID of a contact that belongs to the billing account of the order line item. The billing account is the order account.

You can update this field only for a sales OLI and only when the sales OLI is in the Executing state (when the itemState field is set as Executing).

taxCodestring

The tax code for the Order Line Item (OLI).

You can update this field only for a sales OLI and only when the sales OLI is in the Executing state (when the itemState field is set as Executing).

taxMode'TaxInclusive' | 'TaxExclusive'

The tax mode for the Order Line Item (OLI).

You can update this field only for a sales OLI and only when the sales OLI is in the Executing state (when the itemState field is set as Executing).

transactionEndDatestring date

The date a transaction is completed. The default value of this field is the transaction start date. Also, the value of this field should always equal or be later than the value of the transactionStartDate field.

You can update this field for a sales or return OLI only when the OLI is in the Executing state (when the itemState field is set as Executing).

transactionStartDatestring date

The date a transaction starts. The default value of this field is the order date.

You can update this field for a sales or return OLI only when the OLI is in the Executing state (when the itemState field is set as Executing).

unbilledReceivablesAccountingCodestring

You can update this field only for a sales OLI and only when the sales OLI is in the Executing state (when the itemState field is set as Executing).

Response

processIdstring

The ID of the process that handles the operation.

requestIdstring uuid

Unique identifier of the request.

successboolean

Indicates whether the call succeeded.

Update an order line item

Path parameters

Headers

Request body

Response

Changes