Get User Subscription Info
Gets extended information about the user’s subscription
Headers
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
The tier of the workspace subscription.
The status of the workspace subscription.
free, free_disabled, trialing, active, incomplete, past_due, on_hold, cancelled, expired The number of credits currently available to the workspace.
The number of credits included in the current billing period.
The number of credits used by the workspace.
The current usage-based credit overage cost.
Maximum number of credits that the credit limit can be exceeded by. "unlimited" means no cap, 0 means usage-based billing is disabled.
Whether the workspace is entitled to enter credit overages.
The number of instant voice-clone slots used in the current workspace.
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.
The maximum number of instant voice-clone slots in the plan.
The maximum number of professional voice-clone slots in the plan.
Whether the plan permits instant voice cloning.
Whether the plan permits professional voice cloning.
The open invoices for the workspace.
Whether the workspace has open invoices.
The display name of the workspace subscription plan.
The billing period of the workspace subscription.
monthly_period, 3_month_period, 6_month_period, annual_period The period on which included credits refresh.
monthly_period, 3_month_period, 6_month_period, annual_period Unix timestamp for the start of the current billing period.
Unix timestamp for the end of the current billing period.
Unix timestamp for the next billing event.
Whether the subscription cancels at period end.
The currency of the workspace subscription.
usd, eur, inr, pln Whether the workspace can use delayed payment methods when creating invoices.
The Unix timestamp of the next included-credit reset.
The number of professional voice-clone slots used in the current workspace.
The next open invoice for the workspace.
The pending subscription change for the workspace.
- PendingSubscriptionSwitchResponseModel
- PendingCancellationResponseModel
True if this account has redeemed a starter first-period discount coupon.
True if this account has redeemed a creator first-period discount coupon.