Sign in
Object Queries

Retrieve an order action

Retrieve the details of a specific Order Action object.

get/object-query/order-actions/{key}

Path parameters

keystring required

Object ID or Number.

Query parameters

pageSizeinteger

The maximum number of results to return in a single page. If the specified pageSize is less than 1 or greater than 99, Zuora will return a 400 error.

cursorstring

A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with next_page=W3sib3JkZXJ=, your subsequent call can include cursor=W3sib3JkZXJ= in order to fetch the next page of the list.

sort[]string[]

A case-insensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. accountnumber.ASC) or descending (e.g. accountnumber.DESC). You cannot sort on properties in arrays. If the array-type properties are specified for the sort[] parameter, they are ignored.

expand[]string[]

Allows you to expand responses by including related object information in a single call.

filter[]string[]

A case-insensitive filter on the list.

fields[]string[]

A case-insensitive query parameter that allows you to specify which fields are returned in the response.

includeNullFieldsboolean

Specifies whether to include fields with the null value in the response.

  • If set to true, all fields will be returned in the response, including those with the null value.
  • If set to false, only fields with non-null values will be returned.

Headers

Idempotency-Keystring

Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types.

With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.

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.

Response

OK

idstring

The unique identifier of the order action.

createdByIdstring

The unique identifier of the user who created the order action.

createdDatestring date-time

The time that the order action gets created in the system, in the YYYY-MM-DD HH:MM:SS format.

updatedByIdstring

The unique identifier of the user who last updated the order action.

updatedDatestring date-time

The date and time when the order action was last updated.

contractEffectiveDatestring date

Effective contract date for this subscription, as yyyy-mm-dd.

customerAcceptanceDatestring date

The date on which the services or products within a subscription have been accepted by the customer, as yyyy-mm-dd.

type'CreateSubscription' | 'TermsAndConditions' | 'AddProduct' | 'UpdateProduct' | 'RemoveProduct' | 'RenewSubscription' | 'CancelSubscription' | 'OwnerTransfer' | 'Suspend' | 'Resume' | 'ChangePlan'

Type of the order action.

Note: The change plan type of order action is supported for 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. However, it is currently not supported for the <a href="https://docs.zuora.com?resourceId=revenue-billing-integration" target="_blank">Billing - Revenue Integration</a> feature. When Billing - Revenue Integration is enabled, the change plan type of order action will no longer be applicable in Zuora Billing.

sequenceinteger

The sequence of the order actions processed in the order.

subscriptionVersionAmendmentIdstring

The unique identifier of the amendment that changes the version of the subscription.

orderIdstring

The unique identifier of the order that the order action belongs to.

subscriptionIdstring

The unique identifier of the subscription associated with the order action.

subscriptionNumberstring

The number of the subscription associated with the order action.

serviceActivationDatestring date

The date on which the services or products within a subscription have been activated and access has been provided to the customer, as yyyy-mm-dd.

autoRenewboolean

If true, the subscription automatically renews at the end of the term.

renewSetting'RENEW_WITH_SPECIFIC_TERM' | 'RENEW_TO_EVERGREEN'

Specifies whether a termed subscription will remain termed or change to evergreen when it is renewed.

renewalTerminteger

The length of the period for the subscription renewal term.

renewalTermPeriodType'Month' | 'Year' | 'Day' | 'Week'

The period type for the subscription renewal term.

This field is used with the renewalTerm field to specify the subscription renewal term.

termStartDatestring date

The date on which the subscription term begins, as yyyy-mm-dd. If this is a renewal subscription, this date is different from the subscription start date.

termType'TERMED' | 'EVERGREEN'

The type of the subscription term.

currentTerminteger

The length of the period for the current subscription term.

currentTermPeriodType'Month' | 'Year' | 'Day' | 'Week'

The period type for the current subscription term.

suspendDatestring date

The date when subscription suspension takes effect, in the yyyy-mm-dd format.

resumeDatestring date

The resume date when the resumption takes effect.

cancellationEffectiveDatestring date

Date when the cancellation takes effect, in the yyyy-mm-dd format. Used only if cancellationPolicy is SpecificDate. It should not be earlier than the subscription contract-effective date, later than the subscription term-end date, or within a period for which the customer has been invoiced.

