Skip to content

Get billing status and usage

GET
/v1/organizations/{org}/billing
curl --request GET \
--url https://api.caller9.app/v1/organizations/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/billing \
--header 'Authorization: Bearer <token>'

Returns the organization’s plan, subscription status, billing contact details and usage for the current billing period.

org
required
string format: uuid

Organization ID (UUID). Must be the organization that owns the API key.

Billing status.

Media typeapplication/json
object
plan
required
string
Allowed values: demo basic premium enterprise
currency
required
string
Allowed values: usd cad
subscriptionStatus
required

Stripe subscription status, or none.

string
currentPeriodStart
required
string | null format: date-time
currentPeriodEnd
required
string | null format: date-time
billingCompanyName
required
string | null
billingContactName
required
string | null
billingEmail
required
string | null
billingInfoComplete
required
boolean
studioCount
required
integer
trunkCount
required

Number of SIP trunks.

integer
usage
required

Usage for the current billing period.

object
callingMinutesUsed
required
number
callingMinutesIncluded
required
number
aiScreeningMinutesUsed
required
number
trunkMinutesUsed
required
number

Example

{
"plan": "demo",
"currency": "usd"
}

Missing, invalid, expired or revoked API key.

Media typeapplication/json
object
error
required

Human-readable error message.

string
code

Machine-readable code (authentication failures only, e.g. KEY_EXPIRED, RATE_LIMITED).

string

Example generated

{
"error": "example",
"code": "example"
}

Not found, or belongs to another organization.

Media typeapplication/json
object
error
required

Human-readable error message.

string
code

Machine-readable code (authentication failures only, e.g. KEY_EXPIRED, RATE_LIMITED).

string

Example generated

{
"error": "example",
"code": "example"
}

Too many requests for this API key. Retry after Retry-After seconds.

Media typeapplication/json
object
error
required

Human-readable error message.

string
code

Machine-readable code (authentication failures only, e.g. KEY_EXPIRED, RATE_LIMITED).

string

Example generated

{
"error": "example",
"code": "example"
}
Retry-After
integer

Seconds until the rate-limit window resets.