Get User

curl -X POST https://api.console.tts.monster/user \
-H "Authorization: ttsm_12345-abcdef"

{
  "current_plan": "free",
  "status": "active",
  "renewal_time": 1727392003,
  "character_usage": 145892,
  "character_allowance": 500000,
  "portal_url": "https://billing.stripe.com/p/session/live_12345",
  "has_payment_method": true,
  "downgrading_to_plan": null
}

POST

user

curl -X POST https://api.console.tts.monster/user \
-H "Authorization: ttsm_12345-abcdef"

{
  "current_plan": "free",
  "status": "active",
  "renewal_time": 1727392003,
  "character_usage": 145892,
  "character_allowance": 500000,
  "portal_url": "https://billing.stripe.com/p/session/live_12345",
  "has_payment_method": true,
  "downgrading_to_plan": null
}

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.

number

required

The character usage for the current billing period.

number

required

The character allowance for the current billing period.

string

The current active plan of the user.

string

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

boolean

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

string

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

number

UNIX timestamp of when the subscription will be renewed.

string

Current status of the subscription.

curl -X POST https://api.console.tts.monster/user \
-H "Authorization: ttsm_12345-abcdef"

{
  "current_plan": "free",
  "status": "active",
  "renewal_time": 1727392003,
  "character_usage": 145892,
  "character_allowance": 500000,
  "portal_url": "https://billing.stripe.com/p/session/live_12345",
  "has_payment_method": true,
  "downgrading_to_plan": null
}

Get Started

API Documentation

Endpoints

Header

Response

​Header

​Response

Header

Response