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.
Authorization
apiKey Workspace API key created in Workspace settings → API keys. Scopes on the key bound what it can read and write.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
curl -X POST "https://example.com/v1/admin/billing/experiments" \ -H "Content-Type: application/json" \ -d '{ "name": "string", "allocation": 0, "variants": [ { "label": "string", "split": 0, "prices": [ { "plan": "free", "interval": "month", "amountCents": 0 } ] } ] }'{ "data": { "id": "string", "name": "string", "hypothesis": "string", "status": "draft", "allocation": 0, "assignmentUnit": "workspace", "audience": "string", "startedAt": "string", "winner": "string", "variants": [ { "variantId": "string", "label": "string", "split": 0, "exposures": 0, "conversions": 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 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.
List Polar subscriptions not linked to a workspace
Returns the Polar subscriptions that exist upstream but are not yet attached to a Snoze workspace, joined with the plan each product maps to. Used for the migration flow. Platform admins only.