Retrieve the details of a specific Order Action object.
Idempotency-Key | string <= 255 characters 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-Encoding | string Include the If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a |
Content-Encoding | string Include the |
Zuora-Track-Id | string <= 64 characters 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 ( |
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. |
Authorization | string The value is in the |
OK
Invalid input
Unauthorized
curl -i -X GET \ 'https://rest.test.zuora.com/object-query/order-actions/{key}?pageSize=10&cursor=string&sort%5B%5D=string&expand%5B%5D=subscription&filter%5B%5D=string' \ -H 'Accept-Encoding: string' \ -H 'Authorization: string' \ -H 'Content-Encoding: string' \ -H 'Idempotency-Key: string' \ -H 'Zuora-Entity-Ids: string' \ -H 'Zuora-Track-Id: string'
{- "id": "string",
- "createdById": "string",
- "createdDate": "2019-08-24T14:15:22Z",
- "updatedById": "string",
- "updatedDate": "2019-08-24T14:15:22Z",
- "contractEffectiveDate": "2019-08-24",
- "customerAcceptanceDate": "2019-08-24",
- "type": "CreateSubscription",
- "sequence": 0,
- "subscriptionVersionAmendmentId": "string",
- "orderId": "string",
- "subscriptionId": "string",
- "serviceActivationDate": "2019-08-24",
- "autoRenew": false,
- "renewSetting": "RENEW_WITH_SPECIFIC_TERM",
- "renewalTerm": 0,
- "renewalTermPeriodType": "Month",
- "termStartDate": "2019-08-24",
- "termType": "TERMED",
- "currentTerm": 0,
- "currentTermPeriodType": "Month",
- "suspendDate": "2019-08-24",
- "resumeDate": "2019-08-24",
- "cancellationEffectiveDate": "2019-08-24",
- "cancellationPolicy": "EndOfCurrentTerm",
- "paymentTerm": "string",
- "billToContactId": "string",
- "invoiceTemplateId": "string",
- "sequenceSetId": "string",
- "soldToContactId": "string",
- "clearingExistingPaymentTerm": false,
- "clearingExistingBillToContact": false,
- "clearingExistingInvoiceTemplate": false,
- "clearingExistingSequenceSet": false,
- "clearingExistingSoldToContact": false,
- "subType": "Upgrade",
- "effectivePolicy": "EffectiveImmediately",
- "subscription": {
- "id": "string",
- "createdById": "string",
- "createdDate": "2019-08-24T14:15:22Z",
- "updatedById": "string",
- "updatedDate": "2019-08-24T14:15:22Z",
- "accountId": "string",
- "autoRenew": false,
- "cancelledDate": "2019-08-24",
- "contractAcceptanceDate": "2019-08-24",
- "contractEffectiveDate": "2019-08-24",
- "creatorAccountId": "string",
- "creatorInvoiceOwnerId": "string",
- "currentTerm": 0,
- "currentTermPeriodType": "Month",
- "initialTerm": 0,
- "initialTermPeriodType": "Month",
- "invoiceOwnerId": "string",
- "isInvoiceSeparate": false,
- "name": "string",
- "notes": "string",
- "originalCreatedDate": "string",
- "originalId": "string",
- "previousSubscriptionId": "string",
- "renewalSetting": "RENEW_WITH_SPECIFIC_TERM",
- "renewalTerm": 0,
- "renewalTermPeriodType": "Month",
- "revision": "string",
- "serviceActivationDate": "2019-08-24",
- "status": "Draft",
- "isLatestVersion": true,
- "subscriptionEndDate": "2019-08-24",
- "subscriptionStartDate": "2019-08-24",
- "subscriptionVersionAmendmentId": "string",
- "termEndDate": "2019-08-24",
- "termStartDate": "2019-08-24",
- "termType": "TERMED",
- "version": 0,
- "cMRR": 0,
- "billToContactSnapshotId": "string",
- "billToContactId": "string",
- "invoiceTemplateId": "string",
- "sequenceSetId": "string",
- "soldToContactId": "string",
- "soldToContactSnapshotId": "string",
- "externallyManagedBy": "Amazon",
- "lastBookingDate": "2019-08-24",
- "invoiceScheduleId": "string",
- "cancelReason": "string",
- "prepayment": true,
- "currency": "string",
- "orderId": "string",
- "rampId": "string",
- "paymentTerm": "string",
- "quoteNumber__QT": "string",
- "quoteType__QT": "string",
- "quoteBusinessType__QT": "string",
- "opportunityName__QT": "string",
- "opportunityCloseDate__QT": "2019-08-24",
- "cpqBundleJsonId__QT": "string",
- "account": { },
- "invoiceOwner": { },
- "billToContact": { },
- "invoiceItems": [
- { }
], - "ratePlans": [
- { }
], - "property1": { },
- "property2": { }
}, - "order": {
- "id": "string",
- "createdById": "string",
- "createdDate": "2019-08-24T14:15:22Z",
- "updatedById": "string",
- "updatedDate": "2019-08-24T14:15:22Z",
- "description": "string",
- "orderDate": "2019-08-24",
- "orderNumber": "string",
- "accountId": "string",
- "status": "Draft",
- "state": "string",
- "createdByMigration": true,
- "category": "string",
- "invoiceScheduleId": "string",
- "scheduledDate": "2019-08-24",
- "scheduledDatePolicy": "SpecificDate",
- "errorCode": "string",
- "errorMessage": "string",
- "response": "string",
- "account": {
- "id": "string",
- "createdById": "string",
- "createdDate": "2019-08-24T14:15:22Z",
- "updatedById": "string",
- "updatedDate": "2019-08-24T14:15:22Z",
- "accountNumber": "string",
- "additionalEmailAddresses": "string",
- "allowInvoiceEdit": false,
- "autoPay": true,
- "balance": 0.1,
- "batch": "string",
- "bcdSettingOption": "ManualSet",
- "billCycleDay": 0,
- "billToId": "string",
- "communicationProfileId": "string",
- "creditBalance": 0.1,
- "crmId": "string",
- "currency": "string",
- "customerServiceRepName": "string",
- "defaultPaymentMethodId": "string",
- "eInvoiceProfileId": "string",
- "invoiceDeliveryPrefsEmail": true,
- "invoiceDeliveryPrefsPrint": true,
- "invoiceTemplateId": "string",
- "lastInvoiceDate": "2019-08-24",
- "lastMetricsUpdate": "2019-08-24T14:15:22Z",
- "name": "string",
- "notes": "string",
- "organizationId": "string",
- "parentId": "string",
- "partnerAccount": true,
- "paymentMethodCascadingConsent": true,
- "purchaseOrderNumber": "string",
- "salesRepName": "string",
- "sequenceSetId": "string",
- "soldToId": "string",
- "status": "Active",
- "taxCompanyCode": "string",
- "taxExemptCertificateID": "string",
- "taxExemptCertificateType": "string",
- "taxExemptDescription": "string",
- "taxExemptEffectiveDate": "2019-08-24",
- "taxExemptEntityUseCode": "string",
- "taxExemptExpirationDate": "2019-08-24",
- "taxExemptIssuingJurisdiction": "string",
- "taxExemptStatus": "No",
- "totalInvoiceBalance": 0.1,
- "unappliedBalance": 0,
- "vATId": "string",
- "mrr": 0,
- "totalDebitMemoBalance": 0.1,
- "unappliedCreditMemoAmount": 0.1,
- "creditMemoTemplateId": "string",
- "debitMemoTemplateId": "string",
- "paymentGateway": "string",
- "paymentTerm": "string",
- "billTo": { },
- "soldTo": { },
- "defaultPaymentMethod": { },
- "subscriptions": [
- { }
], - "payments": [
- { }
], - "refunds": [
- { }
], - "creditMemos": [
- { }
], - "debitMemos": [
- { }
], - "invoices": [
- { }
], - "usages": [
- { }
], - "paymentMethods": [
- { }
], - "property1": { },
- "property2": { }
}, - "orderLineItems": [
- {
- "id": "string",
- "createdById": "string",
- "createdDate": "2019-08-24T14:15:22Z",
- "updatedById": "string",
- "updatedDate": "2019-08-24T14:15:22Z",
- "accountingCode": "string",
- "billTargetDate": "2019-08-24",
- "amountPerUnit": 0,
- "description": "string",
- "amount": 0,
- "amountWithoutTax": 0,
- "itemName": "string",
- "itemNumber": "string",
- "itemState": "Executing",
- "itemType": "Product",
- "listPricePerUnit": 0,
- "listPrice": 0,
- "orderId": "string",
- "productCode": "string",
- "purchaseOrderNumber": "string",
- "quantity": 0,
- "revenueRecognitionRule": "string",
- "productRatePlanChargeId": "string",
- "billToId": "string",
- "billToSnapshotId": "string",
- "soldTo": "string",
- "soldToSnapshotId": "string",
- "soldToOrderContactId": "string",
- "ownerAccountId": "string",
- "invoiceOwnerAccountId": "string",
- "taxCode": "string",
- "taxMode": "TaxInclusive",
- "transactionDate": "2019-08-24",
- "uOM": "string",
- "relatedSubscriptionNumber": "string",
- "transactionEndDate": "2019-08-24",
- "transactionStartDate": "2019-08-24",
- "excludeItemBillingFromRevenueAccounting": true,
- "excludeItemBookingFromRevenueAccounting": true,
- "originalOrderDate": "2019-08-24",
- "amendedByOrderOn": "2019-08-24",
- "itemCategory": "Sales",
- "originalOrderId": "string",
- "originalOrderLineItemId": "string",
- "originalOrderLineItemNumber": "string",
- "originalOrderNumber": "string",
- "quantityAvailableForReturn": 0,
- "quantityFulfilled": 0,
- "quantityPendingFulfillment": 0,
- "requiresFulfillment": true,
- "billingRule": "TriggerWithoutFulfillment",
- "inlineDiscountPerUnit": 0,
- "inlineDiscountType": "Percentage",
- "discount": 0,
- "recognizedRevenueAccountingCodeId": "string",
- "deferredRevenueAccountingCodeId": "string",
- "contractAssetAccountingCode": "string",
- "contractLiabilityAccountingCode": "string",
- "contractRecognizedRevenueAccountingCodeId": "string",
- "unbilledReceivablesAccountingCodeId": "string",
- "adjustmentRevenueAccountingCodeId": "string",
- "adjustmentLiabilityAccountingCodeId": "string",
- "invoiceItems": [
- { }
], - "property1": { },
- "property2": { }
}
], - "orderActions": [
- {
- "id": "string",
- "createdById": "string",
- "createdDate": "2019-08-24T14:15:22Z",
- "updatedById": "string",
- "updatedDate": "2019-08-24T14:15:22Z",
- "contractEffectiveDate": "2019-08-24",
- "customerAcceptanceDate": "2019-08-24",
- "type": "CreateSubscription",
- "sequence": 0,
- "subscriptionVersionAmendmentId": "string",
- "orderId": "string",
- "subscriptionId": "string",
- "serviceActivationDate": "2019-08-24",
- "autoRenew": false,
- "renewSetting": "RENEW_WITH_SPECIFIC_TERM",
- "renewalTerm": 0,
- "renewalTermPeriodType": "Month",
- "termStartDate": "2019-08-24",
- "termType": "TERMED",
- "currentTerm": 0,
- "currentTermPeriodType": "Month",
- "suspendDate": "2019-08-24",
- "resumeDate": "2019-08-24",
- "cancellationEffectiveDate": "2019-08-24",
- "cancellationPolicy": "EndOfCurrentTerm",
- "paymentTerm": "string",
- "billToContactId": "string",
- "invoiceTemplateId": "string",
- "sequenceSetId": "string",
- "soldToContactId": "string",
- "clearingExistingPaymentTerm": false,
- "clearingExistingBillToContact": false,
- "clearingExistingInvoiceTemplate": false,
- "clearingExistingSequenceSet": false,
- "clearingExistingSoldToContact": false,
- "subType": "Upgrade",
- "effectivePolicy": "EffectiveImmediately",
- "subscription": { },
- "property1": { },
- "property2": { }
}
], - "property1": { },
- "property2": { }
}, - "property1": { },
- "property2": { }
}