Skip to content

AdminIncomePeriodTotal

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
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}$/
gross
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}$/
fee
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}$/
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
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}$/
net_by_source
required
Array<object>

The net of one source over a period, by currency.

object
source
required

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.

string
Allowed values: subscription one_time unknown
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}$/

Example generated

{
"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"
}
]
}
]
}

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

Analytics on this site