Skip to main content
GET
/
revenue
List all revenue items
curl --request GET \
  --url https://web.subly.app/api/v1/revenue \
  --header 'x-api-key: <api-key>'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "amount": 123,
    "is_recurring": true,
    "billing_freq": 123,
    "billing_range": "day",
    "category": "<string>",
    "tags": [
      123
    ],
    "nextPaymentDate": "2023-11-07T05:31:56Z",
    "end_date": "2023-11-07T05:31:56Z",
    "currency": "<string>",
    "isActive": true,
    "website": "<string>",
    "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
]

Authorizations

​
x-api-key
string
header
required

Your private API key for authentication. This key identifies your workspace for all requests.

Query Parameters

​
project_id
string<uuid>

The unique identifier of the project to filter revenue by.

​
is_recurring
boolean

Filter by whether the revenue is recurring.

Response

A list of revenue items.

​
id
string<uuid>

Unique identifier for the revenue item.

​
name
string

Name of the revenue source.

​
amount
number<float>

The monetary amount of the revenue.

​
is_recurring
boolean

Flag indicating if the revenue is recurring.

​
billing_freq
integer

Numeric value for billing frequency. Required if recurring.

​
billing_range
enum<string>

Time unit for billing frequency. Required if recurring.

Available options:
day,
week,
month,
year
​
category
string

Category for the revenue item.

​
tags
integer[]

Array of tag IDs for organization.

​
nextPaymentDate
string<date-time>

Date of the next expected payment. Required if recurring.

​
end_date
string<date-time>

Date the recurring revenue stream ends.

​
currency
string

ISO 4217 currency code for the amount.

​
isActive
boolean

Whether the revenue item is currently active.

​
website
string<uri>

Associated URL, e.g., a client's website.

​
workspace_id
string<uuid>

Identifier of the workspace this revenue belongs to.

​
project_id
string<uuid>

Identifier of the project this revenue is assigned to.