Skip to content

IncomeTotals

The income totals over the periods from the one that holds from to the one that holds to, oldest first. plans, the number of members of each supporter plan now, is present only where the plans are shown, with tips, whether the totals include the tips because the server takes them now. No answer carries individual payments, the subscribers, the amounts of each plan, the amount or the number of the tips, or the gross and the fees.

object
granularity
required

The periods of the totals: ISO 8601 weeks (Monday to Sunday), calendar months, or calendar years, cut by date.

string
Allowed values: week month year
basis
required

How the totals place a payment. amortized (the default) spreads each payment of a schedule longer than a month (every 2 or more months, every year, every 5 or more weeks) by day over the days up to the next payment, with the cumulative rounding; the other payments stay on their dates. cash places every payment on its date. Imported usage charges spread by day over their billing period under both.

string
Allowed values: amortized cash
periods
required
Array<object>

A week, month, or year of the income totals (label: 2026-W17, 2026-04, or 2026): the net income of each currency (what the payments brought less the provider’s fees and the refunds), never converted, sorted by currency code. balance is the net less the costs of each currency under the same basis, present only where the balance is shown: a currency of one side alone shows that side’s amount.

object
label
required
string
starts_on
required

A calendar date YYYY-MM-DD without a time or a time zone, such as the day of a payment on a card statement or an invoice.

string
/^[0-9]{4}-[0-9]{2}-[0-9]{2}$/
ends_on
required

A calendar date YYYY-MM-DD without a time or a time zone, such as the day of a payment on a card statement or an invoice.

string
/^[0-9]{4}-[0-9]{2}-[0-9]{2}$/
net
required
Array<object>

An amount of money: a decimal string in the major unit with the digits of its currency (12.34 USD, 1650 JPY), never a JSON number, and its ISO 4217 code.

object
amount
required
string
/^-?[0-9]+(\.[0-9]+)?$/
currency
required
string
/^[A-Z]{3}$/
balance
Array<object>

An amount of money: a decimal string in the major unit with the digits of its currency (12.34 USD, 1650 JPY), never a JSON number, and its ISO 4217 code.

object
amount
required
string
/^-?[0-9]+(\.[0-9]+)?$/
currency
required
string
/^[A-Z]{3}$/
plans
Array<object>

The number of members of a supporter plan now: the subscriptions that hold the plan’s role (active, canceling, or past due within the grace period). A retired plan appears while it has members. Never the plan’s amounts.

object
plan_id
required

The ID of a resource, a UUIDv7 in its canonical string form.

string format: uuid
name
required
string
members
required
integer format: int64
tips
boolean
rules
required
object

Example generated

{
"granularity": "week",
"basis": "amortized",
"periods": [
{
"label": "example",
"starts_on": "example",
"ends_on": "example",
"net": [
{
"amount": "example",
"currency": "example"
}
],
"balance": [
{
"amount": "example",
"currency": "example"
}
]
}
],
"plans": [
{
"plan_id": "01890a5d-ac96-774b-bcce-b302099a8057",
"name": "example",
"members": 1
}
],
"tips": true,
"rules": {}
}

For LLMs and coding agents:llms.txt,llms-full.txt, llms-small.txt

Analytics on this site