Skip to content

Get revenue breakdown by plan

GET
/dashboard/revenue_by_plan

Get revenue breakdown by plan for donut chart visualization.

start_date
Any of:
string format: date

Period start date (YYYY-MM-DD)

end_date
Any of:
string format: date

Period end date (YYYY-MM-DD)

Successful Response

RevenueByPlanResponse
object
by_plan
required
By Plan
Array<object>
PlanRevenueBreakdown
object
plan_name
required
Plan Name
string
revenue_cents
required
Revenue Cents
number
currency
required
Currency
string

Unauthorized – invalid or missing API key

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object