contracts
Create a recurring billing agreement
post/api/v1/documents/contracts
Headers
x-api-keystring nullable
Request body
contractorEmailstring nullable
clientEmailstring nullable
labelstring nullable
type'service' | 'employment' | 'nda' | 'contractor' | 'vendor' | 'msa' | 'other'
What the recurring agreement is for. A label only — it drives no logic.
documentIdsstring[]
generateAgreementboolean
agreementInstructionsstring nullable
priorityMethodsTransactionType[]
paymentMethodsobject[]
Response
Successful Response
idstring uuid required
clientIdstring uuid required
contractorIdstring uuid required
creatorIdstring uuid nullable
labelstring nullable
type'service' | 'employment' | 'nda' | 'contractor' | 'vendor' | 'msa' | 'other' required
What the recurring agreement is for. A label only — it drives no logic.
status'active' | 'paused' | 'completed' | 'cancelled' required
Contract status. A contract is live the moment it is created.
amountstring required
currency'USD' | 'EUR' | 'GBP' | 'JPY' | 'CHF' | 'CAD' | 'AUD' | 'NZD' | 'SEK' | 'NOK' | 'AED' | 'HKD' | 'BRL' | 'MXN' | 'USDC' | 'USDT' | 'DAI' | 'SOL' | 'BTC' | 'ETH' | 'NEAR' | 'BNB' | 'XRP' | 'ADA' | 'DOGE' | 'TRX' | 'GRAM' | 'AVAX' | 'MATIC' | 'DOT' | 'LTC' | 'LINK' | 'ARB' | 'OP' | 'SUI' required
Supported invoice/contract currencies. G10 majors + AED/HKD, plus popular crypto tokens.
priorityMethodsTransactionType[]
paymentMethodsobject[]
createdAtstring date-time required
updatedAtstring date-time required