Pause billing

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

Pause billing

cURL

curl --request POST \
  --url https://api.example.com/api/v1/documents/contracts/{contract_id}/pause \
  --header 'Authorization: Bearer <token>'

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "clientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "contractorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "type": "service",
  "status": "active",
  "terms": {
    "currency": "USD",
    "rateType": "fixed",
    "items": [
      {
        "name": "<string>",
        "quantity": "1",
        "price": "0"
      }
    ],
    "scope": "<string>",
    "jobTitle": "<string>",
    "paymentTerms": "<string>"
  },
  "amount": "<string>",
  "currency": "USD",
  "billing": {
    "period": "once",
    "activationAt": "2023-11-07T05:31:56Z",
    "expirationAt": "2023-11-07T05:31:56Z",
    "firstPaymentAt": "2023-12-25",
    "endsOn": "<string>"
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "creatorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "client": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "email": "<string>",
    "displayName": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "entityName": "<string>",
    "avatarUrl": "<string>",
    "isBusiness": false,
    "address": {
      "streetAddress": "<string>",
      "addressLine2": "<string>",
      "city": "<string>",
      "state": "<string>",
      "country": "AF",
      "zip": "<string>"
    }
  },
  "contractor": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "email": "<string>",
    "displayName": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "entityName": "<string>",
    "avatarUrl": "<string>",
    "isBusiness": false,
    "address": {
      "streetAddress": "<string>",
      "addressLine2": "<string>",
      "city": "<string>",
      "state": "<string>",
      "country": "AF",
      "zip": "<string>"
    }
  },
  "label": "<string>",
  "clientAddress": {
    "streetAddress": "<string>",
    "addressLine2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "country": "AF",
    "zip": "<string>"
  },
  "contractorAddress": {
    "streetAddress": "<string>",
    "addressLine2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "country": "AF",
    "zip": "<string>"
  },
  "schedule": {
    "period": "once",
    "firstPaymentAt": "2023-12-25",
    "currentPeriod": 123,
    "periods": [
      {
        "index": 123,
        "periodStart": "2023-12-25",
        "periodEnd": "2023-12-25",
        "dueDate": "2023-12-25"
      }
    ],
    "endsOn": "<string>",
    "totalPeriods": 123
  },
  "documents": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "createdAt": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "fileName": "<string>",
      "documentType": "<string>",
      "downloadLink": "<string>"
    }
  ],
  "priorityMethods": [
    "sepa"
  ],
  "paymentMethods": [
    {}
  ],
  "lastInvoice": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "amount": "<string>",
    "currency": "USD",
    "status": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "contractId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "invoiceNumber": "<string>",
    "issuedDate": "2023-12-25",
    "dueDate": "2023-12-25",
    "paidAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization · string · header · required

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

Headers

x-api-key · string | null

Path Parameters

contract_id · string<uuid> · required

Response

200

application/json

Successful Response

A recurring billing agreement.

id · string<uuid> · required

clientId · string<uuid> · required

contractorId · string<uuid> · required

type · enum<string> · required

What the recurring agreement is for. A label only — it drives no logic.

Available options: service, employment, nda, contractor, vendor, msa, other

status · enum<string> · required

Contract status. A contract is live the moment it is created.

Available options: active, paused, completed, cancelled

terms · ContractTermsInput · object · required

Commercial terms a client sets on a contract.

Show child attributes

amount · string · required

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

currency · enum<string> · required

Supported invoice/contract currencies. G10 majors + AED/HKD, plus popular crypto tokens.

Available options: 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

billing · BillingCycleInput · object · required

The calendar schedule a contract bills on.

endsOn anchors the cycle: a day of month ("1".."31" or "last") for monthly/quarterly/yearly, a weekday name for weekly/biweekly. It is rejected for a one-time contract.

Show child attributes

createdAt · string<date-time> · required

updatedAt · string<date-time> · required

creatorId · string<uuid> | null

client · ContractParty · object | null

Minimal user data embedded in contract responses.

Show child attributes

contractor · ContractParty · object | null

Minimal user data embedded in contract responses.

Show child attributes

label · string | null

clientAddress · UserAddress · object | null

Address schema for user.

Canonical field names: street_address, address_line_2, city, state, country, zip. Accepts legacy Align/IBAN field names (street_line_1, street_line_2, postal_code) for backward compatibility with existing JSONB data.

Show child attributes

contractorAddress · UserAddress · object | null

Address schema for user.

Canonical field names: street_address, address_line_2, city, state, country, zip. Accepts legacy Align/IBAN field names (street_line_1, street_line_2, postal_code) for backward compatibility with existing JSONB data.

Show child attributes

schedule · ContractScheduleResponse · object | null

The resolved calendar schedule of a contract.

Show child attributes

documents · ContractDocument · object[]

Show child attributes

priorityMethods · enum<string>[]

Transaction type - payment rail.

Includes all FiatPaymentType values (sepa/swift/ach/uaefts) plus extended fiat variants (wire/swift-usd/swift-eur/fedwire/pix) and non-fiat rails (crypto/card/internal/refund/oneclick/hevn_transfer).

oneclick, move and hevn_transfer are not stored on Transaction.type but are accepted as filter values for parity with the frontend TransactionType enum (otherwise selecting the "Transfers" category, which sends hevn_transfer, would 400 in parse_csv).

Available options: sepa, swift, ach, uaefts, fedwire, rtp, fednow, spei, pse, transfers_3_0, ukfps, swift-usd, swift-eur, wire, pix, crypto, card, internal, refund, oneclick, move, hevn_transfer, subscription

paymentMethods · Paymentmethods · object[]

lastInvoice · ContractLastInvoice · object | null

Flat last-invoice data embedded in contract responses.

Show child attributes