---
title: "Consumer Breakdown"
method: GET
path: "/api/v1/gtm/consumers/breakdown"
tags: ["GTM - Consumers"]
---

# Consumer Breakdown

`GET /api/v1/gtm/consumers/breakdown`

## Request

- Base URL: `https://api.gemstoneaiapp.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.gemstoneaiapp.com/api/v1/gtm/consumers/breakdown`
- Auth: none declared

Aggregate paying subscribers by store, billing period, and product_id.

"Paying" = latest sub per user with status=active AND plan_option.price > 0.
Churning = paying AND cancel_at_period_end.

## Headers

- `x-admin-key` string, nullable

## Response `200`

Successful Response

- ConsumerBreakdown
  - `total_paying` integer, required
  - `total_churning` integer, required
  - `by_store` BreakdownBucket[], required
    - `key` string, required
    - `count` integer, required
    - `mrr_cents` integer, required
  - `by_billing_period` BreakdownBucket[], required
    - `key` string, required
    - `count` integer, required
    - `mrr_cents` integer, required
  - `by_product` BreakdownBucket[], required
    - `key` string, required
    - `count` integer, required
    - `mrr_cents` integer, required

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/gemstoneaiapp/apis/gemstoneai-api.md) · [All operations](https://skmtc.dev/gemstoneaiapp/apis/gemstoneai-api/llms.txt) · [OpenAPI document](https://skmtc.dev/gemstoneaiapp/apis/gemstoneai-api/revisions/fcb441f55161?raw)