Workspaces

Get plan entitlements

GET/v1/workspaces/{workspaceId}/entitlements

What the workspace's plan lets it do: its limits, what it uses, its features and how much response history it shows. Creating past a limit answers 403 plan_limit. Using a feature the plan lacks answers 403 plan_feature, and one the workspace's stage doesn't see yet answers 403 feature_unavailable. See Paid checks and Plan history and retention.

curl "$AYEFORM_API/v1/workspaces/$WORKSPACE_ID/entitlements" \
  -H "Authorization: Bearer $AYEFORM_KEY"

200 Response

{
  "plan": "business",
  "planName": "…",
  "status": "trialing",
  "trialEndsAt": 1790879400000,
  "limits": {
    "forms": 1,
    "brands": 1,
    "users": 1
  },
  "usage": {
    "forms": 1,
    "brands": 1,
    "users": 1
  },
  "retentionDays": 1,
  "features": {
    "tracking": false,
    "security": false,
    "botProtection": false,
    "exportsAndApi": false,
    "leadId": false,
    "perBrandAccess": false,
    "verification": false,
    "aiFields": false,
    "hideBadge": false,
    "partialCapture": false
  },
  "planFeatures": {
    "crust": false
  },
  "includedCreditsUsd": 1,
  "integrations": "some",
  "stage": "alpha",
  "overrides": {
    "crust": "Thin crust"
  },
  "free": {
    "plan": "business",
    "metering": false
  },
  "plans": [
    {
      "id": "business",
      "name": "Luigi's Pizza",
      "priceUsd": 1,
      "yearlyPerMonthUsd": 1,
      "limits": {
        "forms": 1,
        "brands": 1,
        "users": 1
      },
      "retentionDays": 1,
      "features": {
        "tracking": false,
        "security": false,
        "botProtection": false,
        "exportsAndApi": false,
        "leadId": false,
        "perBrandAccess": false,
        "verification": false,
        "aiFields": false,
        "hideBadge": false,
        "partialCapture": false
      },
      "integrations": "some",
      "includedCreditsUsd": 1
    }
  ],
  "billingOn": false
}

Path parameters

workspaceIdstringrequired
The workspace's id. An API key can only use its own workspace.

Query parameters

usageboolean
Whether to count what the workspace uses. Defaults to true. Send false to skip counting, and usage comes back null.

Response

planenumrequired
The plan the limits come from.
One of "business", "publishers", "agencies"
planNamestringrequired
statusenumrequired
One of "trialing", "active", "suspended"
trialEndsAtnumber or nullrequired
When the trial ends, in milliseconds since the epoch. Null when there is no trial.
limitsobjectrequired
How many of each the plan includes. Null means unlimited.
Show 3 fieldsHide 3 fields
- formsnumber or nullrequired
  Forms, drafts included. Null means unlimited.
- brandsnumber or nullrequired
  Brands. Null means unlimited.
- usersnumber or nullrequired
  Members, pending invites included. Null means unlimited.
usageone of 2required
How much of each limit the workspace uses, counted up to 500. Null when you pass usage=false, and for a member limited to some brands.
Show 2 optionsHide 2 options
- Option 1
  - formsnumberrequired
  - brandsnumberrequired
  - usersnumberrequired
- null
retentionDaysnumber or nullrequired
Responses older than this many days are hidden, never deleted. Null means every response is shown.
featuresobjectrequired
What the plan includes, plus every released feature by name.
Show 10 fieldsHide 10 fields
- trackingbooleanrequired
- securitybooleanrequired
- botProtectionbooleanrequired
- exportsAndApibooleanrequired
- leadIdbooleanrequired
- perBrandAccessbooleanrequired
- verificationbooleanrequired
  Phone verify and email validate fields. In alpha, so it's true only when both the plan and the workspace's stage allow it.
- aiFieldsbooleanrequired
  ai_autocomplete questions. In alpha, so it's true only when both the plan and the workspace's stage allow it.
- hideBadgebooleanrequired
  Forms may hide the "Powered by ayeform" badge with the form setting hideBadge.
- partialCapturebooleanrequired
  Live forms save unfinished responses with the form setting partialCapture, so visitors can come back to them and the submission.abandoned webhook event fires.
planFeaturesobjectrequired
What the plan includes whatever the stage, with the same keys as features. Use it to show plans, not to decide what works.
includedCreditsUsdnumberrequired
Free credits for metered checks this month, in dollars.
integrationsenumrequired
Which integrations the plan includes, some or all.
One of "some", "all"
stageenumrequired
The workspace's release stage. A feature still in alpha or beta only works for workspaces whose stage sees it.
One of "alpha", "beta", "general"
overridesobjectrequired
Staff's changes to the plan.
freeone of 2required
Set when staff made the workspace free, so it is never billed. Null otherwise.
Show 2 optionsHide 2 options
- Option 1
  - planenum or nullrequired
  - meteringbooleanrequired
- null
plansarray of objectrequired
Every plan's limits and price.
Show 9 fieldsHide 9 fields
- idenumrequired
  One of "business", "publishers", "agencies"
- namestringrequired
- priceUsdnumberrequired
  The monthly price when paid monthly.
- yearlyPerMonthUsdnumberrequired
  The monthly price when paid yearly. A year costs 12 times this.
- limitsobjectrequired
  How many of each the plan includes. Null means unlimited.
  Show 3 fieldsHide 3 fields
  formsnumber or nullrequired
  Forms, drafts included. Null means unlimited.
  brandsnumber or nullrequired
  Brands. Null means unlimited.
  usersnumber or nullrequired
  Members, pending invites included. Null means unlimited.
- retentionDaysnumber or nullrequired
- featuresobjectrequired
  What the plan includes, plus every released feature by name.
  Show 10 fieldsHide 10 fields
  trackingbooleanrequired
  securitybooleanrequired
  botProtectionbooleanrequired
  exportsAndApibooleanrequired
  leadIdbooleanrequired
  perBrandAccessbooleanrequired
  verificationbooleanrequired
  Phone verify and email validate fields. In alpha, so it's true only when both the plan and the workspace's stage allow it.
  aiFieldsbooleanrequired
  ai_autocomplete questions. In alpha, so it's true only when both the plan and the workspace's stage allow it.
  hideBadgebooleanrequired
  Forms may hide the "Powered by ayeform" badge with the form setting hideBadge.
  partialCapturebooleanrequired
  Live forms save unfinished responses with the form setting partialCapture, so visitors can come back to them and the submission.abandoned webhook event fires.
- integrationsenumrequired
  One of "some", "all"
- includedCreditsUsdnumberrequired
billingOnbooleanrequired
Whether plans are for sale on this deployment. While false, no message asks anyone to upgrade.

Errors answer with a status and the error shape.