ユーザーサブスクリプションを取得

ユーザーのサブスクリプションに関する拡張情報を取得します。

ヘッダー

xi-api-keystringオプション

レスポンス

成功レスポンス。

tierstring

ユーザーのサブスクリプションのティアです。

character_countinteger

ユーザーが使用した文字数。

character_limitinteger

現在の請求期間に許可される最大文字数。

max_character_limit_extensioninteger or null

非推奨:max_credit_limit_extensionを使用してください。文字数上限を超過できる最大文字数。ワークスペース管理者が管理します。

max_credit_limit_extensioninteger or "unlimited"

クレジット上限を超過できる最大クレジット数。ワークスペース管理者が管理します。"unlimited"は上限なし、0は従量課金が無効であることを意味します。

can_extend_character_limitboolean

ワークスペースが超過分(従量課金)を利用できるかどうか。

allowed_to_extend_character_limitboolean

非推奨:max_credit_limit_extension != 0を使用してください。ユーザーに文字数上限の拡張が許可されているかどうか。

voice_slots_usedinteger

ユーザーが使用した音声スロット数。

professional_voice_slots_usedinteger

使用中のプロフェッショナル音声スロット数。統合請求では、グループ内のすべてのワークスペースを対象としたグループ全体の数です。現在のワークスペースのみの数はprofessional_voice_slots_used_in_workspaceを参照してください。

professional_voice_slots_used_in_workspaceinteger

現在のワークスペースで使用中のプロフェッショナル音声スロット数。統合請求では、professional_voice_slots_usedはグループ内のすべてのワークスペースを対象に集計しますが、これは現在のワークスペースのみを対象に集計します。

voice_limitinteger

ユーザーに許可される音声スロットの最大数。

voice_add_edit_counterinteger

ユーザーが使用した音声の追加・編集回数。

professional_voice_limitinteger

ユーザーに許可されるプロフェッショナル音声の最大数。

can_extend_voice_limitboolean

ユーザーが音声数の上限を拡張できるかどうか。

can_use_instant_voice_cloningboolean

ユーザーがインスタントボイスクローンを使用できるかどうか。

can_use_professional_voice_cloningboolean

ユーザーがプロフェッショナルボイスクローンを使用できるかどうか。

current_overageobject

現在の従量制超過料金。

statusenum

ユーザーのサブスクリプションのステータス。

open_invoiceslist of objects

ユーザーの未払い請求書。

has_open_invoicesboolean

ユーザーに未払いの請求書があるかどうか。

next_character_count_reset_unixinteger or nullオプション

次回の文字数カウントのリセット日時を示すUnixタイムスタンプです。

max_voice_add_editsinteger or nullオプション

ユーザーに許可される音声の追加・編集の最大数。

currencyenum or nullオプション

ユーザーのサブスクリプションの通貨。

許可された値:
billing_periodenum or nullオプション

ユーザーのサブスクリプションの請求期間。

許可された値:
character_refresh_periodenum or nullオプション

ユーザーのサブスクリプションにおける文字数の更新期間。

許可された値:
next_invoiceobject or nullオプション

ユーザーの次の請求書。

pending_changeobject or nullオプション

ユーザーの保留中の変更。

has_used_starter_coupon_on_accountbooleanオプションデフォルト値 false

このユーザーの認証アカウントが所有するいずれかのワークスペースで、スターターの初月割引クーポンが利用済みの場合はtrueです。

has_used_creator_coupon_on_accountbooleanオプションデフォルト値 false

このユーザーの認証アカウントが所有するいずれかのワークスペースで、クリエイターの初月割引クーポンが利用済みの場合はtrueです。

エラー

422
Unprocessable Entity Error