IncomeMovementPage
A page of money movements, newest first.
object
An opaque pagination cursor. Clients pass it back unchanged and never parse it.
A money movement of the payment provider as the income records keep it:
recorded once its amounts are final, and never edited. occurred_on is occurred_at as a
date in the provider’s reporting time zone. A payment carries the billing period it pays
for (covers_starts_on to covers_ends_on) when it has one; a refund, a chargeback, or a
reversal carries the provider ID of its payment (parent_provider_id). subscription_id
names the subscription while it is known, and tip_id the tip of a one_time movement while
its record is kept; account_id and username are the local account of the subscriber or of
the user who paid the tip while the account exists. A fee of no subscription has none of them.
object
The ID of a resource, a UUIDv7 in its canonical string form.
The kind of a money movement of the payment provider: payment of a
subscription, refund and chargeback of a payment (a negative gross), the
chargeback_reversal that gives a chargeback back, and a fee of the provider that
belongs to no payment (a zero gross and a negative net).
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.
The ID of a resource, a UUIDv7 in its canonical string form.
The ID of a resource, a UUIDv7 in its canonical string form.
The ID of a resource, a UUIDv7 in its canonical string form.
The username of the subscriber or of the user who paid the tip; omitted with account_id for an erased account.
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.
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.
Schema: Money
object
Schema: Money
object
Schema: Money
object
Example generated
{ "next_cursor": "example", "items": [ { "id": "01890a5d-ac96-774b-bcce-b302099a8057", "provider": "example", "provider_id": "example", "kind": "payment", "source": "subscription", "parent_provider_id": "example", "subscription_id": "01890a5d-ac96-774b-bcce-b302099a8057", "tip_id": "01890a5d-ac96-774b-bcce-b302099a8057", "account_id": "01890a5d-ac96-774b-bcce-b302099a8057", "username": "example", "occurred_at": "2026-04-15T12:00:00Z", "occurred_on": "example", "covers_starts_on": "example", "covers_ends_on": "example", "gross": {}, "fee": {}, "net": {}, "recorded_at": "2026-04-15T12:00:00Z" } ]}For LLMs and coding agents:llms.txt,llms-full.txt, llms-small.txt