ADMINISTRATIONUser

Get user subscription

Gets extended information about the users subscription

Headers

xi-api-keystringRequired

Response

Successful Response

tierstring

The tier of the user’s subscription.

character_countinteger

The number of characters used by the user.

character_limitinteger

The maximum number of characters allowed in the current billing period.

can_extend_character_limitboolean

Whether the user can extend their character limit.

allowed_to_extend_character_limitboolean

Whether the user is allowed to extend their character limit.

voice_slots_usedinteger

The number of voice slots used by the user.

professional_voice_slots_usedinteger

The number of professional voice slots used by the workspace/user if single seat.

voice_limitinteger

The maximum number of voice slots allowed for the user.

voice_add_edit_counterinteger

The number of voice add/edits used by the user.

professional_voice_limitinteger

The maximum number of professional voices allowed for the user.

can_extend_voice_limitboolean

Whether the user can extend their voice limit.

can_use_instant_voice_cloningboolean

Whether the user can use instant voice cloning.

can_use_professional_voice_cloningboolean

Whether the user can use professional voice cloning.

statusenum

The status of the user’s subscription.

has_open_invoicesboolean

Whether the user has open invoices.

max_character_limit_extensionintegerOptional

Maximum number of characters that the character limit can be exceeded by. Managed by the workspace admin.

next_character_count_reset_unixintegerOptional

The Unix timestamp of the next character count reset.

max_voice_add_editsintegerOptional

The maximum number of voice add/edits allowed for the user.

currencyenumOptional

The currency of the user’s subscription.

Allowed values:
billing_periodenumOptional

The billing period of the user’s subscription.

Allowed values:
character_refresh_periodenumOptional

The character refresh period of the user’s subscription.

Allowed values:
next_invoiceobjectOptional

The next invoice for the user.

Errors