Skip to content
Vocapable Developers

Read this tenant's subscription

GET
/v1/subscription
curl --request GET \
  --url https://api.vocapable.com/v1/subscription \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
Subscription
object
id
required
Id
string
status
required
Status
string
Allowed values: trialing active past_due unpaid canceled
plan
required
PlanSummary
object
id
required
Id
string
name
required
Name
string
base_price_minor
required
Base Price Minor
integer
currency
required
Currency
string
included_quantities
Included Quantities
object
key
additional properties
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
overage_rates
Overage Rates
object
key
additional properties
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
concurrency_limit
required
Concurrency Limit
integer
receptionist_connections_included
Receptionist Connections Included
integer
0
term
Any of:
string
Allowed values: mtm three_year
feature_flags
Feature Flags
object
key
additional properties
any
workload_class
Any of:
string
Allowed values: engage workforce sales receptionist
extra_sessions
Extra Sessions
integer
0
total_sessions
required
Total Sessions
integer
receptionist_connections
Receptionist Connections
integer
0
total_receptionist_connections
required
Total Receptionist Connections
integer
minute_rate_minor
required
Minute Rate Minor
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
current_period_start
required
Current Period Start
string format: date-time
current_period_end
required
Current Period End
string format: date-time
overrides
Overrides
object
key
additional properties
any
spend_cap
Any of:
SpendCap

The cap pacer governor #4 enforces, wherever it is currently stored.

wallet is the canonical P1 store; subscription_override is the P0 store that remains readable until every cap has migrated (docs/11-billing.md §Wallet).

object
amount_minor
required
Amount Minor
integer
period
Any of:
string
source
required
Source
string
Allowed values: wallet subscription_override
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time
Example
{
  "status": "trialing",
  "plan": {
    "receptionist_connections_included": 0,
    "term": "mtm"
  },
  "workload_class": "engage",
  "extra_sessions": 0,
  "receptionist_connections": 0,
  "spend_cap": {
    "source": "wallet"
  }
}