Skip to main content
GET
/
revenue
/
events
List revenue events
curl --request GET \
  --url https://api.billing.io/v1/revenue/events \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "org_id": "<string>",
      "amount": 123,
      "currency": "<string>",
      "checkout_id": "<string>",
      "subscription_id": "<string>",
      "customer_id": "<string>",
      "renewal_id": "<string>",
      "adjustment_id": "<string>",
      "tx_hash": "<string>",
      "description": "<string>",
      "occurred_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z"
    }
  ],
  "has_more": true,
  "next_cursor": "<string>"
}
List revenue events. Filter by type or date range. 
curl "https://api.billing.io/v1/revenue/events?event_type=checkout_confirmed&limit=10" \
  -H "Authorization: Bearer $BILLING_API_KEY"

Authorizations

​
Authorization
string
header
required

Use your secret API key as a Bearer token. Keys are prefixed: sk_live_ (production) or sk_test_ (sandbox).

Query Parameters

​
cursor
string

Opaque cursor for pagination. Omit for the first page.

​
limit
integer
default:25

Number of items per page.

Required range: 1 <= x <= 100
​
event_type
enum<string>

Type of revenue event

Available options:
checkout_confirmed,
subscription_charged,
refund,
adjustment_credit,
adjustment_debit,
chargeback
​
date_from
string<date-time>

Filter events from this date

​
date_to
string<date-time>

Filter events up to this date

Response

Revenue event list

​
data
object[]
​
has_more
boolean
​
next_cursor
string | null