curl --request GET \
--url https://web.subly.app/api/v1/revenue \
--header 'x-api-key: <api-key>'import requests
url = "https://web.subly.app/api/v1/revenue"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://web.subly.app/api/v1/revenue', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://web.subly.app/api/v1/revenue",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://web.subly.app/api/v1/revenue"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://web.subly.app/api/v1/revenue")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://web.subly.app/api/v1/revenue")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body[
{
"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"
}
]{
"error": "<string>"
}List all revenue items
Retrieves a list of all revenue items for the authenticated workspace. Can be filtered by project or recurrence status.
curl --request GET \
--url https://web.subly.app/api/v1/revenue \
--header 'x-api-key: <api-key>'import requests
url = "https://web.subly.app/api/v1/revenue"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://web.subly.app/api/v1/revenue', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://web.subly.app/api/v1/revenue",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://web.subly.app/api/v1/revenue"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://web.subly.app/api/v1/revenue")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://web.subly.app/api/v1/revenue")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body[
{
"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"
}
]{
"error": "<string>"
}Authorizations
Your private API key for authentication. This key identifies your workspace for all requests.
Query Parameters
The unique identifier of the project to filter revenue by.
Filter by whether the revenue is recurring.
Response
A list of revenue items.
Unique identifier for the revenue item.
Name of the revenue source.
The monetary amount of the revenue.
Flag indicating if the revenue is recurring.
Numeric value for billing frequency. Required if recurring.
Time unit for billing frequency. Required if recurring.
day, week, month, year Category for the revenue item.
Array of tag IDs for organization.
Date of the next expected payment. Required if recurring.
Date the recurring revenue stream ends.
ISO 4217 currency code for the amount.
Whether the revenue item is currently active.
Associated URL, e.g., a client's website.
Identifier of the workspace this revenue belongs to.
Identifier of the project this revenue is assigned to.
Was this page helpful?