cancellationPolicy'EndOfCurrentTerm' | 'EndOfLastInvoicePeriod' | 'SpecificDate'

Cancellation method.

paymentTermstring

The name of the payment term associated with the subscription. For example, Net 30. The payment term determines the due dates of invoices.

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 or you select Default Term from Account for this field during subscription creation, the value of this field is automatically set to null in the response body.
billToContactIdstring

The ID of the bill-to contact associated with the subscription.

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 or you select Default Contact from Account for this field during subscription creation, the value of this field is automatically set to null in the response body.
invoiceTemplateIdstring

The ID of the invoice template associated with the subscription.

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 or you select Default Template from Account for this field during subscription creation, the value of this field is automatically set to null in the response body.
sequenceSetIdstring nullable

The ID of the sequence set associated with the subscription.

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 or you select Default Set from Account for this field during subscription creation, the value of this field is automatically set to null in the response body.
shipToContactIdstring

The ID of the ship-to contact associated with the subscription.

soldToContactIdstring

The ID of the sold-to contact associated with the subscription.

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 or you select Default Contact from Account for this field during subscription creation, the value of this field is automatically set to null in the response body.
clearingExistingPaymentTermboolean

Whether to clear the existing payment term at the subscription level. This field is mutually exclusive with the paymentTerm field.

Note: If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is null in the response body.

clearingExistingBillToContactboolean

Whether to clear the existing bill-to contact ID at the subscription level. This field is mutually exclusive with the billToContactId field.

Note: If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is null in the response body.

clearingExistingInvoiceTemplateboolean

Whether to clear the existing invoice template ID at the subscription level. This field is mutually exclusive with the invoiceTemplateId field.

Note: If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is null in the response body.

clearingExistingSequenceSetboolean

Whether to clear the existing sequence set ID at the subscription level. This field is mutually exclusive with the sequenceSetId field.

Note: If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is null in the response body.

clearingExistingShipToContactboolean

Whether to clear the existing ship-to contact ID at the subscription level. This field is mutually exclusive with the shipToContactId field.

Note: If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is null in the response body.

clearingExistingSoldToContactboolean

Whether to clear the existing sold-to contact ID at the subscription level. This field is mutually exclusive with the soldToContactId field.

Note: If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is null in the response body.

communicationProfileIdstring nullable

The ID of the communication profile associated with the subscription.

Note: This field is available in the request body only if you have the <a href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes" target="_blank">Flexible Billing Attributes</a> feature turned on. The value is null in the response body without this feature turned on.

clearingExistingCommunicationProfileboolean

Whether to clear the existing communication profile at the subscription level. This field is mutually exclusive with the communicationProfileId field.

subType'Upgrade' | 'Downgrade' | 'Crossgrade' | 'PlanChanged'

The sub type for the change plan order action.

If this field was not set by user, the field is automatically generated by the system according to the following rules:

When the old and new rate plans are within the same Grading catalog group:

  • If the grade of new plan is greater than that of the old plan, this is an "Upgrade".
  • If the grade of new plan is less than that of the old plan, this is a "Downgrade".
  • If the grade of new plan equals that of the old plan, this is a "Crossgrade".

When the old and new rate plans are not in the same Grading catalog group, or either has no group, this is "PlanChanged".

effectivePolicy'EffectiveImmediately' | 'EffectiveEndOfBillingPeriod' | 'SpecificDate'

The default value for the effectivePolicy field is as follows:

  • If the rate plan change (from old to new) is an upgrade, the effective policy is EffectiveImmediately by default.
  • If the rate plan change (from old to new) is a downgrade, the effective policy is EffectiveEndOfBillingPeriod by default.
  • Otherwise, the effective policy is SpecificDate by default.

Notes:

  • When setting this field to EffectiveEndOfBillingPeriod, you cannot set the <a href="https://docs.zuora.com?resourceId=billing-trigger-dates-updation-for-subscriptions" target="_blank">billing trigger dates</a> for the subscription as the system will automatically set the trigger dates to the end of billing period.
  • When setting this field to SpecificDate, you must also set the contractEffectiveDate field.

Changes