Skip to main content
GET
/
billing
/
tier
cURL
curl --request GET \
  --url https://api.useanima.sh/v1/billing/tier \
  --header 'Authorization: Bearer <token>'
{
  "name": "<string>",
  "price": 123,
  "limits": {
    "messages": 123,
    "agents": 123,
    "domains": 123
  },
  "renewalDate": "2023-11-07T05:31:56Z",
  "cancelAtPeriodEnd": true
}

Authorizations

​
Authorization
string
header
required

JWT Bearer token obtained from authentication. Pass as: Authorization: Bearer

Response

200 - application/json

OK

Subscription tier details including pricing and resource limits

​
tier
enum<string>
required

Current subscription tier identifier

Available options:
free,
starter,
growth,
scale,
enterprise
​
name
string
required

Human-readable name of the subscription tier

​
price
integer | null
required

Monthly price in cents, null for custom-priced tiers

​
limits
object
required

Resource limits for this tier

​
renewalDate
string<date-time> | null
required

ISO 8601 timestamp of the next billing cycle renewal

​
billingStatus
enum<string> | null
required

Current subscription status from Stripe, null if no subscription

Available options:
active,
past_due,
canceled,
cancelled,
incomplete,
trialing,
paused,
payment_failed,
none
​
cancelAtPeriodEnd
boolean
required

Whether the subscription is set to cancel at the end of the current period