POST
/
user
Authorization
string
required

Add your API token here. You can find it by reading the /authentication page.

Response

Although the character_usage and character_allowance fields will always be available through this endpoint, other fields are added here for transparency and may be added or removed without notice.

character_usage
number
required

The character usage for the current billing period.

character_allowance
number
required

The character allowance for the current billing period.

current_plan
string

The current active plan of the user.

downgrading_to_plan
string

The name of the plan being downgraded to, if applicable.

has_payment_method
boolean

Whether the user has a payment method attached to their account.

portal_url
string

Direct link to the Stripe Portal to make changes to the payment method.

renewal_time
number

UNIX timestamp of when the subscription will be renewed.

status
string

Current status of the subscription.