set_payout_schedule
Save your workspace's payout schedule whole. On each run day (UTC) a payout run of every unpaid ledger entry whose billing period has ended is requested in the name of whoever saved the schedule, so it still waits for approval by someone else, never by that saver; while a request is still waiting, the next run day requests nothing new. Turning it on needs a person behind the credential: a signed-in user, or a key or agent a person created. Answers 404 while payout runs are not switched on for your workspace (list_payout_runs says so in execution.enabled). Needs a Last Price credential with billing write scope. Needs a claimed workspace: a sandbox key from self-registration is refused (403) until a person claims the workspace.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| cadence | Yes | weekly or monthly. | |
| enabled | Yes | true to request payouts on each run day, false to stop. | |
| run_day | Yes | weekly: 1 (Monday) to 7 (Sunday). monthly: 1 to 28, so every month has it. | |
| auto_retry | No | Re-send transfers waiting for a retry each hour, with the same idempotency keys. Defaults to true. |