Skip to main content
GET
Get subscription

Authorizations

Authorization
string
header
required

Use a JWT bearer token or a Veryfront API key in the Authorization header.

Response

The authenticated user’s subscription. Under external billing, configured entitlements are returned for an existing user even without a stored subscription. Seat usage is the usage that seat changes and invitations are checked against.

id
string<uuid>

Subscription ID

project_id
string<uuid> | null

Project this subscription is scoped to, when applicable

line_items
object[]

Subscription line items. Credits are one-time top-ups and are not included here.

seat_usage
object

Seat usage that seat changes and invitations are checked against. A seat change must keep at least used seats.

status
string

Subscription status

current_period_start
string | null

Current billing period start timestamp

current_period_end
string | null

Current billing period end timestamp

expires_at
string | null

Subscription expiration timestamp

canceled_at
string | null

Subscription cancellation timestamp

created_at
string

Subscription creation timestamp

billing_mode
enum<string>
Available options:
stripe,
external
entitlements
object
plan_type
enum<string>

Canonical plan resolved from the configured plan price ID, independent of billed amount

Available options:
free,
pro,
enterprise
user_id
string<uuid>

Captured financial actor UUID retained for compatibility; the account owns the subscription

server_usage
number

Active dedicated server records for the account

sandbox_usage
number

Active sandbox records for the account

server_usage_details
object[]

Active server add-on usage with linked project and environment labels