get/billing/tier

Request

  • Base URL: https://api.useanima.sh/v1
  • URL: https://api.useanima.sh/v1/billing/tier
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Response

OK

tier'free' | 'starter' | 'growth' | 'enterprise' required

Current subscription tier identifier

namestring required

Human-readable name of the subscription tier

priceinteger nullable required

Monthly price in cents, null for custom-priced tiers

renewalDatestring date-time nullable required

ISO 8601 timestamp of the next billing cycle renewal

billingStatus'active' | 'past_due' | 'canceled' | 'cancelled' | 'incomplete' | 'trialing' | 'paused' | 'payment_failed' | 'none' nullable required

Current subscription status from Stripe, null if no subscription

cancelAtPeriodEndboolean required

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

Changes

No recorded changes to this operation across all 1 revision of this API.