Sign in

v3

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-0162167359.9 KB
contracts

Pause contract

post/api/v1/documents/contracts/{contract_id}/pause

Path parameters

contract_idstring uuid required

Headers

x-api-keystring nullable

Response

Successful Response

idstring uuid required
clientIdstring uuid required
contractorIdstring uuid required
labelstring nullable
documentIdstring uuid nullable
documentNamestring nullable
documentFileNamestring nullable
documentDownloadLinkstring nullable
type'service' | 'employment' | 'nda' | 'contractor' | 'default_contractor' | 'custom' | 'vendor' | 'milestone' | 'msa' | 'other' required

Contract type.

status'pending_approval_by_contractor' | 'pending_approval_by_client' | 'active' | 'completed' | 'cancelled' | 'paused' required

Contract status.

amountstring nullable
currency'USD' | 'EUR' | 'GBP' | 'JPY' | 'CHF' | 'CAD' | 'AUD' | 'NZD' | 'SEK' | 'NOK' | 'AED' | 'HKD'

Supported invoice/contract currencies. G10 majors + AED/HKD.

periodstring nullable
activationAtstring date-time nullable
expirationAtstring date-time nullable
signatureRequestIdstring nullable
signedobject nullable
clientAcceptanceobject nullable
contractorAcceptanceobject nullable
creatorIdstring uuid nullable
fieldsobject nullable
priorityMethodsTransactionType[]
paymentMethodsobject[]
createdAtstring date-time required
updatedAtstring date-time required