Contracts API Reference

{
  "success": true,
  "message": "Contracts fetched successfully",
  "data": [
    {
      "id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
      "lead": {
        "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "first_name": "John",
        "last_name": "Doe",
        "email": "john.doe@example.com"
      },
      "program": {
        "name": "12-Week Coaching Program"
      },
      "total_amount": 2997.0,
      "collected_amount": 997.0,
      "to_be_collected": 2000.0,
      "next_due_date": "2026-04-15T00:00:00.000Z",
      "closer": {
        "first_name": "Jane",
        "last_name": "Smith",
        "profile_image_url": "https://img.clerk.com/eyJ0eXBlIjoicHJveHkiLCJzcmMiOiJodHRwczovL2ltYWdlcy5jbGVyay5kZXYvb2F1dGhfZ29vZ2xlL2ltZ18zOWJ3NkxJaTFFSTdlM3Z4RHFhTFViUTZVeFMifQ",
        "id": "user_456def",
        "role": "org:admin"
      },
      "setter": null,
      "triager": null,
      "currency": "USD",
      "contract_status": "SIGNED",
      "contract_type": "PP",
      "subscription_status": null,
      "signed_at": "2026-02-10T14:30:00.000Z",
      "created_at": "2026-02-08T10:00:00.000Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 1,
    "totalPages": 1,
    "hasNext": false,
    "hasPrev": false
  }
}

{
  "success": true,
  "message": "Contract fetched successfully",
  "data": {
    "id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
    "created_with_template": true,
    "currency": "USD",
    "lead": {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "first_name": "John",
      "last_name": "Doe",
      "email": "john.doe@example.com",
      "phone_country": "US",
      "phone_e164": "+14155551234",
      "sales_status": {
        "id": "status_xyz789",
        "name": "Closed Won",
        "text_color": "#14532D",
        "bg_color": "#DCFCE7"
      }
    },
    "first_source": { "id": "src_abc", "name": "Facebook Ad" },
    "last_source": { "id": "src_def", "name": "Referral" },
    "status": "SIGNED",
    "signed_at": "2026-02-10T14:30:00.000Z",
    "voided_at": null,
    "voided_reason": null,
    "voided_by_details": null,
    "type": "PP",
    "closer": {
      "first_name": "Jane",
      "last_name": "Smith",
      "profile_image_url": null,
      "id": "user_456def",
      "role": "org:admin"
    },
    "setter": null,
    "triager": null,
    "program": {
      "id": "prog_abc123",
      "name": "12-Week Coaching Program",
      "notes": null,
      "template_name": "Standard Contract",
      "price": 2997.0,
      "type": "ONE_TIME",
      "co_signer": null
    },
    "payment_mandate": null,
    "custom_fields": [],
    "sign_page_url": "https://sign.hermon.io/c/abc123",
    "esign_preview_pdf_url": "https://sign.hermon.io/preview/abc123.pdf",
    "engagement": {
      "id": "eng_xyz789",
      "name": "John Doe — 12-Week Coaching",
      "status": {
        "id": "engstatus_001",
        "name": "Active",
        "text_color": "#14532D",
        "bg_color": "#DCFCE7"
      }
    },
    "created_at": "2026-02-08T10:00:00.000Z",
    "updated_at": "2026-02-10T14:30:00.000Z",
    "total_value": 2997.0,
    "collected_amount": 997.0,
    "remaining_amount": 2000.0,
    "payments": [
      {
        "id": "pay_001",
        "type": "DEPOSIT",
        "amount": 997.0,
        "date": "2026-02-10T00:00:00.000Z",
        "status": "PAID",
        "payment_provider": "STRIPE",
        "is_mandate_payment": false,
        "active_payment_link": null
      },
      {
        "id": "pay_002",
        "type": "INSTALMENT",
        "amount": 2000.0,
        "date": "2026-04-15T00:00:00.000Z",
        "status": "PENDING",
        "payment_provider": "STRIPE",
        "is_mandate_payment": true,
        "active_payment_link": {
          "id": "link_abc",
          "url": "https://pay.stripe.com/xyz"
        }
      }
    ]
  }
}