---
title: "Retrieve an omnichannel subscription"
method: GET
path: "/v1/omni-channel-subscriptions/{subscriptionKey}"
tags: ["Omnichannel Subscriptions"]
---

# Retrieve an omnichannel subscription

`GET /v1/omni-channel-subscriptions/{subscriptionKey}`

Retrieves the information about a specific omnichannel subscription.

## Path parameters

- `subscriptionKey` string, required

## Query parameters

- `getAccountDetails` boolean

## Headers

- `Accept-Encoding` string
- `Content-Encoding` string
- `Zuora-Track-Id` string
- `Zuora-Entity-Ids` string
- `Zuora-Org-Ids` string
- `Zuora-Version` string

## Response `200`

OK

- GetOmniChannelSubscriptionResponse — Container for custom fields of a Subscription object.
  - `processId` string — The ID of the process that handles the operation.
  - `reasons` object[] — The container of the error code and message. This field is available only if the `success` field is `false`.
    - `code` string — The error code of response.
    - `message` string — The detail information of the error response
  - `requestId` string, uuid — Unique identifier of the request.
  - `success` boolean — Indicates whether the call succeeded.
  - `id` string — The system generated ID in Billing.
  - `subscriptionNumber` string — The system generated subscription number.
  - `accountId` string — The ID of the account associated with this subscription.
  - `externalSubscriptionId` string — The original transaction ID of the notification.
  - `externalTransactionReason` string — The latest transaction reason.
  - `externalSourceSystem` string — The source app store from which the channel subscription originated. For example, Apple, Google, Roku, Amazon.
  - `externalState` string — The original status from client, such as active, canceled, expired, pastDue.
  - `state` string — The common external subscription state.
  - `externalProductId` string — The product ID in the external system.
  - `externalReplaceByProductId` string, nullable — The product ID is going to replace the existing product ID in the `externalProductId` field during the subscription renewal.
  - `externalInAppOwnershipType` string — Such as purchased, family_shared.
  - `externalQuantity` integer — The quantity of the product, must be greater than 0.
  - `currency` string — The currency code of the transaction. If not specified, get value from the Account.
  - `autoRenew` boolean — If `true`, the subscription automatically renews at the end of the term.
  - `originalPurchaseDate` string, datetime — The value of `externalPurchaseDate` when this external subscription firstly created. UTC time, `yyyy-mm-dd hh:mm:ss`.
  - `externalPurchaseDate` string, datetime — When the App Store charged the user’s account for a purchase, restored product, subscription, or subscription renewal after a lapse. UTC time, `yyyy-mm-dd hh:mm:ss`.
  - `externalActivationDate` string, datetime — When the external subscription was activated on the external platform. UTC time, `yyyy-mm-dd hh:mm:ss`.
  - `externalExpirationDate` string, datetime — This expiration date is a static value that applies for each transaction. UTC time, `yyyy-mm-dd hh:mm:ss`.
  - `externalApplicationId` string — The external application ID.
  - `externalBundleId` string — The external bundler ID.
  - `externalSubscriberId` string — The external subscriber ID.
  - `externalPrice` number — The price in external system.
  - `externalPurchaseType` string — The external purchase type.
  - `externalLastRenewalDate` string, datetime — This last renewal date is a static value that applies for each transaction. UTC time, `yyyy-mm-dd hh:mm:ss`.
  - `externalNextRenewalDate` string, datetime — This next renewal date is a static value that applies for each transaction. UTC time, `yyyy-mm-dd hh:mm:ss`.

## Other responses

- `500` — Internal Server Error
- `4XX` — Invalid input

---

[API](https://skmtc.dev/zuora/apis/api-reference.md) · [All operations](https://skmtc.dev/zuora/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/zuora/api-reference/revisions/d11e237f3e54/schema)