Retrieve a subscription

Retrieve the details of a specific Subscription object.

Request
path Parameters
key
required
string

Object ID or Number.

query Parameters
pageSize
integer [ 1 .. 99 ]
Default: 10

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.

cursor
string

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[]
Array of strings

A case-sensitive 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[]
Array of strings

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

Items Enum: "account" "invoiceowner" "billtocontact" "invoiceitems" "rateplans" "rateplans.rateplancharges" "account.billto" "account.soldto" "account.paymentmethods"
filter[]
Array of strings

A case-sensitive filter on the list.

header Parameters
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 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-Encoding
string

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-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 (:), semicolon (;), double quote ("), and quote (').

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 do not need to set this header.

Authorization
string

The value is in the Bearer {token} format where {token} is a valid OAuth token generated by calling Create an OAuth token.

Responses
200

OK

400

Invalid input

401
403

Unauthorized

get/object-query/subscriptions/{key}
Request samples
Response samples
application/json
{
  • "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": [
    ]
}