AdminIncomeTotals
The income totals as the administrators see them over the periods from the one that holds
from to the one that holds to, oldest first, with the number of members of each
supporter plan now, and tips, whether the server takes tips now.
object
The periods of the totals: ISO 8601 weeks (Monday to Sunday), calendar months, or calendar years, cut by date.
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.
A week, month, or year of the income totals as the administrators see it: the gross, the
provider’s fee, and the net (gross less fee) of each currency, sorted by currency code,
and the balance, the net less the costs of each currency under the same basis.
net_by_source is the net of each source that the period has: the subscriptions, the tips
(one_time), and the movements of neither.
object
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.
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.
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
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
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
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
The net of one source over a period, by currency.
object
Where a money movement comes from: a subscription to a supporter plan (subscription), a tip
(one_time), or neither (unknown: a payment taken outside this server, or a fee of no
subscription). A refund, a chargeback, or a reversal has the source of its payment.
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
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
The ID of a resource, a UUIDv7 in its canonical string form.
Schema: IncomeTotalsRules
object
Example generated
{ "granularity": "week", "basis": "amortized", "periods": [ { "label": "example", "starts_on": "example", "ends_on": "example", "gross": [ { "amount": "example", "currency": "example" } ], "fee": [ { "amount": "example", "currency": "example" } ], "net": [ { "amount": "example", "currency": "example" } ], "balance": [ { "amount": "example", "currency": "example" } ], "net_by_source": [ { "source": "subscription", "net": [ { "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