Retrieve a subscription by key

This REST API reference describes how to retrieve detailed information about a specified subscription in the latest version.

Request
path Parameters
subscription-key
required
string

Possible values are:

  • a subscription number
  • a subscription ID
query Parameters
charge-detail
string

The segmented rate plan charges. When an amendment results in a change to a charge, Zuora creates a segmented rate plan charge. Use this field to track segment charges.

Possible values are:

  • last-segment: (Default) The last rate plan charge on the subscription. The last rate plan charge is the last one in the order of time on the subscription rather than the most recent changed charge on the subscription.

  • current-segment: The segmented charge that is active on today’s date (effectiveStartDate <= today’s date < effectiveEndDate).

  • all-segments: All the segmented charges. The chargeSegments field is returned in the response. The chargeSegments field contains an array of the charge information for all the charge segments.

  • specific-segment&as-of-date=date: The segmented charge that is active on a date you specified ((specific date = effectiveStartDate) OR (effectiveStartDate < specific date < effectiveEndDate)). The format of the date is yyyy-mm-dd.

exclude-rate-plans-with-no-charges
boolean

If the exclude-rate-plans-with-no-charges is true, only the active charges and rate plans will be in the response. The default value is false.

header Parameters
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.

Authorization
string

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

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

Zuora-Org-Ids
string

Comma separated IDs. If you have Zuora Multi-Org 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.

If the header is not set, the operation is performed in scope of the user's accessible orgs.

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 (').

Responses
200
get/v1/subscriptions/{subscription-key}
Request samples
Response samples
application/json
{
  • "accountId": "8a8082c45aa81b51015ad64396090f5c",
  • "accountName": "ABCD",
  • "accountNumber": "A00002641",
  • "autoRenew": true,
  • "billToContact": {
    },
  • "contractEffectiveDate": "2017-01-01",
  • "contractedMrr": 8.33,
  • "currency": "USD",
  • "currentTerm": 12,
  • "currentTermPeriodType": "Month",
  • "customerAcceptanceDate": "2017-01-01",
  • "id": "8a8082c45aa81b51015ad68743ec0fdb",
  • "initialTerm": 12,
  • "initialTermPeriodType": "Month",
  • "invoiceGroupNumber": "N-0001",
  • "invoiceOwnerAccountId": "8a8082c45aa81b51015ad64396090f5c",
  • "invoiceOwnerAccountName": "ABCD",
  • "invoiceOwnerAccountNumber": "A00002641",
  • "invoiceScheduleId": "ec6f0d5dc8af451ab95343fb3c588c1a",
  • "invoiceSeparately": false,
  • "invoiceTemplateId": "2c9081a03c638994013c63978baf002b",
  • "invoiceTemplateName": "InvoiceTemplateName",
  • "notes": "",
  • "paymentTerm": "Net 30",
  • "ratePlans": [
    ],
  • "renewalSetting": "RENEW_WITH_SPECIFIC_TERM",
  • "renewalTerm": 12,
  • "renewalTermPeriodType": "Month",
  • "revision": "1.0",
  • "sequenceSetId": "6abcc30846de11e990900242ac1f0003",
  • "sequenceSetName": "DEFAULT",
  • "serviceActivationDate": "2017-01-01",
  • "soldToContact": {
    },
  • "status": "Active",
  • "subscriptionNumber": "A-S00007412",
  • "subscriptionStartDate": "2017-01-01",
  • "success": true,
  • "termEndDate": "2018-01-01",
  • "termStartDate": "2017-01-01",
  • "termType": "TERMED",
  • "totalContractedValue": 100,
  • "version": 1
}