Skip to content
BoxBilling

Get subscription metrics

GET
/dashboard/subscriptions

Get subscription metrics: active, new, canceled, by-plan breakdown.

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
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)

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

SubscriptionMetricsResponse
object
active
required
Active
integer
new_this_month
required
New This Month
integer
canceled_this_month
required
Canceled This Month
integer
by_plan
required
By Plan
Array<object>
SubscriptionPlanBreakdown
object
plan_name
required
Plan Name
string
count
required
Count
integer
new_trend
Any of:
TrendIndicator
object
previous_value
required
Previous Value
number
change_percent
required
Any of:
number
canceled_trend
Any of:
TrendIndicator
object
previous_value
required
Previous Value
number
change_percent
required
Any of:
number

401

Section titled “401 ”

Unauthorized – invalid or missing API key

422

Section titled “422 ”

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