Subscriptions
A subscription always refers to one application and one API Product, along with a selected plan. It represents the agreement between an API consumer and provider — specifying who has access, to what, and under which terms.
Subscriptions can be created through the Management API, the Administration Portal, or self-service through a Developer Portal. When an API Product is configured to require approval, subscription requests enter a pending state and must be explicitly approved or declined by an administrator before access is granted.
Subscribing to an API Product automatically deploys the subscription, application, and selected plan to all environments where the product's APIs are deployed. If terms of use are attached to the product, the consumer must accept them before the subscription is activated.
Key concepts
- Subscription — Connects an application to an API Product via a plan. A single application can have multiple subscriptions to different products
- Approval status —
APPROVED(active),PENDING(awaiting admin review), orDECLINED(rejected). Products with self-service subscriptions enabled bypass the approval step - Deployment — Subscriptions are automatically deployed when created, but may need manual redeployment after plan changes. Failed deployments can be retried
Subscription properties
| Field | Type | Description |
|---|---|---|
application | UUID | The subscribing application |
apiProduct | UUID | The API Product being subscribed to |
plan | UUID | The plan (rate limit tier) |
environments | UUID[] | Target deployment environments |
approvalStatus | enum | APPROVED, PENDING, or DECLINED |
termsOfUseAccepted | boolean | Whether terms were accepted |
Related guides
- Manage Subscriptions — Create and manage subscriptions
- Approval Workflows — Configure and manage approval requests