Consumers
Subscriptions
The admin Subscriptions surface in Apiable: a subscription's tabs and statuses, creating a subscription for a consumer, upgrading to a new plan version, and viewing billing and consumption.
A subscription is one consumer team's instance of a plan. It carries the credentials, status, billing link, and scope grants for that team's access to one of your API products. You manage every subscription from the dashboard under Consumers, Subscriptions.
What is a subscription in Apiable?
A subscription connects a consumer team to a single plan on one of your products. It holds the team's API credentials, its lifecycle status, its billing link to the payment provider, and any per-subscription scope grants.
You open the full list under Consumers, Subscriptions in the sidebar. The list shows each subscription's name, plan, team, Status, and pipeline stage. Use the Status and plan filters to narrow it down.
What statuses can a subscription have?
A subscription moves through eight statuses across its lifecycle. The status shows as a badge on the subscription detail page and as a Status column in the Subscriptions list.
| Status | What it means |
|---|---|
| Pending Payment | The subscription was created and is waiting for the payment provider to confirm payment. |
| Payment Failed | The payment provider reported a failed payment. |
| Pending Approval | The subscription was created and is waiting for an admin to approve it. The credentials are not issued yet. |
| Active | The subscription is approved and its credentials are live. |
| Rejected | The subscription was not approved. No credentials are issued. |
| Cancelled | The subscription was cancelled. Existing credentials stay valid until it expires, with no renewal. |
| Expired | The subscription reached the end date set by the plan's duration. Credentials are revoked. |
| Pending Cancellation | A cancellation is scheduled and has not taken effect yet. |
What tabs does a subscription have?
A subscription detail page opens on Details and adds more tabs based on the plan and the subscription's data. Details is always present. The rest appear only when they apply.
| Tab | When it appears | What it holds |
|---|---|---|
| Details | Always | Product, plan, start and end dates, owner, the team link, API usage, and the danger zone. |
| Authorization | When the subscription exists | The subscription's credentials and authorization details. |
| Billing | Paid plans only (not Free or Contract) | Billing cycle, next invoice, invoice history, and consumption. |
| Custom Properties | When the subscription has custom properties | The values captured for the plan's custom properties. |
| Scopes | Scope-based plans with an authorization server and at least one scope | The subscription's Active, Optional, and Restricted scope grants. |
| Requests | When there is a pending request on this subscription | The subscription's own pending approval and any pending scope requests, labelled Requests ({{count}}). |
How does an admin create a subscription for a consumer?
You create a subscription from inside a consumer team, not from the flat Subscriptions list. Open the team, add a subscription, choose the product and plan, then click Create.
- Go to Consumers, Consumer Teams and open the team you are subscribing.
- Start a new subscription on that team. The flat Subscriptions list is read-only and shows the hint that subscriptions are created on the team.
- In the modal, enter a Name for the subscription.
- Pick a Product, then pick a Plan on that product. The Active plans only toggle filters the plan list to active plans.
- If the plan defines custom properties for the subscription wizard, fill the required ones. Required fields are marked with an asterisk.
- Click Create. If creation fails, the modal shows Failed to create subscription with the reason.
How do I upgrade a subscription to a new plan version?
Open the subscription's Details tab. When a newer version of its plan exists, a green banner reads "There is a new version of this plan available." with an Upgrade subscription button. Click it and confirm in the dialog.
The upgrade moves the subscription to the latest version of the same plan and keeps its credentials. This is a version bump on the current plan, not a move to a different plan. To switch the subscription to a different plan, use the plan picker described next.
Can I change the plan on a subscription?
Yes, from the plan picker on the Details tab, when the target plan is compatible. A target plan is selectable only when it uses the same security level as the current plan, has no custom properties, and is Active or Published.
Incompatible plans stay in the list but are disabled, with the reason shown on hover:
| Reason a plan is disabled | What it means |
|---|---|
| Different security level | The target plan uses a different security level than the current plan. A subscription cannot move across security levels. |
| Plan has custom properties that require configuration | The target plan defines custom properties, which the change path does not collect. |
| Plan status is not Active or Published | The target plan is in a status the change path does not allow, such as Draft or Deprecated. |
The plan picker itself is disabled when the current subscription has custom properties, or when its status is an end state (Cancelled, Expired, or Rejected).
Where do I view billing and consumption?
Open the Billing tab. It shows the billing cycle, the next invoice date, a Resynchronize action that refreshes status from the payment provider, and an invoice history table with Status, Amount, and Date columns.
For usage-based plans (Volume or Graduated) and overage plans (Flat fee + overage), the tab also shows a consumption block with the current period total drawn from the payment provider. The Billing tab does not appear on Free or Contract plans, since there is nothing to invoice.
How do I approve, cancel, or activate a subscription?
A subscription in Pending Approval shows Reject and Approve in the page header, for admins in the plan's approval group. The Details tab's danger zone holds Cancel subscription and Activate subscription.
| Action | Where | When it is available |
|---|---|---|
| Approve / Reject | Subscription header | Status is Pending Approval and you are in the plan's approval group. |
| Cancel subscription | Details tab, danger zone | Status is Active, Pending Payment, or Payment Failed. You pick the cancellation date. |
| Activate subscription | Details tab, danger zone | Status is Pending Payment. |
For the full approval inbox across registration, subscription, and access requests, see Requests and approvals.
Troubleshooting
Match what you see in the dashboard to the fix:
| What you see | What to do |
|---|---|
| No add button on the Subscriptions list | Subscriptions are created on a team. Open the team under Consumers, Consumer Teams and add the subscription there. |
| The plan picker is disabled on Details | The subscription has custom properties, or its status is an end state (Cancelled, Expired, Rejected). End states lock plan, date, and owner edits. |
| A plan is greyed out in the picker | The target plan has a different security level, has custom properties, or is not Active or Published. Hover the option to see the exact reason. |
| No Billing tab on the subscription | The plan's revenue model is Free or Contract, so there is nothing to invoice. |
| No Scopes tab on the subscription | The plan is not scope-based, or no authorization server is connected, or the plan has no scopes. See Scope grants. |
| Invoice history shows "No invoices found" | The subscription is not yet linked to the payment provider, or no invoices exist. Use Resynchronize to refresh status from the provider. |
| Banner: "OAuth2 client was not found in the connected authorization server." | The subscription's OAuth2 client is missing at the authorization server. Scope grants may not sync until the client is re-provisioned. |
Where to next
Subscribe to an API (consumer side)
What a consumer does in the API Portal to subscribe to a plan, and how their request reaches your approval queue.
Requests and approvals
The Consumers, Requests inbox: registration, subscription, and access requests in one place, with approve and decline.
Scope grants
How the Scopes tab works: requesting, approving, and revoking Optional and Restricted scopes on a subscription.
Connect Stripe
Link the payment provider that drives a subscription's billing cycle, invoices, and consumption totals.