---
title: "Get Metrics"
method: GET
path: "/v1/metrics/"
tags: ["metrics", "public"]
---

# Get Metrics

`GET /v1/metrics/`

Get metrics about your orders and subscriptions.

Currency values are output in cents.

**Scopes**: `metrics:read`

## Query parameters

- `start_date` string, date, required — Start date.
- `end_date` string, date, required — End date.
- `timezone` 'Africa/Abidjan' | 'Africa/Accra' | 'Africa/Addis_Ababa' | 'Africa/Algiers' | 'Africa/Asmara' | 'Africa/Asmera' | 'Africa/Bamako' | 'Africa/Bangui' | 'Africa/Banjul' | 'Africa/Bissau' | 'Africa/Blantyre' | 'Africa/Brazzaville' | 'Africa/Bujumbura' | 'Africa/Cairo' | 'Africa/Casablanca' | 'Africa/Ceuta' | 'Africa/Conakry' | 'Africa/Dakar' | 'Africa/Dar_es_Salaam' | 'Africa/Djibouti' | 'Africa/Douala' | 'Africa/El_Aaiun' | 'Africa/Freetown' | 'Africa/Gaborone' | 'Africa/Harare' | 'Africa/Johannesburg' | 'Africa/Juba' | 'Africa/Kampala' | 'Africa/Khartoum' | 'Africa/Kigali' | 'Africa/Kinshasa' | 'Africa/Lagos' | 'Africa/Libreville' | 'Africa/Lome' | 'Africa/Luanda' | 'Africa/Lubumbashi' | 'Africa/Lusaka' | 'Africa/Malabo' | 'Africa/Maputo' | 'Africa/Maseru' | 'Africa/Mbabane' | 'Africa/Mogadishu' | 'Africa/Monrovia' | 'Africa/Nairobi' | 'Africa/Ndjamena' | 'Africa/Niamey' | 'Africa/Nouakchott' | 'Africa/Ouagadougou' | 'Africa/Porto-Novo' | 'Africa/Sao_Tome' | 'Africa/Timbuktu' | 'Africa/Tripoli' | 'Africa/Tunis' | 'Africa/Windhoek' | 'America/Adak' | 'America/Anchorage' | 'America/Anguilla' | 'America/Antigua' | 'America/Araguaina' | 'America/Argentina/Buenos_Aires' | 'America/Argentina/Catamarca' | 'America/Argentina/ComodRivadavia' | 'America/Argentina/Cordoba' | 'America/Argentina/Jujuy' | 'America/Argentina/La_Rioja' | 'America/Argentina/Mendoza' | 'America/Argentina/Rio_Gallegos' | 'America/Argentina/Salta' | 'America/Argentina/San_Juan' | 'America/Argentina/San_Luis' | 'America/Argentina/Tucuman' | 'America/Argentina/Ushuaia' | 'America/Aruba' | 'America/Asuncion' | 'America/Atikokan' | 'America/Atka' | 'America/Bahia' | 'America/Bahia_Banderas' | 'America/Barbados' | 'America/Belem' | 'America/Belize' | 'America/Blanc-Sablon' | 'America/Boa_Vista' | 'America/Bogota' | 'America/Boise' | 'America/Buenos_Aires' | 'America/Cambridge_Bay' | 'America/Campo_Grande' | 'America/Cancun' | 'America/Caracas' | 'America/Catamarca' | 'America/Cayenne' | 'America/Cayman' | 'America/Chicago' | 'America/Chihuahua' | 'America/Ciudad_Juarez' | 'America/Coral_Harbour' | 'America/Cordoba' | 'America/Costa_Rica' | 'America/Coyhaique' | 'America/Creston' | 'America/Cuiaba' | 'America/Curacao' | 'America/Danmarkshavn' | 'America/Dawson' | 'America/Dawson_Creek' | 'America/Denver' | 'America/Detroit' | 'America/Dominica' | 'America/Edmonton' | 'America/Eirunepe' | 'America/El_Salvador' | 'America/Ensenada' | 'America/Fort_Nelson' | 'America/Fort_Wayne' | 'America/Fortaleza' | 'America/Glace_Bay' | 'America/Godthab' | 'America/Goose_Bay' | 'America/Grand_Turk' | 'America/Grenada' | 'America/Guadeloupe' | 'America/Guatemala' | 'America/Guayaquil' | 'America/Guyana' | 'America/Halifax' | 'America/Havana' | 'America/Hermosillo' | 'America/Indiana/Indianapolis' | 'America/Indiana/Knox' | 'America/Indiana/Marengo' | 'America/Indiana/Petersburg' | 'America/Indiana/Tell_City' | 'America/Indiana/Vevay' | 'America/Indiana/Vincennes' | 'America/Indiana/Winamac' | 'America/Indianapolis' | 'America/Inuvik' | 'America/Iqaluit' | 'America/Jamaica' | 'America/Jujuy' | 'America/Juneau' | 'America/Kentucky/Louisville' | 'America/Kentucky/Monticello' | 'America/Knox_IN' | 'America/Kralendijk' | 'America/La_Paz' | 'America/Lima' | 'America/Los_Angeles' | 'America/Louisville' | 'America/Lower_Princes' | 'America/Maceio' | 'America/Managua' | 'America/Manaus' | 'America/Marigot' | 'America/Martinique' | 'America/Matamoros' | 'America/Mazatlan' | 'America/Mendoza' | 'America/Menominee' | 'America/Merida' | 'America/Metlakatla' | 'America/Mexico_City' | 'America/Miquelon' | 'America/Moncton' | 'America/Monterrey' | 'America/Montevideo' | 'America/Montreal' | 'America/Montserrat' | 'America/Nassau' | 'America/New_York' | 'America/Nipigon' | 'America/Nome' | 'America/Noronha' | 'America/North_Dakota/Beulah' | 'America/North_Dakota/Center' | 'America/North_Dakota/New_Salem' | 'America/Nuuk' | 'America/Ojinaga' | 'America/Panama' | 'America/Pangnirtung' | 'America/Paramaribo' | 'America/Phoenix' | 'America/Port-au-Prince' | 'America/Port_of_Spain' | 'America/Porto_Acre' | 'America/Porto_Velho' | 'America/Puerto_Rico' | 'America/Punta_Arenas' | 'America/Rainy_River' | 'America/Rankin_Inlet' | 'America/Recife' | 'America/Regina' | 'America/Resolute' | 'America/Rio_Branco' | 'America/Rosario' | 'America/Santa_Isabel' | 'America/Santarem' | 'America/Santiago' | 'America/Santo_Domingo' | 'America/Sao_Paulo' | 'America/Scoresbysund' | 'America/Shiprock' | 'America/Sitka' | 'America/St_Barthelemy' | 'America/St_Johns' | 'America/St_Kitts' | 'America/St_Lucia' | 'America/St_Thomas' | 'America/St_Vincent' | 'America/Swift_Current' | 'America/Tegucigalpa' | 'America/Thule' | 'America/Thunder_Bay' | 'America/Tijuana' | 'America/Toronto' | 'America/Tortola' | 'America/Vancouver' | 'America/Virgin' | 'America/Whitehorse' | 'America/Winnipeg' | 'America/Yakutat' | 'America/Yellowknife' | 'Antarctica/Casey' | 'Antarctica/Davis' | 'Antarctica/DumontDUrville' | 'Antarctica/Macquarie' | 'Antarctica/Mawson' | 'Antarctica/McMurdo' | 'Antarctica/Palmer' | 'Antarctica/Rothera' | 'Antarctica/South_Pole' | 'Antarctica/Syowa' | 'Antarctica/Troll' | 'Antarctica/Vostok' | 'Arctic/Longyearbyen' | 'Asia/Aden' | 'Asia/Almaty' | 'Asia/Amman' | 'Asia/Anadyr' | 'Asia/Aqtau' | 'Asia/Aqtobe' | 'Asia/Ashgabat' | 'Asia/Ashkhabad' | 'Asia/Atyrau' | 'Asia/Baghdad' | 'Asia/Bahrain' | 'Asia/Baku' | 'Asia/Bangkok' | 'Asia/Barnaul' | 'Asia/Beirut' | 'Asia/Bishkek' | 'Asia/Brunei' | 'Asia/Calcutta' | 'Asia/Chita' | 'Asia/Choibalsan' | 'Asia/Chongqing' | 'Asia/Chungking' | 'Asia/Colombo' | 'Asia/Dacca' | 'Asia/Damascus' | 'Asia/Dhaka' | 'Asia/Dili' | 'Asia/Dubai' | 'Asia/Dushanbe' | 'Asia/Famagusta' | 'Asia/Gaza' | 'Asia/Harbin' | 'Asia/Hebron' | 'Asia/Ho_Chi_Minh' | 'Asia/Hong_Kong' | 'Asia/Hovd' | 'Asia/Irkutsk' | 'Asia/Istanbul' | 'Asia/Jakarta' | 'Asia/Jayapura' | 'Asia/Jerusalem' | 'Asia/Kabul' | 'Asia/Kamchatka' | 'Asia/Karachi' | 'Asia/Kashgar' | 'Asia/Kathmandu' | 'Asia/Katmandu' | 'Asia/Khandyga' | 'Asia/Kolkata' | 'Asia/Krasnoyarsk' | 'Asia/Kuala_Lumpur' | 'Asia/Kuching' | 'Asia/Kuwait' | 'Asia/Macao' | 'Asia/Macau' | 'Asia/Magadan' | 'Asia/Makassar' | 'Asia/Manila' | 'Asia/Muscat' | 'Asia/Nicosia' | 'Asia/Novokuznetsk' | 'Asia/Novosibirsk' | 'Asia/Omsk' | 'Asia/Oral' | 'Asia/Phnom_Penh' | 'Asia/Pontianak' | 'Asia/Pyongyang' | 'Asia/Qatar' | 'Asia/Qostanay' | 'Asia/Qyzylorda' | 'Asia/Rangoon' | 'Asia/Riyadh' | 'Asia/Saigon' | 'Asia/Sakhalin' | 'Asia/Samarkand' | 'Asia/Seoul' | 'Asia/Shanghai' | 'Asia/Singapore' | 'Asia/Srednekolymsk' | 'Asia/Taipei' | 'Asia/Tashkent' | 'Asia/Tbilisi' | 'Asia/Tehran' | 'Asia/Tel_Aviv' | 'Asia/Thimbu' | 'Asia/Thimphu' | 'Asia/Tokyo' | 'Asia/Tomsk' | 'Asia/Ujung_Pandang' | 'Asia/Ulaanbaatar' | 'Asia/Ulan_Bator' | 'Asia/Urumqi' | 'Asia/Ust-Nera' | 'Asia/Vientiane' | 'Asia/Vladivostok' | 'Asia/Yakutsk' | 'Asia/Yangon' | 'Asia/Yekaterinburg' | 'Asia/Yerevan' | 'Atlantic/Azores' | 'Atlantic/Bermuda' | 'Atlantic/Canary' | 'Atlantic/Cape_Verde' | 'Atlantic/Faeroe' | 'Atlantic/Faroe' | 'Atlantic/Jan_Mayen' | 'Atlantic/Madeira' | 'Atlantic/Reykjavik' | 'Atlantic/South_Georgia' | 'Atlantic/St_Helena' | 'Atlantic/Stanley' | 'Australia/ACT' | 'Australia/Adelaide' | 'Australia/Brisbane' | 'Australia/Broken_Hill' | 'Australia/Canberra' | 'Australia/Currie' | 'Australia/Darwin' | 'Australia/Eucla' | 'Australia/Hobart' | 'Australia/LHI' | 'Australia/Lindeman' | 'Australia/Lord_Howe' | 'Australia/Melbourne' | 'Australia/NSW' | 'Australia/North' | 'Australia/Perth' | 'Australia/Queensland' | 'Australia/South' | 'Australia/Sydney' | 'Australia/Tasmania' | 'Australia/Victoria' | 'Australia/West' | 'Australia/Yancowinna' | 'Brazil/Acre' | 'Brazil/DeNoronha' | 'Brazil/East' | 'Brazil/West' | 'CET' | 'CST6CDT' | 'Canada/Atlantic' | 'Canada/Central' | 'Canada/Eastern' | 'Canada/Mountain' | 'Canada/Newfoundland' | 'Canada/Pacific' | 'Canada/Saskatchewan' | 'Canada/Yukon' | 'Chile/Continental' | 'Chile/EasterIsland' | 'Cuba' | 'EET' | 'EST' | 'EST5EDT' | 'Egypt' | 'Eire' | 'Etc/GMT' | 'Etc/GMT+0' | 'Etc/GMT+1' | 'Etc/GMT+10' | 'Etc/GMT+11' | 'Etc/GMT+12' | 'Etc/GMT+2' | 'Etc/GMT+3' | 'Etc/GMT+4' | 'Etc/GMT+5' | 'Etc/GMT+6' | 'Etc/GMT+7' | 'Etc/GMT+8' | 'Etc/GMT+9' | 'Etc/GMT-0' | 'Etc/GMT-1' | 'Etc/GMT-10' | 'Etc/GMT-11' | 'Etc/GMT-12' | 'Etc/GMT-13' | 'Etc/GMT-14' | 'Etc/GMT-2' | 'Etc/GMT-3' | 'Etc/GMT-4' | 'Etc/GMT-5' | 'Etc/GMT-6' | 'Etc/GMT-7' | 'Etc/GMT-8' | 'Etc/GMT-9' | 'Etc/GMT0' | 'Etc/Greenwich' | 'Etc/UCT' | 'Etc/UTC' | 'Etc/Universal' | 'Etc/Zulu' | 'Europe/Amsterdam' | 'Europe/Andorra' | 'Europe/Astrakhan' | 'Europe/Athens' | 'Europe/Belfast' | 'Europe/Belgrade' | 'Europe/Berlin' | 'Europe/Bratislava' | 'Europe/Brussels' | 'Europe/Bucharest' | 'Europe/Budapest' | 'Europe/Busingen' | 'Europe/Chisinau' | 'Europe/Copenhagen' | 'Europe/Dublin' | 'Europe/Gibraltar' | 'Europe/Guernsey' | 'Europe/Helsinki' | 'Europe/Isle_of_Man' | 'Europe/Istanbul' | 'Europe/Jersey' | 'Europe/Kaliningrad' | 'Europe/Kiev' | 'Europe/Kirov' | 'Europe/Kyiv' | 'Europe/Lisbon' | 'Europe/Ljubljana' | 'Europe/London' | 'Europe/Luxembourg' | 'Europe/Madrid' | 'Europe/Malta' | 'Europe/Mariehamn' | 'Europe/Minsk' | 'Europe/Monaco' | 'Europe/Moscow' | 'Europe/Nicosia' | 'Europe/Oslo' | 'Europe/Paris' | 'Europe/Podgorica' | 'Europe/Prague' | 'Europe/Riga' | 'Europe/Rome' | 'Europe/Samara' | 'Europe/San_Marino' | 'Europe/Sarajevo' | 'Europe/Saratov' | 'Europe/Simferopol' | 'Europe/Skopje' | 'Europe/Sofia' | 'Europe/Stockholm' | 'Europe/Tallinn' | 'Europe/Tirane' | 'Europe/Tiraspol' | 'Europe/Ulyanovsk' | 'Europe/Uzhgorod' | 'Europe/Vaduz' | 'Europe/Vatican' | 'Europe/Vienna' | 'Europe/Vilnius' | 'Europe/Volgograd' | 'Europe/Warsaw' | 'Europe/Zagreb' | 'Europe/Zaporozhye' | 'Europe/Zurich' | 'Factory' | 'GB' | 'GB-Eire' | 'GMT' | 'GMT+0' | 'GMT-0' | 'GMT0' | 'Greenwich' | 'HST' | 'Hongkong' | 'Iceland' | 'Indian/Antananarivo' | 'Indian/Chagos' | 'Indian/Christmas' | 'Indian/Cocos' | 'Indian/Comoro' | 'Indian/Kerguelen' | 'Indian/Mahe' | 'Indian/Maldives' | 'Indian/Mauritius' | 'Indian/Mayotte' | 'Indian/Reunion' | 'Iran' | 'Israel' | 'Jamaica' | 'Japan' | 'Kwajalein' | 'Libya' | 'MET' | 'MST' | 'MST7MDT' | 'Mexico/BajaNorte' | 'Mexico/BajaSur' | 'Mexico/General' | 'NZ' | 'NZ-CHAT' | 'Navajo' | 'PRC' | 'PST8PDT' | 'Pacific/Apia' | 'Pacific/Auckland' | 'Pacific/Bougainville' | 'Pacific/Chatham' | 'Pacific/Chuuk' | 'Pacific/Easter' | 'Pacific/Efate' | 'Pacific/Enderbury' | 'Pacific/Fakaofo' | 'Pacific/Fiji' | 'Pacific/Funafuti' | 'Pacific/Galapagos' | 'Pacific/Gambier' | 'Pacific/Guadalcanal' | 'Pacific/Guam' | 'Pacific/Honolulu' | 'Pacific/Johnston' | 'Pacific/Kanton' | 'Pacific/Kiritimati' | 'Pacific/Kosrae' | 'Pacific/Kwajalein' | 'Pacific/Majuro' | 'Pacific/Marquesas' | 'Pacific/Midway' | 'Pacific/Nauru' | 'Pacific/Niue' | 'Pacific/Norfolk' | 'Pacific/Noumea' | 'Pacific/Pago_Pago' | 'Pacific/Palau' | 'Pacific/Pitcairn' | 'Pacific/Pohnpei' | 'Pacific/Ponape' | 'Pacific/Port_Moresby' | 'Pacific/Rarotonga' | 'Pacific/Saipan' | 'Pacific/Samoa' | 'Pacific/Tahiti' | 'Pacific/Tarawa' | 'Pacific/Tongatapu' | 'Pacific/Truk' | 'Pacific/Wake' | 'Pacific/Wallis' | 'Pacific/Yap' | 'Poland' | 'Portugal' | 'ROC' | 'ROK' | 'Singapore' | 'Turkey' | 'UCT' | 'US/Alaska' | 'US/Aleutian' | 'US/Arizona' | 'US/Central' | 'US/East-Indiana' | 'US/Eastern' | 'US/Hawaii' | 'US/Indiana-Starke' | 'US/Michigan' | 'US/Mountain' | 'US/Pacific' | 'US/Samoa' | 'UTC' | 'Universal' | 'W-SU' | 'WET' | 'Zulu' | 'localtime' — Timezone to use for the timestamps. Default is UTC.
- `interval` 'year' | 'month' | 'week' | 'day' | 'hour', required
- `organization_id` union — Filter by organization ID.
  - string, uuid4 — The organization ID.
  - string[]
