Skip to main content
GET
How much of the plan is left right now

Authorizations

Authorization
string
header
required

Enter your API key (Bearer token)

Response

200 - application/json
concurrent_calls
number
required

How many calls may be in flight at once, inbound or outbound.

Example:

1

ends_at
string | null
required

ISO-8601. When the plan stops, while plan_status is ending. Otherwise null.

Example:

null

limited
boolean
required

False for plans with no fair-use ceilings. windows is then empty, and nothing here refuses a call.

max_call_minutes
number
required

Longest single call, in minutes. Not a window; a per-call cap.

Example:

60

number_held_until
string | null
required

Reserved for a later release that holds the number for a few days after the plan ends. Always null today.

Example:

null

plan_status
enum<string>
required

ending means the owner cancelled: everything keeps working until ends_at, then the number is released for good. While ending, stop giving the number out to new people. ended means the plan is over.

Available options:
active,
ending,
ended
Example:

"active"

windows
object[]
required