List revenue contracts

GET/revenue/contracts

Returns all revenue contracts for the tenant. Use to populate contract selectors in subscription creation, amendment workflows, or renewal forecast dashboards.

Request

Query parameters

Name	Type	Required	Description
status	string	No	Filter contracts by lifecycle status. One of: "draft", "active", "amended", "expired", "terminated"
page	integer	No	Page number for paginated results. Default: 1

Responses

200 Paginated list of revenue contracts

Content type application/json, object.

Field	Type	Required	Description
data	array of object · RevenueContractV1	No
data[].id	integer	No	Auto-incremented primary key.
data[].name	string	No	Descriptive name of the contract.
data[].status	string	No	Current lifecycle status of the contract. One of: "draft", "active", "amended", "expired", "terminated"
data[].start_date	string (date)	No	Contract commencement date.
data[].end_date	string (date), nullable	No	Contract expiry date. Null for open-ended contracts.
data[].total_value	number (float)	No	Total contract value in the specified currency.
data[].currency	string	No	ISO 4217 three-letter currency code (e.g. USD, GHS, EUR). Max length: 3
data[].billing_frequency	string	No	How often billing events are generated for this contract. One of: "monthly", "quarterly", "annually", "one_off"
data[].customer_id	integer, nullable	No	ID of the associated customer record.
data[].notes	string, nullable	No
data[].created_at	string (date-time)	No
data[].updated_at	string (date-time)	No
meta	object · PaginationMeta	No
meta.current_page	integer	No
meta.per_page	integer	No
meta.total	integer	No

Example

{
  "data": [
    {
      "id": 12,
      "name": "Acme Corp Enterprise Agreement 2026",
      "status": "active",
      "start_date": "2026-01-01",
      "end_date": "2026-12-31",
      "total_value": 48000.0,
      "currency": "USD",
      "billing_frequency": "monthly",
      "created_at": "2025-12-15T10:00:00Z"
    }
  ],
  "meta": {
    "current_page": 1,
    "per_page": 15,
    "total": 34
  }
}

Example request

curl -X GET "https://{tenant}.faciotech.net/api/v1/revenue/contracts" \
  -H "Accept: application/json"