Update a plan's entitlements
Changes the limits and entitlements attached to one plan. Platform admins only; an unknown plan is reported as not found and invalid entitlement values are rejected as a validation error.
Authorization
apiKey Workspace API key created in Workspace settings → API keys. Scopes on the key bound what it can read and write.
In: header
Path Parameters
Value in
- "free"
- "team"
- "business"
- "enterprise"
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
curl -X PATCH "https://example.com/v1/admin/billing/plans/free" \ -H "Content-Type: application/json" \ -d '{}'{ "data": { "plan": "free", "name": "string", "tagline": "string", "bullets": [ "string" ], "selfServe": true, "sortOrder": 0, "maxEditorSeats": 0, "maxRecords": 0, "automationRunsBasePerMonth": 0, "automationRunsPerSeatPerMonth": 0, "maxAutomations": 0, "maxDashboards": 0, "maxForms": 0, "maxStorageBytes": 0, "historyRetentionDays": 0, "features": [ "string" ], "aiMonthlyBaseMicrousd": 0, "aiMonthlyPerSeatMicrousd": 0, "aiBurstMicrousd": 0, "aiOnboardingGrantMicrousd": 0 }}{ "_tag": "ApiNotFound", "error": "not_found", "message": "That item does not exist, or this key cannot see it.", "status": 404}{ "_tag": "ApiNotFound", "error": "not_found", "message": "That item does not exist, or this key cannot see it.", "status": 404}Update a billing price row
Changes an existing price and re-provisions its Polar product so the returned `polarProductId` stays current. Platform admins only; an unknown `priceId` is reported as not found.
Launch a pricing experiment
Creates the variant price rows for a pricing experiment, provisions their Polar products, and returns the experiment summary. Platform admins only; an invalid variant set is rejected as a validation error.