Skip to main content
POST
Create programs
Requires programs:write. See the programs guide for behavior and examples.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string

Optional retry key, unique within the selected program. Reuse the same key, method, path and validated payload; a conflicting reuse returns 409.

Required string length: 8 - 200
Pattern: ^[\x21-\x7e]+$
X-Program-Id
string

Select the key's original program or a program provisioned by this exact key. Other owned programs remain inaccessible.

Body

application/json
name
string
required
Required string length: 1 - 100
websiteUrl
string<uri>
required
Maximum string length: 2000
currency
string
default:USD
Pattern: ^[A-Z]{3}$
Required range: 1 <= x <= 3650
daysToPayout
integer
default:30
Required range: 0 <= x <= 3650
minPayoutThreshold
number
default:0
Required range: 0 <= x <= 1000000000
commissionRate
number
default:0
Required range: 0 <= x <= 1000000000
commissionType
enum<string>
default:PERCENTAGE
Available options:
PERCENTAGE,
FLAT
numberOfPayments
integer
default:0
Required range: 0 <= x <= 1000000
numberOfMonths
integer
default:0
Required range: 0 <= x <= 1000000
paymentTrigger
enum<string>
default:PURCHASE
Available options:
PURCHASE,
SIGNUP

Response

Success; see management guide for state and accounting semantics

Last modified on October 23, 2026