{
"error": {
"type": "invalid_request_error",
"code": "meter_name_taken",
"message": "A meter named \"Image generations\" already exists in this store",
"request_id": "req_abc123def456",
"param": "events[3].customer_id",
"details": {
"archived_holder": true,
"archived_holder_id": "mtr_abc123"
}
}
}
Meters
Archive a meter
Archive a meter: it leaves the default listing and stops accruing new usage, but is never deleted, so the usage it already recorded stays meaningful. Idempotent — archiving an archived meter returns it unchanged.
POST
/
v1
/
meters
/
{id}
/
archive
Archive a meter
curl --request POST \ --url https://api.creem.io/v1/meters/{id}/archive \ --header 'x-api-key: <api-key>'
{"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":""},"chroma":{"liveDeploymentHistoryId":"6ae068cec9d0adb3afbc2c95","collectionId":"2fa55d35-6965-42a5-84f0-414da7321369","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae068cec9d0adb3afbc2c95"},"entitlements":{},"buildId":"6ae068cec9d0adb3afbc2c95","clientVersion":"0.0.4006","searchFilterCounts":[{"language":"default","tag":"Documentation","count":100},{"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":"Meters","count":9},{"language":"default","tag":"Get Started","count":9},{"language":"default","tag":"Webhooks","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":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","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":"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":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-private-page-search","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":"editor-nav-generations","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":"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":"byok-sep-25","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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","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":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"styles.css","content":"#topbar-cta-button{color:#000}"}],"page":{"pagePath":"api-reference/endpoint/archive-meter","slug":"/api-reference/endpoint/archive-meter","pageMetadata":{"title":"Archive a meter","description":"Archive a meter: it leaves the default listing and stops accruing new usage, but is never deleted, so the usage it already recorded stays meaningful. Idempotent — archiving an archived meter returns it unchanged.","openapi":"post /v1/meters/{id}/archive","href":"/api-reference/endpoint/archive-meter"},"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: \"Archive a meter: it leaves the default listing and stops accruing new usage, but is never deleted, so the usage it already recorded stays meaningful. Idempotent — archiving an archived meter returns it unchanged.\"\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":"Archive a meter","description":"Archive a meter: it leaves the default listing and stops accruing new usage, but is never deleted, so the usage it already recorded stays meaningful. Idempotent — archiving an archived meter returns it unchanged.","openapi":"post /v1/meters/{id}/archive","href":"/api-reference/endpoint/archive-meter"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/creem/c0258fabb625b4ba/scripts/generate-api-docs.js"],"openApiReferenceData":{"operation":{"operationId":"archiveMeter","x-speakeasy-name-override":"archiveMeter","x-speakeasy-group":"meters","summary":"Archive a meter","description":"Archive a meter: it leaves the default listing and stops accruing new usage, but is never deleted, so the usage it already recorded stays meaningful. Idempotent — archiving an archived meter returns it unchanged.","parameters":["be19da24-66bd-4060-87d8-2f6a341e8f6d"],"responses":{"200":"c35dbae3-a30e-4539-bb51-cf7741e6e3f1","400":"1a85257b-a8d3-46c6-9408-6975918b30b6","401":"d9b09cec-e52f-490e-961e-aec55b038d11","404":"ec6e0c4d-9ed4-43a6-a0e4-32691b1b65dd","409":"eab90412-9833-4038-9614-31831c456839"},"tags":["Meters"],"security":["dcf53aae-590e-44de-bae6-2f31132c2661"],"method":"post","type":"path","servers":["ce73d8da-bcf3-4183-ac11-826f6188634a","a3b3db05-e3f5-4845-baed-eca093fbbcd7"],"path":"/v1/meters/{id}/archive","baseUrlOptions":["https://api.creem.io","https://test-api.creem.io"],"title":"Archive a meter","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"be19da24-66bd-4060-87d8-2f6a341e8f6d":{"name":"id","required":true,"in":"path","schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"responses":{"c35dbae3-a30e-4539-bb51-cf7741e6e3f1":{"description":"Meter archived","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Meter ID","example":"mtr_abc123","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"store_id":{"type":"string","description":"Store ID","example":"sto_abc123","isRequired":true,"uniqueKey":"store_id","typeLabel":"string"},"name":{"type":"string","description":"Meter name","example":"Image generations","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"event_name":{"type":"string","description":"Usage event name the meter consumes","example":"image.generated","isRequired":true,"uniqueKey":"event_name","typeLabel":"string"},"aggregation":{"type":"string","description":"Aggregation applied to matching events","enum":["count","sum","average","min","max","unique"],"example":"sum","isRequired":true,"uniqueKey":"aggregation","typeLabel":"enum\u003cstring>"},"aggregation_property":{"oneOf":[{"type":"string","description":"Property the aggregation reduces; null for \"count\"","example":"tokens","isRequired":true,"uniqueKey":"aggregation_property.oneOf.0","typeLabel":"string"},{"type":"null","description":"Property the aggregation reduces; null for \"count\"","example":"tokens","isRequired":true,"uniqueKey":"aggregation_property.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"aggregation_property","typeLabel":"string | null"},"filter":{"type":"object","description":"The meter filter; always present (empty clauses = match all)","required":["conjunction","clauses"],"properties":{"conjunction":{"type":"string","description":"How the clauses combine","enum":["and","or"],"example":"and","isRequired":true,"uniqueKey":"filter.conjunction","typeLabel":"enum\u003cstring>"},"clauses":{"description":"Filter clauses; empty means the meter counts every event","type":"array","items":{"type":"object","properties":{"property":{"type":"string","description":"Event property tested","example":"tier","isRequired":true,"uniqueKey":"filter.clauses.items.[INDEX].property","typeLabel":"string"},"operator":{"type":"string","description":"Comparison operator","example":"equals","isRequired":true,"uniqueKey":"filter.clauses.items.[INDEX].operator","typeLabel":"string"},"value":{"oneOf":[{"type":"string","description":"Value compared against, as stored after parsing","example":"pro","isRequired":true,"uniqueKey":"filter.clauses.items.[INDEX].value.oneOf.0","typeLabel":"string"},{"type":"number","description":"Value compared against, as stored after parsing","example":"pro","isRequired":true,"uniqueKey":"filter.clauses.items.[INDEX].value.oneOf.1","typeLabel":"number"},{"type":"boolean","description":"Value compared against, as stored after parsing","example":"pro","isRequired":true,"uniqueKey":"filter.clauses.items.[INDEX].value.oneOf.2","typeLabel":"boolean"}],"isRequired":true,"uniqueKey":"filter.clauses.items.[INDEX].value","typeLabel":"string | number | boolean"}},"required":["property","operator","value"],"uniqueKey":"filter.clauses.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"filter.clauses","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"filter","typeLabel":"object"},"unit_label":{"type":"string","description":"Display unit","example":"images","isRequired":true,"uniqueKey":"unit_label","typeLabel":"string"},"status":{"type":"string","description":"Whether the meter is active or archived","enum":["active","archived"],"example":"active","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"created_at":{"type":"string","description":"Creation timestamp (ISO 8601)","isRequired":true,"uniqueKey":"created_at","typeLabel":"string"},"updated_at":{"type":"string","description":"Last update timestamp (ISO 8601)","isRequired":true,"uniqueKey":"updated_at","typeLabel":"string"}},"required":["id","store_id","name","event_name","aggregation","aggregation_property","filter","unit_label","status","created_at","updated_at"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"mtr_abc123","store_id":"sto_abc123","name":"Image generations","event_name":"image.generated","aggregation":"sum","aggregation_property":"tokens","filter":{"conjunction":"and","clauses":[{"property":"tier","operator":"equals","value":"pro"}]},"unit_label":"images","status":"active","created_at":"\u003cstring>","updated_at":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"1a85257b-a8d3-46c6-9408-6975918b30b6":{"description":"Bad Request - Invalid input parameters","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"d9b09cec-e52f-490e-961e-aec55b038d11":{"description":"Unauthorized - Invalid or missing API key","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"ec6e0c4d-9ed4-43a6-a0e4-32691b1b65dd":{"description":"Not Found - Resource does not exist","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"eab90412-9833-4038-9614-31831c456839":{"description":"The meter is priced on a product you are still selling — remove the usage charge (or archive the product) first","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","description":"Error details","required":["type","code","message","request_id"],"properties":{"type":{"type":"string","description":"Error category","enum":["invalid_request_error","api_error","authentication_error","rate_limit_error"],"example":"invalid_request_error","isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"code":{"oneOf":[{"type":"string","description":"Machine-readable error code","example":"meter_name_taken","isRequired":true,"uniqueKey":"error.code.oneOf.0","typeLabel":"string"},{"type":"null","description":"Machine-readable error code","example":"meter_name_taken","isRequired":true,"uniqueKey":"error.code.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.code","typeLabel":"string | null"},"message":{"type":"string","description":"Human-readable error message","example":"A meter named \"Image generations\" already exists in this store","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"type":"string","description":"Unique request identifier for support","example":"req_abc123def456","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"},"param":{"oneOf":[{"type":"string","description":"The parameter related to the error, if applicable","example":"events[3].customer_id","uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","description":"The parameter related to the error, if applicable","example":"events[3].customer_id","uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.param","typeLabel":"string | null"},"details":{"type":"object","description":"Structured, machine-readable context for errors that support an action, omitted entirely when there is none. Currently emitted for `meter_name_taken` when the colliding name is held by an ARCHIVED meter: `archived_holder` is true and `archived_holder_id` is that meter, which can be restored via POST /v1/meters/{id}/unarchive. Additive — treat unknown keys as ignorable.","example":{"archived_holder":true,"archived_holder_id":"mtr_abc123"},"additionalProperties":true,"uniqueKey":"error.details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"type":"invalid_request_error","code":"meter_name_taken","message":"A meter named \"Image generations\" already exists in this store","request_id":"req_abc123def456","param":"events[3].customer_id","details":{"archived_holder":true,"archived_holder_id":"mtr_abc123"}}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"dcf53aae-590e-44de-bae6-2f31132c2661":{"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":[]}}},"servers":{"ce73d8da-bcf3-4183-ac11-826f6188634a":{"url":"https://api.creem.io","description":"Production — live API for processing real transactions and data.","x-speakeasy-server-id":"prod"},"a3b3db05-e3f5-4845-baed-eca093fbbcd7":{"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":[]},"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":"Archive a meter - Creem","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-14T12:00:05.446Z","originalFileLocation":"api-reference/endpoint/archive-meter.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=\"Archive a meter: it leaves the default listing and stops accruing new usage, but is never deleted, so the usage it already recorded stays meaningful. Idempotent — archiving an archived meter returns it unchanged.\">\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=\"Archive a meter - Creem\">\u003cmeta data-mint-head property=\"og:description\" content=\"Archive a meter: it leaves the default listing and stops accruing new usage, but is never deleted, so the usage it already recorded stays meaningful. Idempotent — archiving an archived meter returns it unchanged.\">\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/archive-meter\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://creem.mintlify.app/_mintlify/api/og/v2?division=Meters\u0026amp;title=Archive+a+meter\u0026amp;description=Archive+a+meter%3A+it+leaves+the+default+listing+and+stops+accruing+new+usage%2C+but+is+never+deleted%2C+so+the+usage+it+already+recorded+stays+meaningful.+Idempotent\u0026amp;theme=cafe6ce3ebe1df8d45ed0a88\u0026amp;signature=4c723b8eba092c54ddce9032cb1dd357f4dc73d07261455492e307b7f948d84c\">\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=\"Archive a meter - Creem\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Archive a meter: it leaves the default listing and stops accruing new usage, but is never deleted, so the usage it already recorded stays meaningful. Idempotent — archiving an archived meter returns it unchanged.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://creem.mintlify.app/_mintlify/api/og/v2?division=Meters\u0026amp;title=Archive+a+meter\u0026amp;description=Archive+a+meter%3A+it+leaves+the+default+listing+and+stops+accruing+new+usage%2C+but+is+never+deleted%2C+so+the+usage+it+already+recorded+stays+meaningful.+Idempotent\u0026amp;theme=cafe6ce3ebe1df8d45ed0a88\u0026amp;signature=4c723b8eba092c54ddce9032cb1dd357f4dc73d07261455492e307b7f948d84c\">\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/archive-meter\">\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/archive-meter.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/archive-meter#webpage\",\"url\":\"https://docs.creem.io/api-reference/endpoint/archive-meter\",\"name\":\"Archive a meter\",\"description\":\"Archive a meter: it leaves the default listing and stops accruing new usage, but is never deleted, so the usage it already recorded stays meaningful. Idempotent — archiving an archived meter returns it unchanged.\",\"dateModified\":\"2026-09-14T12:00:05.446Z\",\"isPartOf\":{\"@id\":\"https://docs.creem.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.creem.io/api-reference/endpoint/archive-meter#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.creem.io/api-reference/endpoint/archive-meter#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Features\",\"item\":\"https://docs.creem.io/features/checkout/checkout-api\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Meters\",\"item\":\"https://docs.creem.io/api-reference/endpoint/create-meter\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Archive a meter\",\"item\":\"https://docs.creem.io/api-reference/endpoint/archive-meter\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.creem.io/api-reference/endpoint/archive-meter#apireference\",\"headline\":\"Archive a meter\",\"name\":\"Archive a meter\",\"description\":\"Archive a meter: it leaves the default listing and stops accruing new usage, but is never deleted, so the usage it already recorded stays meaningful. Idempotent — archiving an archived meter returns it unchanged.\",\"url\":\"https://docs.creem.io/api-reference/endpoint/archive-meter\",\"mainEntityOfPage\":{\"@id\":\"https://docs.creem.io/api-reference/endpoint/archive-meter#webpage\"},\"dateModified\":\"2026-09-14T12:00:05.446Z\",\"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\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","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","groups":[{"group":"Get Started","icon":"rocket","pages":[{"title":"Ship Software. Get Paid Globally.","href":"/getting-started/introduction"},{"title":"Quickstart","href":"/getting-started/quickstart"},{"title":"Test Mode","href":"/getting-started/test-mode"},{"group":"Account Reviews","pages":[{"title":"Account Reviews","href":"/merchant-of-record/account-reviews/account-reviews"},{"title":"How to Request a Re-Review","href":"/merchant-of-record/account-reviews/re-review-guide"},{"title":"If your account was rejected","href":"/merchant-of-record/account-reviews/rejected-accounts"},{"title":"AI Wrapper Compliance","href":"/merchant-of-record/account-reviews/ai-wrapper-compliance"}]},{"title":"Dashboard Overview","href":"/getting-started/dashboard-overview"},{"title":"Migrate to Creem","href":"/getting-started/migrate"}]},{"group":"AI","icon":"robot","pages":[{"title":"AI Integration","href":"/ai/introduction"},{"group":"For Humans","pages":[{"title":"Getting Started","href":"/ai/for-humans/getting-started"},{"title":"Creem CLI","href":"/ai/for-humans/cli"}]},{"group":"For Agents","pages":[{"title":"Skill Files","href":"/ai/for-agents/skill-files"},{"title":"MCP Server","href":"/ai/for-agents/mcp-server"},{"title":"Creem CLI","href":"/ai/for-agents/cli"},{"title":"Store Monitoring","href":"/ai/for-agents/store-monitoring"}]}]},{"group":"Features","icon":"sparkles","pages":[{"group":"Checkout","pages":[{"title":"Checkout API","href":"/features/checkout/checkout-api"},{"title":"Checkout Link","href":"/features/checkout/checkout-link"},{"title":"Embedded Checkout","href":"/features/checkout/embedded-checkout"},{"title":"Checkout Customization","href":"/features/checkout/checkout-customization"},{"title":"Checkout Custom Fields","href":"/features/checkout/checkout-custom-fields"},{"title":"Checkout Localization","href":"/features/checkout/checkout-localization"}]},{"title":"One Time Payments","href":"/features/one-time-payment"},{"title":"Pay What You Want","href":"/features/pay-what-you-want"},{"group":"Subscriptions","pages":[{"title":"Subscriptions","href":"/features/subscriptions/introduction"},{"title":"Managing Subscriptions","href":"/features/subscriptions/managing"},{"title":"Refunds and Cancellations","href":"/features/subscriptions/refunds-and-cancellations"}]},{"title":"Seat Based Billing","href":"/features/seat-based-billing"},{"title":"Revenue Splits","href":"/features/split-payments"},{"title":"Affiliate Program","sidebarTitle":"Affiliate Program","href":"/features/affiliate-program"},{"title":"Referral Program","sidebarTitle":"Referral Program","href":"/features/referral-program"},{"title":"Storefronts","href":"/features/storefronts"},{"title":"Custom Domains","href":"/features/custom-domains"},{"title":"Short Links","href":"/features/short-links"},{"title":"Discount Codes","href":"/features/discounts"},{"title":"Trials","href":"/features/trials"},{"title":"Customer Portal","href":"/features/customer-portal"},{"title":"Product Bundles","href":"/features/product-bundles"},{"title":"Moderation","href":"/features/moderation"},{"title":"Usage-Based Billing","href":"/features/usage-based-billing"},{"group":"Customer Credits","pages":[{"title":"Customer Credits","sidebarTitle":"Introduction","href":"/features/customer-credits/introduction"},{"title":"Accounts","href":"/features/customer-credits/accounts"},{"title":"Transactions","href":"/features/customer-credits/transactions"},{"title":"Auto-refill","href":"/features/customer-credits/auto-refill"}]},{"group":"Events","pages":[{"title":"Ingest usage events","openapi":"post /v1/events/ingest","href":"/api-reference/endpoint/ingest-usage-events"},{"title":"Preview usage events","openapi":"post /v1/events/preview","href":"/api-reference/endpoint/preview-usage-events"},{"title":"List usage events","openapi":"get /v1/events","href":"/api-reference/endpoint/list-usage-events"}]},{"group":"Meters","pages":[{"title":"Create a meter","openapi":"post /v1/meters","href":"/api-reference/endpoint/create-meter"},{"title":"List meters","openapi":"get /v1/meters","href":"/api-reference/endpoint/list-meters"},{"title":"Retrieve a meter","openapi":"get /v1/meters/{id}","href":"/api-reference/endpoint/get-meter"},{"title":"Update a meter","openapi":"patch /v1/meters/{id}","href":"/api-reference/endpoint/update-meter"},{"title":"Preview an unsaved meter definition","openapi":"post /v1/meters/preview","href":"/api-reference/endpoint/preview-meter"},{"title":"Preview an existing meter","openapi":"post /v1/meters/{id}/preview","href":"/api-reference/endpoint/preview-existing-meter"},{"title":"Get consumed units for a customer","description":"How many units a customer has consumed through this meter in a billing period, alongside the period's boundaries. Without `at`, this is an O(1) read of the current period's projection — the number billing uses. With `at`, the units are replayed from the raw events as of that instant, within the billing period containing it, which is the right call for reconstructing what a customer had consumed at a past moment (an invoice date, a support question).","openapi":"get /v1/meters/{id}/consumed","href":"/api-reference/endpoint/get-meter-consumed-units"},{"title":"Archive a meter","openapi":"post /v1/meters/{id}/archive","href":"/api-reference/endpoint/archive-meter"},{"title":"Unarchive a meter","description":"Restore an archived meter: it returns to the default listing and resumes accruing usage from the next matching event. Idempotent — unarchiving an active meter returns it unchanged. No gate applies and none is needed: archiving never released the meter's name, because per-store name uniqueness counts archived meters (which is why creating a meter with an archived meter's name returns 409 `meter_name_taken` with `details.archived_holder`), and it never altered the definition. Usage ingested while the meter was archived is retained as raw events and IS folded back in for any period still inside the late-event window, since a period is recomputed in full rather than incrementally — so units for an open period can increase by more than the usage seen since the unarchive. Finalized periods are not moved.","openapi":"post /v1/meters/{id}/unarchive","href":"/api-reference/endpoint/unarchive-meter"}]},{"group":"Addons","pages":[{"title":"License Keys","href":"/features/addons/licenses"},{"title":"Private Notes","href":"/features/addons/private-notes"},{"title":"File Downloads","href":"/features/addons/file-downloads"},{"title":"Abandoned Cart Recovery","href":"/features/addons/abandoned-cart-recovery"}]}]},{"group":"Code","icon":"code","pages":[{"group":"SDKs","pages":[{"title":"TypeScript","href":"/code/sdks/typescript"},{"title":"Next.js adapter","href":"/code/sdks/nextjs"},{"group":"Better Auth","pages":[{"title":"Overview","href":"/code/sdks/better-auth"},{"title":"Quickstart","href":"/code/sdks/better-auth/quickstart"},{"title":"Configuration","href":"/code/sdks/better-auth/configuration"},{"title":"Client API","href":"/code/sdks/better-auth/client"},{"title":"Webhooks and access","href":"/code/sdks/better-auth/webhooks"},{"title":"Server API","href":"/code/sdks/better-auth/server"},{"title":"Migration","href":"/code/sdks/better-auth/migration"}]},{"group":"Convex","pages":[{"title":"Quickstart","href":"/code/sdks/convex/quickstart"},{"title":"Concepts","href":"/code/sdks/convex/concepts"},{"title":"Subscriptions","href":"/code/sdks/convex/subscriptions"},{"title":"One-Time Products \u0026 Credits","href":"/code/sdks/convex/one-time-and-credits"},{"title":"Entitlements \u0026 Account UI","href":"/code/sdks/convex/entitlements"},{"title":"Advanced","href":"/code/sdks/convex/advanced"},{"title":"Migration","href":"/code/sdks/convex/migration"},{"title":"Component Reference","href":"/code/sdks/convex/reference"}]},{"title":"Creem Next.js Template","href":"/code/sdks/templates"},{"title":"AI Agents","href":"/code/sdks/ai-agents"}]},{"title":"Creem CLI","href":"/code/cli"},{"title":"Webhooks","href":"/code/webhooks"}]},{"group":"Integrations","icon":"link","pages":[{"group":"Affiliate programs","pages":[{"title":"Affonso Affiliate Program Integration","sidebarTitle":"Affonso","href":"/integrations/affonso"},{"title":"LinkJolt Affiliate Program Integration","sidebarTitle":"LinkJolt","href":"/integrations/linkjolt"},{"title":"Referly Affiliate Program Integration","sidebarTitle":"Referly","href":"/integrations/referly"},{"title":"Refgrow Affiliate Program Integration","sidebarTitle":"Refgrow","href":"/integrations/refgrow"},{"title":"Rekomi Affiliate Program Integration","sidebarTitle":"Rekomi","href":"/integrations/rekomi"}]},{"title":"Evendeals","href":"/integrations/evendeals"},{"title":"Framer","href":"/integrations/framer"},{"title":"Strapi","href":"/integrations/strapi"}]},{"group":"Community","icon":"users","pages":[{"title":"Community Resources","href":"/code/community/community-resources"}]},{"group":"Merchant of Record","icon":"building","pages":[{"title":"What is a Merchant of Record","href":"/merchant-of-record/what-is"},{"title":"Supported Countries","href":"/merchant-of-record/supported-countries"},{"group":"Finance","pages":[{"title":"Payouts","href":"/merchant-of-record/finance/payouts"},{"title":"Payout Accounts","href":"/merchant-of-record/finance/payout-accounts"},{"title":"Refunds and Chargebacks","href":"/merchant-of-record/finance/refunds-and-chargebacks"},{"title":"Payments","href":"/merchant-of-record/finance/payment-methods"}]}]},{"group":"For Customers","icon":"circle-question","pages":[{"title":"Why did Creem charge me","href":"/for-customers/why-creem-charged-me"},{"title":"How to cancel a subscription","href":"/for-customers/how-to-cancel-subscription"},{"title":"How to update payment method","href":"/for-customers/how-to-update-payment-method"},{"title":"I can't log in to the Customer Portal","href":"/for-customers/cant-log-in-to-customer-portal"}]}]},{"tab":"Guides","pages":[{"title":"Guides","href":"/guides/introduction"}]},{"tab":"API Reference","pages":[{"title":"API Reference","href":"/api-reference/introduction"}]}]},"title":"Archive a meter - Creem","buildId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","deploymentId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DmVyH30O.js","utils-BHQqGGOd.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-CD-E4BIt.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Bp5Lq9Ds.js","snippetPresets-C4xAVCFP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CgXVLxUC.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BF8I5oUf.js","shallow-Byd0lWnC.js","getApiPlaygroundDisplay-BGOZG1OK.js","CodeSnippet-CpvQL0CY.js","CodeSnippets-B8wkBKXa.js","Page-CBCH2P7b.js","getPastedJson-Ry3scI3Y.js","icon-D7a9HcdD.js","MethodPill-CJ8pmHhz.js","DuplicateIcon-rh1HJF0t.js","createIcon-DvGznqYs.js","DynamicMarkdown-Cc6AuSHS.js","SectionHeading-B4A0S-ep.js","axios-vUo_bRtp.js","Markdown-Cc16CX65.js","clsx-Cs6nMGht.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-zbf22OZA.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-C_fs-y5n.js"]}