Skip to main content
GET
/
v0
/
revenue
Get revenue time series
curl --request GET \
  --url https://api.paygentic.io/v0/revenue \
  --header 'Authorization: Bearer <token>'
{
  "object": "<string>",
  "buckets": [
    {
      "timestamp": "2023-11-07T05:31:56Z",
      "subscriptionStats": {},
      "totalStats": {
        "usageRevenue": "<string>",
        "feeRevenue": "<string>",
        "refundAmount": "<string>",
        "netRevenue": "<string>",
        "usageCount": 123,
        "feeCount": 123,
        "usageRefundCount": 123,
        "feeRefundCount": 123
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

API key authentication

Query Parameters

​
startTime
string<date-time>
required

Start of the time range (ISO 8601 format)

​
endTime
string<date-time>
required

End of the time range (ISO 8601 format)

​
bucketWidth
enum<string>
default:hour

Time bucket granularity

Available options:
minute,
hour,
day
​
merchantId
string

Filter by merchant ID. At least one of merchantId, subscriptionIds, or customerId must be provided. Unique identifier for an organization

Pattern: ^org_[a-zA-Z0-9]+$
​
customerId
string

Filter by customer ID. At least one of merchantId, subscriptionIds, or customerId must be provided.

​
subscriptionIds
string[]

Filter by subscription IDs. At least one of merchantId, subscriptionIds, or customerId must be provided.

​
topN
integer
default:10

Limit to top N subscriptions by net revenue. Remaining subscriptions are aggregated into 'other'.

Required range: 1 <= x <= 100

Response

Revenue time series data

​
object
string
required

Object type identifier

Allowed value: "revenue_time_series"
​
buckets
object[]
required

Time-bucketed revenue data