curl --request GET \
--url https://api.1club.ai/v1/platform/reports/memberships \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.1club.ai/v1/platform/reports/memberships"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.1club.ai/v1/platform/reports/memberships', 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://api.1club.ai/v1/platform/reports/memberships",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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://api.1club.ai/v1/platform/reports/memberships"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.1club.ai/v1/platform/reports/memberships")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.1club.ai/v1/platform/reports/memberships")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"period": {
"from": "2023-12-25",
"to": "2023-12-25",
"days": 123
},
"timezone": "<string>",
"totals": {
"added": 123,
"cancelled": 123,
"activeAtStart": 123,
"activeAtEnd": 123,
"cancellationRate": 123
},
"byKind": [
{
"added": 123,
"cancelled": 123,
"activeAtStart": 123,
"activeAtEnd": 123,
"cancellationRate": 123,
"kind": "membership"
}
],
"byPlan": [
{
"planId": 123,
"planName": "<string>",
"kind": "membership",
"added": 123,
"cancelled": 123,
"activeAtEnd": 123
}
],
"comparison": {
"kind": "previous_period",
"period": {
"from": "2023-12-25",
"to": "2023-12-25"
},
"totals": {
"added": 123,
"cancelled": 123,
"activeAtStart": 123,
"activeAtEnd": 123,
"cancellationRate": 123
},
"change": {
"added": {
"amount": 123,
"percent": 123
},
"cancelled": {
"amount": 123,
"percent": 123
},
"activeAtEnd": {
"amount": 123,
"percent": 123
}
}
},
"trend": {
"granularity": "day",
"points": [
{
"start": "2023-12-25",
"added": 123,
"cancelled": 123
}
]
}
}{
"error": "<string>",
"code": "<string>",
"details": {}
}{
"error": "<string>",
"code": "<string>",
"details": {}
}{
"error": "<string>",
"code": "<string>",
"details": {}
}{
"error": "<string>",
"code": "<string>",
"details": {}
}Memberships report for a period
How the organization’s memberships moved over a period: how many were added and cancelled, how many were active when it began and ended, and what share of those active at the start were cancelled in it - for recurring Memberships, Passes and Drop-Ins apart (byKind) and together (totals), and for the plans that moved most (byPlan).
added counts the memberships created in the period, whatever became of them since, except a checkout still waiting for its first payment - the Memberships series of the admin’s Historical dashboard. cancelled counts the cancellations recorded in the period, immediate or at the end of the paid period; one undone since is not counted. A membership is active at a moment when it has started, is not past its end date and has not been stopped (cancelled outright, or a Pass with every entry used); a paused membership is active, one still waiting for its first payment is not. Money is not here: what memberships earned is in the revenue report’s memberships, passes and drop_ins streams.
The period is compared with the same number of days just before it or the same dates a year earlier, and trend buckets the additions and cancellations by day, week or month. Days are the club’s own calendar days, on the organization’s clock. A period may span at most 366 days. Reports have their own limit of 20 requests a minute, on top of the platform’s.
curl --request GET \
--url https://api.1club.ai/v1/platform/reports/memberships \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.1club.ai/v1/platform/reports/memberships"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.1club.ai/v1/platform/reports/memberships', 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://api.1club.ai/v1/platform/reports/memberships",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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://api.1club.ai/v1/platform/reports/memberships"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.1club.ai/v1/platform/reports/memberships")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.1club.ai/v1/platform/reports/memberships")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"period": {
"from": "2023-12-25",
"to": "2023-12-25",
"days": 123
},
"timezone": "<string>",
"totals": {
"added": 123,
"cancelled": 123,
"activeAtStart": 123,
"activeAtEnd": 123,
"cancellationRate": 123
},
"byKind": [
{
"added": 123,
"cancelled": 123,
"activeAtStart": 123,
"activeAtEnd": 123,
"cancellationRate": 123,
"kind": "membership"
}
],
"byPlan": [
{
"planId": 123,
"planName": "<string>",
"kind": "membership",
"added": 123,
"cancelled": 123,
"activeAtEnd": 123
}
],
"comparison": {
"kind": "previous_period",
"period": {
"from": "2023-12-25",
"to": "2023-12-25"
},
"totals": {
"added": 123,
"cancelled": 123,
"activeAtStart": 123,
"activeAtEnd": 123,
"cancellationRate": 123
},
"change": {
"added": {
"amount": 123,
"percent": 123
},
"cancelled": {
"amount": 123,
"percent": 123
},
"activeAtEnd": {
"amount": 123,
"percent": 123
}
}
},
"trend": {
"granularity": "day",
"points": [
{
"start": "2023-12-25",
"added": 123,
"cancelled": 123
}
]
}
}{
"error": "<string>",
"code": "<string>",
"details": {}
}{
"error": "<string>",
"code": "<string>",
"details": {}
}{
"error": "<string>",
"code": "<string>",
"details": {}
}{
"error": "<string>",
"code": "<string>",
"details": {}
}Authorizations
Organization-scoped bearer credential: a customer API key (1club_sk_live_...) or an MCP OAuth access token.
Query Parameters
First day of the period (YYYY-MM-DD), on the organization's own clock.
Last day of the period, inclusive.
Only the memberships sold for this club.
What to compare the period with.
previous_period, previous_year, none How trend buckets the period. Chosen from the period's length when omitted.
day, week, month How many plans byPlan lists.
1 <= x <= 50Response
The report
Show child attributes
Show child attributes
The clock the days are read on: the organization's timezone, as on the admin analytics dashboards.
Show child attributes
Show child attributes
Memberships (recurring), Passes and Drop-Ins apart.
Show child attributes
Show child attributes
The plans that moved most - added plus cancelled - largest first.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?