Do credentials keep working after I cancel a subscription?

Until the cancellation date. Cancelling always asks for a date and moves the subscription to Pending Cancellation, where its credentials keep working. After that date passes, an hourly check moves it to Cancelled, which revokes the credentials.

How do I move a subscription to a new plan version?

When the subscription's plan version is deprecated, the Details tab shows 'There is a new version of this plan available.' with an Upgrade button. Confirm with 'I understand, upgrade.' Upgrading can change billing and the subscription's credentials.

Where do I see what a subscription is consuming?

Open the Billing tab. It shows the billing cycle, the next invoice, the last five invoices, and, for usage-based and overage plans, the total consumption reported for the current period. The Billing tab appears on every plan except Free and Contract.

Can I change the plan on an active subscription?

Yes, from the Plan picker on the Details tab, then Save Changes. A target plan must use the same security level, have no custom properties, and be Active or Published. The picker is locked when the subscription itself has custom properties or has ended.

Consumers

Subscriptions

The admin Subscriptions surface in Apiable: what each subscription status means for credentials, the detail tabs, creating a subscription for a team, changing or upgrading its plan, cancelling it, 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.

Open the full list under Consumers, Subscriptions. The list shows each subscription's name, team, product, plan, approval, Status, and Pipeline phase. Filter it by Status, Plan, and internal or external Teams.

What statuses can a subscription have?

A subscription moves through eight statuses. The status decides whether the team's credentials work. It shows in the Status column of the list and in the subscription's header.

Status	What it means	Credentials
Pending Payment	Waiting for the developer to complete checkout, or for the payment provider to confirm payment.	Hidden in the API Portal until payment is confirmed.
Payment Failed	The payment provider reported a failed payment.	Not revoked. The developer pays the open invoice from the subscription in your API Portal.
Pending Approval	Waiting for someone to approve it.	Can't be created yet.
Active	Approved and live.	Work, and can be created and regenerated.
Rejected	The subscription was not approved.	Revoked, if any existed.
Cancelled	The subscription has ended.	Revoked when it enters this status.
Expired	The subscription reached its end date.	Revoked.
Pending Cancellation	A cancellation is scheduled for a date.	Keep working until that date. An hourly check then moves the subscription to Cancelled.

What tabs does a subscription have?

A subscription detail page opens on Details. The other tabs appear when they apply.

Tab	When it appears	What it holds
Details	Always	Product, plan, start and end dates, owner, the team that created it, API usage on rate-limited plans, and the danger zone.
Authorization	Always	The subscription's credential details and the credential actions.
Billing	Every plan except Free and Contract	Billing cycle, next invoice, recent invoices, and consumption.
Custom Properties	When the subscription has custom properties	The values captured for the plan's custom properties.
Scopes	Your Apiable plan includes scope-based access control, an authorization server is connected, and the subscription's plan has scopes	The subscription's Active, Optional, and Restricted scope grants.
Requests (n)	While the subscription has pending items	Its own pending approval and any pending scope requests. n is the pending count.

How does an admin create a subscription for a consumer?

You create a subscription from inside a team, not from the Subscriptions list. Open the team, go to its Subscriptions tab, and use + Create subscription.

Go to Consumers, Teams and open the team you are subscribing.
Open the team's Subscriptions tab and click + Create subscription. Elsewhere, the list only shows the hint that new subscriptions are created on a team.
In Subscription Create, enter a Name.
Pick a Product, then a Plan on that product. Show only active plans limits the plan list to active plans.
If the plan defines custom properties, fill in the required ones, marked with an asterisk.
Click Create. If creation fails, the modal shows Failed to create subscription with the reason.

A subscription you create here skips the plan's approval group. It starts Active, or Pending Payment on a paid plan. On a sandbox plan it starts in the sandbox. Creating subscriptions needs the Organisation Owner, or the Organisation Admin or Portal Admin role.

How do I upgrade a subscription to a new plan version?

