API Products
API Products are the primary unit of consumption in the API Control Plane. They bundle one or more APIs into a single subscribable package, which is especially important in microservice architectures where developers would otherwise need individual subscriptions to dozens of APIs. By grouping related APIs around common themes or specific use cases, products simplify the subscription experience.
Products are what developers see and subscribe to on Developer Portals. Each product can have plans for rate limiting, terms of use for legal agreements, and visibility settings that control which organizations can access them.
Key concepts
- API Product — A bundle of APIs offered to consumers as a single subscription unit
- Visibility — Controls who can see the product:
PUBLIC(all users) orRESTRICTED(specific organizations only) - Published status — Whether the product is listed on developer portals. Unpublished products are only visible to administrators
- Plans — Rate-limiting and access tiers attached to a product. A product can have multiple plans (e.g., Free, Pro, Enterprise), and consumers select one when subscribing
- Self-service subscriptions — When enabled, consumers can subscribe directly through a developer portal. When disabled, all subscriptions require administrator approval
Product properties
| Field | Type | Description |
|---|---|---|
name | string | Unique technical name (max 255 chars) |
displayName | string | Human-readable name (max 255 chars) |
description | string | Description (max 1000 chars) |
visibility | enum | PUBLIC or RESTRICTED |
published | boolean | Whether the product is published |
allowSelfServiceSubscription | boolean | Allow subscriptions without approval |
mcpStatus | enum | ENABLED or DISABLED |
tags | string[] | Tags for categorization |
Subscribable status
| Status | Description |
|---|---|
OK | Product is ready for subscriptions |
NO_APIS | No APIs assigned to the product |
NO_PLANS | No plans assigned to the product |
NOT_DEPLOYED | Product is not deployed to any environment |
NOT_DEPLOYED_IN_PRODUCTION | Product is not deployed to a production environment |
ENVIRONMENT_ACCESS_DENIED | Access to the deployment environment is restricted |
Related guides
- Manage Products — Create, list, update, and delete products
- Plans & Organizations — Manage plans and organization access
- Product Documentation — Add documentation to products
- Product Deployment — Deploy products to environments