Billing

Start a checkout

POST/v1/workspaces/{workspaceId}/billing/checkout

Start paying for a plan through the provider's hosted checkout. Paying there makes the workspace active on that plan at once (lifting a suspension; published forms come back without republishing). It fails with 409 plan_does_not_fit when the workspace doesn't fit the plan, and issues says what is over, such as "4 brands, Business includes 1". A subscription that hasn't ended answers 409 already_subscribed: change an active one with POST /v1/workspaces/{workspaceId}/billing/plan, and one on hold or paused in the portal. It also fails with 409 billing_off when billing isn't configured, 409 yearly_unavailable for a yearly interval where yearly isn't sold, and 409 free_workspace when staff made the workspace free. Only the workspace owner can do this, and only from the app. See Owner-only and app-only.

curl -X POST "$AYEFORM_API/v1/workspaces/$WORKSPACE_ID/billing/checkout" \
  -H "Authorization: Bearer $AYEFORM_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "plan": "business"
  }'

200 Response

{
  "url": "https://luigispizza.com"
}

Path parameters

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

Body

JSON, with Content-Type: application/json.

planenumrequired
The plan: business, publishers or agencies.
One of "business", "publishers", "agencies"
intervalenum
month (the default) or year. Yearly is billed once a year at the plan's priceYearly, where yearlyAvailable in the billing state is true.
One of "month", "year"
default "month"

Response

urlstringrequired
The provider's hosted checkout.

Errors answer with a status and the error shape.