billing

What this workspace's plan allows, and how much of it is used

get/workspaces/{id}/entitlements

Request

  • Base URL: https://api.swingfactor.ai/v1
  • URL: https://api.swingfactor.ai/v1/workspaces/{id}/entitlements
  • Auth: HTTP bearer

Path parameters

idstring uuid required

The workspace's id (a UUID).

Response

The plan, its status, its limits and the counts.

plan'observer' | 'investigator' | 'institute' | 'null' nullable required
status'active' | 'trialing' | 'past_due' | 'canceled' required
cycle'monthly' | 'annual' required
provider'stripe' | 'apple' | 'google' | 'null' nullable required
renewsAtstring nullable required
cancelAtPeriodEndboolean required
everPaidboolean
featuresstring[] required
limitsobject required
quantityinteger
usageobject
resetsobject
balancesobject

Changes

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