Create a fixed-pay agreement
Create a fixed-pay agreement. Agree a PROJECT fee or WEEKLY/MONTHLY fixed compensation. It replaces hourly pay for the covered project (or all projects) and dates. Terms are immutable; periods are paid in full without proration. Overlaps and windows containing approved hourly pay are rejected (422). Owner/Admin only (Managers and Members receive 403 before any record lookup); Agency plan (`teamPayouts`, 402 with requiredPlan agency otherwise). Requires the `write` scope. Requires an Idempotency-Key. Money values are exact decimal strings; dates are ISO calendar dates.
Authorization
BearerAuth Personal Access Token. Mint at Settings → API. Token shape: hsk_<env>_<prefix12>_<secret32>.
In: header
Path Parameters
Header Parameters
Caller-generated UUID/ULID. Same key + same body replays the original response; the key also derives the durable operation identity, so a retried payment, reversal or draft is never applied twice.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/team-payouts/payees/497f6eca-6276-4993-bfeb-53cbbbba6f08/fixed-agreements" \ -H "Idempotency-Key: string" \ -H "Content-Type: application/json" \ -d '{ "cadence": "PROJECT", "description": "string", "amount": "string", "currency": "str", "startsOn": "2019-08-24" }'{ "data": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "payeeId": "79417842-2e1e-4110-a361-89b9f39b36ed", "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b", "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8", "projectName": "string", "cadence": "PROJECT", "description": "string", "amount": "string", "currency": "string", "startsOn": "2019-08-24", "endsOn": "2019-08-24", "archivedAt": "2019-08-24T14:15:22Z", "archivedOn": "2019-08-24", "status": "ACTIVE", "links": { "app": "string", "payee": "string" } }, "warnings": [ "string" ]}{ "error": { "code": "unauthenticated", "message": "string", "fields": { "property1": "string", "property2": "string" }, "requiredPlan": "studio", "feature": "string", "requestId": "string" }}{ "error": { "code": "unauthenticated", "message": "string", "fields": { "property1": "string", "property2": "string" }, "requiredPlan": "studio", "feature": "string", "requestId": "string" }}{ "error": { "code": "unauthenticated", "message": "string", "fields": { "property1": "string", "property2": "string" }, "requiredPlan": "studio", "feature": "string", "requestId": "string" }}{ "error": { "code": "unauthenticated", "message": "string", "fields": { "property1": "string", "property2": "string" }, "requiredPlan": "studio", "feature": "string", "requestId": "string" }}{ "error": { "code": "unauthenticated", "message": "string", "fields": { "property1": "string", "property2": "string" }, "requiredPlan": "studio", "feature": "string", "requestId": "string" }}{ "error": { "code": "unauthenticated", "message": "string", "fields": { "property1": "string", "property2": "string" }, "requiredPlan": "studio", "feature": "string", "requestId": "string" }}List fixed-pay agreements
Read-only. Fixed-pay agreements (oldest start first, up to 500), optionally for one payee, with status relative to today. Unknown or repeated query parameters return 422. Owner/Admin only (Managers and Members receive 403 before any record lookup); Agency plan (`teamPayouts`, 402 with requiredPlan agency otherwise). Requires the `read` scope. Money values are exact decimal strings; dates are ISO calendar dates.
Archive a fixed-pay agreement
Irreversible: coverage ends before the archive day — today in the workspace payout calendar, or the day after the last period an approved bill already covers, if that is later; the response's archivedOn is that effective day. Complete earlier periods stay payable. Archiving an archived agreement changes nothing. Body: {} or empty. Owner/Admin only (Managers and Members receive 403 before any record lookup); Agency plan (`teamPayouts`, 402 with requiredPlan agency otherwise). Requires the `write` scope. Requires an Idempotency-Key. Money values are exact decimal strings; dates are ISO calendar dates.