Skip to main content
GET
Subscribe channel (ENTERPRISE)

Overview

Links a channel to the account’s active Stripe subscription. The channel is automatically added to the existing subscription and a prorated charge for the remaining billing period is included on the next invoice.
Payment is completed beforehand by the user in the Omni Z-API dashboard. This endpoint should be called after the checkout is completed in the dashboard to activate the channel via API.
Example response:
The channelId is obtained from the Create channel endpoint.

Authorizations

Authorization
string
header
required

Secret Key generated in the Omni Z-API Security panel

Path Parameters

channelId
string
required

Channel ID (obtained via Create channel)

Example:

"019E4C54B1B375A28970B605CA9B03C3"

Response

Channel linked to subscription successfully

type
enum<string>

Indicates the channel was successfully added to the subscription

Available options:
SUBSCRIPTION_UPDATED
Example:

"SUBSCRIPTION_UPDATED"

message
string

Informational message to display to the user

Example:

"Channel active. Prorated charge will be included in the next invoice."