GET Subscriptions By Key

Retrieve a subscription by key

GET/v1/subscriptions/{subscription-key}

Use it in a workflow

Add a step and choose the Zuora connector.
Pick the GET Subscriptions By Key action (under Zuora).
Fill in the fields below, then reference the result from later steps as {{getSubscriptionsByKey.response.data}}.

Request

Path parameters

subscription-keystringrequired

Possible values are: * a subscription number * a subscription ID

Query parameters

charge-detailstring

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, that is, the last segmented rate plan charge with the maximum start and end dates. * __current-segment__: The segmented charge that is active on today’s date (effectiveStartDate <= today’s date <= effectiveEndDate). * __all-segments__: All the segmented charges. The `ratePlans` > `ratePlanCharges` >`chargeSegments` nested field is returned in the response. The `chargeSegments` field contains an array of the charge information for all the charge segments. * __specific-segment__: Use this value together with `as-of-date={specificDate}`. The segmented charge that is active on a date you specified ((specific date = effectiveStartDate) OR (effectiveStartDate < specific date < effectiveEndDate)) is returned. The format of the date is `yyyy-mm-dd`.

as-of-datestring

The date for `charge-detail`. It is only available when `charge-detail` is `specific-segment`. The date should be in the format `YYYY-MM-DD`.

exclude-rate-plans-with-no-chargesboolean

When a rate plan charge has multiple segments, the last segment is returned by default. If this charge has been removed before the start date of the last segment (the latest one), with this parameter set to `true`, this charge is excluded from the response; If all the charges under a rate plan are excluded, the rate plan is not returned in the response. The default value is `false`.

getDetailedMetricsboolean

If the `getDetailedMetrics` field is `true`, `contractedNetMrr`, `asOfDayGrossMrr`, `asOfDayNetMrr`, and `netTotalContractedValue` will be in the response. The default value is `false`.

Default false

asOfDaystring

The date for detailed metrics. Only available when `getDetailedMetrics` is `true`. The date should be in the format `YYYY-MM-DD`. The default value is the current date.

getInvoiceOwnerDetailsboolean

Retrieves the invoice owner of a subscription. If this parameter is set to `true`, the invoice owner account details `invoiceOwnerAccountDetails` will be in the response.

getSubscriptionOwnerDetailsboolean

Retrieves the owner of a subscription. If this parameter is set to `true`, the subscription owner account details `accountOwnerDetails` will be in the response.

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](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/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](https://developer.zuora.com/v1-api-reference/api-upgrades/).

Response

Returns 200 with a any. Read it in later steps with {{getSubscriptionsByKey.response.data.<field>}}.

Need more? See the Zuora guide for connection setup and behaviour shared by every action.

Was this page helpful?