MRR, subscriptions, new, churned and collected

GET

/v1/revenue/summary

Per currency: mrr_minor, active and trialing subscriptions, paying customers, and for the period new and churned subscriptions with their MRR, net MRR change, collected revenue and payment count. MRR is operational: yearly plans ÷ 12, running coupons applied, metered and tiered prices counted as zero, refunds not subtracted. Amounts are in the smallest currency unit, reported per currency, and never converted or added together. Every response includes sync (status, last_synced_at, livemode): backfilling means the first import is still running, revoked or error means the numbers are as of the last successful sync.

Auth: Secret key only. Indie or Builder.

Authorizations

SecretApiKey

Parameters

Query Parameters

period_days

integer

default: 30 >= 1 <= 730

Capped by plan: Indie 90, Builder 730.

Responses

200

Revenue summary

401

Error envelope. See error.code for the discriminator.

object

data

required

null

error

required

object

code

required

string

message

required

string

remediation

required

string

doc_url

string format: uri

param

string

request_id

string

meta

object

key

additional properties

403

Error envelope. See error.code for the discriminator.

object

data

required

null

error

required

object

code

required

string

message

required

string

remediation

required

string

doc_url

string format: uri

param

string

request_id

string

meta

object

key

additional properties

409

STRIPE_NOT_CONNECTED: connect Stripe in the dashboard first.

object

data

required

null

error

required

object

code

required

string

message

required

string

remediation

required

string

doc_url

string format: uri

param

string

request_id

string

meta

object

key

additional properties