Skip to content

List subscriptions

GET/revenue/subscriptions

Returns all active and inactive subscriptions for the tenant. Subscriptions represent a customer's recurring product/service commitment, linked to a contract and a price book. Use to populate the subscription management dashboard or feed renewal forecasting.

Request

Query parameters

NameTypeRequiredDescription
statusstringNo

Filter subscriptions by lifecycle status.

One of: "trial", "active", "paused", "cancelled", "expired"

contract_idintegerNo

Filter subscriptions linked to a specific contract.

Responses

200 List of subscriptions

Content type application/json, array of object · RevenueSubscriptionV1.

FieldTypeRequiredDescription
idintegerNo
namestringNo

Descriptive name for the subscription.

statusstringNo

One of: "trial", "active", "paused", "cancelled", "expired"

contract_idinteger, nullableNo

ID of the governing revenue contract.

price_book_idinteger, nullableNo

ID of the price book used to price this subscription.

customer_idinteger, nullableNo
start_datestring (date)No
end_datestring (date), nullableNo
monthly_valuenumber (float)No

Monthly recurring revenue value of this subscription.

currencystringNo

Max length: 3

seatsinteger, nullableNo

Number of licensed seats (if seat-based pricing).

next_billing_datestring (date), nullableNo
created_atstring (date-time)No

Example

[
  {
    "id": 8,
    "name": "Acme Corp — Enterprise Plan",
    "status": "active",
    "contract_id": 12,
    "price_book_id": 3,
    "start_date": "2026-01-01",
    "next_billing_date": "2026-05-01",
    "monthly_value": 4000.0,
    "currency": "USD"
  }
]

Example request

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