Skip to main content

CheckCapacity verifies if organization can add more of a resource.

POST 
/api/v1/billing/subscription/check-capacity

Performs a pre-flight check before adding resources (seats, phone numbers, etc.) to verify the organization hasn't exceeded their plan limits. Returns capacity information and pricing for the requested quantity.

Authorization​

Requires billing:read permission.

Use Cases​

  • Before adding a new agent, check if seat quota allows it
  • Before provisioning a phone number, verify capacity
  • Display "Add More" buttons only when capacity available

Response​

Returns CheckCapacityResponse with:

  • allowed: whether the addition is permitted
  • current: current count of this resource
  • limit: plan limit (-1 for unlimited)
  • available: how many more can be added
  • unit_price_cents: cost per unit if adding

Errors​

  • NOT_FOUND: No subscription exists
  • INVALID_ARGUMENT: Unknown lookup_key

Request​

Responses​

A successful response.