Retrieve aggregated store metrics including counts, revenue, and MRR. When startDate and endDate are provided, totals are filtered to that date range. When interval is also provided, the response includes a periods array with time-series data points grouped by that interval. The periods array starts from the store’s first transaction or startDate, whichever is later, to avoid empty leading buckets. All monetary amounts are in cents (integer, no decimals).
GET
/
v1
/
stats
/
summary
Get store metrics summary
curl --request GET \ --url https://api.creem.io/v1/stats/summary \ --header 'x-api-key: <api-key>'
API key for authentication. You can find your API key in the Creem dashboard under Settings > API Keys.
Query Parameters
currency
enum<string>
Currency the monetary totals are converted to. Defaults to USD when omitted.
Available options:
EUR,
USD
startDate
number
Start of the date range as a Unix timestamp in milliseconds (e.g. 1740614400000). When provided with endDate, filters totals to this range. Required when interval is specified.
endDate
number
End of the date range as a Unix timestamp in milliseconds (e.g. 1772150400000). When provided with startDate, filters totals to this range. Required when interval is specified.
interval
enum<string>
Groups time-series data into buckets of this size. Requires startDate and endDate. Returns a periods array with one entry per bucket containing grossRevenue and netRevenue.
Available options:
day,
week,
month
Response
Successfully retrieved store metrics summary
totals
object
required
Aggregated totals for the queried date range
Show child attributes
periods
object[]
Time-series data points grouped by the requested interval. Only present when interval, startDate, and endDate are provided.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Creem","colors":{"primary":"#FFBE98","light":"#FFBE98","dark":"#B09CFB"},"logo":{"light":"https://mintcdn.com/creem/-AIVGXbrCJu_8i70/logo/light.svg?fit=max\u0026auto=format\u0026n=-AIVGXbrCJu_8i70\u0026q=85\u0026s=686f06f43a3d7e4c0456e22de64c8bae","dark":"https://mintcdn.com/creem/-AIVGXbrCJu_8i70/logo/dark.svg?fit=max\u0026auto=format\u0026n=-AIVGXbrCJu_8i70\u0026q=85\u0026s=7c9135ca8b2365d6ec3728dc087f694d"},"favicon":"https://mintcdn.com/creem/-AIVGXbrCJu_8i70/favicon.svg?fit=max\u0026auto=format\u0026n=-AIVGXbrCJu_8i70\u0026q=85\u0026s=92df9cacbac6c8f17dbeb2d8b6befb93","navbar":{"links":[{"href":"https://creem.io/contact","label":"Support"},{"href":"https://docs.creem.io/llms.txt","label":"llms.txt"},{"href":"https://docs.creem.io/llms-full.txt","label":"llms-full.txt"}],"primary":{"type":"button","label":"Creem","href":"https://creem.io"}},"footer":{"socials":{"x":"https://x.com/creem_io","linkedin":"https://www.linkedin.com/company/creemio"}},"seo":{"metatags":{"twitter:site":"@creem_io","og:site_name":"Creem Documentation","keywords":"merchant of record, payment api, saas billing, subscription management, global payments, MoR, affiliate program, affiliate marketing, referral program"},"indexing":"all"},"integrations":{"posthog":{"apiKey":"phc_placeholder_gabriel_will_provide","apiHost":"https://us.posthog.com"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity"],"display":"header"},"styling":{"latex":true},"navigation":{"global":{"anchors":[{"anchor":"Community","icon":"discord","href":"https://discord.gg/q3GKZs92Av"},{"anchor":"Blog","icon":"newspaper","href":"https://creem.io/blog"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"creem","hasAudioNarration":false,"actualSubdomain":"creem","customDomains":["docs.creem.io"],"gitSource":{"type":"github","owner":"armitage-labs","repo":"creem","deployBranch":"main","contentDirectory":"packages/docs","isPrivate":false,"mountPath":"","label":""},"entitlements":{},"buildId":"6af70a5907e6a796f0fdb66b","clientVersion":"0.0.4128","searchFilterCounts":[{"language":"default","tag":"Documentation","count":103},{"language":"default","tag":"API Reference","count":65},{"language":"default","tag":"Features","count":44},{"language":"default","tag":"Code","count":21},{"language":"default","tag":"Customer Credits","count":19},{"language":"default","tag":"SDKs","count":19},{"language":"default","tag":"Guides","count":18},{"language":"default","tag":"Get Started","count":11},{"language":"default","tag":"Meters","count":9},{"language":"default","tag":"AI","count":8}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"styles.css","content":"#topbar-cta-button{color:#000000}"}],"page":{"pagePath":"api-reference/endpoint/get-stats-summary","slug":"/api-reference/endpoint/get-stats-summary","pageMetadata":{"title":"Get store metrics summary","description":"Retrieve aggregated store metrics including counts, revenue, and MRR. When startDate and endDate are provided, totals are filtered to that date range. When interval is also provided, the response includes a periods array with time-series data points grouped by that interval. The periods array starts from the store's first transaction or startDate, whichever is later, to avoid empty leading buckets. All monetary amounts are in cents (integer, no decimals).","openapi":"get /v1/stats/summary","href":"/api-reference/endpoint/get-stats-summary"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Retrieve aggregated store metrics including counts, revenue, and MRR. When startDate and endDate are provided, totals are filtered to that date range. When interval is also provided, the response includes a periods array with time-series data points grouped by that interval. The periods array starts from the store’s first transaction or startDate, whichever is later, to avoid empty leading buckets. All monetary amounts are in cents (integer, no decimals).\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get store metrics summary","description":"Retrieve aggregated store metrics including counts, revenue, and MRR. When startDate and endDate are provided, totals are filtered to that date range. When interval is also provided, the response includes a periods array with time-series data points grouped by that interval. The periods array starts from the store's first transaction or startDate, whichever is later, to avoid empty leading buckets. All monetary amounts are in cents (integer, no decimals).","openapi":"get /v1/stats/summary","href":"/api-reference/endpoint/get-stats-summary"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/creem/c0258fabb625b4ba/scripts/generate-api-docs.js"],"openApiReferenceData":{"operation":{"operationId":"getMetricsSummary","x-speakeasy-name-override":"getSummary","summary":"Get store metrics summary","description":"Retrieve aggregated store metrics including counts, revenue, and MRR. When startDate and endDate are provided, totals are filtered to that date range. When interval is also provided, the response includes a periods array with time-series data points grouped by that interval. The periods array starts from the store's first transaction or startDate, whichever is later, to avoid empty leading buckets. All monetary amounts are in cents (integer, no decimals).","parameters":["2809b904-8eb8-431d-a3c6-ee638708b5a4","9cec3bb6-5f63-440c-b213-5e7e281fe482","f6493522-378c-45b6-b367-e51fb33003da","303679c1-3b9e-4d94-883f-6c6ebd9c91ef"],"responses":{"200":"fb4f097a-4788-49c1-910a-4a357365a2cd","400":"88187909-0560-4508-87b7-8294b19293f5","401":"e49caa26-4c48-4a2f-a04f-4da0cd7777d8","404":"b8562da9-848a-419d-934a-7d3c59d6674d"},"tags":["Stats"],"security":["097095a5-63a6-4090-8ca3-3ad82103c916"],"method":"get","type":"path","servers":["6bbba29f-d261-4b65-b10a-c1342dea9d61","452e0804-0433-4304-9751-c53b9941c44b"],"path":"/v1/stats/summary","baseUrlOptions":["https://api.creem.io","https://test-api.creem.io"],"title":"Get store metrics summary","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"2809b904-8eb8-431d-a3c6-ee638708b5a4":{"name":"currency","required":false,"in":"query","description":"Currency the monetary totals are converted to. Defaults to USD when omitted.","schema":{"enum":["EUR","USD"],"type":"string","isRequired":false,"description":"Currency the monetary totals are converted to. Defaults to USD when omitted.","uniqueKey":"","typeLabel":"enum\u003cstring>"}},"9cec3bb6-5f63-440c-b213-5e7e281fe482":{"name":"startDate","required":false,"in":"query","description":"Start of the date range as a Unix timestamp in milliseconds (e.g. 1740614400000). When provided with endDate, filters totals to this range. Required when interval is specified.","schema":{"type":"number","isRequired":false,"description":"Start of the date range as a Unix timestamp in milliseconds (e.g. 1740614400000). When provided with endDate, filters totals to this range. Required when interval is specified.","uniqueKey":"","typeLabel":"number"}},"f6493522-378c-45b6-b367-e51fb33003da":{"name":"endDate","required":false,"in":"query","description":"End of the date range as a Unix timestamp in milliseconds (e.g. 1772150400000). When provided with startDate, filters totals to this range. Required when interval is specified.","schema":{"type":"number","isRequired":false,"description":"End of the date range as a Unix timestamp in milliseconds (e.g. 1772150400000). When provided with startDate, filters totals to this range. Required when interval is specified.","uniqueKey":"","typeLabel":"number"}},"303679c1-3b9e-4d94-883f-6c6ebd9c91ef":{"name":"interval","required":false,"in":"query","description":"Groups time-series data into buckets of this size. Requires startDate and endDate. Returns a periods array with one entry per bucket containing grossRevenue and netRevenue.","schema":{"enum":["day","week","month"],"type":"string","isRequired":false,"description":"Groups time-series data into buckets of this size. Requires startDate and endDate. Returns a periods array with one entry per bucket containing grossRevenue and netRevenue.","uniqueKey":"","typeLabel":"enum\u003cstring>"}}},"responses":{"fb4f097a-4788-49c1-910a-4a357365a2cd":{"description":"Successfully retrieved store metrics summary","content":{"application/json":{"schema":{"type":"object","properties":{"totals":{"type":"object","description":"Aggregated totals for the queried date range","required":["totalProducts","totalSubscriptions","totalCustomers","totalPayments","activeSubscriptions","totalRevenue","totalNetRevenue","netMonthlyRecurringRevenue","monthlyRecurringRevenue"],"properties":{"totalProducts":{"type":"number","description":"Total number of products in the store","example":12,"isRequired":true,"uniqueKey":"totals.totalProducts","typeLabel":"number"},"totalSubscriptions":{"type":"number","description":"Total number of subscriptions within the queried date range","example":48,"isRequired":true,"uniqueKey":"totals.totalSubscriptions","typeLabel":"number"},"totalCustomers":{"type":"number","description":"Total number of customers within the queried date range","example":35,"isRequired":true,"uniqueKey":"totals.totalCustomers","typeLabel":"number"},"totalPayments":{"type":"number","description":"Total number of payments within the queried date range","example":62,"isRequired":true,"uniqueKey":"totals.totalPayments","typeLabel":"number"},"activeSubscriptions":{"type":"number","description":"Number of currently active subscriptions","example":21,"isRequired":true,"uniqueKey":"totals.activeSubscriptions","typeLabel":"number"},"totalRevenue":{"type":"number","description":"Total gross revenue in cents within the queried date range","example":553939,"isRequired":true,"uniqueKey":"totals.totalRevenue","typeLabel":"number"},"totalNetRevenue":{"type":"number","description":"Total net revenue in cents within the queried date range (after fees and taxes)","example":478094,"isRequired":true,"uniqueKey":"totals.totalNetRevenue","typeLabel":"number"},"netMonthlyRecurringRevenue":{"type":"number","description":"Net monthly recurring revenue in cents (after estimated fees)","example":89500,"isRequired":true,"uniqueKey":"totals.netMonthlyRecurringRevenue","typeLabel":"number"},"monthlyRecurringRevenue":{"type":"number","description":"Gross monthly recurring revenue in cents","example":94200,"isRequired":true,"uniqueKey":"totals.monthlyRecurringRevenue","typeLabel":"number"}},"isRequired":true,"uniqueKey":"totals","typeLabel":"object"},"periods":{"description":"Time-series data points grouped by the requested interval. Only present when interval, startDate, and endDate are provided.","example":[{"timestamp":1763337600000,"grossRevenue":2999,"netRevenue":2909},{"timestamp":1763942400000,"grossRevenue":32989,"netRevenue":31998},{"timestamp":1764547200000,"grossRevenue":47984,"netRevenue":46542},{"timestamp":1765152000000,"grossRevenue":125958,"netRevenue":122173},{"timestamp":1765756800000,"grossRevenue":343968,"netRevenue":278372},{"timestamp":1766361600000,"grossRevenue":0,"netRevenue":0},{"timestamp":1766966400000,"grossRevenue":0,"netRevenue":0},{"timestamp":1767571200000,"grossRevenue":225240,"netRevenue":192096}],"type":"array","items":{"type":"object","properties":{"timestamp":{"type":"number","description":"Start of the period as a Unix timestamp in milliseconds (e.g. Monday of that week for weekly intervals)","example":1765152000000,"isRequired":true,"uniqueKey":"periods.items.[INDEX].timestamp","typeLabel":"number"},"grossRevenue":{"type":"number","description":"Gross revenue in cents for this period","example":125958,"isRequired":true,"uniqueKey":"periods.items.[INDEX].grossRevenue","typeLabel":"number"},"netRevenue":{"type":"number","description":"Net revenue in cents for this period (after fees and taxes)","example":122173,"isRequired":true,"uniqueKey":"periods.items.[INDEX].netRevenue","typeLabel":"number"}},"required":["timestamp","grossRevenue","netRevenue"],"uniqueKey":"periods.items.[INDEX]","typeLabel":"object"},"uniqueKey":"periods","typeLabel":"object[]"}},"required":["totals"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"totals":{"totalProducts":12,"totalSubscriptions":48,"totalCustomers":35,"totalPayments":62,"activeSubscriptions":21,"totalRevenue":553939,"totalNetRevenue":478094,"netMonthlyRecurringRevenue":89500,"monthlyRecurringRevenue":94200},"periods":[{"timestamp":1763337600000,"grossRevenue":2999,"netRevenue":2909},{"timestamp":1763942400000,"grossRevenue":32989,"netRevenue":31998},{"timestamp":1764547200000,"grossRevenue":47984,"netRevenue":46542},{"timestamp":1765152000000,"grossRevenue":125958,"netRevenue":122173},{"timestamp":1765756800000,"grossRevenue":343968,"netRevenue":278372},{"timestamp":1766361600000,"grossRevenue":0,"netRevenue":0},{"timestamp":1766966400000,"grossRevenue":0,"netRevenue":0},{"timestamp":1767571200000,"grossRevenue":225240,"netRevenue":192096}]}}},"exampleType":"generated"}},"exampleType":"generated"},"88187909-0560-4508-87b7-8294b19293f5":{"description":"Bad Request - Invalid input parameters","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"e49caa26-4c48-4a2f-a04f-4da0cd7777d8":{"description":"Unauthorized - Invalid or missing API key","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"b8562da9-848a-419d-934a-7d3c59d6674d":{"description":"Not Found - Resource does not exist","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"097095a5-63a6-4090-8ca3-3ad82103c916":{"ApiKey":{"type":"apiKey","in":"header","name":"x-api-key","description":"API key for authentication. You can find your API key in the Creem dashboard under Settings > API Keys.","scopes":[],"schemeName":"ApiKey"}}},"servers":{"6bbba29f-d261-4b65-b10a-c1342dea9d61":{"url":"https://api.creem.io","description":"Production — live API for processing real transactions and data.","x-speakeasy-server-id":"prod"},"452e0804-0433-4304-9751-c53b9941c44b":{"url":"https://test-api.creem.io","description":"Test — sandbox API for development and testing with no real charges.","x-speakeasy-server-id":"test"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-api-key","description":"API key for authentication. You can find your API key in the Creem dashboard under Settings > API Keys.","scopes":[],"schemeName":"ApiKey"},"schema":{"title":"x-api-key","type":"string","description":"API key for authentication. You can find your API key in the Creem dashboard under Settings > API Keys.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKey","name":"x-api-key"}],"title":"ApiKey"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"creem","siteName":"Creem","title":"Get store metrics summary - Creem","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-07-21T18:29:29.743Z","originalFileLocation":"api-reference/endpoint/get-stats-summary.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Retrieve aggregated store metrics including counts, revenue, and MRR. When startDate and endDate are provided, totals are filtered to that date range. When interval is also provided, the response includes a periods array with time-series data points grouped by that interval. The periods array starts from the store\u0026#x27;s first transaction or startDate, whichever is later, to avoid empty leading buckets. All monetary amounts are in cents (integer, no decimals).\">\u003cmeta data-mint-head name=\"keywords\" content=\"merchant of record, payment api, saas billing, subscription management, global payments, MoR, affiliate program, affiliate marketing, referral program\">\u003cmeta data-mint-head name=\"application-name\" content=\"Creem\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/creem/nizlPYWnvgrMkN5E/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/creem/nizlPYWnvgrMkN5E/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/creem/nizlPYWnvgrMkN5E/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/creem/nizlPYWnvgrMkN5E/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/creem/nizlPYWnvgrMkN5E/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/creem/nizlPYWnvgrMkN5E/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/creem/nizlPYWnvgrMkN5E/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/creem/nizlPYWnvgrMkN5E/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/creem/nizlPYWnvgrMkN5E/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get store metrics summary - Creem\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieve aggregated store metrics including counts, revenue, and MRR. When startDate and endDate are provided, totals are filtered to that date range. When interval is also provided, the response includes a periods array with time-series data points grouped by that interval. The periods array starts from the store\u0026#x27;s first transaction or startDate, whichever is later, to avoid empty leading buckets. All monetary amounts are in cents (integer, no decimals).\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Creem Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.creem.io/api-reference/endpoint/get-stats-summary\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://creem.mintlify.site/_mintlify/api/og/v2?division=Stats\u0026amp;title=Get+store+metrics+summary\u0026amp;description=Retrieve+aggregated+store+metrics+including+counts%2C+revenue%2C+and+MRR.+When+startDate+and+endDate+are+provided%2C+totals+are+filtered+to+that+date+range.+When+inte\u0026amp;theme=19d74014ebb4a0780d75c372\u0026amp;signature=5f96b558e75ba0fbf2dfbb981731992345f8e330a39caaced757cf895b196e07\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get store metrics summary - Creem\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieve aggregated store metrics including counts, revenue, and MRR. When startDate and endDate are provided, totals are filtered to that date range. When interval is also provided, the response includes a periods array with time-series data points grouped by that interval. The periods array starts from the store\u0026#x27;s first transaction or startDate, whichever is later, to avoid empty leading buckets. All monetary amounts are in cents (integer, no decimals).\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://creem.mintlify.site/_mintlify/api/og/v2?division=Stats\u0026amp;title=Get+store+metrics+summary\u0026amp;description=Retrieve+aggregated+store+metrics+including+counts%2C+revenue%2C+and+MRR.+When+startDate+and+endDate+are+provided%2C+totals+are+filtered+to+that+date+range.+When+inte\u0026amp;theme=19d74014ebb4a0780d75c372\u0026amp;signature=5f96b558e75ba0fbf2dfbb981731992345f8e330a39caaced757cf895b196e07\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/creem/nizlPYWnvgrMkN5E/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Creem\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#FFBE98\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.creem.io/api-reference/endpoint/get-stats-summary\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/endpoint/get-stats-summary.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.creem.io/#organization\",\"name\":\"Creem\",\"url\":\"https://docs.creem.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/creem/-AIVGXbrCJu_8i70/logo/light.svg?fit=max\u0026auto=format\u0026n=-AIVGXbrCJu_8i70\u0026q=85\u0026s=686f06f43a3d7e4c0456e22de64c8bae\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.creem.io#website\",\"name\":\"Creem\",\"url\":\"https://docs.creem.io\",\"publisher\":{\"@id\":\"https://docs.creem.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.creem.io/api-reference/endpoint/get-stats-summary#webpage\",\"url\":\"https://docs.creem.io/api-reference/endpoint/get-stats-summary\",\"name\":\"Get store metrics summary\",\"description\":\"Retrieve aggregated store metrics including counts, revenue, and MRR. When startDate and endDate are provided, totals are filtered to that date range. When interval is also provided, the response includes a periods array with time-series data points grouped by that interval. The periods array starts from the store's first transaction or startDate, whichever is later, to avoid empty leading buckets. All monetary amounts are in cents (integer, no decimals).\",\"dateModified\":\"2026-07-21T18:29:29.743Z\",\"isPartOf\":{\"@id\":\"https://docs.creem.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.creem.io/api-reference/endpoint/get-stats-summary#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.creem.io/api-reference/endpoint/get-stats-summary#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Creem\",\"item\":\"https://docs.creem.io\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get store metrics summary\",\"item\":\"https://docs.creem.io/api-reference/endpoint/get-stats-summary\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.creem.io/api-reference/endpoint/get-stats-summary#apireference\",\"headline\":\"Get store metrics summary\",\"name\":\"Get store metrics summary\",\"description\":\"Retrieve aggregated store metrics including counts, revenue, and MRR. When startDate and endDate are provided, totals are filtered to that date range. When interval is also provided, the response includes a periods array with time-series data points grouped by that interval. The periods array starts from the store's first transaction or startDate, whichever is later, to avoid empty leading buckets. All monetary amounts are in cents (integer, no decimals).\",\"url\":\"https://docs.creem.io/api-reference/endpoint/get-stats-summary\",\"mainEntityOfPage\":{\"@id\":\"https://docs.creem.io/api-reference/endpoint/get-stats-summary#webpage\"},\"dateModified\":\"2026-07-21T18:29:29.743Z\",\"publisher\":{\"@id\":\"https://docs.creem.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.creem.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Creem\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Creem\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/endpoint/get-stats-summary.md","siteName":"Creem","nav":{"global":{"anchors":[{"anchor":"Community","icon":"discord","href":"https://discord.gg/q3GKZs92Av"},{"anchor":"Blog","icon":"newspaper","href":"https://creem.io/blog"}]},"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":""}]},{"tab":"Guides","pages":[{"title":"Guides","href":"/guides/introduction"}]},{"tab":"API Reference","groups":[{"group":"API Documentation","icon":"book","pages":[{"title":"Introduction","href":"/api-reference/introduction"},{"title":"Error Handling","href":"/api-reference/error-codes"}]},{"group":"Checkout","icon":"shopping-cart","pages":[{"title":"Creates a new checkout session","openapi":"post /v1/checkouts","href":"/api-reference/endpoint/create-checkout"},{"title":"Retrieve a checkout session","openapi":"get /v1/checkouts","href":"/api-reference/endpoint/get-checkout"}]},{"group":"Product","icon":"box","pages":[{"title":"Creates a new product","openapi":"post /v1/products","href":"/api-reference/endpoint/create-product"},{"title":"Get a product by ID","openapi":"get /v1/products/{id}","href":"/api-reference/endpoint/get-product"},{"title":"List all products","openapi":"get /v1/products/search","href":"/api-reference/endpoint/search-products"},{"title":"Update a product","openapi":"patch /v1/products/{id}","href":"/api-reference/endpoint/update-product"},{"title":"Archive a product","openapi":"delete /v1/products/{id}","href":"/api-reference/endpoint/archive-product"}]},{"group":"Customer","icon":"users","pages":[{"title":"Retrieve a customer","openapi":"get /v1/customers","href":"/api-reference/endpoint/get-customer"},{"title":"Update a customer","openapi":"patch /v1/customers","href":"/api-reference/endpoint/update-customer"},{"title":"List all customers","openapi":"get /v1/customers/list","href":"/api-reference/endpoint/list-customers"},{"title":"Generate Customer Links","openapi":"post /v1/customers/billing","href":"/api-reference/endpoint/create-customer-billing"}]},{"group":"Transactions","icon":"receipt","pages":[{"title":"Get a transaction by ID","openapi":"get /v1/transactions","href":"/api-reference/endpoint/get-transaction"},{"title":"List all transactions","openapi":"get /v1/transactions/search","href":"/api-reference/endpoint/get-transactions"},{"title":"Refund a payment","openapi":"post /v1/refunds","href":"/api-reference/endpoint/refund-payment"}]},{"group":"Affiliate","icon":"users","pages":[{"title":"List all affiliates","openapi":"get /v1/affiliates","href":"/api-reference/endpoint/list-affiliates"},{"title":"Retrieve an affiliate","openapi":"get /v1/affiliates/{id}","href":"/api-reference/endpoint/retrieve-affiliate"},{"title":"List affiliate commissions","openapi":"get /v1/affiliates/{id}/commissions","href":"/api-reference/endpoint/list-affiliate-commissions"},{"title":"Create an affiliate invitation","openapi":"post /v1/affiliates/invites","href":"/api-reference/endpoint/create-affiliate-invite"},{"title":"List affiliate invitations","openapi":"get /v1/affiliates/invites","href":"/api-reference/endpoint/list-affiliate-invites"}]},{"group":"License","icon":"key","pages":[{"title":"Validates a license key or instance","openapi":"post /v1/licenses/validate","href":"/api-reference/endpoint/validate-license"},{"title":"Activates a license key","openapi":"post /v1/licenses/activate","href":"/api-reference/endpoint/activate-license"},{"title":"Deactivate a license key instance","openapi":"post /v1/licenses/deactivate","href":"/api-reference/endpoint/deactivate-license"},{"title":"List license instances","openapi":"get /v1/licenses/{id}/instances","href":"/api-reference/endpoint/list-license-instances"}]},{"group":"Discount Code","icon":"tag","pages":[{"title":"Create a discount","openapi":"post /v1/discounts","href":"/api-reference/endpoint/create-discount-code"},{"title":"Delete a discount","openapi":"delete /v1/discounts/{id}/delete","href":"/api-reference/endpoint/delete-discount-code"},{"title":"Retrieve discount","openapi":"get /v1/discounts","href":"/api-reference/endpoint/get-discount-code"},{"title":"Search discounts","openapi":"get /v1/discounts/search","href":"/api-reference/endpoint/search-discounts"}]},{"group":"Subscription","icon":"repeat","pages":[{"title":"Retrieve a subscription","openapi":"get /v1/subscriptions","href":"/api-reference/endpoint/get-subscription"},{"title":"List all subscriptions","openapi":"get /v1/subscriptions/search","href":"/api-reference/endpoint/search-subscriptions"},{"title":"Update a subscription","openapi":"post /v1/subscriptions/{id}","href":"/api-reference/endpoint/update-subscription"},{"title":"Upgrade a subscription to a different product","openapi":"post /v1/subscriptions/{id}/upgrade","href":"/api-reference/endpoint/upgrade-subscription"},{"title":"Pause a subscription","openapi":"post /v1/subscriptions/{id}/pause","href":"/api-reference/endpoint/pause-subscription"},{"title":"Resume a subscription","openapi":"post /v1/subscriptions/{id}/resume","href":"/api-reference/endpoint/resume-subscription"},{"title":"Cancel a subscription","openapi":"post /v1/subscriptions/{id}/cancel","href":"/api-reference/endpoint/cancel-subscription"}]},{"group":"Splits","icon":"arrows-split-up-and-left","pages":[{"title":"Create a split","openapi":"post /v1/splits","href":"/api-reference/endpoint/create-split"},{"title":"List all splits","openapi":"get /v1/splits","href":"/api-reference/endpoint/list-splits"},{"title":"Retrieve a split","openapi":"get /v1/splits/{id}","href":"/api-reference/endpoint/retrieve-split"},{"title":"Delete a split","description":"Delete a split by ID. The split stops applying to future payments immediately. Splits belonging to another store cannot be deleted.","openapi":"delete /v1/splits/{id}","href":"/api-reference/endpoint/delete-split"}]},{"group":"Stats","icon":"chart-line","pages":[{"title":"Get store metrics summary","openapi":"get /v1/stats/summary","href":"/api-reference/endpoint/get-stats-summary"}]},{"group":"Customer Credits","icon":"coins","pages":[{"title":"Create a customer credits account","description":"Create a new credits account for a customer. Optionally seed it with an initial balance.","openapi":"post /v1/customer-credits/accounts","href":"/api-reference/endpoint/create-credits-account"},{"title":"List customer credits accounts","openapi":"get /v1/customer-credits/accounts","href":"/api-reference/endpoint/list-credits-accounts"},{"title":"Retrieve a customer credits account","openapi":"get /v1/customer-credits/accounts/{id}","href":"/api-reference/endpoint/get-credits-account"},{"title":"Get account balance","openapi":"get /v1/customer-credits/accounts/{id}/balance","href":"/api-reference/endpoint/get-credits-account-balance"},{"title":"List account entries","openapi":"get /v1/customer-credits/accounts/{id}/entries","href":"/api-reference/endpoint/list-credits-entries"},{"title":"Credit an account","openapi":"post /v1/customer-credits/accounts/{id}/credit","href":"/api-reference/endpoint/credit-account"},{"title":"Debit an account","openapi":"post /v1/customer-credits/accounts/{id}/debit","href":"/api-reference/endpoint/debit-account"},{"title":"Reverse a transaction","openapi":"post /v1/customer-credits/accounts/{id}/reverse","href":"/api-reference/endpoint/reverse-credits-transaction"},{"title":"Freeze an account","openapi":"post /v1/customer-credits/accounts/{id}/freeze","href":"/api-reference/endpoint/freeze-credits-account"},{"title":"Unfreeze an account","openapi":"post /v1/customer-credits/accounts/{id}/unfreeze","href":"/api-reference/endpoint/unfreeze-credits-account"},{"title":"Close an account","openapi":"post /v1/customer-credits/accounts/{id}/close","href":"/api-reference/endpoint/close-credits-account"},{"title":"Post a transaction","openapi":"post /v1/customer-credits/transactions","href":"/api-reference/endpoint/post-credits-transaction"},{"title":"Retrieve a transaction","openapi":"get /v1/customer-credits/transactions/{id}","href":"/api-reference/endpoint/get-credits-transaction"},{"title":"Reverse a transaction","openapi":"post /v1/customer-credits/transactions/{id}/reverse","href":"/api-reference/endpoint/reverse-credits-transaction-by-id"},{"title":"List transactions by reference","openapi":"get /v1/customer-credits/transactions","href":"/api-reference/endpoint/list-credits-transactions"}]},{"group":"Moderation","icon":"shield-check","pages":[{"title":"Screen a prompt","openapi":"post /v1/moderation/prompt","href":"/api-reference/endpoint/screen-prompt"}]},{"group":"Webhooks","icon":"webhook","pages":[{"title":"List webhook endpoints","openapi":"get /v1/webhooks","href":"/api-reference/endpoint/list-webhooks"},{"title":"Create a webhook endpoint","openapi":"post /v1/webhooks","href":"/api-reference/endpoint/create-webhook"},{"title":"Retrieve a webhook endpoint","openapi":"get /v1/webhooks/{id}","href":"/api-reference/endpoint/get-webhook"},{"title":"Update a webhook endpoint","openapi":"patch /v1/webhooks/{id}","href":"/api-reference/endpoint/update-webhook"},{"title":"Delete a webhook endpoint","openapi":"delete /v1/webhooks/{id}","href":"/api-reference/endpoint/delete-webhook"},{"title":"Retrieve a webhook signing secret","openapi":"get /v1/webhooks/{id}/secret","href":"/api-reference/endpoint/get-webhook-secret"},{"title":"List pending events for a CLI webhook endpoint","openapi":"get /v1/webhooks/{id}/events/pending","href":"/api-reference/endpoint/list-pending-webhook-events"},{"title":"Acknowledge a CLI webhook event","openapi":"post /v1/webhooks/{id}/events/{event_id}/ack","href":"/api-reference/endpoint/acknowledge-webhook-event"}]}]}]},"basePath":"","title":"Get store metrics summary - Creem","buildId":"dpl_5tKr6cUUeuVJdEZ9JAEY3h4soMJ8","deploymentId":"dpl_5tKr6cUUeuVJdEZ9JAEY3h4soMJ8","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DbeN8Wo6.js","utils-CwSb5Doc.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BmREeM3N.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-AYjWerCj.js","snippetPresets-QD4ULQlp.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-Digj5cjF.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CiHrzluR.js","shallow-D7h7pFGg.js","getApiPlaygroundDisplay-mlxkpAUf.js","CodeSnippet-D2rH5lZI.js","CodeSnippets-B53ulOaL.js","Page-CqcDm2To.js","getPastedJson-DxGeNMih.js","icon-BHbyrebp.js","MethodPill-C7F_KEEJ.js","DuplicateIcon-j3c5-73z.js","createIcon-OvCnyFqD.js","DynamicMarkdown-DpAS3GCb.js","SectionHeading-DMPpdrvW.js","axios-vUo_bRtp.js","Markdown-D7pDRguu.js","clsx-2_c6mSt_.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-Cu7_SikL.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-ydqCcy4b.js"]}