Skip to main content
GET
Get User Subscription Info

Headers

x-api-key
string | null

Your API key for programmatic access. Send it in the x-api-key header; you can create and manage keys from the Developers page.

Response

Successful Response

tier
string
required

The tier of the workspace subscription.

status
enum<string>
required

The status of the workspace subscription.

Available options:
free,
free_disabled,
trialing,
active,
incomplete,
past_due,
on_hold,
cancelled,
expired
credits_balance
integer
required

The number of credits currently available to the workspace.

credits_limit
integer
required

The number of credits included in the current billing period.

credits_used
integer
required

The number of credits used by the workspace.

current_overage
Price · object
required

The current usage-based credit overage cost.

max_credit_limit_extension
required

Maximum number of credits that the credit limit can be exceeded by. "unlimited" means no cap, 0 means usage-based billing is disabled.

can_extend_credit_limit
boolean
required

Whether the workspace is entitled to enter credit overages.

voice_slots_used
integer
required

The number of instant voice-clone slots used in the current workspace.

professional_voice_slots_used
integer
required

The number of professional voice-clone slots used across the consolidated billing group. For independently billed workspaces, this equals professional_voice_slots_used_in_workspace.

voice_limit
integer
required

The maximum number of instant voice-clone slots in the plan.

professional_voice_limit
integer
required

The maximum number of professional voice-clone slots in the plan.

can_use_instant_voice_cloning
boolean
required

Whether the plan permits instant voice cloning.

can_use_professional_voice_cloning
boolean
required

Whether the plan permits professional voice cloning.

open_invoices
InvoiceResponseModel · object[]
required

The open invoices for the workspace.

has_open_invoices
boolean
required

Whether the workspace has open invoices.

plan_name
string | null

The display name of the workspace subscription plan.

billing_period
enum<string> | null

The billing period of the workspace subscription.

Available options:
monthly_period,
3_month_period,
6_month_period,
annual_period
credit_refresh_period
enum<string> | null

The period on which included credits refresh.

Available options:
monthly_period,
3_month_period,
6_month_period,
annual_period
current_period_start_unix_secs
integer | null

Unix timestamp for the start of the current billing period.

current_period_end_unix_secs
integer | null

Unix timestamp for the end of the current billing period.

next_billing_at_unix_secs
integer | null

Unix timestamp for the next billing event.

cancel_at_period_end
boolean
default:false

Whether the subscription cancels at period end.

currency
enum<string> | null

The currency of the workspace subscription.

Available options:
usd,
eur,
inr,
pln
trust_on_invoice_creation
boolean
default:false

Whether the workspace can use delayed payment methods when creating invoices.

next_credit_reset_unix
integer | null

The Unix timestamp of the next included-credit reset.

professional_voice_slots_used_in_workspace
integer | null

The number of professional voice-clone slots used in the current workspace.

next_invoice
InvoiceResponseModel · object | null

The next open invoice for the workspace.

pending_change
PendingSubscriptionSwitchResponseModel · object

The pending subscription change for the workspace.

has_used_starter_coupon_on_account
boolean
default:false

True if this account has redeemed a starter first-period discount coupon.

has_used_creator_coupon_on_account
boolean
default:false

True if this account has redeemed a creator first-period discount coupon.