Skip to main content
GET
Get Billing Access

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

workspace_id
string<uuid>
required
refresh_subscription
boolean
default:false

Response

Successful Response

workspace_id
string<uuid>
required
has_access
boolean
required
source
string
required
enforcement_enabled
boolean
required
billing_mode
enum<string>
required
Available options:
pending_setup,
stripe_checkout,
manual
is_ontora_staff
boolean
default:false
subscription_status
string | null
subscription_id
string | null
plan_key
string | null
subscription_amount_cents
integer | null
subscription_base_amount_cents
integer | null
subscription_currency
string | null
subscription_interval
string | null
subscription_interval_count
integer | null
subscription_discount_applied
boolean
default:false
subscription_cancel_at_period_end
boolean
default:false
trial_ends_at
string<date-time> | null
current_period_end
string<date-time> | null
access_ends_at
string<date-time> | null
is_tester
boolean
default:false