API referenceAdmin deals
Draft an enterprise deal
Creates a draft deal for a workspace with the enterprise plan's limits as the starting point. One open deal per workspace.
Authorization
apiKey AuthorizationBearer <token>
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/deals" \ -H "Content-Type: application/json" \ -d '{ "workspaceId": "string", "label": "string", "reason": "string" }'{ "data": { "id": "string", "workspaceId": "string", "status": "draft", "label": "string", "customerName": "string", "billingEmail": "string", "notes": "string", "billingMode": "polar", "pricingModel": "per_seat", "amountCents": 2147483647, "currency": "string", "interval": "month", "committedSeats": 100000, "startsAt": "string", "endsAt": "string", "autoRenew": true, "maxEditorSeats": 0, "maxRecords": 0, "automationRunsBasePerMonth": 0, "automationRunsPerSeatPerMonth": 0, "maxAutomations": 0, "maxDashboards": 0, "maxForms": 0, "maxStorageBytes": 0, "historyRetentionDays": 0, "features": [ "integrations" ], "aiMonthlyPoolMicrousd": 2147483647, "aiMonthlyPerSeatMicrousd": 2147483647, "aiBurstMicrousd": 2147483647, "aiAutoWindowMicrousd": 2147483647, "aiAutoDailyMicrousd": 2147483647, "polarProductId": "string", "polarCheckoutUrl": "string", "polarSubscriptionId": "string", "activatedAt": "string", "endedAt": "string", "endedReason": "string", "createdAt": "string", "updatedAt": "string" }}{ "_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}