Billing

Open the billing portal

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

Open the provider's customer portal for cards, invoices and cancelling. Before the workspace's first checkout it fails with 409 no_billing_account. 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/portal" \
  -H "Authorization: Bearer $AYEFORM_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

200 Response

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

Path parameters

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

Response

urlstringrequired
The provider's customer portal.

Errors answer with a status and the error shape.