When the subscription's plan version is deprecated, for example after you publish a newer version, the Details tab shows a banner: "There is a new version of this plan available." Click Upgrade, read the dialog, and confirm with I understand, upgrade.

The upgrade moves the subscription to the latest active version of the same plan. As the dialog warns, it can change billing and the subscription's credentials. To move the subscription to a different plan, use the plan picker described next.

Can I change the plan on a subscription?

Yes. Pick the new plan in the Plan picker on the Details tab, then click Save Changes in the header and confirm. 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.

Plans that don't qualify stay in the list but are disabled, with the reason shown on hover:

Reason shown	What it means
Incompatible security level	The target plan uses a different security level. 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 '...'	The target plan is not Active or Published, for example Draft or Deprecated.

The plan picker itself is locked when the current subscription has custom properties, or when it is in an end state. Changing the plan can change the credentials, as the Instructions next to the form note.

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 the status from the payment provider, and an Invoice History table with the last five invoices.

Part of the tab	What it shows
Billing Cycle	How often the plan bills.
Next Invoice	The date of the next invoice. It reads "No invoices found" when the payment provider has no upcoming invoice.
Advanced	The payment provider customer and subscription IDs, with lookups in your payment provider.
Resynchronize Billing	Resynchronize refreshes the subscription's billing status from the payment provider.
Invoice History	Status, Amount, and Date for the last five invoices of the subscription's customer.
Subscription usage	For usage-based plans (Volume or Graduated) and overage plans (Flat fee + overage), the total consumption reported to the payment provider for the current period.

How do I approve, cancel, or activate a subscription?

A subscription in Pending Approval shows Reject and Approve in its header to members of 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. Anyone with dashboard access can also act from Consumers, Requests.
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. Activating bypasses payment.

Sandbox subscriptions are not approved from the subscription header. When a partner submits one for production, you review it under Consumers, Pipeline. See From sandbox to production.

What happens when you cancel a subscription?

The subscription moves to Pending Cancellation and its credentials keep working until the date you pick. After that date, an hourly check moves it to Cancelled, which revokes the credentials and cancels billing in the payment provider.

On the Details tab, click Cancel Subscription in the danger zone.
Choose a date in Select date.
Confirm. The subscription shows Pending Cancellation and a Canceled date until the date arrives.

If you pick today, the subscription is cancelled within an hour, not at the moment you confirm.

Troubleshooting

Match what you see in the dashboard to the fix:

What you see	What to do
No + Create subscription button on the Subscriptions list	Subscriptions are created on a team. Open the team under Consumers, Teams and use its Subscriptions tab.
The plan picker is locked on Details	The subscription has custom properties, or it is Cancelled, Expired, or Rejected.
A plan is greyed out in the picker	Hover it to see the reason: a different security level, custom properties, or a status other than Active or Published.
No Billing tab on the subscription	The plan's revenue model is Free or Contract, so there is nothing to invoice.
Next Invoice reads "No invoices found"	The payment provider has no upcoming invoice for the subscription. Use Resynchronize to refresh the status.
No Scopes tab on the subscription	Your Apiable plan does not include scope-based access control, no authorization server is connected, or the subscription's plan has no scopes. See Scope grants.
Credential provisioning failed on the Scopes tab	The consumer's OAuth2 client could not be created at the authorization server. Fix the cause, then click Retry Provisioning.
Banner: "This subscription is active, but missing authorization."	The subscription has no credential. Go to the Authorization tab and use Regenerate Credentials.
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.
A cancelled subscription's credentials still work	Check the status. Pending Cancellation keeps credentials working until the cancellation date.

Where to next

Subscribing to a plan

What a developer does in the API Portal to subscribe, and how their request reaches your approval queue.

Requests and approvals

The Consumers, Requests inbox: registration, subscription, and access requests in one place.

Scope grants

How the Scopes tab works: requesting, approving, and revoking Optional and Restricted scopes.

Connect Stripe

Link the payment provider that drives a subscription's billing cycle, invoices, and consumption.