Sign in
Omnichannel Subscriptions

Create an omnichannel subscription

Creates or updates an omnichannel subscription for a customer account.

You can also create a new customer account and assign it to the new omnichannel subscription.

post/v1/omni-channel-subscriptions

Headers

Idempotency-Keystring

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

Request body

accountIdstring

The ID of the account associated with this subscription.

externalSubscriptionIdstring required

The original transaction ID of the notification. This must be unique in the tenant.

externalTransactionReasonstring

The latest transaction reason.

externalSourceSystemstring

The source app store from which the channel subscription originated. For example, Apple, Google, Roku, Amazon.

Note: When creating a new Omnichannel subscription, externalSourceSystem is a required field. When updating an existing Omnichannel subscription, externalSourceSystem is an optional field.

externalStatestring

The original status from client, such as active, canceled, expired, pastDue.

statestring

The common external subscription state.

externalProductIdstring

The product ID in the external system.

externalReplaceByProductIdstring nullable

The product ID is going to replace the existing product ID in the externalProductId field during the subscription renewal.

externalInAppOwnershipTypestring

Such as purchased, family_shared.

externalQuantityinteger

The quantity of the product, must be greather than 0.

currencystring

The currency code of the transaction. If not specified, get value from the Account.

autoRenewboolean

If true, the subscription automatically renews at the end of the term.

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

externalActivationDatestring datetime

When the external subscription was activated on the external platform. UTC time, yyyy-mm-dd hh:mm:ss.

externalExpirationDatestring datetime

This expiration date is a static value that applies for each transaction. UTC time, yyyy-mm-dd hh:mm:ss.

externalApplicationIdstring

The external application ID.

externalBundleIdstring

The external bundler ID.

externalSubscriberIdstring

The external subscriber ID.

externalPricenumber

The price in external system.

externalPurchaseTypestring

The external purchase type.

externalLastRenewalDatestring datetime

This last renewal date is a static value that applies for each transaction. UTC time, yyyy-mm-dd hh:mm:ss.

externalNextRenewalDatestring datetime

This next renewal date is a static value that applies for each transaction. UTC time, yyyy-mm-dd hh:mm:ss.

accountIdentifierFieldstring

The account field used to identify the account in acountData. It could be a custom field.

Example request

{
  "externalSubscriptionId": "original-transaction-id1",
  "accountId": "8a90b4488e602d56018e6062ff5700a3",
  "externalSourceSystem": "Apple",
  "externalTransactionReason": "Purchase",
  "externalState": "Active",
  "state": "Active",
  "externalProductId": "external-product-id-1",
  "externalInAppOwnershipType": "Purchased",
  "externalQuantity": 1,
  "currency": "USD",
  "autoRenew": true,
  "externalPurchaseDate": "2024-02-01 00:01:15",
  "externalActivationDate": "2024-02-01 00:01:15",
  "externalExpirationDate": "2024-05-01 00:01:15",
  "externalApplicationId": "004d58fca978fec3697fec4af1d10065",
  "externalBundleId": "43dcdc4562784ed8a59ece4ef7d98e57",
  "externalSubscriberId": "2466082b6d1149c184a09b15bd5be694",
  "externalPurchaseType": "Purchased",
  "externalPrice": 100,
  "externalLastRenewalDate": "2024-10-01 00:00:00",
  "externalNextRenewalDate": "2025-01-01 00:00:00"
}

Response

OK

processIdstring

The ID of the process that handles the operation.

requestIdstring uuid

Unique identifier of the request.

successboolean

Indicates whether the call succeeded.

subscriptionIdstring

The system generated ID in Billing.

subscriptionNumberstring

The system generated subscription number.

accountIdstring

The ID of the account associated with this subscription.

accountNumberstring

The number of the account associated with this subscription.

Changes