- `product_id` union — Filter by product ID.
  - string, uuid4 — The product ID.
  - string[]
- `billing_type` union — Filter by billing type. `recurring` will filter data corresponding to subscriptions creations or renewals. `one_time` will filter data corresponding to one-time purchases.
  - 'one_time' | 'recurring'
  - ProductBillingType[]
- `customer_id` union — Filter by customer ID.
  - string, uuid4 — The customer ID.
  - string[]
- `metrics` string[], nullable — List of metric slugs to focus on. When provided, only the queries needed for these metrics will be executed, improving performance. If not provided, all metrics are returned.

## Response `200`

Successful Response

- MetricsResponse — Metrics response schema.
  - `periods` MetricPeriod[], required — List of data for each timestamp.
    - `timestamp` string, date-time, required — Timestamp of this period data.
    - `active_subscriptions` union
      - integer
      - number
    - `committed_subscriptions` union
      - integer
      - number
    - `monthly_recurring_revenue` union
      - integer
      - number
    - `trial_monthly_recurring_revenue` union
      - integer
      - number
    - `committed_monthly_recurring_revenue` union
      - integer
      - number
    - `trial_committed_monthly_recurring_revenue` union
      - integer
      - number
    - `average_revenue_per_user` union
      - integer
      - number
    - `checkouts` union
      - integer
      - number
    - `succeeded_checkouts` union
      - integer
      - number
    - `churned_subscriptions` union
      - integer
      - number
    - `churn_rate` union
      - integer
      - number
    - `seats_total` union
      - integer
      - number
    - `seats_claimed` union
      - integer
      - number
    - `seats_pending` union
      - integer
      - number
    - `seat_customers` union
      - integer
      - number
    - `new_seat_customers` union
      - integer
      - number
    - `churned_seat_customers` union
      - integer
      - number
    - `orders` union
      - integer
      - number
    - `revenue` union
      - integer
      - number
    - `net_revenue` union
      - integer
      - number
    - `cumulative_revenue` union
      - integer
      - number
    - `net_cumulative_revenue` union
      - integer
      - number
    - `costs` union
      - integer
      - number
    - `cumulative_costs` union
      - integer
      - number
    - `average_order_value` union
      - integer
      - number
    - `net_average_order_value` union
      - integer
      - number
    - `cost_per_user` union
      - integer
      - number
    - `active_user_by_event` union
      - integer
      - number
    - `one_time_products` union
      - integer
      - number
    - `one_time_products_revenue` union
      - integer
      - number
    - `one_time_products_net_revenue` union
      - integer
      - number
    - `new_subscriptions` union
      - integer
      - number
    - `new_subscriptions_revenue` union
      - integer
      - number
    - `new_subscriptions_net_revenue` union
      - integer
      - number
    - `renewed_subscriptions` union
      - integer
      - number
    - `renewed_subscriptions_revenue` union
      - integer
      - number
    - `renewed_subscriptions_net_revenue` union
      - integer
      - number
    - `canceled_subscriptions` union
      - integer
      - number
    - `canceled_subscriptions_customer_service` union
      - integer
      - number
    - `canceled_subscriptions_low_quality` union
      - integer
      - number
    - `canceled_subscriptions_missing_features` union
      - integer
      - number
    - `canceled_subscriptions_switched_service` union
      - integer
      - number
    - `canceled_subscriptions_too_complex` union
      - integer
      - number
    - `canceled_subscriptions_too_expensive` union
      - integer
      - number
    - `canceled_subscriptions_unused` union
      - integer
      - number
    - `canceled_subscriptions_other` union
      - integer
      - number
    - `annual_recurring_revenue` union
      - integer
      - number
    - `committed_annual_recurring_revenue` union
      - integer
      - number
    - `checkouts_conversion` union
      - integer
      - number
    - `ltv` union
      - integer
      - number
    - `gross_margin` union
      - integer
      - number
    - `gross_margin_percentage` union
      - integer
      - number
    - `cashflow` union
      - integer
      - number
    - `average_seats_per_customer` union
      - integer
      - number
    - `seat_utilization_rate` union
      - integer
      - number
  - `totals` MetricsTotals, required
    - `active_subscriptions` union
      - integer
      - number
    - `committed_subscriptions` union
      - integer
      - number
    - `monthly_recurring_revenue` union
      - integer
      - number
    - `trial_monthly_recurring_revenue` union
      - integer
      - number
    - `committed_monthly_recurring_revenue` union
      - integer
      - number
    - `trial_committed_monthly_recurring_revenue` union
      - integer
      - number
    - `average_revenue_per_user` union
      - integer
      - number
    - `checkouts` union
      - integer
      - number
    - `succeeded_checkouts` union
      - integer
      - number
    - `churned_subscriptions` union
      - integer
      - number
    - `churn_rate` union
      - integer
      - number
    - `seats_total` union
      - integer
      - number
    - `seats_claimed` union
      - integer
      - number
    - `seats_pending` union
      - integer
      - number
    - `seat_customers` union
      - integer
      - number
    - `new_seat_customers` union
      - integer
      - number
    - `churned_seat_customers` union
      - integer
      - number
    - `orders` union
      - integer
      - number
    - `revenue` union
      - integer
      - number
    - `net_revenue` union
      - integer
      - number
    - `cumulative_revenue` union
      - integer
      - number
    - `net_cumulative_revenue` union
      - integer
      - number
    - `costs` union
      - integer
      - number
    - `cumulative_costs` union
      - integer
      - number
    - `average_order_value` union
      - integer
      - number
    - `net_average_order_value` union
      - integer
      - number
    - `cost_per_user` union
      - integer
      - number
    - `active_user_by_event` union
      - integer
      - number
    - `one_time_products` union
      - integer
      - number
    - `one_time_products_revenue` union
      - integer
      - number
    - `one_time_products_net_revenue` union
      - integer
      - number
    - `new_subscriptions` union
      - integer
      - number
    - `new_subscriptions_revenue` union
      - integer
      - number
    - `new_subscriptions_net_revenue` union
      - integer
      - number
    - `renewed_subscriptions` union
      - integer
      - number
    - `renewed_subscriptions_revenue` union
      - integer
      - number
    - `renewed_subscriptions_net_revenue` union
      - integer
      - number
    - `canceled_subscriptions` union
      - integer
      - number
    - `canceled_subscriptions_customer_service` union
      - integer
      - number
    - `canceled_subscriptions_low_quality` union
      - integer
      - number
    - `canceled_subscriptions_missing_features` union
      - integer
      - number
    - `canceled_subscriptions_switched_service` union
      - integer
      - number
    - `canceled_subscriptions_too_complex` union
      - integer
      - number
    - `canceled_subscriptions_too_expensive` union
      - integer
      - number
    - `canceled_subscriptions_unused` union
      - integer
      - number
    - `canceled_subscriptions_other` union
      - integer
      - number
    - `annual_recurring_revenue` union
      - integer
      - number
    - `committed_annual_recurring_revenue` union
      - integer
      - number
    - `checkouts_conversion` union
      - integer
      - number
    - `ltv` union
      - integer
      - number
    - `gross_margin` union
      - integer
      - number
    - `gross_margin_percentage` union
      - integer
      - number
    - `cashflow` union
      - integer
      - number
    - `average_seats_per_customer` union
      - integer
      - number
    - `seat_utilization_rate` union
      - integer
      - number
  - `metrics` Metrics, required
    - `active_subscriptions` Metric — Information about a metric.
      - `slug` string, required — Unique identifier for the metric.
      - `display_name` string, required — Human-readable name for the metric.
      - `type` 'scalar' | 'currency' | 'currency_sub_cent' | 'percentage', required
    - `committed_subscriptions` Metric — Information about a metric.
      - `slug` string, required — Unique identifier for the metric.
      - `display_name` string, required — Human-readable name for the metric.
      - `type` 'scalar' | 'currency' | 'currency_sub_cent' | 'percentage', required
    - `monthly_recurring_revenue` Metric — Information about a metric.
      - `slug` string, required — Unique identifier for the metric.
      - `display_name` string, required — Human-readable name for the metric.
      - `type` 'scalar' | 'currency' | 'currency_sub_cent' | 'percentage', required
    - `trial_monthly_recurring_revenue` Metric — Information about a metric.
      - `slug` string, required — Unique identifier for the metric.
      - `display_name` string, required — Human-readable name for the metric.
      - `type` 'scalar' | 'currency' | 'currency_sub_cent' | 'percentage', required
    - `committed_monthly_recurring_revenue` Metric — Information about a metric.
      - `slug` string, required — Unique identifier for the metric.
      - `display_name` string, required — Human-readable name for the metric.
      - `type` 'scalar' | 'currency' | 'currency_sub_cent' | 'percentage', required
    - `trial_committed_monthly_recurring_revenue` Metric — Information about a metric.
      - `slug` string, required — Unique identifier for the metric.
      - `display_name` string, required — Human-readable name for the metric.
      - `type` 'scalar' | 'currency' | 'currency_sub_cent' | 'percentage', required
    - `average_revenue_per_user` Metric — Information about a metric.
      - `slug` string, required — Unique identifier for the metric.
      - `display_name` string, required — Human-readable name for the metric.
      - `type` 'scalar' | 'currency' | 'currency_sub_cent' | 'percentage', required
    - `checkouts` Metric — Information about a metric.
      - `slug` string, required — Unique identifier for the metric.
      - `display_name` string, required — Human-readable name for the metric.
      - `type` 'scalar' | 'currency' | 'currency_sub_cent' | 'percentage', required
    - `succeeded_checkouts` Metric — Information about a metric.
      - `slug` string, required — Unique identifier for the metric.
      - `display_name` string, required — Human-readable name for the metric.
      - `type` 'scalar' | 'currency' | 'currency_sub_cent' | 'percentage', required
    - `churned_subscriptions` Metric — Information about a metric.
      - `slug` string, required — Unique identifier for the metric.
      - `display_name` string, required — Human-readable name for the metric.
      - `type` 'scalar' | 'currency' | 'currency_sub_cent' | 'percentage', required
    - `churn_rate` Metric — Information about a metric.
      - `slug` string, required — Unique identifier for the metric.
      - `display_name` string, required — Human-readable name for the metric.
      - `type` 'scalar' | 'currency' | 'currency_sub_cent' | 'percentage', required
    - `seats_total` Metric — Information about a metric.
      - `slug` string, required — Unique identifier for the metric.
      - `display_name` string, required — Human-readable name for the metric.
      - `type` 'scalar' | 'currency' | 'currency_sub_cent' | 'percentage', required
    - `seats_claimed` Metric — Information about a metric.
      - `slug` string, required — Unique identifier for the metric.
      - `display_name` string, required — Human-readable name for the metric.
      - `type` 'scalar' | 'currency' | 'currency_sub_cent' | 'percentage', required
    - `seats_pending` Metric — Information about a metric.
      - `slug` string, required — Unique identifier for the metric.
      - `display_name` string, required — Human-readable name for the metric.
      - `type` 'scalar' | 'currency' | 'currency_sub_cent' | 'percentage', required
    - `seat_customers` Metric — Information about a metric.
      - `slug` string, required — Unique identifier for the metric.
      - `display_name` string, required — Human-readable name for the metric.
      - `type` 'scalar' | 'currency' | 'currency_sub_cent' | 'percentage', required
    - `new_seat_customers` Metric — Information about a metric.
      - `slug` string, required — Unique identifier for the metric.
      - `display_name` string, required — Human-readable name for the metric.
      - `type` 'scalar' | 'currency' | 'currency_sub_cent' | 'percentage', required
    - `churned_seat_customers` Metric — Information about a metric.
      - `slug` string, required — Unique identifier for the metric.
      - `display_name` string, required — Human-readable name for the metric.
      - `type` 'scalar' | 'currency' | 'currency_sub_cent' | 'percentage', required
    - `orders` Metric — Information about a metric.
      - `slug` string, required — Unique identifier for the metric.
      - `display_name` string, required — Human-readable name for the metric.
      - `type` 'scalar' | 'currency' | 'currency_sub_cent' | 'percentage', required
    - `revenue` Metric — Information about a metric.
      - `slug` string, required — Unique identifier for the metric.
      - `display_name` string, required — Human-readable name for the metric.
      - `type` 'scalar' | 'currency' | 'currency_sub_cent' | 'percentage', required
    - `net_revenue` Metric — Information about a metric.
      - `slug` string, required — Unique identifier for the metric.
      - `display_name` string, required — Human-readable name for the metric.
      - `type` 'scalar' | 'currency' | 'currency_sub_cent' | 'percentage', required
    - `cumulative_revenue` Metric — Information about a metric.
      - `slug` string, required — Unique identifier for the metric.
      - `display_name` string, required — Human-readable name for the metric.
      - `type` 'scalar' | 'currency' | 'currency_sub_cent' | 'percentage', required
    - `net_cumulative_revenue` Metric — Information about a metric.
      - `slug` string, required — Unique identifier for the metric.
      - `display_name` string, required — Human-readable name for the metric.
      - `type` 'scalar' | 'currency' | 'currency_sub_cent' | 'percentage', required
    - `costs` Metric — Information about a metric.
      - `slug` string, required — Unique identifier for the metric.
      - `display_name` string, required — Human-readable name for the metric.
      - `type` 'scalar' | 'currency' | 'currency_sub_cent' | 'percentage', required
    - `cumulative_costs` Metric — Information about a metric.
      - `slug` string, required — Unique identifier for the metric.
      - `display_name` string, required — Human-readable name for the metric.
      - `type` 'scalar' | 'currency' | 'currency_sub_cent' | 'percentage', required
    - `average_order_value` Metric — Information about a metric.
      - `slug` string, required — Unique identifier for the metric.
      - `display_name` string, required — Human-readable name for the metric.
      - `type` 'scalar' | 'currency' | 'currency_sub_cent' | 'percentage', required
    - `net_average_order_value` Metric — Information about a metric.
      - `slug` string, required — Unique identifier for the metric.
      - `display_name` string, required — Human-readable name for the metric.
      - `type` 'scalar' | 'currency' | 'currency_sub_cent' | 'percentage', required
    - `cost_per_user` Metric — Information about a metric.
      - `slug` string, required — Unique identifier for the metric.
      - `display_name` string, required — Human-readable name for the metric.
      - `type` 'scalar' | 'currency' | 'currency_sub_cent' | 'percentage', required
    - `active_user_by_event` Metric — Information about a metric.
      - `slug` string, required — Unique identifier for the metric.
      - `display_name` string, required — Human-readable name for the metric.
      - `type` 'scalar' | 'currency' | 'currency_sub_cent' | 'percentage', required
    - `one_time_products` Metric — Information about a metric.
      - `slug` string, required — Unique identifier for the metric.
      - `display_name` string, required — Human-readable name for the metric.
      - `type` 'scalar' | 'currency' | 'currency_sub_cent' | 'percentage', required
    - `one_time_products_revenue` Metric — Information about a metric.
      - `slug` string, required — Unique identifier for the metric.
      - `display_name` string, required — Human-readable name for the metric.
      - `type` 'scalar' | 'currency' | 'currency_sub_cent' | 'percentage', required
    - `one_time_products_net_revenue` Metric — Information about a metric.
      - `slug` string, required — Unique identifier for the metric.
      - `display_name` string, required — Human-readable name for the metric.
      - `type` 'scalar' | 'currency' | 'currency_sub_cent' | 'percentage', required
    - `new_subscriptions` Metric — Information about a metric.
      - `slug` string, required — Unique identifier for the metric.
      - `display_name` string, required — Human-readable name for the metric.
      - `type` 'scalar' | 'currency' | 'currency_sub_cent' | 'percentage', required
    - `new_subscriptions_revenue` Metric — Information about a metric.
      - `slug` string, required — Unique identifier for the metric.
      - `display_name` string, required — Human-readable name for the metric.
      - `type` 'scalar' | 'currency' | 'currency_sub_cent' | 'percentage', required
    - `new_subscriptions_net_revenue` Metric — Information about a metric.
      - `slug` string, required — Unique identifier for the metric.
      - `display_name` string, required — Human-readable name for the metric.
      - `type` 'scalar' | 'currency' | 'currency_sub_cent' | 'percentage', required
    - `renewed_subscriptions` Metric — Information about a metric.
      - `slug` string, required — Unique identifier for the metric.
      - `display_name` string, required — Human-readable name for the metric.
      - `type` 'scalar' | 'currency' | 'currency_sub_cent' | 'percentage', required
    - `renewed_subscriptions_revenue` Metric — Information about a metric.
      - `slug` string, required — Unique identifier for the metric.
      - `display_name` string, required — Human-readable name for the metric.
      - `type` 'scalar' | 'currency' | 'currency_sub_cent' | 'percentage', required
    - `renewed_subscriptions_net_revenue` Metric — Information about a metric.
      - `slug` string, required — Unique identifier for the metric.
      - `display_name` string, required — Human-readable name for the metric.
      - `type` 'scalar' | 'currency' | 'currency_sub_cent' | 'percentage', required
    - `canceled_subscriptions` Metric — Information about a metric.
      - `slug` string, required — Unique identifier for the metric.
      - `display_name` string, required — Human-readable name for the metric.
      - `type` 'scalar' | 'currency' | 'currency_sub_cent' | 'percentage', required
    - `canceled_subscriptions_customer_service` Metric — Information about a metric.
      - `slug` string, required — Unique identifier for the metric.
      - `display_name` string, required — Human-readable name for the metric.
      - `type` 'scalar' | 'currency' | 'currency_sub_cent' | 'percentage', required
    - `canceled_subscriptions_low_quality` Metric — Information about a metric.
      - `slug` string, required — Unique identifier for the metric.
      - `display_name` string, required — Human-readable name for the metric.
      - `type` 'scalar' | 'currency' | 'currency_sub_cent' | 'percentage', required
    - `canceled_subscriptions_missing_features` Metric — Information about a metric.
      - `slug` string, required — Unique identifier for the metric.
      - `display_name` string, required — Human-readable name for the metric.
      - `type` 'scalar' | 'currency' | 'currency_sub_cent' | 'percentage', required
    - `canceled_subscriptions_switched_service` Metric — Information about a metric.
      - `slug` string, required — Unique identifier for the metric.
      - `display_name` string, required — Human-readable name for the metric.
      - `type` 'scalar' | 'currency' | 'currency_sub_cent' | 'percentage', required
    - `canceled_subscriptions_too_complex` Metric — Information about a metric.
      - `slug` string, required — Unique identifier for the metric.
      - `display_name` string, required — Human-readable name for the metric.
      - `type` 'scalar' | 'currency' | 'currency_sub_cent' | 'percentage', required
    - `canceled_subscriptions_too_expensive` Metric — Information about a metric.
      - `slug` string, required — Unique identifier for the metric.
      - `display_name` string, required — Human-readable name for the metric.
      - `type` 'scalar' | 'currency' | 'currency_sub_cent' | 'percentage', required
    - `canceled_subscriptions_unused` Metric — Information about a metric.
      - `slug` string, required — Unique identifier for the metric.
      - `display_name` string, required — Human-readable name for the metric.
      - `type` 'scalar' | 'currency' | 'currency_sub_cent' | 'percentage', required
    - `canceled_subscriptions_other` Metric — Information about a metric.
      - `slug` string, required — Unique identifier for the metric.
      - `display_name` string, required — Human-readable name for the metric.
      - `type` 'scalar' | 'currency' | 'currency_sub_cent' | 'percentage', required
    - `annual_recurring_revenue` Metric — Information about a metric.
      - `slug` string, required — Unique identifier for the metric.
      - `display_name` string, required — Human-readable name for the metric.
      - `type` 'scalar' | 'currency' | 'currency_sub_cent' | 'percentage', required
    - `committed_annual_recurring_revenue` Metric — Information about a metric.
      - `slug` string, required — Unique identifier for the metric.
      - `display_name` string, required — Human-readable name for the metric.
      - `type` 'scalar' | 'currency' | 'currency_sub_cent' | 'percentage', required
    - `checkouts_conversion` Metric — Information about a metric.
      - `slug` string, required — Unique identifier for the metric.
      - `display_name` string, required — Human-readable name for the metric.
      - `type` 'scalar' | 'currency' | 'currency_sub_cent' | 'percentage', required
    - `ltv` Metric — Information about a metric.
      - `slug` string, required — Unique identifier for the metric.
      - `display_name` string, required — Human-readable name for the metric.
      - `type` 'scalar' | 'currency' | 'currency_sub_cent' | 'percentage', required
    - `gross_margin` Metric — Information about a metric.
      - `slug` string, required — Unique identifier for the metric.
      - `display_name` string, required — Human-readable name for the metric.
      - `type` 'scalar' | 'currency' | 'currency_sub_cent' | 'percentage', required
    - `gross_margin_percentage` Metric — Information about a metric.
      - `slug` string, required — Unique identifier for the metric.
      - `display_name` string, required — Human-readable name for the metric.
      - `type` 'scalar' | 'currency' | 'currency_sub_cent' | 'percentage', required
    - `cashflow` Metric — Information about a metric.
      - `slug` string, required — Unique identifier for the metric.
      - `display_name` string, required — Human-readable name for the metric.
      - `type` 'scalar' | 'currency' | 'currency_sub_cent' | 'percentage', required
    - `average_seats_per_customer` Metric — Information about a metric.
      - `slug` string, required — Unique identifier for the metric.
      - `display_name` string, required — Human-readable name for the metric.
      - `type` 'scalar' | 'currency' | 'currency_sub_cent' | 'percentage', required
    - `seat_utilization_rate` Metric — Information about a metric.
      - `slug` string, required — Unique identifier for the metric.
      - `display_name` string, required — Human-readable name for the metric.
      - `type` 'scalar' | 'currency' | 'currency_sub_cent' | 'percentage', required

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/polar/apis/polar-api.md) · [All operations](https://skmtc.net/polar/apis/polar-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/polar/polar-api/revisions/f9688fd328d6/schema)
