Revenue

Org-wide revenue events across every project. Powers the revenue transactions page. Supports filtering by project, date range, and event type.

get/revenue/events

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/revenue/events
  • Auth: HTTP bearer

Query parameters

project_idinteger

Filter to a single project

fromstring

Lower bound (inclusive), ISO-8601

tostring

Upper bound (inclusive), ISO-8601

event_typesstring

Comma-separated event types (e.g. invoice.paid,charge.succeeded)

limitinteger

Max rows, default 100, max 500

Response

amount_minorinteger nullable
currencystring nullable
customer_refstring nullable
event_typestring required
idinteger required
mrr_minorinteger nullable
occurred_atstring date-time required
project_idinteger required
project_namestring required

Changes

No recorded changes to this operation across all 50 revisions of this API.