from flexprice import Flexprice
with Flexprice(
api_key_auth="<YOUR_API_KEY_HERE>",
) as f_client:
res = f_client.addons.create_addon(lookup_key="<value>", name="<value>")
# Handle response
print(res)
import { Flexprice } from "@flexprice/sdk";
const flexprice = new Flexprice({
apiKeyAuth: "<YOUR_API_KEY_HERE>",
});
async function run() {
const result = await flexprice.addons.createAddon({
lookupKey: "<value>",
name: "<value>",
});
console.log(result);
}
run();
from flexprice import Flexprice
with Flexprice(
api_key_auth="<YOUR_API_KEY_HERE>",
) as f_client:
res = f_client.addons.create_addon(lookup_key="<value>", name="<value>")
# Handle response
print(res)
import { Flexprice } from "@flexprice/sdk";
const flexprice = new Flexprice({
apiKeyAuth: "<YOUR_API_KEY_HERE>",
});
async function run() {
const result = await flexprice.addons.createAddon({
lookupKey: "<value>",
name: "<value>",
});
console.log(result);
}
run();
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Flexprice","colors":{"primary":"#15547c","light":"#2580b5","dark":"#134a6b"},"logo":{"light":"https://mintcdn.com/flexprice/Qokjirde4CQUcFy8/images/FlexpriceWordMarkDark.png?fit=max\u0026auto=format\u0026n=Qokjirde4CQUcFy8\u0026q=85\u0026s=d706a1b6139418c2d57ba902fb0b6de4","dark":"https://mintcdn.com/flexprice/Qokjirde4CQUcFy8/images/FlexpriceWordMarkLight.png?fit=max\u0026auto=format\u0026n=Qokjirde4CQUcFy8\u0026q=85\u0026s=3fe3d9881552f4ebecb6f6aa7cfe2f66"},"favicon":"https://mintcdn.com/flexprice/Qokjirde4CQUcFy8/doc.png?fit=max\u0026auto=format\u0026n=Qokjirde4CQUcFy8\u0026q=85\u0026s=7e9ab0952b828b96d03f9298571462a4","api":{"examples":{"languages":["curl","python","typescript","go"]}},"background":{"decoration":"gradient","color":{"light":"#fffdf8","dark":"#010b13"}},"navbar":{"links":[],"primary":{"type":"button","label":"Dashboard","href":"https://admin.flexprice.io/"}},"footer":{"socials":{"github":"https://github.com/flexprice/flexprice","linkedin":"https://www.linkedin.com/company/flexpriceio","website":"https://flexprice.io/","x":"https://x.com/tryflexprice"}},"fonts":{"family":"Geist"},"integrations":{"ga4":{"measurementId":"G-9RV8NDCXNN"}},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"styling":{"latex":true},"navigation":{"global":{"anchors":[{"anchor":"Support","icon":"https://mintlify.s3.us-west-1.amazonaws.com/flexprice/images/anchors/mail.svg","href":"mailto:support@flexprice.io"},{"anchor":"Community","icon":"https://mintlify.s3.us-west-1.amazonaws.com/flexprice/images/anchors/slack.svg","href":"https://join.slack.com/t/flexpricecommunity/shared_invite/zt-39uat51l0-n8JmSikHZP~bHJNXladeaQ"},{"anchor":"Website","icon":"https://mintlify.s3.us-west-1.amazonaws.com/flexprice/images/anchors/flexprice.svg","href":"https://flexprice.io/"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"flexprice","hasAudioNarration":false,"actualSubdomain":"flexprice","customDomains":["docs.flexprice.io"],"gitSource":{"type":"github","owner":"flexprice","repo":"flexprice-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6adb5c47a0e78eb4aee8f95c","collectionId":"da2d6ec5-0a60-46e2-9ea7-aff6d0cc5f88","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6adb5c47a0e78eb4aee8f95c"},"feedback":{"thumbs":false,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6adb5c47a0e78eb4aee8f95c","clientVersion":"0.0.3964","searchFilterCounts":[{"language":"default","tag":"API Reference","count":300},{"language":"default","tag":"Resources","count":297},{"language":"default","tag":"Developers","count":142},{"language":"default","tag":"Documentation","count":118},{"language":"default","tag":"Integrations","count":102},{"language":"default","tag":"Webhook Events","count":62},{"language":"default","tag":"Subscriptions","count":45},{"language":"default","tag":"CLI","count":38},{"language":"default","tag":"Command reference","count":34},{"language":"default","tag":"Pricing and Packaging","count":25}]},"assistantConfig":{"enableStarterQuestions":false,"deflection":{"enabled":true,"email":"support@flexprice.io","showHelpButton":true}},"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":"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}],"privacy":{"consentBanner":{"enabled":false}},"isAtlas":false,"googleFontsInlined":true},"customCss":[{"filePath":"style.css","content":"/* latin-ext */\n@font-face {\n font-family: 'DM Sans';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/dmsans/v17/rP2Yp2ywxg089UriI5-g4vlH9VoD8Cmcqbu6-K6h9Q.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'DM Sans';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/dmsans/v17/rP2Yp2ywxg089UriI5-g4vlH9VoD8Cmcqbu0-K4.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* latin-ext */\n@font-face {\n font-family: 'DM Sans';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/dmsans/v17/rP2Yp2ywxg089UriI5-g4vlH9VoD8Cmcqbu6-K6h9Q.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'DM Sans';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/dmsans/v17/rP2Yp2ywxg089UriI5-g4vlH9VoD8Cmcqbu0-K4.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* latin-ext */\n@font-face {\n font-family: 'DM Sans';\n font-style: normal;\n font-weight: 600;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/dmsans/v17/rP2Yp2ywxg089UriI5-g4vlH9VoD8Cmcqbu6-K6h9Q.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'DM Sans';\n font-style: normal;\n font-weight: 600;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/dmsans/v17/rP2Yp2ywxg089UriI5-g4vlH9VoD8Cmcqbu0-K4.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* latin-ext */\n@font-face {\n font-family: 'DM Sans';\n font-style: normal;\n font-weight: 700;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/dmsans/v17/rP2Yp2ywxg089UriI5-g4vlH9VoD8Cmcqbu6-K6h9Q.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'DM Sans';\n font-style: normal;\n font-weight: 700;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/dmsans/v17/rP2Yp2ywxg089UriI5-g4vlH9VoD8Cmcqbu0-K4.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\nh1{font-family:'DM Sans',sans-serif;font-weight:700!important;letter-spacing:-.01em!important}.page-title,.section-title,.title,[data-title]{font-family:'DM Sans',sans-serif;font-weight:400;letter-spacing:.025em!important}.nav-logo{height:22px}[class*=Navbar] a[href*=\"admin.flexprice.io\"],[class*=nav] a[href*=\"admin.flexprice.io\"]{background-color:#134a6b!important;color:#fff!important;font-weight:500;border-radius:6px;padding:.5rem 1rem}[class*=Navbar] a[href*=\"admin.flexprice.io\"]:hover,[class*=nav] a[href*=\"admin.flexprice.io\"]:hover{background-color:#0d3d5c!important;color:#fff!important}.\\32xl\\:max-w-2xl,.content-area{max-width:50rem!important}.nav-anchor:hover>div{background-color:rgba(21,84,124,.08)!important}.dark .nav-anchor:hover>div{background-color:rgba(255,255,255,.08)!important}.nav-anchor img{background-color:transparent!important}.dark .nav-anchor img[src*=\"anchors/flexprice\"]{filter:brightness(0) invert(1)}"}],"page":{"pagePath":"api-reference/addons/create-addon","slug":"/api-reference/addons/create-addon","pageMetadata":{"title":"Create addon","description":"Use when defining an optional purchasable item (e.g. extra storage or support tier). Ideal for add-ons that customers can attach to a subscription.","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /addons","href":"/api-reference/addons/create-addon","autogeneratedByOpenApi":true},"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: \"Use when defining an optional purchasable item (e.g. extra storage or support tier). Ideal for add-ons that customers can attach to a subscription.\"\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":"Create addon","description":"Use when defining an optional purchasable item (e.g. extra storage or support tier). Ideal for add-ons that customers can attach to a subscription.","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /addons","href":"/api-reference/addons/create-addon","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/flexprice/c6cd5bf06bcd0181/reo-tracking.js"],"openApiReferenceData":{"operation":{"tags":["Addons"],"summary":"Create addon","description":"Use when defining an optional purchasable item (e.g. extra storage or support tier). Ideal for add-ons that customers can attach to a subscription.","operationId":"createAddon","requestBody":"e02dae97-1889-4444-a275-91e8b50f155d","responses":{"201":"81582037-90eb-44a4-9a38-2497b3dd525e","400":"d7a63c66-3683-4eec-aea9-650d58453d6a","500":"46ee2115-3828-421c-a50b-2e30f96f0f12"},"security":["8b87f3c0-3989-42b2-a69f-4ef195813e56"],"x-codegen-request-body-name":"addon","x-codeSamples":[{"lang":"go","label":"Go","source":"package main\n\nimport(\n\t\"context\"\n\tflexprice \"github.com/flexprice/go-sdk/v2\"\n\t\"github.com/flexprice/go-sdk/v2/models/types\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := flexprice.New(\n flexprice.WithSecurity(\"\u003cYOUR_API_KEY_HERE>\"),\n )\n\n res, err := s.Addons.CreateAddon(ctx, types.CreateAddonRequest{\n LookupKey: \"\u003cvalue>\",\n Name: \"\u003cvalue>\",\n })\n if err != nil {\n log.Fatal(err)\n }\n if res.CreateAddonResponse != nil {\n // handle response\n }\n}"},{"lang":"python","label":"Python","source":"from flexprice import Flexprice\n\n\nwith Flexprice(\n api_key_auth=\"\u003cYOUR_API_KEY_HERE>\",\n) as f_client:\n\n res = f_client.addons.create_addon(lookup_key=\"\u003cvalue>\", name=\"\u003cvalue>\")\n\n # Handle response\n print(res)"},{"lang":"typescript","label":"TypeScript","source":"import { Flexprice } from \"@flexprice/sdk\";\n\nconst flexprice = new Flexprice({\n apiKeyAuth: \"\u003cYOUR_API_KEY_HERE>\",\n});\n\nasync function run() {\n const result = await flexprice.addons.createAddon({\n lookupKey: \"\u003cvalue>\",\n name: \"\u003cvalue>\",\n });\n\n console.log(result);\n}\n\nrun();"}],"method":"post","type":"path","servers":["c3a552c0-fb0d-4192-bbfb-41d490814c91","8d9b0e10-8210-4fd4-9d91-5200cae97a59"],"path":"/addons","baseUrlOptions":["https://us.api.flexprice.io/v1","https://api.cloud.flexprice.io/v1"],"title":"Create addon","codeSamples":[{"label":"Go","lang":"go","source":"package main\n\nimport(\n\t\"context\"\n\tflexprice \"github.com/flexprice/go-sdk/v2\"\n\t\"github.com/flexprice/go-sdk/v2/models/types\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := flexprice.New(\n flexprice.WithSecurity(\"\u003cYOUR_API_KEY_HERE>\"),\n )\n\n res, err := s.Addons.CreateAddon(ctx, types.CreateAddonRequest{\n LookupKey: \"\u003cvalue>\",\n Name: \"\u003cvalue>\",\n })\n if err != nil {\n log.Fatal(err)\n }\n if res.CreateAddonResponse != nil {\n // handle response\n }\n}"},{"label":"Python","lang":"python","source":"from flexprice import Flexprice\n\n\nwith Flexprice(\n api_key_auth=\"\u003cYOUR_API_KEY_HERE>\",\n) as f_client:\n\n res = f_client.addons.create_addon(lookup_key=\"\u003cvalue>\", name=\"\u003cvalue>\")\n\n # Handle response\n print(res)"},{"label":"TypeScript","lang":"typescript","source":"import { Flexprice } from \"@flexprice/sdk\";\n\nconst flexprice = new Flexprice({\n apiKeyAuth: \"\u003cYOUR_API_KEY_HERE>\",\n});\n\nasync function run() {\n const result = await flexprice.addons.createAddon({\n lookupKey: \"\u003cvalue>\",\n name: \"\u003cvalue>\",\n });\n\n console.log(result);\n}\n\nrun();"}],"requestExampleLanguages":["bash","python","typescript","go"],"requiredOnlyExamples":false,"requestExampleType":"codeSamples","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"description":"Addon Request","content":{"application/json":{"schema":{"required":["lookup_key","name"],"type":"object","properties":{"lookup_key":{"type":"string","isRequired":true,"uniqueKey":"lookup_key","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"description":{"type":"string","uniqueKey":"description","typeLabel":"string"},"metadata":{"type":"object","additionalProperties":true,"uniqueKey":"metadata","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"lookup_key":"\u003cstring>","name":"\u003cstring>","description":"\u003cstring>","metadata":{}}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"81582037-90eb-44a4-9a38-2497b3dd525e":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"created_at":{"type":"string","format":"date-time","uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"created_by":{"type":"string","uniqueKey":"created_by","typeLabel":"string"},"credit_grants":{"type":"array","items":{"type":"object","properties":{"addon_id":{"type":"string","uniqueKey":"credit_grants.items.[INDEX].addon_id","typeLabel":"string"},"cadence":{"type":"string","enum":["ONETIME","RECURRING"],"x-enum-varnames":["CreditGrantCadenceOneTime","CreditGrantCadenceRecurring"],"x-speakeasy-name-override":"CreditGrantCadence","uniqueKey":"credit_grants.items.[INDEX].cadence","typeLabel":"enum\u003cstring>"},"conversion_rate":{"type":"string","description":"amount in the currency = number of credits * conversion_rate\nex if conversion_rate is 1, then 1 USD = 1 credit\nex if conversion_rate is 2, then 1 USD = 0.5 credits\nex if conversion_rate is 0.5, then 1 USD = 2 credits","uniqueKey":"credit_grants.items.[INDEX].conversion_rate","typeLabel":"string"},"created_at":{"type":"string","format":"date-time","uniqueKey":"credit_grants.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"created_by":{"type":"string","uniqueKey":"credit_grants.items.[INDEX].created_by","typeLabel":"string"},"credit_grant_anchor":{"type":"string","format":"date-time","uniqueKey":"credit_grants.items.[INDEX].credit_grant_anchor","typeLabel":"string\u003cdate-time>"},"credits":{"type":"string","uniqueKey":"credit_grants.items.[INDEX].credits","typeLabel":"string"},"end_date":{"type":"string","format":"date-time","uniqueKey":"credit_grants.items.[INDEX].end_date","typeLabel":"string\u003cdate-time>"},"environment_id":{"type":"string","uniqueKey":"credit_grants.items.[INDEX].environment_id","typeLabel":"string"},"expiration_duration":{"type":"integer","uniqueKey":"credit_grants.items.[INDEX].expiration_duration","typeLabel":"integer"},"expiration_duration_unit":{"type":"string","enum":["DAY","WEEK","MONTH","YEAR"],"x-enum-varnames":["CreditGrantExpiryDurationUnitDays","CreditGrantExpiryDurationUnitWeeks","CreditGrantExpiryDurationUnitMonths","CreditGrantExpiryDurationUnitYears"],"x-speakeasy-name-override":"CreditGrantExpiryDurationUnit","uniqueKey":"credit_grants.items.[INDEX].expiration_duration_unit","typeLabel":"enum\u003cstring>"},"expiration_type":{"type":"string","enum":["NEVER","DURATION","BILLING_CYCLE"],"x-enum-varnames":["CreditGrantExpiryTypeNever","CreditGrantExpiryTypeDuration","CreditGrantExpiryTypeBillingCycle"],"x-speakeasy-name-override":"CreditGrantExpiryType","uniqueKey":"credit_grants.items.[INDEX].expiration_type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","uniqueKey":"credit_grants.items.[INDEX].id","typeLabel":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"credit_grants.items.[INDEX].metadata.additionalProperties","typeLabel":"string"},"x-speakeasy-name-override":"Metadata","uniqueKey":"credit_grants.items.[INDEX].metadata","typeLabel":"object"},"name":{"type":"string","uniqueKey":"credit_grants.items.[INDEX].name","typeLabel":"string"},"period":{"type":"string","enum":["DAILY","WEEKLY","MONTHLY","ANNUAL","QUARTERLY","HALF_YEARLY"],"x-enum-varnames":["CREDIT_GRANT_PERIOD_DAILY","CREDIT_GRANT_PERIOD_WEEKLY","CREDIT_GRANT_PERIOD_MONTHLY","CREDIT_GRANT_PERIOD_ANNUAL","CREDIT_GRANT_PERIOD_QUARTER","CREDIT_GRANT_PERIOD_HALF_YEARLY"],"x-speakeasy-name-override":"CreditGrantPeriod","uniqueKey":"credit_grants.items.[INDEX].period","typeLabel":"enum\u003cstring>"},"period_count":{"type":"integer","uniqueKey":"credit_grants.items.[INDEX].period_count","typeLabel":"integer"},"plan_id":{"type":"string","uniqueKey":"credit_grants.items.[INDEX].plan_id","typeLabel":"string"},"priority":{"type":"integer","uniqueKey":"credit_grants.items.[INDEX].priority","typeLabel":"integer"},"scope":{"type":"string","enum":["PLAN","SUBSCRIPTION","ADDON"],"x-enum-varnames":["CreditGrantScopePlan","CreditGrantScopeSubscription","CreditGrantScopeAddon"],"x-speakeasy-name-override":"CreditGrantScope","uniqueKey":"credit_grants.items.[INDEX].scope","typeLabel":"enum\u003cstring>"},"start_date":{"type":"string","format":"date-time","uniqueKey":"credit_grants.items.[INDEX].start_date","typeLabel":"string\u003cdate-time>"},"status":{"type":"string","enum":["published","deleted","archived"],"x-enum-varnames":["StatusPublished","StatusDeleted","StatusArchived"],"x-speakeasy-name-override":"Status","uniqueKey":"credit_grants.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"subscription_id":{"type":"string","uniqueKey":"credit_grants.items.[INDEX].subscription_id","typeLabel":"string"},"tenant_id":{"type":"string","uniqueKey":"credit_grants.items.[INDEX].tenant_id","typeLabel":"string"},"topup_conversion_rate":{"type":"string","description":"topup_conversion_rate is the conversion rate for the topup to the currency\nex if topup_conversion_rate is 1, then 1 USD = 1 credit\nex if topup_conversion_rate is 2, then 1 USD = 0.5 credits\nex if topup_conversion_rate is 0.5, then 1 USD = 2 credits","uniqueKey":"credit_grants.items.[INDEX].topup_conversion_rate","typeLabel":"string"},"updated_at":{"type":"string","format":"date-time","uniqueKey":"credit_grants.items.[INDEX].updated_at","typeLabel":"string\u003cdate-time>"},"updated_by":{"type":"string","uniqueKey":"credit_grants.items.[INDEX].updated_by","typeLabel":"string"}},"uniqueKey":"credit_grants.items.[INDEX]","typeLabel":"object"},"uniqueKey":"credit_grants","typeLabel":"object[]"},"description":{"type":"string","uniqueKey":"description","typeLabel":"string"},"entitlements":{"type":"array","items":{"type":"object","properties":{"addon":{"type":"object","properties":{"created_at":{"type":"string","format":"date-time","uniqueKey":"entitlements.items.[INDEX].addon.created_at","typeLabel":"string\u003cdate-time>"},"created_by":{"type":"string","uniqueKey":"entitlements.items.[INDEX].addon.created_by","typeLabel":"string"},"credit_grants":{"type":"array","items":{"type":"object","properties":{"addon_id":{"type":"string","uniqueKey":"entitlements.items.[INDEX].addon.credit_grants.items.[INDEX].addon_id","typeLabel":"string"},"cadence":{"type":"string","enum":["ONETIME","RECURRING"],"x-enum-varnames":["CreditGrantCadenceOneTime","CreditGrantCadenceRecurring"],"x-speakeasy-name-override":"CreditGrantCadence","uniqueKey":"entitlements.items.[INDEX].addon.credit_grants.items.[INDEX].cadence","typeLabel":"enum\u003cstring>"},"conversion_rate":{"type":"string","description":"amount in the currency = number of credits * conversion_rate\nex if conversion_rate is 1, then 1 USD = 1 credit\nex if conversion_rate is 2, then 1 USD = 0.5 credits\nex if conversion_rate is 0.5, then 1 USD = 2 credits","uniqueKey":"entitlements.items.[INDEX].addon.credit_grants.items.[INDEX].conversion_rate","typeLabel":"string"},"created_at":{"type":"string","format":"date-time","uniqueKey":"entitlements.items.[INDEX].addon.credit_grants.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"created_by":{"type":"string","uniqueKey":"entitlements.items.[INDEX].addon.credit_grants.items.[INDEX].created_by","typeLabel":"string"},"credit_grant_anchor":{"type":"string","format":"date-time","uniqueKey":"entitlements.items.[INDEX].addon.credit_grants.items.[INDEX].credit_grant_anchor","typeLabel":"string\u003cdate-time>"},"credits":{"type":"string","uniqueKey":"entitlements.items.[INDEX].addon.credit_grants.items.[INDEX].credits","typeLabel":"string"},"end_date":{"type":"string","format":"date-time","uniqueKey":"entitlements.items.[INDEX].addon.credit_grants.items.[INDEX].end_date","typeLabel":"string\u003cdate-time>"},"environment_id":{"type":"string","uniqueKey":"entitlements.items.[INDEX].addon.credit_grants.items.[INDEX].environment_id","typeLabel":"string"},"expiration_duration":{"type":"integer","uniqueKey":"entitlements.items.[INDEX].addon.credit_grants.items.[INDEX].expiration_duration","typeLabel":"integer"},"expiration_duration_unit":{"type":"string","enum":["DAY","WEEK","MONTH","YEAR"],"x-enum-varnames":["CreditGrantExpiryDurationUnitDays","CreditGrantExpiryDurationUnitWeeks","CreditGrantExpiryDurationUnitMonths","CreditGrantExpiryDurationUnitYears"],"x-speakeasy-name-override":"CreditGrantExpiryDurationUnit","uniqueKey":"entitlements.items.[INDEX].addon.credit_grants.items.[INDEX].expiration_duration_unit","typeLabel":"enum\u003cstring>"},"expiration_type":{"type":"string","enum":["NEVER","DURATION","BILLING_CYCLE"],"x-enum-varnames":["CreditGrantExpiryTypeNever","CreditGrantExpiryTypeDuration","CreditGrantExpiryTypeBillingCycle"],"x-speakeasy-name-override":"CreditGrantExpiryType","uniqueKey":"entitlements.items.[INDEX].addon.credit_grants.items.[INDEX].expiration_type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","uniqueKey":"entitlements.items.[INDEX].addon.credit_grants.items.[INDEX].id","typeLabel":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"entitlements.items.[INDEX].addon.credit_grants.items.[INDEX].metadata.additionalProperties","typeLabel":"string"},"x-speakeasy-name-override":"Metadata","uniqueKey":"entitlements.items.[INDEX].addon.credit_grants.items.[INDEX].metadata","typeLabel":"object"},"name":{"type":"string","uniqueKey":"entitlements.items.[INDEX].addon.credit_grants.items.[INDEX].name","typeLabel":"string"},"period":{"type":"string","enum":["DAILY","WEEKLY","MONTHLY","ANNUAL","QUARTERLY","HALF_YEARLY"],"x-enum-varnames":["CREDIT_GRANT_PERIOD_DAILY","CREDIT_GRANT_PERIOD_WEEKLY","CREDIT_GRANT_PERIOD_MONTHLY","CREDIT_GRANT_PERIOD_ANNUAL","CREDIT_GRANT_PERIOD_QUARTER","CREDIT_GRANT_PERIOD_HALF_YEARLY"],"x-speakeasy-name-override":"CreditGrantPeriod","uniqueKey":"entitlements.items.[INDEX].addon.credit_grants.items.[INDEX].period","typeLabel":"enum\u003cstring>"},"period_count":{"type":"integer","uniqueKey":"entitlements.items.[INDEX].addon.credit_grants.items.[INDEX].period_count","typeLabel":"integer"},"plan_id":{"type":"string","uniqueKey":"entitlements.items.[INDEX].addon.credit_grants.items.[INDEX].plan_id","typeLabel":"string"},"priority":{"type":"integer","uniqueKey":"entitlements.items.[INDEX].addon.credit_grants.items.[INDEX].priority","typeLabel":"integer"},"scope":{"type":"string","enum":["PLAN","SUBSCRIPTION","ADDON"],"x-enum-varnames":["CreditGrantScopePlan","CreditGrantScopeSubscription","CreditGrantScopeAddon"],"x-speakeasy-name-override":"CreditGrantScope","uniqueKey":"entitlements.items.[INDEX].addon.credit_grants.items.[INDEX].scope","typeLabel":"enum\u003cstring>"},"start_date":{"type":"string","format":"date-time","uniqueKey":"entitlements.items.[INDEX].addon.credit_grants.items.[INDEX].start_date","typeLabel":"string\u003cdate-time>"},"status":{"type":"string","enum":["published","deleted","archived"],"x-enum-varnames":["StatusPublished","StatusDeleted","StatusArchived"],"x-speakeasy-name-override":"Status","uniqueKey":"entitlements.items.[INDEX].addon.credit_grants.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"subscription_id":{"type":"string","uniqueKey":"entitlements.items.[INDEX].addon.credit_grants.items.[INDEX].subscription_id","typeLabel":"string"},"tenant_id":{"type":"string","uniqueKey":"entitlements.items.[INDEX].addon.credit_grants.items.[INDEX].tenant_id","typeLabel":"string"},"topup_conversion_rate":{"type":"string","description":"topup_conversion_rate is the conversion rate for the topup to the currency\nex if topup_conversion_rate is 1, then 1 USD = 1 credit\nex if topup_conversion_rate is 2, then 1 USD = 0.5 credits\nex if topup_conversion_rate is 0.5, then 1 USD = 2 credits","uniqueKey":"entitlements.items.[INDEX].addon.credit_grants.items.[INDEX].topup_conversion_rate","typeLabel":"string"},"updated_at":{"type":"string","format":"date-time","uniqueKey":"entitlements.items.[INDEX].addon.credit_grants.items.[INDEX].updated_at","typeLabel":"string\u003cdate-time>"},"updated_by":{"type":"string","uniqueKey":"entitlements.items.[INDEX].addon.credit_grants.items.[INDEX].updated_by","typeLabel":"string"}},"uniqueKey":"entitlements.items.[INDEX].addon.credit_grants.items.[INDEX]","typeLabel":"object"},"uniqueKey":"entitlements.items.[INDEX].addon.credit_grants","typeLabel":"object[]"},"description":{"type":"string","uniqueKey":"entitlements.items.[INDEX].addon.description","typeLabel":"string"},"entitlements":{"oneOf":[{"$circularRef":"8ae9e152-6edf-472c-9b6e-b5cc555f8111"}],"uniqueKey":"entitlements.items.[INDEX].addon.entitlements","typeLabel":"any"},"environment_id":{"type":"string","uniqueKey":"entitlements.items.[INDEX].addon.environment_id","typeLabel":"string"},"id":{"type":"string","uniqueKey":"entitlements.items.[INDEX].addon.id","typeLabel":"string"},"lookup_key":{"type":"string","uniqueKey":"entitlements.items.[INDEX].addon.lookup_key","typeLabel":"string"},"metadata":{"type":"object","additionalProperties":true,"uniqueKey":"entitlements.items.[INDEX].addon.metadata","typeLabel":"object"},"name":{"type":"string","uniqueKey":"entitlements.items.[INDEX].addon.name","typeLabel":"string"},"price_sync_status":{"type":"object","properties":{"current_sequence":{"type":"integer","uniqueKey":"entitlements.items.[INDEX].addon.price_sync_status.current_sequence","typeLabel":"integer"},"synced":{"type":"boolean","uniqueKey":"entitlements.items.[INDEX].addon.price_sync_status.synced","typeLabel":"boolean"},"unsynced_association_count":{"type":"integer","uniqueKey":"entitlements.items.[INDEX].addon.price_sync_status.unsynced_association_count","typeLabel":"integer"}},"uniqueKey":"entitlements.items.[INDEX].addon.price_sync_status","typeLabel":"object"},"prices":{"type":"array","description":"Optional expanded fields","items":{"type":"object","properties":{"addon":{"oneOf":[{"$circularRef":"6c04a6f7-e9a8-4aa6-bb72-c876420f4348"}],"uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].addon","typeLabel":"any"},"amount":{"type":"string","description":"Amount stored in main currency units (e.g., dollars, not cents)\nFor USD: 12.50 means $12.50","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].amount","typeLabel":"string"},"billing_cadence":{"type":"string","enum":["RECURRING"],"x-enum-varnames":["BILLING_CADENCE_RECURRING"],"x-speakeasy-name-override":"BillingCadence","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].billing_cadence","typeLabel":"enum\u003cstring>"},"billing_model":{"type":"string","enum":["FLAT_FEE","PACKAGE","TIERED"],"x-enum-varnames":["BILLING_MODEL_FLAT_FEE","BILLING_MODEL_PACKAGE","BILLING_MODEL_TIERED"],"x-speakeasy-name-override":"BillingModel","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].billing_model","typeLabel":"enum\u003cstring>"},"billing_period":{"type":"string","enum":["MONTHLY","ANNUAL","WEEKLY","DAILY","QUARTERLY","HALF_YEARLY","ONETIME"],"x-enum-varnames":["BILLING_PERIOD_MONTHLY","BILLING_PERIOD_ANNUAL","BILLING_PERIOD_WEEKLY","BILLING_PERIOD_DAILY","BILLING_PERIOD_QUARTER","BILLING_PERIOD_HALF_YEAR","BILLING_PERIOD_ONETIME"],"x-speakeasy-name-override":"BillingPeriod","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].billing_period","typeLabel":"enum\u003cstring>"},"billing_period_count":{"type":"integer","description":"BillingPeriodCount is the count of the billing period ex 1, 3, 6, 12","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].billing_period_count","typeLabel":"integer"},"bucket_size":{"type":"string","enum":["MINUTE","15MIN","30MIN","HOUR","3HOUR","6HOUR","12HOUR","DAY","WEEK","MONTH"],"x-enum-varnames":["WindowSizeMinute","WindowSize15Min","WindowSize30Min","WindowSizeHour","WindowSize3Hour","WindowSize6Hour","WindowSize12Hour","WindowSizeDay","WindowSizeWeek","WindowSizeMonth"],"x-speakeasy-name-override":"WindowSize","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].bucket_size","typeLabel":"enum\u003cstring>"},"conversion_rate":{"type":"string","description":"ConversionRate is the conversion rate of the price unit to the fiat currency","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].conversion_rate","typeLabel":"string"},"created_at":{"type":"string","format":"date-time","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"created_by":{"type":"string","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].created_by","typeLabel":"string"},"currency":{"type":"string","description":"Currency 3 digit ISO currency code in lowercase ex usd, eur, gbp","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].currency","typeLabel":"string"},"description":{"type":"string","description":"Description of the price","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].description","typeLabel":"string"},"display_amount":{"type":"string","description":"DisplayAmount is the formatted amount with currency symbol\nFor USD: $12.50","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].display_amount","typeLabel":"string"},"display_name":{"type":"string","description":"DisplayName is the name of the price","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].display_name","typeLabel":"string"},"display_price_unit_amount":{"type":"string","description":"DisplayPriceUnitAmount is the formatted amount of the price unit","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].display_price_unit_amount","typeLabel":"string"},"end_date":{"type":"string","description":"EndDate is the end date of the price","format":"date-time","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].end_date","typeLabel":"string\u003cdate-time>"},"entity_id":{"type":"string","description":"EntityID holds the value of the \"entity_id\" field.","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].entity_id","typeLabel":"string"},"entity_type":{"type":"string","enum":["PLAN","SUBSCRIPTION","ADDON","PRICE","COSTSHEET"],"x-enum-varnames":["PRICE_ENTITY_TYPE_PLAN","PRICE_ENTITY_TYPE_SUBSCRIPTION","PRICE_ENTITY_TYPE_ADDON","PRICE_ENTITY_TYPE_PRICE","PRICE_ENTITY_TYPE_COSTSHEET"],"x-speakeasy-name-override":"PriceEntityType","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].entity_type","typeLabel":"enum\u003cstring>"},"environment_id":{"type":"string","description":"EnvironmentID is the environment identifier for the price","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].environment_id","typeLabel":"string"},"feature":{"type":"object","properties":{"reporting_unit":{"type":"object","properties":{"conversion_rate":{"type":"number","description":"Multiplier: reporting_unit_value = unit_value * conversion_rate; must be > 0","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].feature.reporting_unit.conversion_rate","typeLabel":"number"},"unit_plural":{"type":"string","description":"Display unit label, plural (e.g. \"seconds\")","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].feature.reporting_unit.unit_plural","typeLabel":"string"},"unit_singular":{"type":"string","description":"Display unit label, singular (e.g. \"second\")","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].feature.reporting_unit.unit_singular","typeLabel":"string"}},"x-speakeasy-name-override":"ReportingUnit","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].feature.reporting_unit","typeLabel":"object"}},"uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].feature","typeLabel":"object"},"group":{"type":"object","properties":{"created_at":{"type":"string","format":"date-time","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].group.created_at","typeLabel":"string\u003cdate-time>"},"entity_ids":{"type":"array","items":{"type":"string","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].group.entity_ids.items.[INDEX]","typeLabel":"string"},"uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].group.entity_ids","typeLabel":"string[]"},"entity_type":{"type":"string","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].group.entity_type","typeLabel":"string"},"id":{"type":"string","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].group.id","typeLabel":"string"},"lookup_key":{"type":"string","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].group.lookup_key","typeLabel":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].group.metadata.additionalProperties","typeLabel":"string"},"uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].group.metadata","typeLabel":"object"},"name":{"type":"string","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].group.name","typeLabel":"string"},"status":{"type":"string","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].group.status","typeLabel":"string"},"updated_at":{"type":"string","format":"date-time","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].group.updated_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].group","typeLabel":"object"},"group_id":{"type":"string","description":"GroupID references the group this price belongs to","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].group_id","typeLabel":"string"},"id":{"type":"string","description":"ID uuid identifier for the price","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].id","typeLabel":"string"},"invoice_cadence":{"type":"string","enum":["ARREAR","ADVANCE"],"x-enum-varnames":["InvoiceCadenceArrear","InvoiceCadenceAdvance"],"x-speakeasy-name-override":"InvoiceCadence","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].invoice_cadence","typeLabel":"enum\u003cstring>"},"lookup_key":{"type":"string","description":"LookupKey used for looking up the price in the database","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].lookup_key","typeLabel":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].metadata.additionalProperties","typeLabel":"string"},"uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].metadata","typeLabel":"object"},"meter":{"type":"object","properties":{"aggregation":{"type":"object","properties":{"bucket_size":{"type":"string","enum":["MINUTE","15MIN","30MIN","HOUR","3HOUR","6HOUR","12HOUR","DAY","WEEK","MONTH"],"x-enum-varnames":["WindowSizeMinute","WindowSize15Min","WindowSize30Min","WindowSizeHour","WindowSize3Hour","WindowSize6Hour","WindowSize12Hour","WindowSizeDay","WindowSizeWeek","WindowSizeMonth"],"x-speakeasy-name-override":"WindowSize","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].meter.aggregation.bucket_size","typeLabel":"enum\u003cstring>"},"expression":{"type":"string","description":"Expression is an optional CEL expression to compute per-event quantity from event.properties.\nWhen set, it replaces Field-based extraction. Property names are used directly (e.g., token * duration * pixel).","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].meter.aggregation.expression","typeLabel":"string"},"field":{"type":"string","description":"Field is the key in $event.properties on which the aggregation is to be applied\nFor ex if the aggregation type is sum for API usage, the field could be \"duration_ms\"\nIgnored when Expression is set.","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].meter.aggregation.field","typeLabel":"string"},"group_by":{"type":"string","description":"GroupBy is the property name in event.properties to group by before aggregating.\nRequires MAX aggregation. Windowing comes from the price, so this no longer\nimplies a meter-level bucket_size.\nWhen set, aggregation is applied per unique value of this property within each bucket,\nthen the per-group results are summed to produce the bucket total.","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].meter.aggregation.group_by","typeLabel":"string"},"multiplier":{"type":"string","description":"Multiplier is the multiplier for the aggregation\nFor ex if the aggregation type is sum_with_multiplier for API usage, the multiplier could be 1000\nto scale up by a factor of 1000. If not provided, it will be null.","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].meter.aggregation.multiplier","typeLabel":"string"},"type":{"type":"string","enum":["COUNT","SUM","AVG","COUNT_UNIQUE","LATEST","SUM_WITH_MULTIPLIER","MAX","WEIGHTED_SUM"],"x-enum-comments":{"AggregationSumWithMultiplier":"Sum with a multiplier - [sum(value) * multiplier]"},"x-enum-varnames":["AggregationCount","AggregationSum","AggregationAvg","AggregationCountUnique","AggregationLatest","AggregationSumWithMultiplier","AggregationMax","AggregationWeightedSum"],"x-speakeasy-name-override":"AggregationType","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].meter.aggregation.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].meter.aggregation","typeLabel":"object"},"created_at":{"type":"string","example":"2024-03-20T15:04:05Z","format":"date-time","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].meter.created_at","typeLabel":"string\u003cdate-time>"},"event_name":{"type":"string","example":"api_request","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].meter.event_name","typeLabel":"string"},"filters":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":"Key is the key for the filter from $event.properties\nCurrently we support only first level keys in the properties and not nested keys","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].meter.filters.items.[INDEX].key","typeLabel":"string"},"values":{"type":"array","description":"Values are the possible values for the filter to be considered for the meter\nFor ex \"model_name\" could have values \"o1-mini\", \"gpt-4o\" etc","items":{"type":"string","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].meter.filters.items.[INDEX].values.items.[INDEX]","typeLabel":"string"},"uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].meter.filters.items.[INDEX].values","typeLabel":"string[]"}},"uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].meter.filters.items.[INDEX]","typeLabel":"object"},"uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].meter.filters","typeLabel":"object[]"},"id":{"type":"string","example":"550e8400-e29b-41d4-a716-446655440000","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].meter.id","typeLabel":"string"},"name":{"type":"string","example":"API Usage Meter","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].meter.name","typeLabel":"string"},"reset_usage":{"type":"string","enum":["BILLING_PERIOD","NEVER"],"x-enum-varnames":["ResetUsageBillingPeriod","ResetUsageNever"],"x-speakeasy-name-override":"ResetUsage","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].meter.reset_usage","typeLabel":"enum\u003cstring>"},"status":{"type":"string","example":"published","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].meter.status","typeLabel":"string"},"tenant_id":{"type":"string","example":"tenant123","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].meter.tenant_id","typeLabel":"string"},"updated_at":{"type":"string","example":"2024-03-20T15:04:05Z","format":"date-time","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].meter.updated_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].meter","typeLabel":"object"},"meter_id":{"type":"string","description":"MeterID is the id of the meter for usage based pricing","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].meter_id","typeLabel":"string"},"min_quantity":{"oneOf":[{"type":"string","description":"MinQuantity is the minimum quantity of the price","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].min_quantity.oneOf.0","typeLabel":"string"},{"type":"null","description":"MinQuantity is the minimum quantity of the price","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].min_quantity.oneOf.1","typeLabel":"null"}],"uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].min_quantity","typeLabel":"string | null"},"parent_price_id":{"type":"string","description":"ParentPriceID references the root price (always set for price lineage tracking)","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].parent_price_id","typeLabel":"string"},"plan":{"type":"object","properties":{"created_at":{"type":"string","format":"date-time","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].plan.created_at","typeLabel":"string\u003cdate-time>"},"created_by":{"type":"string","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].plan.created_by","typeLabel":"string"},"credit_grants":{"type":"array","items":{"type":"object","properties":{"addon_id":{"type":"string","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].plan.credit_grants.items.[INDEX].addon_id","typeLabel":"string"},"cadence":{"type":"string","enum":["ONETIME","RECURRING"],"x-enum-varnames":["CreditGrantCadenceOneTime","CreditGrantCadenceRecurring"],"x-speakeasy-name-override":"CreditGrantCadence","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].plan.credit_grants.items.[INDEX].cadence","typeLabel":"enum\u003cstring>"},"conversion_rate":{"type":"string","description":"amount in the currency = number of credits * conversion_rate\nex if conversion_rate is 1, then 1 USD = 1 credit\nex if conversion_rate is 2, then 1 USD = 0.5 credits\nex if conversion_rate is 0.5, then 1 USD = 2 credits","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].plan.credit_grants.items.[INDEX].conversion_rate","typeLabel":"string"},"created_at":{"type":"string","format":"date-time","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].plan.credit_grants.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"created_by":{"type":"string","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].plan.credit_grants.items.[INDEX].created_by","typeLabel":"string"},"credit_grant_anchor":{"type":"string","format":"date-time","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].plan.credit_grants.items.[INDEX].credit_grant_anchor","typeLabel":"string\u003cdate-time>"},"credits":{"type":"string","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].plan.credit_grants.items.[INDEX].credits","typeLabel":"string"},"end_date":{"type":"string","format":"date-time","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].plan.credit_grants.items.[INDEX].end_date","typeLabel":"string\u003cdate-time>"},"environment_id":{"type":"string","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].plan.credit_grants.items.[INDEX].environment_id","typeLabel":"string"},"expiration_duration":{"type":"integer","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].plan.credit_grants.items.[INDEX].expiration_duration","typeLabel":"integer"},"expiration_duration_unit":{"type":"string","enum":["DAY","WEEK","MONTH","YEAR"],"x-enum-varnames":["CreditGrantExpiryDurationUnitDays","CreditGrantExpiryDurationUnitWeeks","CreditGrantExpiryDurationUnitMonths","CreditGrantExpiryDurationUnitYears"],"x-speakeasy-name-override":"CreditGrantExpiryDurationUnit","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].plan.credit_grants.items.[INDEX].expiration_duration_unit","typeLabel":"enum\u003cstring>"},"expiration_type":{"type":"string","enum":["NEVER","DURATION","BILLING_CYCLE"],"x-enum-varnames":["CreditGrantExpiryTypeNever","CreditGrantExpiryTypeDuration","CreditGrantExpiryTypeBillingCycle"],"x-speakeasy-name-override":"CreditGrantExpiryType","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].plan.credit_grants.items.[INDEX].expiration_type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].plan.credit_grants.items.[INDEX].id","typeLabel":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].plan.credit_grants.items.[INDEX].metadata.additionalProperties","typeLabel":"string"},"x-speakeasy-name-override":"Metadata","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].plan.credit_grants.items.[INDEX].metadata","typeLabel":"object"},"name":{"type":"string","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].plan.credit_grants.items.[INDEX].name","typeLabel":"string"},"period":{"type":"string","enum":["DAILY","WEEKLY","MONTHLY","ANNUAL","QUARTERLY","HALF_YEARLY"],"x-enum-varnames":["CREDIT_GRANT_PERIOD_DAILY","CREDIT_GRANT_PERIOD_WEEKLY","CREDIT_GRANT_PERIOD_MONTHLY","CREDIT_GRANT_PERIOD_ANNUAL","CREDIT_GRANT_PERIOD_QUARTER","CREDIT_GRANT_PERIOD_HALF_YEARLY"],"x-speakeasy-name-override":"CreditGrantPeriod","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].plan.credit_grants.items.[INDEX].period","typeLabel":"enum\u003cstring>"},"period_count":{"type":"integer","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].plan.credit_grants.items.[INDEX].period_count","typeLabel":"integer"},"plan_id":{"type":"string","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].plan.credit_grants.items.[INDEX].plan_id","typeLabel":"string"},"priority":{"type":"integer","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].plan.credit_grants.items.[INDEX].priority","typeLabel":"integer"},"scope":{"type":"string","enum":["PLAN","SUBSCRIPTION","ADDON"],"x-enum-varnames":["CreditGrantScopePlan","CreditGrantScopeSubscription","CreditGrantScopeAddon"],"x-speakeasy-name-override":"CreditGrantScope","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].plan.credit_grants.items.[INDEX].scope","typeLabel":"enum\u003cstring>"},"start_date":{"type":"string","format":"date-time","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].plan.credit_grants.items.[INDEX].start_date","typeLabel":"string\u003cdate-time>"},"status":{"type":"string","enum":["published","deleted","archived"],"x-enum-varnames":["StatusPublished","StatusDeleted","StatusArchived"],"x-speakeasy-name-override":"Status","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].plan.credit_grants.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"subscription_id":{"type":"string","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].plan.credit_grants.items.[INDEX].subscription_id","typeLabel":"string"},"tenant_id":{"type":"string","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].plan.credit_grants.items.[INDEX].tenant_id","typeLabel":"string"},"topup_conversion_rate":{"type":"string","description":"topup_conversion_rate is the conversion rate for the topup to the currency\nex if topup_conversion_rate is 1, then 1 USD = 1 credit\nex if topup_conversion_rate is 2, then 1 USD = 0.5 credits\nex if topup_conversion_rate is 0.5, then 1 USD = 2 credits","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].plan.credit_grants.items.[INDEX].topup_conversion_rate","typeLabel":"string"},"updated_at":{"type":"string","format":"date-time","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].plan.credit_grants.items.[INDEX].updated_at","typeLabel":"string\u003cdate-time>"},"updated_by":{"type":"string","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].plan.credit_grants.items.[INDEX].updated_by","typeLabel":"string"}},"uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].plan.credit_grants.items.[INDEX]","typeLabel":"object"},"uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].plan.credit_grants","typeLabel":"object[]"},"description":{"type":"string","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].plan.description","typeLabel":"string"},"display_order":{"type":"integer","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].plan.display_order","typeLabel":"integer"},"entitlements":{"type":"array","items":{"$circularRef":"1c99a94f-ba2d-4aeb-aec5-928f5daeddec"},"uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].plan.entitlements","typeLabel":"array"},"environment_id":{"type":"string","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].plan.environment_id","typeLabel":"string"},"id":{"type":"string","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].plan.id","typeLabel":"string"},"lookup_key":{"type":"string","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].plan.lookup_key","typeLabel":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].plan.metadata.additionalProperties","typeLabel":"string"},"x-speakeasy-name-override":"Metadata","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].plan.metadata","typeLabel":"object"},"name":{"type":"string","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].plan.name","typeLabel":"string"},"price_sync_status":{"type":"object","properties":{"current_sequence":{"type":"integer","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].plan.price_sync_status.current_sequence","typeLabel":"integer"},"synced":{"type":"boolean","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].plan.price_sync_status.synced","typeLabel":"boolean"},"unsynced_subscription_count":{"type":"integer","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].plan.price_sync_status.unsynced_subscription_count","typeLabel":"integer"}},"uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].plan.price_sync_status","typeLabel":"object"},"prices":{"type":"array","description":"TODO: Add inline addons","items":{"$circularRef":"0dc125d7-6bd8-40a5-8d18-2c0190dcf082"},"uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].plan.prices","typeLabel":"array"},"status":{"type":"string","enum":["published","deleted","archived"],"x-enum-varnames":["StatusPublished","StatusDeleted","StatusArchived"],"x-speakeasy-name-override":"Status","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].plan.status","typeLabel":"enum\u003cstring>"},"tenant_id":{"type":"string","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].plan.tenant_id","typeLabel":"string"},"updated_at":{"type":"string","format":"date-time","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].plan.updated_at","typeLabel":"string\u003cdate-time>"},"updated_by":{"type":"string","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].plan.updated_by","typeLabel":"string"}},"uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].plan","typeLabel":"object"},"price_unit":{"type":"string","description":"PriceUnit is the code of the price unit (e.g., 'btc', 'eth')","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].price_unit","typeLabel":"string"},"price_unit_amount":{"type":"string","description":"PriceUnitAmount is the amount of the price unit","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].price_unit_amount","typeLabel":"string"},"price_unit_id":{"type":"string","description":"PriceUnitID is the id of the price unit (for CUSTOM type)","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].price_unit_id","typeLabel":"string"},"price_unit_tiers":{"type":"array","description":"PriceUnitTiers are the tiers for the price unit when BillingModel is TIERED","items":{"type":"object","properties":{"flat_amount":{"type":"string","description":"flat_amount is the flat amount for the given tier (optional)\nApplied on top of unit_amount*quantity. Useful for cases like \"2.7$ + 5c\"","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].price_unit_tiers.items.[INDEX].flat_amount","typeLabel":"string"},"unit_amount":{"type":"string","description":"unit_amount is the amount per unit for the given tier","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].price_unit_tiers.items.[INDEX].unit_amount","typeLabel":"string"},"up_to":{"type":"integer","description":"up_to is the quantity up to which this tier applies. It is null for the last tier.\nIMPORTANT: Tier boundaries are INCLUSIVE.\n- If up_to is 1000, then quantity less than or equal to 1000 belongs to this tier\n- This behavior is consistent across both VOLUME and SLAB tier modes","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].price_unit_tiers.items.[INDEX].up_to","typeLabel":"integer"}},"uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].price_unit_tiers.items.[INDEX]","typeLabel":"object"},"uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].price_unit_tiers","typeLabel":"object[]"},"price_unit_type":{"type":"string","enum":["FIAT","CUSTOM"],"x-enum-varnames":["PRICE_UNIT_TYPE_FIAT","PRICE_UNIT_TYPE_CUSTOM"],"x-speakeasy-name-override":"PriceUnitType","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].price_unit_type","typeLabel":"enum\u003cstring>"},"pricing_unit":{"type":"object","properties":{"base_currency":{"type":"string","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].pricing_unit.base_currency","typeLabel":"string"},"code":{"type":"string","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].pricing_unit.code","typeLabel":"string"},"conversion_rate":{"type":"string","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].pricing_unit.conversion_rate","typeLabel":"string"},"created_at":{"type":"string","format":"date-time","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].pricing_unit.created_at","typeLabel":"string\u003cdate-time>"},"created_by":{"type":"string","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].pricing_unit.created_by","typeLabel":"string"},"environment_id":{"type":"string","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].pricing_unit.environment_id","typeLabel":"string"},"id":{"type":"string","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].pricing_unit.id","typeLabel":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].pricing_unit.metadata.additionalProperties","typeLabel":"string"},"x-speakeasy-name-override":"Metadata","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].pricing_unit.metadata","typeLabel":"object"},"name":{"type":"string","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].pricing_unit.name","typeLabel":"string"},"status":{"type":"string","enum":["published","deleted","archived"],"x-enum-varnames":["StatusPublished","StatusDeleted","StatusArchived"],"x-speakeasy-name-override":"Status","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].pricing_unit.status","typeLabel":"enum\u003cstring>"},"symbol":{"type":"string","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].pricing_unit.symbol","typeLabel":"string"},"tenant_id":{"type":"string","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].pricing_unit.tenant_id","typeLabel":"string"},"updated_at":{"type":"string","format":"date-time","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].pricing_unit.updated_at","typeLabel":"string\u003cdate-time>"},"updated_by":{"type":"string","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].pricing_unit.updated_by","typeLabel":"string"}},"uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].pricing_unit","typeLabel":"object"},"sequence":{"type":"integer","description":"Sequence is the monotonic stamp bumped on every state change that\nsubscription line items need to react to. Read by the plan-price sync;\nset by the database (DEFAULT nextval) on create and by the price\nrepository on termination / compatibility-affecting edits.","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].sequence","typeLabel":"integer"},"start_date":{"type":"string","description":"StartDate is the start date of the price","format":"date-time","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].start_date","typeLabel":"string\u003cdate-time>"},"status":{"type":"string","enum":["published","deleted","archived"],"x-enum-varnames":["StatusPublished","StatusDeleted","StatusArchived"],"x-speakeasy-name-override":"Status","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"tenant_id":{"type":"string","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].tenant_id","typeLabel":"string"},"tier_mode":{"type":"string","enum":["VOLUME","SLAB"],"x-enum-varnames":["BILLING_TIER_VOLUME","BILLING_TIER_SLAB"],"x-speakeasy-name-override":"BillingTier","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].tier_mode","typeLabel":"enum\u003cstring>"},"tiers":{"type":"array","items":{"type":"object","properties":{"flat_amount":{"type":"string","description":"flat_amount is the flat amount for the given tier (optional)\nApplied on top of unit_amount*quantity. Useful for cases like \"2.7$ + 5c\"","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].tiers.items.[INDEX].flat_amount","typeLabel":"string"},"unit_amount":{"type":"string","description":"unit_amount is the amount per unit for the given tier","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].tiers.items.[INDEX].unit_amount","typeLabel":"string"},"up_to":{"type":"integer","description":"up_to is the quantity up to which this tier applies. It is null for the last tier.\nIMPORTANT: Tier boundaries are INCLUSIVE.\n- If up_to is 1000, then quantity less than or equal to 1000 belongs to this tier\n- This behavior is consistent across both VOLUME and SLAB tier modes","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].tiers.items.[INDEX].up_to","typeLabel":"integer"}},"uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].tiers.items.[INDEX]","typeLabel":"object"},"uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].tiers","typeLabel":"object[]"},"transform_quantity":{"type":"object","properties":{"divide_by":{"type":"integer","description":"Divide quantity by this number","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].transform_quantity.divide_by","typeLabel":"integer"},"round":{"type":"string","enum":["up","down"],"x-enum-varnames":["ROUND_UP","ROUND_DOWN"],"x-speakeasy-name-override":"RoundType","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].transform_quantity.round","typeLabel":"enum\u003cstring>"}},"uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].transform_quantity","typeLabel":"object"},"trial_period_days":{"type":"integer","description":"TrialPeriodDays is the number of days for the trial period\nNote: This is only applicable for recurring prices (BILLING_CADENCE_RECURRING)","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].trial_period_days","typeLabel":"integer"},"type":{"type":"string","enum":["USAGE","FIXED"],"x-enum-varnames":["PRICE_TYPE_USAGE","PRICE_TYPE_FIXED"],"x-speakeasy-name-override":"PriceType","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"updated_at":{"type":"string","format":"date-time","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].updated_at","typeLabel":"string\u003cdate-time>"},"updated_by":{"type":"string","uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX].updated_by","typeLabel":"string"}},"uniqueKey":"entitlements.items.[INDEX].addon.prices.items.[INDEX]","typeLabel":"object"},"uniqueKey":"entitlements.items.[INDEX].addon.prices","typeLabel":"object[]"},"status":{"type":"string","enum":["published","deleted","archived"],"x-enum-varnames":["StatusPublished","StatusDeleted","StatusArchived"],"x-speakeasy-name-override":"Status","uniqueKey":"entitlements.items.[INDEX].addon.status","typeLabel":"enum\u003cstring>"},"tenant_id":{"type":"string","uniqueKey":"entitlements.items.[INDEX].addon.tenant_id","typeLabel":"string"},"updated_at":{"type":"string","format":"date-time","uniqueKey":"entitlements.items.[INDEX].addon.updated_at","typeLabel":"string\u003cdate-time>"},"updated_by":{"type":"string","uniqueKey":"entitlements.items.[INDEX].addon.updated_by","typeLabel":"string"}},"uniqueKey":"entitlements.items.[INDEX].addon","typeLabel":"object"},"aggregation_mode":{"type":"string","enum":["additive","parallel"],"x-enum-varnames":["EntitlementAggregationModeAdditive","EntitlementAggregationModeParallel"],"x-speakeasy-name-override":"EntitlementAggregationMode","uniqueKey":"entitlements.items.[INDEX].aggregation_mode","typeLabel":"enum\u003cstring>"},"config_value":{"type":"object","additionalProperties":true,"uniqueKey":"entitlements.items.[INDEX].config_value","typeLabel":"object"},"created_at":{"type":"string","format":"date-time","uniqueKey":"entitlements.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"created_by":{"type":"string","uniqueKey":"entitlements.items.[INDEX].created_by","typeLabel":"string"},"display_order":{"type":"integer","uniqueKey":"entitlements.items.[INDEX].display_order","typeLabel":"integer"},"end_date":{"type":"string","format":"date-time","uniqueKey":"entitlements.items.[INDEX].end_date","typeLabel":"string\u003cdate-time>"},"entity_id":{"type":"string","uniqueKey":"entitlements.items.[INDEX].entity_id","typeLabel":"string"},"entity_type":{"type":"string","enum":["PLAN","SUBSCRIPTION","ADDON"],"x-enum-varnames":["ENTITLEMENT_ENTITY_TYPE_PLAN","ENTITLEMENT_ENTITY_TYPE_SUBSCRIPTION","ENTITLEMENT_ENTITY_TYPE_ADDON"],"x-speakeasy-name-override":"EntitlementEntityType","uniqueKey":"entitlements.items.[INDEX].entity_type","typeLabel":"enum\u003cstring>"},"environment_id":{"type":"string","uniqueKey":"entitlements.items.[INDEX].environment_id","typeLabel":"string"},"feature":{"type":"object","properties":{"alert_settings":{"type":"object","properties":{"alert_enabled":{"type":"boolean","uniqueKey":"entitlements.items.[INDEX].feature.alert_settings.alert_enabled","typeLabel":"boolean"},"alert_threshold_type":{"type":"string","enum":["absolute","percentage"],"x-enum-varnames":["AlertThresholdTypeAbsolute","AlertThresholdTypePercentage"],"x-speakeasy-name-override":"AlertThresholdType","uniqueKey":"entitlements.items.[INDEX].feature.alert_settings.alert_threshold_type","typeLabel":"enum\u003cstring>"},"critical":{"type":"object","properties":{"condition":{"type":"string","enum":["above","below"],"x-enum-varnames":["AlertConditionAbove","AlertConditionBelow"],"x-speakeasy-name-override":"AlertCondition","uniqueKey":"entitlements.items.[INDEX].feature.alert_settings.critical.condition","typeLabel":"enum\u003cstring>"},"threshold":{"type":"string","uniqueKey":"entitlements.items.[INDEX].feature.alert_settings.critical.threshold","typeLabel":"string"}},"x-speakeasy-name-override":"AlertThreshold","uniqueKey":"entitlements.items.[INDEX].feature.alert_settings.critical","typeLabel":"object"},"info":{"type":"object","properties":{"condition":{"type":"string","enum":["above","below"],"x-enum-varnames":["AlertConditionAbove","AlertConditionBelow"],"x-speakeasy-name-override":"AlertCondition","uniqueKey":"entitlements.items.[INDEX].feature.alert_settings.info.condition","typeLabel":"enum\u003cstring>"},"threshold":{"type":"string","uniqueKey":"entitlements.items.[INDEX].feature.alert_settings.info.threshold","typeLabel":"string"}},"x-speakeasy-name-override":"AlertThreshold","uniqueKey":"entitlements.items.[INDEX].feature.alert_settings.info","typeLabel":"object"},"warning":{"type":"object","properties":{"condition":{"type":"string","enum":["above","below"],"x-enum-varnames":["AlertConditionAbove","AlertConditionBelow"],"x-speakeasy-name-override":"AlertCondition","uniqueKey":"entitlements.items.[INDEX].feature.alert_settings.warning.condition","typeLabel":"enum\u003cstring>"},"threshold":{"type":"string","uniqueKey":"entitlements.items.[INDEX].feature.alert_settings.warning.threshold","typeLabel":"string"}},"x-speakeasy-name-override":"AlertThreshold","uniqueKey":"entitlements.items.[INDEX].feature.alert_settings.warning","typeLabel":"object"}},"x-speakeasy-name-override":"AlertSettings","uniqueKey":"entitlements.items.[INDEX].feature.alert_settings","typeLabel":"object"},"created_at":{"type":"string","format":"date-time","uniqueKey":"entitlements.items.[INDEX].feature.created_at","typeLabel":"string\u003cdate-time>"},"created_by":{"type":"string","uniqueKey":"entitlements.items.[INDEX].feature.created_by","typeLabel":"string"},"description":{"type":"string","uniqueKey":"entitlements.items.[INDEX].feature.description","typeLabel":"string"},"environment_id":{"type":"string","uniqueKey":"entitlements.items.[INDEX].feature.environment_id","typeLabel":"string"},"group":{"type":"object","properties":{"created_at":{"type":"string","format":"date-time","uniqueKey":"entitlements.items.[INDEX].feature.group.created_at","typeLabel":"string\u003cdate-time>"},"entity_ids":{"type":"array","items":{"type":"string","uniqueKey":"entitlements.items.[INDEX].feature.group.entity_ids.items.[INDEX]","typeLabel":"string"},"uniqueKey":"entitlements.items.[INDEX].feature.group.entity_ids","typeLabel":"string[]"},"entity_type":{"type":"string","uniqueKey":"entitlements.items.[INDEX].feature.group.entity_type","typeLabel":"string"},"id":{"type":"string","uniqueKey":"entitlements.items.[INDEX].feature.group.id","typeLabel":"string"},"lookup_key":{"type":"string","uniqueKey":"entitlements.items.[INDEX].feature.group.lookup_key","typeLabel":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"entitlements.items.[INDEX].feature.group.metadata.additionalProperties","typeLabel":"string"},"uniqueKey":"entitlements.items.[INDEX].feature.group.metadata","typeLabel":"object"},"name":{"type":"string","uniqueKey":"entitlements.items.[INDEX].feature.group.name","typeLabel":"string"},"status":{"type":"string","uniqueKey":"entitlements.items.[INDEX].feature.group.status","typeLabel":"string"},"updated_at":{"type":"string","format":"date-time","uniqueKey":"entitlements.items.[INDEX].feature.group.updated_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"entitlements.items.[INDEX].feature.group","typeLabel":"object"},"group_id":{"type":"string","uniqueKey":"entitlements.items.[INDEX].feature.group_id","typeLabel":"string"},"id":{"type":"string","uniqueKey":"entitlements.items.[INDEX].feature.id","typeLabel":"string"},"lookup_key":{"type":"string","uniqueKey":"entitlements.items.[INDEX].feature.lookup_key","typeLabel":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"entitlements.items.[INDEX].feature.metadata.additionalProperties","typeLabel":"string"},"x-speakeasy-name-override":"Metadata","uniqueKey":"entitlements.items.[INDEX].feature.metadata","typeLabel":"object"},"meter":{"type":"object","properties":{"aggregation":{"type":"object","properties":{"bucket_size":{"type":"string","enum":["MINUTE","15MIN","30MIN","HOUR","3HOUR","6HOUR","12HOUR","DAY","WEEK","MONTH"],"x-enum-varnames":["WindowSizeMinute","WindowSize15Min","WindowSize30Min","WindowSizeHour","WindowSize3Hour","WindowSize6Hour","WindowSize12Hour","WindowSizeDay","WindowSizeWeek","WindowSizeMonth"],"x-speakeasy-name-override":"WindowSize","uniqueKey":"entitlements.items.[INDEX].feature.meter.aggregation.bucket_size","typeLabel":"enum\u003cstring>"},"expression":{"type":"string","description":"Expression is an optional CEL expression to compute per-event quantity from event.properties.\nWhen set, it replaces Field-based extraction. Property names are used directly (e.g., token * duration * pixel).","uniqueKey":"entitlements.items.[INDEX].feature.meter.aggregation.expression","typeLabel":"string"},"field":{"type":"string","description":"Field is the key in $event.properties on which the aggregation is to be applied\nFor ex if the aggregation type is sum for API usage, the field could be \"duration_ms\"\nIgnored when Expression is set.","uniqueKey":"entitlements.items.[INDEX].feature.meter.aggregation.field","typeLabel":"string"},"group_by":{"type":"string","description":"GroupBy is the property name in event.properties to group by before aggregating.\nRequires MAX aggregation. Windowing comes from the price, so this no longer\nimplies a meter-level bucket_size.\nWhen set, aggregation is applied per unique value of this property within each bucket,\nthen the per-group results are summed to produce the bucket total.","uniqueKey":"entitlements.items.[INDEX].feature.meter.aggregation.group_by","typeLabel":"string"},"multiplier":{"type":"string","description":"Multiplier is the multiplier for the aggregation\nFor ex if the aggregation type is sum_with_multiplier for API usage, the multiplier could be 1000\nto scale up by a factor of 1000. If not provided, it will be null.","uniqueKey":"entitlements.items.[INDEX].feature.meter.aggregation.multiplier","typeLabel":"string"},"type":{"type":"string","enum":["COUNT","SUM","AVG","COUNT_UNIQUE","LATEST","SUM_WITH_MULTIPLIER","MAX","WEIGHTED_SUM"],"x-enum-comments":{"AggregationSumWithMultiplier":"Sum with a multiplier - [sum(value) * multiplier]"},"x-enum-varnames":["AggregationCount","AggregationSum","AggregationAvg","AggregationCountUnique","AggregationLatest","AggregationSumWithMultiplier","AggregationMax","AggregationWeightedSum"],"x-speakeasy-name-override":"AggregationType","uniqueKey":"entitlements.items.[INDEX].feature.meter.aggregation.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"entitlements.items.[INDEX].feature.meter.aggregation","typeLabel":"object"},"created_at":{"type":"string","example":"2024-03-20T15:04:05Z","format":"date-time","uniqueKey":"entitlements.items.[INDEX].feature.meter.created_at","typeLabel":"string\u003cdate-time>"},"event_name":{"type":"string","example":"api_request","uniqueKey":"entitlements.items.[INDEX].feature.meter.event_name","typeLabel":"string"},"filters":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":"Key is the key for the filter from $event.properties\nCurrently we support only first level keys in the properties and not nested keys","uniqueKey":"entitlements.items.[INDEX].feature.meter.filters.items.[INDEX].key","typeLabel":"string"},"values":{"type":"array","description":"Values are the possible values for the filter to be considered for the meter\nFor ex \"model_name\" could have values \"o1-mini\", \"gpt-4o\" etc","items":{"type":"string","uniqueKey":"entitlements.items.[INDEX].feature.meter.filters.items.[INDEX].values.items.[INDEX]","typeLabel":"string"},"uniqueKey":"entitlements.items.[INDEX].feature.meter.filters.items.[INDEX].values","typeLabel":"string[]"}},"uniqueKey":"entitlements.items.[INDEX].feature.meter.filters.items.[INDEX]","typeLabel":"object"},"uniqueKey":"entitlements.items.[INDEX].feature.meter.filters","typeLabel":"object[]"},"id":{"type":"string","example":"550e8400-e29b-41d4-a716-446655440000","uniqueKey":"entitlements.items.[INDEX].feature.meter.id","typeLabel":"string"},"name":{"type":"string","example":"API Usage Meter","uniqueKey":"entitlements.items.[INDEX].feature.meter.name","typeLabel":"string"},"reset_usage":{"type":"string","enum":["BILLING_PERIOD","NEVER"],"x-enum-varnames":["ResetUsageBillingPeriod","ResetUsageNever"],"x-speakeasy-name-override":"ResetUsage","uniqueKey":"entitlements.items.[INDEX].feature.meter.reset_usage","typeLabel":"enum\u003cstring>"},"status":{"type":"string","example":"published","uniqueKey":"entitlements.items.[INDEX].feature.meter.status","typeLabel":"string"},"tenant_id":{"type":"string","example":"tenant123","uniqueKey":"entitlements.items.[INDEX].feature.meter.tenant_id","typeLabel":"string"},"updated_at":{"type":"string","example":"2024-03-20T15:04:05Z","format":"date-time","uniqueKey":"entitlements.items.[INDEX].feature.meter.updated_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"entitlements.items.[INDEX].feature.meter","typeLabel":"object"},"meter_id":{"type":"string","uniqueKey":"entitlements.items.[INDEX].feature.meter_id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"entitlements.items.[INDEX].feature.name","typeLabel":"string"},"reporting_unit":{"type":"object","properties":{"conversion_rate":{"type":"number","description":"Multiplier: reporting_unit_value = unit_value * conversion_rate; must be > 0","uniqueKey":"entitlements.items.[INDEX].feature.reporting_unit.conversion_rate","typeLabel":"number"},"unit_plural":{"type":"string","description":"Display unit label, plural (e.g. \"seconds\")","uniqueKey":"entitlements.items.[INDEX].feature.reporting_unit.unit_plural","typeLabel":"string"},"unit_singular":{"type":"string","description":"Display unit label, singular (e.g. \"second\")","uniqueKey":"entitlements.items.[INDEX].feature.reporting_unit.unit_singular","typeLabel":"string"}},"x-speakeasy-name-override":"ReportingUnit","uniqueKey":"entitlements.items.[INDEX].feature.reporting_unit","typeLabel":"object"},"status":{"type":"string","enum":["published","deleted","archived"],"x-enum-varnames":["StatusPublished","StatusDeleted","StatusArchived"],"x-speakeasy-name-override":"Status","uniqueKey":"entitlements.items.[INDEX].feature.status","typeLabel":"enum\u003cstring>"},"tenant_id":{"type":"string","uniqueKey":"entitlements.items.[INDEX].feature.tenant_id","typeLabel":"string"},"type":{"type":"string","enum":["metered","boolean","static","config"],"x-enum-varnames":["FeatureTypeMetered","FeatureTypeBoolean","FeatureTypeStatic","FeatureTypeConfig"],"x-speakeasy-name-override":"FeatureType","uniqueKey":"entitlements.items.[INDEX].feature.type","typeLabel":"enum\u003cstring>"},"unit_plural":{"type":"string","uniqueKey":"entitlements.items.[INDEX].feature.unit_plural","typeLabel":"string"},"unit_singular":{"type":"string","uniqueKey":"entitlements.items.[INDEX].feature.unit_singular","typeLabel":"string"},"updated_at":{"type":"string","format":"date-time","uniqueKey":"entitlements.items.[INDEX].feature.updated_at","typeLabel":"string\u003cdate-time>"},"updated_by":{"type":"string","uniqueKey":"entitlements.items.[INDEX].feature.updated_by","typeLabel":"string"}},"uniqueKey":"entitlements.items.[INDEX].feature","typeLabel":"object"},"feature_id":{"type":"string","uniqueKey":"entitlements.items.[INDEX].feature_id","typeLabel":"string"},"feature_type":{"type":"string","enum":["metered","boolean","static","config"],"x-enum-varnames":["FeatureTypeMetered","FeatureTypeBoolean","FeatureTypeStatic","FeatureTypeConfig"],"x-speakeasy-name-override":"FeatureType","uniqueKey":"entitlements.items.[INDEX].feature_type","typeLabel":"enum\u003cstring>"},"grant_allocation_behavior":{"type":"string","enum":["first_usage","unit_start"],"x-enum-varnames":["EntitlementGrantAllocationBehaviorFirstUsage","EntitlementGrantAllocationBehaviorUnitStart"],"x-speakeasy-name-override":"EntitlementGrantAllocationBehavior","uniqueKey":"entitlements.items.[INDEX].grant_allocation_behavior","typeLabel":"enum\u003cstring>"},"grant_duration_unit":{"type":"string","enum":["hour","day","week","subscription_period"],"x-enum-varnames":["EntitlementGrantDurationUnitHour","EntitlementGrantDurationUnitDay","EntitlementGrantDurationUnitWeek","EntitlementGrantDurationUnitSubscriptionPeriod"],"x-speakeasy-name-override":"EntitlementGrantDurationUnit","uniqueKey":"entitlements.items.[INDEX].grant_duration_unit","typeLabel":"enum\u003cstring>"},"grant_duration_value":{"type":"integer","uniqueKey":"entitlements.items.[INDEX].grant_duration_value","typeLabel":"integer"},"grant_measure":{"type":"string","enum":["quantity","amount"],"x-enum-varnames":["EntitlementGrantMeasureQuantity","EntitlementGrantMeasureAmount"],"x-speakeasy-name-override":"EntitlementGrantMeasure","uniqueKey":"entitlements.items.[INDEX].grant_measure","typeLabel":"enum\u003cstring>"},"grant_quota":{"type":"string","uniqueKey":"entitlements.items.[INDEX].grant_quota","typeLabel":"string"},"id":{"type":"string","uniqueKey":"entitlements.items.[INDEX].id","typeLabel":"string"},"is_enabled":{"type":"boolean","uniqueKey":"entitlements.items.[INDEX].is_enabled","typeLabel":"boolean"},"is_soft_limit":{"type":"boolean","uniqueKey":"entitlements.items.[INDEX].is_soft_limit","typeLabel":"boolean"},"parent_entitlement_id":{"type":"string","uniqueKey":"entitlements.items.[INDEX].parent_entitlement_id","typeLabel":"string"},"plan":{"type":"object","properties":{"created_at":{"type":"string","format":"date-time","uniqueKey":"entitlements.items.[INDEX].plan.created_at","typeLabel":"string\u003cdate-time>"},"created_by":{"type":"string","uniqueKey":"entitlements.items.[INDEX].plan.created_by","typeLabel":"string"},"credit_grants":{"type":"array","items":{"type":"object","properties":{"addon_id":{"type":"string","uniqueKey":"entitlements.items.[INDEX].plan.credit_grants.items.[INDEX].addon_id","typeLabel":"string"},"cadence":{"type":"string","enum":["ONETIME","RECURRING"],"x-enum-varnames":["CreditGrantCadenceOneTime","CreditGrantCadenceRecurring"],"x-speakeasy-name-override":"CreditGrantCadence","uniqueKey":"entitlements.items.[INDEX].plan.credit_grants.items.[INDEX].cadence","typeLabel":"enum\u003cstring>"},"conversion_rate":{"type":"string","description":"amount in the currency = number of credits * conversion_rate\nex if conversion_rate is 1, then 1 USD = 1 credit\nex if conversion_rate is 2, then 1 USD = 0.5 credits\nex if conversion_rate is 0.5, then 1 USD = 2 credits","uniqueKey":"entitlements.items.[INDEX].plan.credit_grants.items.[INDEX].conversion_rate","typeLabel":"string"},"created_at":{"type":"string","format":"date-time","uniqueKey":"entitlements.items.[INDEX].plan.credit_grants.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"created_by":{"type":"string","uniqueKey":"entitlements.items.[INDEX].plan.credit_grants.items.[INDEX].created_by","typeLabel":"string"},"credit_grant_anchor":{"type":"string","format":"date-time","uniqueKey":"entitlements.items.[INDEX].plan.credit_grants.items.[INDEX].credit_grant_anchor","typeLabel":"string\u003cdate-time>"},"credits":{"type":"string","uniqueKey":"entitlements.items.[INDEX].plan.credit_grants.items.[INDEX].credits","typeLabel":"string"},"end_date":{"type":"string","format":"date-time","uniqueKey":"entitlements.items.[INDEX].plan.credit_grants.items.[INDEX].end_date","typeLabel":"string\u003cdate-time>"},"environment_id":{"type":"string","uniqueKey":"entitlements.items.[INDEX].plan.credit_grants.items.[INDEX].environment_id","typeLabel":"string"},"expiration_duration":{"type":"integer","uniqueKey":"entitlements.items.[INDEX].plan.credit_grants.items.[INDEX].expiration_duration","typeLabel":"integer"},"expiration_duration_unit":{"type":"string","enum":["DAY","WEEK","MONTH","YEAR"],"x-enum-varnames":["CreditGrantExpiryDurationUnitDays","CreditGrantExpiryDurationUnitWeeks","CreditGrantExpiryDurationUnitMonths","CreditGrantExpiryDurationUnitYears"],"x-speakeasy-name-override":"CreditGrantExpiryDurationUnit","uniqueKey":"entitlements.items.[INDEX].plan.credit_grants.items.[INDEX].expiration_duration_unit","typeLabel":"enum\u003cstring>"},"expiration_type":{"type":"string","enum":["NEVER","DURATION","BILLING_CYCLE"],"x-enum-varnames":["CreditGrantExpiryTypeNever","CreditGrantExpiryTypeDuration","CreditGrantExpiryTypeBillingCycle"],"x-speakeasy-name-override":"CreditGrantExpiryType","uniqueKey":"entitlements.items.[INDEX].plan.credit_grants.items.[INDEX].expiration_type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","uniqueKey":"entitlements.items.[INDEX].plan.credit_grants.items.[INDEX].id","typeLabel":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"entitlements.items.[INDEX].plan.credit_grants.items.[INDEX].metadata.additionalProperties","typeLabel":"string"},"x-speakeasy-name-override":"Metadata","uniqueKey":"entitlements.items.[INDEX].plan.credit_grants.items.[INDEX].metadata","typeLabel":"object"},"name":{"type":"string","uniqueKey":"entitlements.items.[INDEX].plan.credit_grants.items.[INDEX].name","typeLabel":"string"},"period":{"type":"string","enum":["DAILY","WEEKLY","MONTHLY","ANNUAL","QUARTERLY","HALF_YEARLY"],"x-enum-varnames":["CREDIT_GRANT_PERIOD_DAILY","CREDIT_GRANT_PERIOD_WEEKLY","CREDIT_GRANT_PERIOD_MONTHLY","CREDIT_GRANT_PERIOD_ANNUAL","CREDIT_GRANT_PERIOD_QUARTER","CREDIT_GRANT_PERIOD_HALF_YEARLY"],"x-speakeasy-name-override":"CreditGrantPeriod","uniqueKey":"entitlements.items.[INDEX].plan.credit_grants.items.[INDEX].period","typeLabel":"enum\u003cstring>"},"period_count":{"type":"integer","uniqueKey":"entitlements.items.[INDEX].plan.credit_grants.items.[INDEX].period_count","typeLabel":"integer"},"plan_id":{"type":"string","uniqueKey":"entitlements.items.[INDEX].plan.credit_grants.items.[INDEX].plan_id","typeLabel":"string"},"priority":{"type":"integer","uniqueKey":"entitlements.items.[INDEX].plan.credit_grants.items.[INDEX].priority","typeLabel":"integer"},"scope":{"type":"string","enum":["PLAN","SUBSCRIPTION","ADDON"],"x-enum-varnames":["CreditGrantScopePlan","CreditGrantScopeSubscription","CreditGrantScopeAddon"],"x-speakeasy-name-override":"CreditGrantScope","uniqueKey":"entitlements.items.[INDEX].plan.credit_grants.items.[INDEX].scope","typeLabel":"enum\u003cstring>"},"start_date":{"type":"string","format":"date-time","uniqueKey":"entitlements.items.[INDEX].plan.credit_grants.items.[INDEX].start_date","typeLabel":"string\u003cdate-time>"},"status":{"type":"string","enum":["published","deleted","archived"],"x-enum-varnames":["StatusPublished","StatusDeleted","StatusArchived"],"x-speakeasy-name-override":"Status","uniqueKey":"entitlements.items.[INDEX].plan.credit_grants.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"subscription_id":{"type":"string","uniqueKey":"entitlements.items.[INDEX].plan.credit_grants.items.[INDEX].subscription_id","typeLabel":"string"},"tenant_id":{"type":"string","uniqueKey":"entitlements.items.[INDEX].plan.credit_grants.items.[INDEX].tenant_id","typeLabel":"string"},"topup_conversion_rate":{"type":"string","description":"topup_conversion_rate is the conversion rate for the topup to the currency\nex if topup_conversion_rate is 1, then 1 USD = 1 credit\nex if topup_conversion_rate is 2, then 1 USD = 0.5 credits\nex if topup_conversion_rate is 0.5, then 1 USD = 2 credits","uniqueKey":"entitlements.items.[INDEX].plan.credit_grants.items.[INDEX].topup_conversion_rate","typeLabel":"string"},"updated_at":{"type":"string","format":"date-time","uniqueKey":"entitlements.items.[INDEX].plan.credit_grants.items.[INDEX].updated_at","typeLabel":"string\u003cdate-time>"},"updated_by":{"type":"string","uniqueKey":"entitlements.items.[INDEX].plan.credit_grants.items.[INDEX].updated_by","typeLabel":"string"}},"uniqueKey":"entitlements.items.[INDEX].plan.credit_grants.items.[INDEX]","typeLabel":"object"},"uniqueKey":"entitlements.items.[INDEX].plan.credit_grants","typeLabel":"object[]"},"description":{"type":"string","uniqueKey":"entitlements.items.[INDEX].plan.description","typeLabel":"string"},"display_order":{"type":"integer","uniqueKey":"entitlements.items.[INDEX].plan.display_order","typeLabel":"integer"},"entitlements":{"type":"array","items":{"$circularRef":"1c99a94f-ba2d-4aeb-aec5-928f5daeddec"},"uniqueKey":"entitlements.items.[INDEX].plan.entitlements","typeLabel":"array"},"environment_id":{"type":"string","uniqueKey":"entitlements.items.[INDEX].plan.environment_id","typeLabel":"string"},"id":{"type":"string","uniqueKey":"entitlements.items.[INDEX].plan.id","typeLabel":"string"},"lookup_key":{"type":"string","uniqueKey":"entitlements.items.[INDEX].plan.lookup_key","typeLabel":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"entitlements.items.[INDEX].plan.metadata.additionalProperties","typeLabel":"string"},"x-speakeasy-name-override":"Metadata","uniqueKey":"entitlements.items.[INDEX].plan.metadata","typeLabel":"object"},"name":{"type":"string","uniqueKey":"entitlements.items.[INDEX].plan.name","typeLabel":"string"},"price_sync_status":{"type":"object","properties":{"current_sequence":{"type":"integer","uniqueKey":"entitlements.items.[INDEX].plan.price_sync_status.current_sequence","typeLabel":"integer"},"synced":{"type":"boolean","uniqueKey":"entitlements.items.[INDEX].plan.price_sync_status.synced","typeLabel":"boolean"},"unsynced_subscription_count":{"type":"integer","uniqueKey":"entitlements.items.[INDEX].plan.price_sync_status.unsynced_subscription_count","typeLabel":"integer"}},"uniqueKey":"entitlements.items.[INDEX].plan.price_sync_status","typeLabel":"object"},"prices":{"type":"array","description":"TODO: Add inline addons","items":{"$circularRef":"0dc125d7-6bd8-40a5-8d18-2c0190dcf082"},"uniqueKey":"entitlements.items.[INDEX].plan.prices","typeLabel":"array"},"status":{"type":"string","enum":["published","deleted","archived"],"x-enum-varnames":["StatusPublished","StatusDeleted","StatusArchived"],"x-speakeasy-name-override":"Status","uniqueKey":"entitlements.items.[INDEX].plan.status","typeLabel":"enum\u003cstring>"},"tenant_id":{"type":"string","uniqueKey":"entitlements.items.[INDEX].plan.tenant_id","typeLabel":"string"},"updated_at":{"type":"string","format":"date-time","uniqueKey":"entitlements.items.[INDEX].plan.updated_at","typeLabel":"string\u003cdate-time>"},"updated_by":{"type":"string","uniqueKey":"entitlements.items.[INDEX].plan.updated_by","typeLabel":"string"}},"uniqueKey":"entitlements.items.[INDEX].plan","typeLabel":"object"},"plan_id":{"type":"string","description":"TODO: Remove this once we have a proper entitlement entity type","uniqueKey":"entitlements.items.[INDEX].plan_id","typeLabel":"string"},"start_date":{"type":"string","format":"date-time","uniqueKey":"entitlements.items.[INDEX].start_date","typeLabel":"string\u003cdate-time>"},"static_value":{"type":"string","uniqueKey":"entitlements.items.[INDEX].static_value","typeLabel":"string"},"status":{"type":"string","enum":["published","deleted","archived"],"x-enum-varnames":["StatusPublished","StatusDeleted","StatusArchived"],"x-speakeasy-name-override":"Status","uniqueKey":"entitlements.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"tenant_id":{"type":"string","uniqueKey":"entitlements.items.[INDEX].tenant_id","typeLabel":"string"},"updated_at":{"type":"string","format":"date-time","uniqueKey":"entitlements.items.[INDEX].updated_at","typeLabel":"string\u003cdate-time>"},"updated_by":{"type":"string","uniqueKey":"entitlements.items.[INDEX].updated_by","typeLabel":"string"},"usage_limit":{"type":"integer","uniqueKey":"entitlements.items.[INDEX].usage_limit","typeLabel":"integer"},"usage_reset_period":{"type":"string","enum":["MONTHLY","ANNUAL","WEEKLY","DAILY","QUARTERLY","HALF_YEARLY","NEVER"],"x-enum-varnames":["ENTITLEMENT_USAGE_RESET_PERIOD_MONTHLY","ENTITLEMENT_USAGE_RESET_PERIOD_ANNUAL","ENTITLEMENT_USAGE_RESET_PERIOD_WEEKLY","ENTITLEMENT_USAGE_RESET_PERIOD_DAILY","ENTITLEMENT_USAGE_RESET_PERIOD_QUARTER","ENTITLEMENT_USAGE_RESET_PERIOD_HALF_YEAR","ENTITLEMENT_USAGE_RESET_PERIOD_NEVER"],"x-speakeasy-name-override":"EntitlementUsageResetPeriod","uniqueKey":"entitlements.items.[INDEX].usage_reset_period","typeLabel":"enum\u003cstring>"}},"uniqueKey":"entitlements.items.[INDEX]","typeLabel":"object"},"uniqueKey":"entitlements","typeLabel":"object[]"},"environment_id":{"type":"string","uniqueKey":"environment_id","typeLabel":"string"},"id":{"type":"string","uniqueKey":"id","typeLabel":"string"},"lookup_key":{"type":"string","uniqueKey":"lookup_key","typeLabel":"string"},"metadata":{"type":"object","additionalProperties":true,"uniqueKey":"metadata","typeLabel":"object"},"name":{"type":"string","uniqueKey":"name","typeLabel":"string"},"price_sync_status":{"type":"object","properties":{"current_sequence":{"type":"integer","uniqueKey":"price_sync_status.current_sequence","typeLabel":"integer"},"synced":{"type":"boolean","uniqueKey":"price_sync_status.synced","typeLabel":"boolean"},"unsynced_association_count":{"type":"integer","uniqueKey":"price_sync_status.unsynced_association_count","typeLabel":"integer"}},"uniqueKey":"price_sync_status","typeLabel":"object"},"prices":{"type":"array","description":"Optional expanded fields","items":{"type":"object","properties":{"addon":{"oneOf":[{"$circularRef":"6c04a6f7-e9a8-4aa6-bb72-c876420f4348"}],"uniqueKey":"prices.items.[INDEX].addon","typeLabel":"any"},"amount":{"type":"string","description":"Amount stored in main currency units (e.g., dollars, not cents)\nFor USD: 12.50 means $12.50","uniqueKey":"prices.items.[INDEX].amount","typeLabel":"string"},"billing_cadence":{"type":"string","enum":["RECURRING"],"x-enum-varnames":["BILLING_CADENCE_RECURRING"],"x-speakeasy-name-override":"BillingCadence","uniqueKey":"prices.items.[INDEX].billing_cadence","typeLabel":"enum\u003cstring>"},"billing_model":{"type":"string","enum":["FLAT_FEE","PACKAGE","TIERED"],"x-enum-varnames":["BILLING_MODEL_FLAT_FEE","BILLING_MODEL_PACKAGE","BILLING_MODEL_TIERED"],"x-speakeasy-name-override":"BillingModel","uniqueKey":"prices.items.[INDEX].billing_model","typeLabel":"enum\u003cstring>"},"billing_period":{"type":"string","enum":["MONTHLY","ANNUAL","WEEKLY","DAILY","QUARTERLY","HALF_YEARLY","ONETIME"],"x-enum-varnames":["BILLING_PERIOD_MONTHLY","BILLING_PERIOD_ANNUAL","BILLING_PERIOD_WEEKLY","BILLING_PERIOD_DAILY","BILLING_PERIOD_QUARTER","BILLING_PERIOD_HALF_YEAR","BILLING_PERIOD_ONETIME"],"x-speakeasy-name-override":"BillingPeriod","uniqueKey":"prices.items.[INDEX].billing_period","typeLabel":"enum\u003cstring>"},"billing_period_count":{"type":"integer","description":"BillingPeriodCount is the count of the billing period ex 1, 3, 6, 12","uniqueKey":"prices.items.[INDEX].billing_period_count","typeLabel":"integer"},"bucket_size":{"type":"string","enum":["MINUTE","15MIN","30MIN","HOUR","3HOUR","6HOUR","12HOUR","DAY","WEEK","MONTH"],"x-enum-varnames":["WindowSizeMinute","WindowSize15Min","WindowSize30Min","WindowSizeHour","WindowSize3Hour","WindowSize6Hour","WindowSize12Hour","WindowSizeDay","WindowSizeWeek","WindowSizeMonth"],"x-speakeasy-name-override":"WindowSize","uniqueKey":"prices.items.[INDEX].bucket_size","typeLabel":"enum\u003cstring>"},"conversion_rate":{"type":"string","description":"ConversionRate is the conversion rate of the price unit to the fiat currency","uniqueKey":"prices.items.[INDEX].conversion_rate","typeLabel":"string"},"created_at":{"type":"string","format":"date-time","uniqueKey":"prices.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"created_by":{"type":"string","uniqueKey":"prices.items.[INDEX].created_by","typeLabel":"string"},"currency":{"type":"string","description":"Currency 3 digit ISO currency code in lowercase ex usd, eur, gbp","uniqueKey":"prices.items.[INDEX].currency","typeLabel":"string"},"description":{"type":"string","description":"Description of the price","uniqueKey":"prices.items.[INDEX].description","typeLabel":"string"},"display_amount":{"type":"string","description":"DisplayAmount is the formatted amount with currency symbol\nFor USD: $12.50","uniqueKey":"prices.items.[INDEX].display_amount","typeLabel":"string"},"display_name":{"type":"string","description":"DisplayName is the name of the price","uniqueKey":"prices.items.[INDEX].display_name","typeLabel":"string"},"display_price_unit_amount":{"type":"string","description":"DisplayPriceUnitAmount is the formatted amount of the price unit","uniqueKey":"prices.items.[INDEX].display_price_unit_amount","typeLabel":"string"},"end_date":{"type":"string","description":"EndDate is the end date of the price","format":"date-time","uniqueKey":"prices.items.[INDEX].end_date","typeLabel":"string\u003cdate-time>"},"entity_id":{"type":"string","description":"EntityID holds the value of the \"entity_id\" field.","uniqueKey":"prices.items.[INDEX].entity_id","typeLabel":"string"},"entity_type":{"type":"string","enum":["PLAN","SUBSCRIPTION","ADDON","PRICE","COSTSHEET"],"x-enum-varnames":["PRICE_ENTITY_TYPE_PLAN","PRICE_ENTITY_TYPE_SUBSCRIPTION","PRICE_ENTITY_TYPE_ADDON","PRICE_ENTITY_TYPE_PRICE","PRICE_ENTITY_TYPE_COSTSHEET"],"x-speakeasy-name-override":"PriceEntityType","uniqueKey":"prices.items.[INDEX].entity_type","typeLabel":"enum\u003cstring>"},"environment_id":{"type":"string","description":"EnvironmentID is the environment identifier for the price","uniqueKey":"prices.items.[INDEX].environment_id","typeLabel":"string"},"feature":{"type":"object","properties":{"reporting_unit":{"type":"object","properties":{"conversion_rate":{"type":"number","description":"Multiplier: reporting_unit_value = unit_value * conversion_rate; must be > 0","uniqueKey":"prices.items.[INDEX].feature.reporting_unit.conversion_rate","typeLabel":"number"},"unit_plural":{"type":"string","description":"Display unit label, plural (e.g. \"seconds\")","uniqueKey":"prices.items.[INDEX].feature.reporting_unit.unit_plural","typeLabel":"string"},"unit_singular":{"type":"string","description":"Display unit label, singular (e.g. \"second\")","uniqueKey":"prices.items.[INDEX].feature.reporting_unit.unit_singular","typeLabel":"string"}},"x-speakeasy-name-override":"ReportingUnit","uniqueKey":"prices.items.[INDEX].feature.reporting_unit","typeLabel":"object"}},"uniqueKey":"prices.items.[INDEX].feature","typeLabel":"object"},"group":{"type":"object","properties":{"created_at":{"type":"string","format":"date-time","uniqueKey":"prices.items.[INDEX].group.created_at","typeLabel":"string\u003cdate-time>"},"entity_ids":{"type":"array","items":{"type":"string","uniqueKey":"prices.items.[INDEX].group.entity_ids.items.[INDEX]","typeLabel":"string"},"uniqueKey":"prices.items.[INDEX].group.entity_ids","typeLabel":"string[]"},"entity_type":{"type":"string","uniqueKey":"prices.items.[INDEX].group.entity_type","typeLabel":"string"},"id":{"type":"string","uniqueKey":"prices.items.[INDEX].group.id","typeLabel":"string"},"lookup_key":{"type":"string","uniqueKey":"prices.items.[INDEX].group.lookup_key","typeLabel":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"prices.items.[INDEX].group.metadata.additionalProperties","typeLabel":"string"},"uniqueKey":"prices.items.[INDEX].group.metadata","typeLabel":"object"},"name":{"type":"string","uniqueKey":"prices.items.[INDEX].group.name","typeLabel":"string"},"status":{"type":"string","uniqueKey":"prices.items.[INDEX].group.status","typeLabel":"string"},"updated_at":{"type":"string","format":"date-time","uniqueKey":"prices.items.[INDEX].group.updated_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"prices.items.[INDEX].group","typeLabel":"object"},"group_id":{"type":"string","description":"GroupID references the group this price belongs to","uniqueKey":"prices.items.[INDEX].group_id","typeLabel":"string"},"id":{"type":"string","description":"ID uuid identifier for the price","uniqueKey":"prices.items.[INDEX].id","typeLabel":"string"},"invoice_cadence":{"type":"string","enum":["ARREAR","ADVANCE"],"x-enum-varnames":["InvoiceCadenceArrear","InvoiceCadenceAdvance"],"x-speakeasy-name-override":"InvoiceCadence","uniqueKey":"prices.items.[INDEX].invoice_cadence","typeLabel":"enum\u003cstring>"},"lookup_key":{"type":"string","description":"LookupKey used for looking up the price in the database","uniqueKey":"prices.items.[INDEX].lookup_key","typeLabel":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"prices.items.[INDEX].metadata.additionalProperties","typeLabel":"string"},"uniqueKey":"prices.items.[INDEX].metadata","typeLabel":"object"},"meter":{"type":"object","properties":{"aggregation":{"type":"object","properties":{"bucket_size":{"type":"string","enum":["MINUTE","15MIN","30MIN","HOUR","3HOUR","6HOUR","12HOUR","DAY","WEEK","MONTH"],"x-enum-varnames":["WindowSizeMinute","WindowSize15Min","WindowSize30Min","WindowSizeHour","WindowSize3Hour","WindowSize6Hour","WindowSize12Hour","WindowSizeDay","WindowSizeWeek","WindowSizeMonth"],"x-speakeasy-name-override":"WindowSize","uniqueKey":"prices.items.[INDEX].meter.aggregation.bucket_size","typeLabel":"enum\u003cstring>"},"expression":{"type":"string","description":"Expression is an optional CEL expression to compute per-event quantity from event.properties.\nWhen set, it replaces Field-based extraction. Property names are used directly (e.g., token * duration * pixel).","uniqueKey":"prices.items.[INDEX].meter.aggregation.expression","typeLabel":"string"},"field":{"type":"string","description":"Field is the key in $event.properties on which the aggregation is to be applied\nFor ex if the aggregation type is sum for API usage, the field could be \"duration_ms\"\nIgnored when Expression is set.","uniqueKey":"prices.items.[INDEX].meter.aggregation.field","typeLabel":"string"},"group_by":{"type":"string","description":"GroupBy is the property name in event.properties to group by before aggregating.\nRequires MAX aggregation. Windowing comes from the price, so this no longer\nimplies a meter-level bucket_size.\nWhen set, aggregation is applied per unique value of this property within each bucket,\nthen the per-group results are summed to produce the bucket total.","uniqueKey":"prices.items.[INDEX].meter.aggregation.group_by","typeLabel":"string"},"multiplier":{"type":"string","description":"Multiplier is the multiplier for the aggregation\nFor ex if the aggregation type is sum_with_multiplier for API usage, the multiplier could be 1000\nto scale up by a factor of 1000. If not provided, it will be null.","uniqueKey":"prices.items.[INDEX].meter.aggregation.multiplier","typeLabel":"string"},"type":{"type":"string","enum":["COUNT","SUM","AVG","COUNT_UNIQUE","LATEST","SUM_WITH_MULTIPLIER","MAX","WEIGHTED_SUM"],"x-enum-comments":{"AggregationSumWithMultiplier":"Sum with a multiplier - [sum(value) * multiplier]"},"x-enum-varnames":["AggregationCount","AggregationSum","AggregationAvg","AggregationCountUnique","AggregationLatest","AggregationSumWithMultiplier","AggregationMax","AggregationWeightedSum"],"x-speakeasy-name-override":"AggregationType","uniqueKey":"prices.items.[INDEX].meter.aggregation.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"prices.items.[INDEX].meter.aggregation","typeLabel":"object"},"created_at":{"type":"string","example":"2024-03-20T15:04:05Z","format":"date-time","uniqueKey":"prices.items.[INDEX].meter.created_at","typeLabel":"string\u003cdate-time>"},"event_name":{"type":"string","example":"api_request","uniqueKey":"prices.items.[INDEX].meter.event_name","typeLabel":"string"},"filters":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":"Key is the key for the filter from $event.properties\nCurrently we support only first level keys in the properties and not nested keys","uniqueKey":"prices.items.[INDEX].meter.filters.items.[INDEX].key","typeLabel":"string"},"values":{"type":"array","description":"Values are the possible values for the filter to be considered for the meter\nFor ex \"model_name\" could have values \"o1-mini\", \"gpt-4o\" etc","items":{"type":"string","uniqueKey":"prices.items.[INDEX].meter.filters.items.[INDEX].values.items.[INDEX]","typeLabel":"string"},"uniqueKey":"prices.items.[INDEX].meter.filters.items.[INDEX].values","typeLabel":"string[]"}},"uniqueKey":"prices.items.[INDEX].meter.filters.items.[INDEX]","typeLabel":"object"},"uniqueKey":"prices.items.[INDEX].meter.filters","typeLabel":"object[]"},"id":{"type":"string","example":"550e8400-e29b-41d4-a716-446655440000","uniqueKey":"prices.items.[INDEX].meter.id","typeLabel":"string"},"name":{"type":"string","example":"API Usage Meter","uniqueKey":"prices.items.[INDEX].meter.name","typeLabel":"string"},"reset_usage":{"type":"string","enum":["BILLING_PERIOD","NEVER"],"x-enum-varnames":["ResetUsageBillingPeriod","ResetUsageNever"],"x-speakeasy-name-override":"ResetUsage","uniqueKey":"prices.items.[INDEX].meter.reset_usage","typeLabel":"enum\u003cstring>"},"status":{"type":"string","example":"published","uniqueKey":"prices.items.[INDEX].meter.status","typeLabel":"string"},"tenant_id":{"type":"string","example":"tenant123","uniqueKey":"prices.items.[INDEX].meter.tenant_id","typeLabel":"string"},"updated_at":{"type":"string","example":"2024-03-20T15:04:05Z","format":"date-time","uniqueKey":"prices.items.[INDEX].meter.updated_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"prices.items.[INDEX].meter","typeLabel":"object"},"meter_id":{"type":"string","description":"MeterID is the id of the meter for usage based pricing","uniqueKey":"prices.items.[INDEX].meter_id","typeLabel":"string"},"min_quantity":{"oneOf":[{"type":"string","description":"MinQuantity is the minimum quantity of the price","uniqueKey":"prices.items.[INDEX].min_quantity.oneOf.0","typeLabel":"string"},{"type":"null","description":"MinQuantity is the minimum quantity of the price","uniqueKey":"prices.items.[INDEX].min_quantity.oneOf.1","typeLabel":"null"}],"uniqueKey":"prices.items.[INDEX].min_quantity","typeLabel":"string | null"},"parent_price_id":{"type":"string","description":"ParentPriceID references the root price (always set for price lineage tracking)","uniqueKey":"prices.items.[INDEX].parent_price_id","typeLabel":"string"},"plan":{"type":"object","properties":{"created_at":{"type":"string","format":"date-time","uniqueKey":"prices.items.[INDEX].plan.created_at","typeLabel":"string\u003cdate-time>"},"created_by":{"type":"string","uniqueKey":"prices.items.[INDEX].plan.created_by","typeLabel":"string"},"credit_grants":{"type":"array","items":{"type":"object","properties":{"addon_id":{"type":"string","uniqueKey":"prices.items.[INDEX].plan.credit_grants.items.[INDEX].addon_id","typeLabel":"string"},"cadence":{"type":"string","enum":["ONETIME","RECURRING"],"x-enum-varnames":["CreditGrantCadenceOneTime","CreditGrantCadenceRecurring"],"x-speakeasy-name-override":"CreditGrantCadence","uniqueKey":"prices.items.[INDEX].plan.credit_grants.items.[INDEX].cadence","typeLabel":"enum\u003cstring>"},"conversion_rate":{"type":"string","description":"amount in the currency = number of credits * conversion_rate\nex if conversion_rate is 1, then 1 USD = 1 credit\nex if conversion_rate is 2, then 1 USD = 0.5 credits\nex if conversion_rate is 0.5, then 1 USD = 2 credits","uniqueKey":"prices.items.[INDEX].plan.credit_grants.items.[INDEX].conversion_rate","typeLabel":"string"},"created_at":{"type":"string","format":"date-time","uniqueKey":"prices.items.[INDEX].plan.credit_grants.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"created_by":{"type":"string","uniqueKey":"prices.items.[INDEX].plan.credit_grants.items.[INDEX].created_by","typeLabel":"string"},"credit_grant_anchor":{"type":"string","format":"date-time","uniqueKey":"prices.items.[INDEX].plan.credit_grants.items.[INDEX].credit_grant_anchor","typeLabel":"string\u003cdate-time>"},"credits":{"type":"string","uniqueKey":"prices.items.[INDEX].plan.credit_grants.items.[INDEX].credits","typeLabel":"string"},"end_date":{"type":"string","format":"date-time","uniqueKey":"prices.items.[INDEX].plan.credit_grants.items.[INDEX].end_date","typeLabel":"string\u003cdate-time>"},"environment_id":{"type":"string","uniqueKey":"prices.items.[INDEX].plan.credit_grants.items.[INDEX].environment_id","typeLabel":"string"},"expiration_duration":{"type":"integer","uniqueKey":"prices.items.[INDEX].plan.credit_grants.items.[INDEX].expiration_duration","typeLabel":"integer"},"expiration_duration_unit":{"type":"string","enum":["DAY","WEEK","MONTH","YEAR"],"x-enum-varnames":["CreditGrantExpiryDurationUnitDays","CreditGrantExpiryDurationUnitWeeks","CreditGrantExpiryDurationUnitMonths","CreditGrantExpiryDurationUnitYears"],"x-speakeasy-name-override":"CreditGrantExpiryDurationUnit","uniqueKey":"prices.items.[INDEX].plan.credit_grants.items.[INDEX].expiration_duration_unit","typeLabel":"enum\u003cstring>"},"expiration_type":{"type":"string","enum":["NEVER","DURATION","BILLING_CYCLE"],"x-enum-varnames":["CreditGrantExpiryTypeNever","CreditGrantExpiryTypeDuration","CreditGrantExpiryTypeBillingCycle"],"x-speakeasy-name-override":"CreditGrantExpiryType","uniqueKey":"prices.items.[INDEX].plan.credit_grants.items.[INDEX].expiration_type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","uniqueKey":"prices.items.[INDEX].plan.credit_grants.items.[INDEX].id","typeLabel":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"prices.items.[INDEX].plan.credit_grants.items.[INDEX].metadata.additionalProperties","typeLabel":"string"},"x-speakeasy-name-override":"Metadata","uniqueKey":"prices.items.[INDEX].plan.credit_grants.items.[INDEX].metadata","typeLabel":"object"},"name":{"type":"string","uniqueKey":"prices.items.[INDEX].plan.credit_grants.items.[INDEX].name","typeLabel":"string"},"period":{"type":"string","enum":["DAILY","WEEKLY","MONTHLY","ANNUAL","QUARTERLY","HALF_YEARLY"],"x-enum-varnames":["CREDIT_GRANT_PERIOD_DAILY","CREDIT_GRANT_PERIOD_WEEKLY","CREDIT_GRANT_PERIOD_MONTHLY","CREDIT_GRANT_PERIOD_ANNUAL","CREDIT_GRANT_PERIOD_QUARTER","CREDIT_GRANT_PERIOD_HALF_YEARLY"],"x-speakeasy-name-override":"CreditGrantPeriod","uniqueKey":"prices.items.[INDEX].plan.credit_grants.items.[INDEX].period","typeLabel":"enum\u003cstring>"},"period_count":{"type":"integer","uniqueKey":"prices.items.[INDEX].plan.credit_grants.items.[INDEX].period_count","typeLabel":"integer"},"plan_id":{"type":"string","uniqueKey":"prices.items.[INDEX].plan.credit_grants.items.[INDEX].plan_id","typeLabel":"string"},"priority":{"type":"integer","uniqueKey":"prices.items.[INDEX].plan.credit_grants.items.[INDEX].priority","typeLabel":"integer"},"scope":{"type":"string","enum":["PLAN","SUBSCRIPTION","ADDON"],"x-enum-varnames":["CreditGrantScopePlan","CreditGrantScopeSubscription","CreditGrantScopeAddon"],"x-speakeasy-name-override":"CreditGrantScope","uniqueKey":"prices.items.[INDEX].plan.credit_grants.items.[INDEX].scope","typeLabel":"enum\u003cstring>"},"start_date":{"type":"string","format":"date-time","uniqueKey":"prices.items.[INDEX].plan.credit_grants.items.[INDEX].start_date","typeLabel":"string\u003cdate-time>"},"status":{"type":"string","enum":["published","deleted","archived"],"x-enum-varnames":["StatusPublished","StatusDeleted","StatusArchived"],"x-speakeasy-name-override":"Status","uniqueKey":"prices.items.[INDEX].plan.credit_grants.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"subscription_id":{"type":"string","uniqueKey":"prices.items.[INDEX].plan.credit_grants.items.[INDEX].subscription_id","typeLabel":"string"},"tenant_id":{"type":"string","uniqueKey":"prices.items.[INDEX].plan.credit_grants.items.[INDEX].tenant_id","typeLabel":"string"},"topup_conversion_rate":{"type":"string","description":"topup_conversion_rate is the conversion rate for the topup to the currency\nex if topup_conversion_rate is 1, then 1 USD = 1 credit\nex if topup_conversion_rate is 2, then 1 USD = 0.5 credits\nex if topup_conversion_rate is 0.5, then 1 USD = 2 credits","uniqueKey":"prices.items.[INDEX].plan.credit_grants.items.[INDEX].topup_conversion_rate","typeLabel":"string"},"updated_at":{"type":"string","format":"date-time","uniqueKey":"prices.items.[INDEX].plan.credit_grants.items.[INDEX].updated_at","typeLabel":"string\u003cdate-time>"},"updated_by":{"type":"string","uniqueKey":"prices.items.[INDEX].plan.credit_grants.items.[INDEX].updated_by","typeLabel":"string"}},"uniqueKey":"prices.items.[INDEX].plan.credit_grants.items.[INDEX]","typeLabel":"object"},"uniqueKey":"prices.items.[INDEX].plan.credit_grants","typeLabel":"object[]"},"description":{"type":"string","uniqueKey":"prices.items.[INDEX].plan.description","typeLabel":"string"},"display_order":{"type":"integer","uniqueKey":"prices.items.[INDEX].plan.display_order","typeLabel":"integer"},"entitlements":{"type":"array","items":{"$circularRef":"1c99a94f-ba2d-4aeb-aec5-928f5daeddec"},"uniqueKey":"prices.items.[INDEX].plan.entitlements","typeLabel":"array"},"environment_id":{"type":"string","uniqueKey":"prices.items.[INDEX].plan.environment_id","typeLabel":"string"},"id":{"type":"string","uniqueKey":"prices.items.[INDEX].plan.id","typeLabel":"string"},"lookup_key":{"type":"string","uniqueKey":"prices.items.[INDEX].plan.lookup_key","typeLabel":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"prices.items.[INDEX].plan.metadata.additionalProperties","typeLabel":"string"},"x-speakeasy-name-override":"Metadata","uniqueKey":"prices.items.[INDEX].plan.metadata","typeLabel":"object"},"name":{"type":"string","uniqueKey":"prices.items.[INDEX].plan.name","typeLabel":"string"},"price_sync_status":{"type":"object","properties":{"current_sequence":{"type":"integer","uniqueKey":"prices.items.[INDEX].plan.price_sync_status.current_sequence","typeLabel":"integer"},"synced":{"type":"boolean","uniqueKey":"prices.items.[INDEX].plan.price_sync_status.synced","typeLabel":"boolean"},"unsynced_subscription_count":{"type":"integer","uniqueKey":"prices.items.[INDEX].plan.price_sync_status.unsynced_subscription_count","typeLabel":"integer"}},"uniqueKey":"prices.items.[INDEX].plan.price_sync_status","typeLabel":"object"},"prices":{"type":"array","description":"TODO: Add inline addons","items":{"$circularRef":"0dc125d7-6bd8-40a5-8d18-2c0190dcf082"},"uniqueKey":"prices.items.[INDEX].plan.prices","typeLabel":"array"},"status":{"type":"string","enum":["published","deleted","archived"],"x-enum-varnames":["StatusPublished","StatusDeleted","StatusArchived"],"x-speakeasy-name-override":"Status","uniqueKey":"prices.items.[INDEX].plan.status","typeLabel":"enum\u003cstring>"},"tenant_id":{"type":"string","uniqueKey":"prices.items.[INDEX].plan.tenant_id","typeLabel":"string"},"updated_at":{"type":"string","format":"date-time","uniqueKey":"prices.items.[INDEX].plan.updated_at","typeLabel":"string\u003cdate-time>"},"updated_by":{"type":"string","uniqueKey":"prices.items.[INDEX].plan.updated_by","typeLabel":"string"}},"uniqueKey":"prices.items.[INDEX].plan","typeLabel":"object"},"price_unit":{"type":"string","description":"PriceUnit is the code of the price unit (e.g., 'btc', 'eth')","uniqueKey":"prices.items.[INDEX].price_unit","typeLabel":"string"},"price_unit_amount":{"type":"string","description":"PriceUnitAmount is the amount of the price unit","uniqueKey":"prices.items.[INDEX].price_unit_amount","typeLabel":"string"},"price_unit_id":{"type":"string","description":"PriceUnitID is the id of the price unit (for CUSTOM type)","uniqueKey":"prices.items.[INDEX].price_unit_id","typeLabel":"string"},"price_unit_tiers":{"type":"array","description":"PriceUnitTiers are the tiers for the price unit when BillingModel is TIERED","items":{"type":"object","properties":{"flat_amount":{"type":"string","description":"flat_amount is the flat amount for the given tier (optional)\nApplied on top of unit_amount*quantity. Useful for cases like \"2.7$ + 5c\"","uniqueKey":"prices.items.[INDEX].price_unit_tiers.items.[INDEX].flat_amount","typeLabel":"string"},"unit_amount":{"type":"string","description":"unit_amount is the amount per unit for the given tier","uniqueKey":"prices.items.[INDEX].price_unit_tiers.items.[INDEX].unit_amount","typeLabel":"string"},"up_to":{"type":"integer","description":"up_to is the quantity up to which this tier applies. It is null for the last tier.\nIMPORTANT: Tier boundaries are INCLUSIVE.\n- If up_to is 1000, then quantity less than or equal to 1000 belongs to this tier\n- This behavior is consistent across both VOLUME and SLAB tier modes","uniqueKey":"prices.items.[INDEX].price_unit_tiers.items.[INDEX].up_to","typeLabel":"integer"}},"uniqueKey":"prices.items.[INDEX].price_unit_tiers.items.[INDEX]","typeLabel":"object"},"uniqueKey":"prices.items.[INDEX].price_unit_tiers","typeLabel":"object[]"},"price_unit_type":{"type":"string","enum":["FIAT","CUSTOM"],"x-enum-varnames":["PRICE_UNIT_TYPE_FIAT","PRICE_UNIT_TYPE_CUSTOM"],"x-speakeasy-name-override":"PriceUnitType","uniqueKey":"prices.items.[INDEX].price_unit_type","typeLabel":"enum\u003cstring>"},"pricing_unit":{"type":"object","properties":{"base_currency":{"type":"string","uniqueKey":"prices.items.[INDEX].pricing_unit.base_currency","typeLabel":"string"},"code":{"type":"string","uniqueKey":"prices.items.[INDEX].pricing_unit.code","typeLabel":"string"},"conversion_rate":{"type":"string","uniqueKey":"prices.items.[INDEX].pricing_unit.conversion_rate","typeLabel":"string"},"created_at":{"type":"string","format":"date-time","uniqueKey":"prices.items.[INDEX].pricing_unit.created_at","typeLabel":"string\u003cdate-time>"},"created_by":{"type":"string","uniqueKey":"prices.items.[INDEX].pricing_unit.created_by","typeLabel":"string"},"environment_id":{"type":"string","uniqueKey":"prices.items.[INDEX].pricing_unit.environment_id","typeLabel":"string"},"id":{"type":"string","uniqueKey":"prices.items.[INDEX].pricing_unit.id","typeLabel":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"prices.items.[INDEX].pricing_unit.metadata.additionalProperties","typeLabel":"string"},"x-speakeasy-name-override":"Metadata","uniqueKey":"prices.items.[INDEX].pricing_unit.metadata","typeLabel":"object"},"name":{"type":"string","uniqueKey":"prices.items.[INDEX].pricing_unit.name","typeLabel":"string"},"status":{"type":"string","enum":["published","deleted","archived"],"x-enum-varnames":["StatusPublished","StatusDeleted","StatusArchived"],"x-speakeasy-name-override":"Status","uniqueKey":"prices.items.[INDEX].pricing_unit.status","typeLabel":"enum\u003cstring>"},"symbol":{"type":"string","uniqueKey":"prices.items.[INDEX].pricing_unit.symbol","typeLabel":"string"},"tenant_id":{"type":"string","uniqueKey":"prices.items.[INDEX].pricing_unit.tenant_id","typeLabel":"string"},"updated_at":{"type":"string","format":"date-time","uniqueKey":"prices.items.[INDEX].pricing_unit.updated_at","typeLabel":"string\u003cdate-time>"},"updated_by":{"type":"string","uniqueKey":"prices.items.[INDEX].pricing_unit.updated_by","typeLabel":"string"}},"uniqueKey":"prices.items.[INDEX].pricing_unit","typeLabel":"object"},"sequence":{"type":"integer","description":"Sequence is the monotonic stamp bumped on every state change that\nsubscription line items need to react to. Read by the plan-price sync;\nset by the database (DEFAULT nextval) on create and by the price\nrepository on termination / compatibility-affecting edits.","uniqueKey":"prices.items.[INDEX].sequence","typeLabel":"integer"},"start_date":{"type":"string","description":"StartDate is the start date of the price","format":"date-time","uniqueKey":"prices.items.[INDEX].start_date","typeLabel":"string\u003cdate-time>"},"status":{"type":"string","enum":["published","deleted","archived"],"x-enum-varnames":["StatusPublished","StatusDeleted","StatusArchived"],"x-speakeasy-name-override":"Status","uniqueKey":"prices.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"tenant_id":{"type":"string","uniqueKey":"prices.items.[INDEX].tenant_id","typeLabel":"string"},"tier_mode":{"type":"string","enum":["VOLUME","SLAB"],"x-enum-varnames":["BILLING_TIER_VOLUME","BILLING_TIER_SLAB"],"x-speakeasy-name-override":"BillingTier","uniqueKey":"prices.items.[INDEX].tier_mode","typeLabel":"enum\u003cstring>"},"tiers":{"type":"array","items":{"type":"object","properties":{"flat_amount":{"type":"string","description":"flat_amount is the flat amount for the given tier (optional)\nApplied on top of unit_amount*quantity. Useful for cases like \"2.7$ + 5c\"","uniqueKey":"prices.items.[INDEX].tiers.items.[INDEX].flat_amount","typeLabel":"string"},"unit_amount":{"type":"string","description":"unit_amount is the amount per unit for the given tier","uniqueKey":"prices.items.[INDEX].tiers.items.[INDEX].unit_amount","typeLabel":"string"},"up_to":{"type":"integer","description":"up_to is the quantity up to which this tier applies. It is null for the last tier.\nIMPORTANT: Tier boundaries are INCLUSIVE.\n- If up_to is 1000, then quantity less than or equal to 1000 belongs to this tier\n- This behavior is consistent across both VOLUME and SLAB tier modes","uniqueKey":"prices.items.[INDEX].tiers.items.[INDEX].up_to","typeLabel":"integer"}},"uniqueKey":"prices.items.[INDEX].tiers.items.[INDEX]","typeLabel":"object"},"uniqueKey":"prices.items.[INDEX].tiers","typeLabel":"object[]"},"transform_quantity":{"type":"object","properties":{"divide_by":{"type":"integer","description":"Divide quantity by this number","uniqueKey":"prices.items.[INDEX].transform_quantity.divide_by","typeLabel":"integer"},"round":{"type":"string","enum":["up","down"],"x-enum-varnames":["ROUND_UP","ROUND_DOWN"],"x-speakeasy-name-override":"RoundType","uniqueKey":"prices.items.[INDEX].transform_quantity.round","typeLabel":"enum\u003cstring>"}},"uniqueKey":"prices.items.[INDEX].transform_quantity","typeLabel":"object"},"trial_period_days":{"type":"integer","description":"TrialPeriodDays is the number of days for the trial period\nNote: This is only applicable for recurring prices (BILLING_CADENCE_RECURRING)","uniqueKey":"prices.items.[INDEX].trial_period_days","typeLabel":"integer"},"type":{"type":"string","enum":["USAGE","FIXED"],"x-enum-varnames":["PRICE_TYPE_USAGE","PRICE_TYPE_FIXED"],"x-speakeasy-name-override":"PriceType","uniqueKey":"prices.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"updated_at":{"type":"string","format":"date-time","uniqueKey":"prices.items.[INDEX].updated_at","typeLabel":"string\u003cdate-time>"},"updated_by":{"type":"string","uniqueKey":"prices.items.[INDEX].updated_by","typeLabel":"string"}},"uniqueKey":"prices.items.[INDEX]","typeLabel":"object"},"uniqueKey":"prices","typeLabel":"object[]"},"status":{"type":"string","enum":["published","deleted","archived"],"x-enum-varnames":["StatusPublished","StatusDeleted","StatusArchived"],"x-speakeasy-name-override":"Status","uniqueKey":"status","typeLabel":"enum\u003cstring>"},"tenant_id":{"type":"string","uniqueKey":"tenant_id","typeLabel":"string"},"updated_at":{"type":"string","format":"date-time","uniqueKey":"updated_at","typeLabel":"string\u003cdate-time>"},"updated_by":{"type":"string","uniqueKey":"updated_by","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"created_at":"2023-11-07T05:31:56Z","created_by":"\u003cstring>","credit_grants":[{"addon_id":"\u003cstring>","cadence":"ONETIME","conversion_rate":"\u003cstring>","created_at":"2023-11-07T05:31:56Z","created_by":"\u003cstring>","credit_grant_anchor":"2023-11-07T05:31:56Z","credits":"\u003cstring>","end_date":"2023-11-07T05:31:56Z","environment_id":"\u003cstring>","expiration_duration":123,"expiration_duration_unit":"DAY","expiration_type":"NEVER","id":"\u003cstring>","metadata":{},"name":"\u003cstring>","period":"DAILY","period_count":123,"plan_id":"\u003cstring>","priority":123,"scope":"PLAN","start_date":"2023-11-07T05:31:56Z","status":"published","subscription_id":"\u003cstring>","tenant_id":"\u003cstring>","topup_conversion_rate":"\u003cstring>","updated_at":"2023-11-07T05:31:56Z","updated_by":"\u003cstring>"}],"description":"\u003cstring>","entitlements":[{"addon":{"created_at":"2023-11-07T05:31:56Z","created_by":"\u003cstring>","credit_grants":[{"addon_id":"\u003cstring>","cadence":"ONETIME","conversion_rate":"\u003cstring>","created_at":"2023-11-07T05:31:56Z","created_by":"\u003cstring>","credit_grant_anchor":"2023-11-07T05:31:56Z","credits":"\u003cstring>","end_date":"2023-11-07T05:31:56Z","environment_id":"\u003cstring>","expiration_duration":123,"expiration_duration_unit":"DAY","expiration_type":"NEVER","id":"\u003cstring>","metadata":{},"name":"\u003cstring>","period":"DAILY","period_count":123,"plan_id":"\u003cstring>","priority":123,"scope":"PLAN","start_date":"2023-11-07T05:31:56Z","status":"published","subscription_id":"\u003cstring>","tenant_id":"\u003cstring>","topup_conversion_rate":"\u003cstring>","updated_at":"2023-11-07T05:31:56Z","updated_by":"\u003cstring>"}],"description":"\u003cstring>","entitlements":"\u003cunknown>","environment_id":"\u003cstring>","id":"\u003cstring>","lookup_key":"\u003cstring>","metadata":{},"name":"\u003cstring>","price_sync_status":{"current_sequence":123,"synced":true,"unsynced_association_count":123},"prices":[{"addon":"\u003cunknown>","amount":"\u003cstring>","billing_cadence":"RECURRING","billing_model":"FLAT_FEE","billing_period":"MONTHLY","billing_period_count":123,"bucket_size":"MINUTE","conversion_rate":"\u003cstring>","created_at":"2023-11-07T05:31:56Z","created_by":"\u003cstring>","currency":"\u003cstring>","description":"\u003cstring>","display_amount":"\u003cstring>","display_name":"\u003cstring>","display_price_unit_amount":"\u003cstring>","end_date":"2023-11-07T05:31:56Z","entity_id":"\u003cstring>","entity_type":"PLAN","environment_id":"\u003cstring>","feature":{"reporting_unit":{"conversion_rate":123,"unit_plural":"\u003cstring>","unit_singular":"\u003cstring>"}},"group":{"created_at":"2023-11-07T05:31:56Z","entity_ids":["\u003cstring>"],"entity_type":"\u003cstring>","id":"\u003cstring>","lookup_key":"\u003cstring>","metadata":{},"name":"\u003cstring>","status":"\u003cstring>","updated_at":"2023-11-07T05:31:56Z"},"group_id":"\u003cstring>","id":"\u003cstring>","invoice_cadence":"ARREAR","lookup_key":"\u003cstring>","metadata":{},"meter":{"aggregation":{"bucket_size":"MINUTE","expression":"\u003cstring>","field":"\u003cstring>","group_by":"\u003cstring>","multiplier":"\u003cstring>","type":"COUNT"},"created_at":"2024-03-20T15:04:05Z","event_name":"api_request","filters":[{"key":"\u003cstring>","values":["\u003cstring>"]}],"id":"550e8400-e29b-41d4-a716-446655440000","name":"API Usage Meter","reset_usage":"BILLING_PERIOD","status":"published","tenant_id":"tenant123","updated_at":"2024-03-20T15:04:05Z"},"meter_id":"\u003cstring>","min_quantity":"\u003cstring>","parent_price_id":"\u003cstring>","plan":{"created_at":"2023-11-07T05:31:56Z","created_by":"\u003cstring>","credit_grants":[{"addon_id":"\u003cstring>","cadence":"ONETIME","conversion_rate":"\u003cstring>","created_at":"2023-11-07T05:31:56Z","created_by":"\u003cstring>","credit_grant_anchor":"2023-11-07T05:31:56Z","credits":"\u003cstring>","end_date":"2023-11-07T05:31:56Z","environment_id":"\u003cstring>","expiration_duration":123,"expiration_duration_unit":"DAY","expiration_type":"NEVER","id":"\u003cstring>","metadata":{},"name":"\u003cstring>","period":"DAILY","period_count":123,"plan_id":"\u003cstring>","priority":123,"scope":"PLAN","start_date":"2023-11-07T05:31:56Z","status":"published","subscription_id":"\u003cstring>","tenant_id":"\u003cstring>","topup_conversion_rate":"\u003cstring>","updated_at":"2023-11-07T05:31:56Z","updated_by":"\u003cstring>"}],"description":"\u003cstring>","display_order":123,"entitlements":"\u003carray>","environment_id":"\u003cstring>","id":"\u003cstring>","lookup_key":"\u003cstring>","metadata":{},"name":"\u003cstring>","price_sync_status":{"current_sequence":123,"synced":true,"unsynced_subscription_count":123},"prices":"\u003carray>","status":"published","tenant_id":"\u003cstring>","updated_at":"2023-11-07T05:31:56Z","updated_by":"\u003cstring>"},"price_unit":"\u003cstring>","price_unit_amount":"\u003cstring>","price_unit_id":"\u003cstring>","price_unit_tiers":[{"flat_amount":"\u003cstring>","unit_amount":"\u003cstring>","up_to":123}],"price_unit_type":"FIAT","pricing_unit":{"base_currency":"\u003cstring>","code":"\u003cstring>","conversion_rate":"\u003cstring>","created_at":"2023-11-07T05:31:56Z","created_by":"\u003cstring>","environment_id":"\u003cstring>","id":"\u003cstring>","metadata":{},"name":"\u003cstring>","status":"published","symbol":"\u003cstring>","tenant_id":"\u003cstring>","updated_at":"2023-11-07T05:31:56Z","updated_by":"\u003cstring>"},"sequence":123,"start_date":"2023-11-07T05:31:56Z","status":"published","tenant_id":"\u003cstring>","tier_mode":"VOLUME","tiers":[{"flat_amount":"\u003cstring>","unit_amount":"\u003cstring>","up_to":123}],"transform_quantity":{"divide_by":123,"round":"up"},"trial_period_days":123,"type":"USAGE","updated_at":"2023-11-07T05:31:56Z","updated_by":"\u003cstring>"}],"status":"published","tenant_id":"\u003cstring>","updated_at":"2023-11-07T05:31:56Z","updated_by":"\u003cstring>"},"aggregation_mode":"additive","config_value":{},"created_at":"2023-11-07T05:31:56Z","created_by":"\u003cstring>","display_order":123,"end_date":"2023-11-07T05:31:56Z","entity_id":"\u003cstring>","entity_type":"PLAN","environment_id":"\u003cstring>","feature":{"alert_settings":{"alert_enabled":true,"alert_threshold_type":"absolute","critical":{"condition":"above","threshold":"\u003cstring>"},"info":{"condition":"above","threshold":"\u003cstring>"},"warning":{"condition":"above","threshold":"\u003cstring>"}},"created_at":"2023-11-07T05:31:56Z","created_by":"\u003cstring>","description":"\u003cstring>","environment_id":"\u003cstring>","group":{"created_at":"2023-11-07T05:31:56Z","entity_ids":["\u003cstring>"],"entity_type":"\u003cstring>","id":"\u003cstring>","lookup_key":"\u003cstring>","metadata":{},"name":"\u003cstring>","status":"\u003cstring>","updated_at":"2023-11-07T05:31:56Z"},"group_id":"\u003cstring>","id":"\u003cstring>","lookup_key":"\u003cstring>","metadata":{},"meter":{"aggregation":{"bucket_size":"MINUTE","expression":"\u003cstring>","field":"\u003cstring>","group_by":"\u003cstring>","multiplier":"\u003cstring>","type":"COUNT"},"created_at":"2024-03-20T15:04:05Z","event_name":"api_request","filters":[{"key":"\u003cstring>","values":["\u003cstring>"]}],"id":"550e8400-e29b-41d4-a716-446655440000","name":"API Usage Meter","reset_usage":"BILLING_PERIOD","status":"published","tenant_id":"tenant123","updated_at":"2024-03-20T15:04:05Z"},"meter_id":"\u003cstring>","name":"\u003cstring>","reporting_unit":{"conversion_rate":123,"unit_plural":"\u003cstring>","unit_singular":"\u003cstring>"},"status":"published","tenant_id":"\u003cstring>","type":"metered","unit_plural":"\u003cstring>","unit_singular":"\u003cstring>","updated_at":"2023-11-07T05:31:56Z","updated_by":"\u003cstring>"},"feature_id":"\u003cstring>","feature_type":"metered","grant_allocation_behavior":"first_usage","grant_duration_unit":"hour","grant_duration_value":123,"grant_measure":"quantity","grant_quota":"\u003cstring>","id":"\u003cstring>","is_enabled":true,"is_soft_limit":true,"parent_entitlement_id":"\u003cstring>","plan":{"created_at":"2023-11-07T05:31:56Z","created_by":"\u003cstring>","credit_grants":[{"addon_id":"\u003cstring>","cadence":"ONETIME","conversion_rate":"\u003cstring>","created_at":"2023-11-07T05:31:56Z","created_by":"\u003cstring>","credit_grant_anchor":"2023-11-07T05:31:56Z","credits":"\u003cstring>","end_date":"2023-11-07T05:31:56Z","environment_id":"\u003cstring>","expiration_duration":123,"expiration_duration_unit":"DAY","expiration_type":"NEVER","id":"\u003cstring>","metadata":{},"name":"\u003cstring>","period":"DAILY","period_count":123,"plan_id":"\u003cstring>","priority":123,"scope":"PLAN","start_date":"2023-11-07T05:31:56Z","status":"published","subscription_id":"\u003cstring>","tenant_id":"\u003cstring>","topup_conversion_rate":"\u003cstring>","updated_at":"2023-11-07T05:31:56Z","updated_by":"\u003cstring>"}],"description":"\u003cstring>","display_order":123,"entitlements":"\u003carray>","environment_id":"\u003cstring>","id":"\u003cstring>","lookup_key":"\u003cstring>","metadata":{},"name":"\u003cstring>","price_sync_status":{"current_sequence":123,"synced":true,"unsynced_subscription_count":123},"prices":"\u003carray>","status":"published","tenant_id":"\u003cstring>","updated_at":"2023-11-07T05:31:56Z","updated_by":"\u003cstring>"},"plan_id":"\u003cstring>","start_date":"2023-11-07T05:31:56Z","static_value":"\u003cstring>","status":"published","tenant_id":"\u003cstring>","updated_at":"2023-11-07T05:31:56Z","updated_by":"\u003cstring>","usage_limit":123,"usage_reset_period":"MONTHLY"}],"environment_id":"\u003cstring>","id":"\u003cstring>","lookup_key":"\u003cstring>","metadata":{},"name":"\u003cstring>","price_sync_status":{"current_sequence":123,"synced":true,"unsynced_association_count":123},"prices":[{"addon":"\u003cunknown>","amount":"\u003cstring>","billing_cadence":"RECURRING","billing_model":"FLAT_FEE","billing_period":"MONTHLY","billing_period_count":123,"bucket_size":"MINUTE","conversion_rate":"\u003cstring>","created_at":"2023-11-07T05:31:56Z","created_by":"\u003cstring>","currency":"\u003cstring>","description":"\u003cstring>","display_amount":"\u003cstring>","display_name":"\u003cstring>","display_price_unit_amount":"\u003cstring>","end_date":"2023-11-07T05:31:56Z","entity_id":"\u003cstring>","entity_type":"PLAN","environment_id":"\u003cstring>","feature":{"reporting_unit":{"conversion_rate":123,"unit_plural":"\u003cstring>","unit_singular":"\u003cstring>"}},"group":{"created_at":"2023-11-07T05:31:56Z","entity_ids":["\u003cstring>"],"entity_type":"\u003cstring>","id":"\u003cstring>","lookup_key":"\u003cstring>","metadata":{},"name":"\u003cstring>","status":"\u003cstring>","updated_at":"2023-11-07T05:31:56Z"},"group_id":"\u003cstring>","id":"\u003cstring>","invoice_cadence":"ARREAR","lookup_key":"\u003cstring>","metadata":{},"meter":{"aggregation":{"bucket_size":"MINUTE","expression":"\u003cstring>","field":"\u003cstring>","group_by":"\u003cstring>","multiplier":"\u003cstring>","type":"COUNT"},"created_at":"2024-03-20T15:04:05Z","event_name":"api_request","filters":[{"key":"\u003cstring>","values":["\u003cstring>"]}],"id":"550e8400-e29b-41d4-a716-446655440000","name":"API Usage Meter","reset_usage":"BILLING_PERIOD","status":"published","tenant_id":"tenant123","updated_at":"2024-03-20T15:04:05Z"},"meter_id":"\u003cstring>","min_quantity":"\u003cstring>","parent_price_id":"\u003cstring>","plan":{"created_at":"2023-11-07T05:31:56Z","created_by":"\u003cstring>","credit_grants":[{"addon_id":"\u003cstring>","cadence":"ONETIME","conversion_rate":"\u003cstring>","created_at":"2023-11-07T05:31:56Z","created_by":"\u003cstring>","credit_grant_anchor":"2023-11-07T05:31:56Z","credits":"\u003cstring>","end_date":"2023-11-07T05:31:56Z","environment_id":"\u003cstring>","expiration_duration":123,"expiration_duration_unit":"DAY","expiration_type":"NEVER","id":"\u003cstring>","metadata":{},"name":"\u003cstring>","period":"DAILY","period_count":123,"plan_id":"\u003cstring>","priority":123,"scope":"PLAN","start_date":"2023-11-07T05:31:56Z","status":"published","subscription_id":"\u003cstring>","tenant_id":"\u003cstring>","topup_conversion_rate":"\u003cstring>","updated_at":"2023-11-07T05:31:56Z","updated_by":"\u003cstring>"}],"description":"\u003cstring>","display_order":123,"entitlements":"\u003carray>","environment_id":"\u003cstring>","id":"\u003cstring>","lookup_key":"\u003cstring>","metadata":{},"name":"\u003cstring>","price_sync_status":{"current_sequence":123,"synced":true,"unsynced_subscription_count":123},"prices":"\u003carray>","status":"published","tenant_id":"\u003cstring>","updated_at":"2023-11-07T05:31:56Z","updated_by":"\u003cstring>"},"price_unit":"\u003cstring>","price_unit_amount":"\u003cstring>","price_unit_id":"\u003cstring>","price_unit_tiers":[{"flat_amount":"\u003cstring>","unit_amount":"\u003cstring>","up_to":123}],"price_unit_type":"FIAT","pricing_unit":{"base_currency":"\u003cstring>","code":"\u003cstring>","conversion_rate":"\u003cstring>","created_at":"2023-11-07T05:31:56Z","created_by":"\u003cstring>","environment_id":"\u003cstring>","id":"\u003cstring>","metadata":{},"name":"\u003cstring>","status":"published","symbol":"\u003cstring>","tenant_id":"\u003cstring>","updated_at":"2023-11-07T05:31:56Z","updated_by":"\u003cstring>"},"sequence":123,"start_date":"2023-11-07T05:31:56Z","status":"published","tenant_id":"\u003cstring>","tier_mode":"VOLUME","tiers":[{"flat_amount":"\u003cstring>","unit_amount":"\u003cstring>","up_to":123}],"transform_quantity":{"divide_by":123,"round":"up"},"trial_period_days":123,"type":"USAGE","updated_at":"2023-11-07T05:31:56Z","updated_by":"\u003cstring>"}],"status":"published","tenant_id":"\u003cstring>","updated_at":"2023-11-07T05:31:56Z","updated_by":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"d7a63c66-3683-4eec-aea9-650d58453d6a":{"description":"Invalid request","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["http_client_error","system_error","internal_error","not_found","already_exists","version_conflict","validation_error","invalid_operation","permission_denied","database_error","service_unavailable","too_many_requests","not_implemented"],"x-enum-varnames":["ErrCodeHTTPClient","ErrCodeSystemError","ErrCodeInternalError","ErrCodeNotFound","ErrCodeAlreadyExists","ErrCodeVersionConflict","ErrCodeValidation","ErrCodeInvalidOperation","ErrCodePermissionDenied","ErrCodeDatabase","ErrCodeServiceUnavailable","ErrCodeTooManyRequests","ErrCodeNotImplemented"],"x-speakeasy-name-override":"ErrorCode","uniqueKey":"code","typeLabel":"enum\u003cstring>"},"http_status_code":{"type":"integer","uniqueKey":"http_status_code","typeLabel":"integer"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"}},"x-speakeasy-name-override":"ErrorResponse","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"http_client_error","http_status_code":123,"message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"46ee2115-3828-421c-a50b-2e30f96f0f12":{"description":"Server error","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["http_client_error","system_error","internal_error","not_found","already_exists","version_conflict","validation_error","invalid_operation","permission_denied","database_error","service_unavailable","too_many_requests","not_implemented"],"x-enum-varnames":["ErrCodeHTTPClient","ErrCodeSystemError","ErrCodeInternalError","ErrCodeNotFound","ErrCodeAlreadyExists","ErrCodeVersionConflict","ErrCodeValidation","ErrCodeInvalidOperation","ErrCodePermissionDenied","ErrCodeDatabase","ErrCodeServiceUnavailable","ErrCodeTooManyRequests","ErrCodeNotImplemented"],"x-speakeasy-name-override":"ErrorCode","uniqueKey":"code","typeLabel":"enum\u003cstring>"},"http_status_code":{"type":"integer","uniqueKey":"http_status_code","typeLabel":"integer"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"}},"x-speakeasy-name-override":"ErrorResponse","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"http_client_error","http_status_code":123,"message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"8b87f3c0-3989-42b2-a69f-4ef195813e56":{"ApiKeyAuth":{"type":"apiKey","description":"Enter your API key in the format *x-api-key \u0026lt;api-key\u0026gt;**","name":"x-api-key","in":"header","scopes":[],"schemeName":"ApiKeyAuth"}}},"servers":{"c3a552c0-fb0d-4192-bbfb-41d490814c91":{"url":"https://us.api.flexprice.io/v1","description":"US Region"},"8d9b0e10-8210-4fd4-9d91-5200cae97a59":{"url":"https://api.cloud.flexprice.io/v1","description":"India Region"}},"schemas":{"8ae9e152-6edf-472c-9b6e-b5cc555f8111":{"type":"array","items":{"type":"object","properties":{"addon":{"type":"object","properties":{"created_at":{"type":"string","format":"date-time"},"created_by":{"type":"string"},"credit_grants":{"type":"array","items":{"type":"object","properties":{"addon_id":{"type":"string"},"cadence":{"type":"string","enum":["ONETIME","RECURRING"],"x-enum-varnames":["CreditGrantCadenceOneTime","CreditGrantCadenceRecurring"],"x-speakeasy-name-override":"CreditGrantCadence"},"conversion_rate":{"type":"string","description":"amount in the currency = number of credits * conversion_rate\nex if conversion_rate is 1, then 1 USD = 1 credit\nex if conversion_rate is 2, then 1 USD = 0.5 credits\nex if conversion_rate is 0.5, then 1 USD = 2 credits"},"created_at":{"type":"string","format":"date-time"},"created_by":{"type":"string"},"credit_grant_anchor":{"type":"string","format":"date-time"},"credits":{"type":"string"},"end_date":{"type":"string","format":"date-time"},"environment_id":{"type":"string"},"expiration_duration":{"type":"integer"},"expiration_duration_unit":{"type":"string","enum":["DAY","WEEK","MONTH","YEAR"],"x-enum-varnames":["CreditGrantExpiryDurationUnitDays","CreditGrantExpiryDurationUnitWeeks","CreditGrantExpiryDurationUnitMonths","CreditGrantExpiryDurationUnitYears"],"x-speakeasy-name-override":"CreditGrantExpiryDurationUnit"},"expiration_type":{"type":"string","enum":["NEVER","DURATION","BILLING_CYCLE"],"x-enum-varnames":["CreditGrantExpiryTypeNever","CreditGrantExpiryTypeDuration","CreditGrantExpiryTypeBillingCycle"],"x-speakeasy-name-override":"CreditGrantExpiryType"},"id":{"type":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string"},"x-speakeasy-name-override":"Metadata"},"name":{"type":"string"},"period":{"type":"string","enum":["DAILY","WEEKLY","MONTHLY","ANNUAL","QUARTERLY","HALF_YEARLY"],"x-enum-varnames":["CREDIT_GRANT_PERIOD_DAILY","CREDIT_GRANT_PERIOD_WEEKLY","CREDIT_GRANT_PERIOD_MONTHLY","CREDIT_GRANT_PERIOD_ANNUAL","CREDIT_GRANT_PERIOD_QUARTER","CREDIT_GRANT_PERIOD_HALF_YEARLY"],"x-speakeasy-name-override":"CreditGrantPeriod"},"period_count":{"type":"integer"},"plan_id":{"type":"string"},"priority":{"type":"integer"},"scope":{"type":"string","enum":["PLAN","SUBSCRIPTION","ADDON"],"x-enum-varnames":["CreditGrantScopePlan","CreditGrantScopeSubscription","CreditGrantScopeAddon"],"x-speakeasy-name-override":"CreditGrantScope"},"start_date":{"type":"string","format":"date-time"},"status":{"type":"string","enum":["published","deleted","archived"],"x-enum-varnames":["StatusPublished","StatusDeleted","StatusArchived"],"x-speakeasy-name-override":"Status"},"subscription_id":{"type":"string"},"tenant_id":{"type":"string"},"topup_conversion_rate":{"type":"string","description":"topup_conversion_rate is the conversion rate for the topup to the currency\nex if topup_conversion_rate is 1, then 1 USD = 1 credit\nex if topup_conversion_rate is 2, then 1 USD = 0.5 credits\nex if topup_conversion_rate is 0.5, then 1 USD = 2 credits"},"updated_at":{"type":"string","format":"date-time"},"updated_by":{"type":"string"}}}},"description":{"type":"string"},"entitlements":{"oneOf":[{}]},"environment_id":{"type":"string"},"id":{"type":"string"},"lookup_key":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"name":{"type":"string"},"price_sync_status":{"type":"object","properties":{"current_sequence":{"type":"integer"},"synced":{"type":"boolean"},"unsynced_association_count":{"type":"integer"}}},"prices":{"type":"array","description":"Optional expanded fields","items":{"type":"object","properties":{"addon":{"oneOf":[{}]},"amount":{"type":"string","description":"Amount stored in main currency units (e.g., dollars, not cents)\nFor USD: 12.50 means $12.50"},"billing_cadence":{"type":"string","enum":["RECURRING"],"x-enum-varnames":["BILLING_CADENCE_RECURRING"],"x-speakeasy-name-override":"BillingCadence"},"billing_model":{"type":"string","enum":["FLAT_FEE","PACKAGE","TIERED"],"x-enum-varnames":["BILLING_MODEL_FLAT_FEE","BILLING_MODEL_PACKAGE","BILLING_MODEL_TIERED"],"x-speakeasy-name-override":"BillingModel"},"billing_period":{"type":"string","enum":["MONTHLY","ANNUAL","WEEKLY","DAILY","QUARTERLY","HALF_YEARLY","ONETIME"],"x-enum-varnames":["BILLING_PERIOD_MONTHLY","BILLING_PERIOD_ANNUAL","BILLING_PERIOD_WEEKLY","BILLING_PERIOD_DAILY","BILLING_PERIOD_QUARTER","BILLING_PERIOD_HALF_YEAR","BILLING_PERIOD_ONETIME"],"x-speakeasy-name-override":"BillingPeriod"},"billing_period_count":{"type":"integer","description":"BillingPeriodCount is the count of the billing period ex 1, 3, 6, 12"},"bucket_size":{"type":"string","enum":["MINUTE","15MIN","30MIN","HOUR","3HOUR","6HOUR","12HOUR","DAY","WEEK","MONTH"],"x-enum-varnames":["WindowSizeMinute","WindowSize15Min","WindowSize30Min","WindowSizeHour","WindowSize3Hour","WindowSize6Hour","WindowSize12Hour","WindowSizeDay","WindowSizeWeek","WindowSizeMonth"],"x-speakeasy-name-override":"WindowSize"},"conversion_rate":{"type":"string","description":"ConversionRate is the conversion rate of the price unit to the fiat currency"},"created_at":{"type":"string","format":"date-time"},"created_by":{"type":"string"},"currency":{"type":"string","description":"Currency 3 digit ISO currency code in lowercase ex usd, eur, gbp"},"description":{"type":"string","description":"Description of the price"},"display_amount":{"type":"string","description":"DisplayAmount is the formatted amount with currency symbol\nFor USD: $12.50"},"display_name":{"type":"string","description":"DisplayName is the name of the price"},"display_price_unit_amount":{"type":"string","description":"DisplayPriceUnitAmount is the formatted amount of the price unit"},"end_date":{"type":"string","description":"EndDate is the end date of the price","format":"date-time"},"entity_id":{"type":"string","description":"EntityID holds the value of the \"entity_id\" field."},"entity_type":{"type":"string","enum":["PLAN","SUBSCRIPTION","ADDON","PRICE","COSTSHEET"],"x-enum-varnames":["PRICE_ENTITY_TYPE_PLAN","PRICE_ENTITY_TYPE_SUBSCRIPTION","PRICE_ENTITY_TYPE_ADDON","PRICE_ENTITY_TYPE_PRICE","PRICE_ENTITY_TYPE_COSTSHEET"],"x-speakeasy-name-override":"PriceEntityType"},"environment_id":{"type":"string","description":"EnvironmentID is the environment identifier for the price"},"feature":{"type":"object","properties":{"reporting_unit":{"type":"object","properties":{"conversion_rate":{"type":"number","description":"Multiplier: reporting_unit_value = unit_value * conversion_rate; must be > 0"},"unit_plural":{"type":"string","description":"Display unit label, plural (e.g. \"seconds\")"},"unit_singular":{"type":"string","description":"Display unit label, singular (e.g. \"second\")"}},"x-speakeasy-name-override":"ReportingUnit"}}},"group":{"type":"object","properties":{"created_at":{"type":"string","format":"date-time"},"entity_ids":{"type":"array","items":{"type":"string"}},"entity_type":{"type":"string"},"id":{"type":"string"},"lookup_key":{"type":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string"}},"name":{"type":"string"},"status":{"type":"string"},"updated_at":{"type":"string","format":"date-time"}}},"group_id":{"type":"string","description":"GroupID references the group this price belongs to"},"id":{"type":"string","description":"ID uuid identifier for the price"},"invoice_cadence":{"type":"string","enum":["ARREAR","ADVANCE"],"x-enum-varnames":["InvoiceCadenceArrear","InvoiceCadenceAdvance"],"x-speakeasy-name-override":"InvoiceCadence"},"lookup_key":{"type":"string","description":"LookupKey used for looking up the price in the database"},"metadata":{"type":"object","additionalProperties":{"type":"string"}},"meter":{"type":"object","properties":{"aggregation":{"type":"object","properties":{"bucket_size":{"type":"string","enum":["MINUTE","15MIN","30MIN","HOUR","3HOUR","6HOUR","12HOUR","DAY","WEEK","MONTH"],"x-enum-varnames":["WindowSizeMinute","WindowSize15Min","WindowSize30Min","WindowSizeHour","WindowSize3Hour","WindowSize6Hour","WindowSize12Hour","WindowSizeDay","WindowSizeWeek","WindowSizeMonth"],"x-speakeasy-name-override":"WindowSize"},"expression":{"type":"string","description":"Expression is an optional CEL expression to compute per-event quantity from event.properties.\nWhen set, it replaces Field-based extraction. Property names are used directly (e.g., token * duration * pixel)."},"field":{"type":"string","description":"Field is the key in $event.properties on which the aggregation is to be applied\nFor ex if the aggregation type is sum for API usage, the field could be \"duration_ms\"\nIgnored when Expression is set."},"group_by":{"type":"string","description":"GroupBy is the property name in event.properties to group by before aggregating.\nRequires MAX aggregation. Windowing comes from the price, so this no longer\nimplies a meter-level bucket_size.\nWhen set, aggregation is applied per unique value of this property within each bucket,\nthen the per-group results are summed to produce the bucket total."},"multiplier":{"type":"string","description":"Multiplier is the multiplier for the aggregation\nFor ex if the aggregation type is sum_with_multiplier for API usage, the multiplier could be 1000\nto scale up by a factor of 1000. If not provided, it will be null."},"type":{"type":"string","enum":["COUNT","SUM","AVG","COUNT_UNIQUE","LATEST","SUM_WITH_MULTIPLIER","MAX","WEIGHTED_SUM"],"x-enum-comments":{"AggregationSumWithMultiplier":"Sum with a multiplier - [sum(value) * multiplier]"},"x-enum-varnames":["AggregationCount","AggregationSum","AggregationAvg","AggregationCountUnique","AggregationLatest","AggregationSumWithMultiplier","AggregationMax","AggregationWeightedSum"],"x-speakeasy-name-override":"AggregationType"}}},"created_at":{"type":"string","example":"2024-03-20T15:04:05Z","format":"date-time"},"event_name":{"type":"string","example":"api_request"},"filters":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":"Key is the key for the filter from $event.properties\nCurrently we support only first level keys in the properties and not nested keys"},"values":{"type":"array","description":"Values are the possible values for the filter to be considered for the meter\nFor ex \"model_name\" could have values \"o1-mini\", \"gpt-4o\" etc","items":{"type":"string"}}}}},"id":{"type":"string","example":"550e8400-e29b-41d4-a716-446655440000"},"name":{"type":"string","example":"API Usage Meter"},"reset_usage":{"type":"string","enum":["BILLING_PERIOD","NEVER"],"x-enum-varnames":["ResetUsageBillingPeriod","ResetUsageNever"],"x-speakeasy-name-override":"ResetUsage"},"status":{"type":"string","example":"published"},"tenant_id":{"type":"string","example":"tenant123"},"updated_at":{"type":"string","example":"2024-03-20T15:04:05Z","format":"date-time"}}},"meter_id":{"type":"string","description":"MeterID is the id of the meter for usage based pricing"},"min_quantity":{"oneOf":[{"type":"string","description":"MinQuantity is the minimum quantity of the price"},{"type":"null","description":"MinQuantity is the minimum quantity of the price"}]},"parent_price_id":{"type":"string","description":"ParentPriceID references the root price (always set for price lineage tracking)"},"plan":{"type":"object","properties":{"created_at":{"type":"string","format":"date-time"},"created_by":{"type":"string"},"credit_grants":{"type":"array","items":{"type":"object","properties":{"addon_id":{"type":"string"},"cadence":{"type":"string","enum":["ONETIME","RECURRING"],"x-enum-varnames":["CreditGrantCadenceOneTime","CreditGrantCadenceRecurring"],"x-speakeasy-name-override":"CreditGrantCadence"},"conversion_rate":{"type":"string","description":"amount in the currency = number of credits * conversion_rate\nex if conversion_rate is 1, then 1 USD = 1 credit\nex if conversion_rate is 2, then 1 USD = 0.5 credits\nex if conversion_rate is 0.5, then 1 USD = 2 credits"},"created_at":{"type":"string","format":"date-time"},"created_by":{"type":"string"},"credit_grant_anchor":{"type":"string","format":"date-time"},"credits":{"type":"string"},"end_date":{"type":"string","format":"date-time"},"environment_id":{"type":"string"},"expiration_duration":{"type":"integer"},"expiration_duration_unit":{"type":"string","enum":["DAY","WEEK","MONTH","YEAR"],"x-enum-varnames":["CreditGrantExpiryDurationUnitDays","CreditGrantExpiryDurationUnitWeeks","CreditGrantExpiryDurationUnitMonths","CreditGrantExpiryDurationUnitYears"],"x-speakeasy-name-override":"CreditGrantExpiryDurationUnit"},"expiration_type":{"type":"string","enum":["NEVER","DURATION","BILLING_CYCLE"],"x-enum-varnames":["CreditGrantExpiryTypeNever","CreditGrantExpiryTypeDuration","CreditGrantExpiryTypeBillingCycle"],"x-speakeasy-name-override":"CreditGrantExpiryType"},"id":{"type":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string"},"x-speakeasy-name-override":"Metadata"},"name":{"type":"string"},"period":{"type":"string","enum":["DAILY","WEEKLY","MONTHLY","ANNUAL","QUARTERLY","HALF_YEARLY"],"x-enum-varnames":["CREDIT_GRANT_PERIOD_DAILY","CREDIT_GRANT_PERIOD_WEEKLY","CREDIT_GRANT_PERIOD_MONTHLY","CREDIT_GRANT_PERIOD_ANNUAL","CREDIT_GRANT_PERIOD_QUARTER","CREDIT_GRANT_PERIOD_HALF_YEARLY"],"x-speakeasy-name-override":"CreditGrantPeriod"},"period_count":{"type":"integer"},"plan_id":{"type":"string"},"priority":{"type":"integer"},"scope":{"type":"string","enum":["PLAN","SUBSCRIPTION","ADDON"],"x-enum-varnames":["CreditGrantScopePlan","CreditGrantScopeSubscription","CreditGrantScopeAddon"],"x-speakeasy-name-override":"CreditGrantScope"},"start_date":{"type":"string","format":"date-time"},"status":{"type":"string","enum":["published","deleted","archived"],"x-enum-varnames":["StatusPublished","StatusDeleted","StatusArchived"],"x-speakeasy-name-override":"Status"},"subscription_id":{"type":"string"},"tenant_id":{"type":"string"},"topup_conversion_rate":{"type":"string","description":"topup_conversion_rate is the conversion rate for the topup to the currency\nex if topup_conversion_rate is 1, then 1 USD = 1 credit\nex if topup_conversion_rate is 2, then 1 USD = 0.5 credits\nex if topup_conversion_rate is 0.5, then 1 USD = 2 credits"},"updated_at":{"type":"string","format":"date-time"},"updated_by":{"type":"string"}}}},"description":{"type":"string"},"display_order":{"type":"integer"},"entitlements":{"type":"array","items":{"$circularRef":"1c99a94f-ba2d-4aeb-aec5-928f5daeddec"}},"environment_id":{"type":"string"},"id":{"type":"string"},"lookup_key":{"type":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string"},"x-speakeasy-name-override":"Metadata"},"name":{"type":"string"},"price_sync_status":{"type":"object","properties":{"current_sequence":{"type":"integer"},"synced":{"type":"boolean"},"unsynced_subscription_count":{"type":"integer"}}},"prices":{"type":"array","description":"TODO: Add inline addons","items":{"$circularRef":"0dc125d7-6bd8-40a5-8d18-2c0190dcf082"}},"status":{"type":"string","enum":["published","deleted","archived"],"x-enum-varnames":["StatusPublished","StatusDeleted","StatusArchived"],"x-speakeasy-name-override":"Status"},"tenant_id":{"type":"string"},"updated_at":{"type":"string","format":"date-time"},"updated_by":{"type":"string"}}},"price_unit":{"type":"string","description":"PriceUnit is the code of the price unit (e.g., 'btc', 'eth')"},"price_unit_amount":{"type":"string","description":"PriceUnitAmount is the amount of the price unit"},"price_unit_id":{"type":"string","description":"PriceUnitID is the id of the price unit (for CUSTOM type)"},"price_unit_tiers":{"type":"array","description":"PriceUnitTiers are the tiers for the price unit when BillingModel is TIERED","items":{"type":"object","properties":{"flat_amount":{"type":"string","description":"flat_amount is the flat amount for the given tier (optional)\nApplied on top of unit_amount*quantity. Useful for cases like \"2.7$ + 5c\""},"unit_amount":{"type":"string","description":"unit_amount is the amount per unit for the given tier"},"up_to":{"type":"integer","description":"up_to is the quantity up to which this tier applies. It is null for the last tier.\nIMPORTANT: Tier boundaries are INCLUSIVE.\n- If up_to is 1000, then quantity less than or equal to 1000 belongs to this tier\n- This behavior is consistent across both VOLUME and SLAB tier modes"}}}},"price_unit_type":{"type":"string","enum":["FIAT","CUSTOM"],"x-enum-varnames":["PRICE_UNIT_TYPE_FIAT","PRICE_UNIT_TYPE_CUSTOM"],"x-speakeasy-name-override":"PriceUnitType"},"pricing_unit":{"type":"object","properties":{"base_currency":{"type":"string"},"code":{"type":"string"},"conversion_rate":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"created_by":{"type":"string"},"environment_id":{"type":"string"},"id":{"type":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string"},"x-speakeasy-name-override":"Metadata"},"name":{"type":"string"},"status":{"type":"string","enum":["published","deleted","archived"],"x-enum-varnames":["StatusPublished","StatusDeleted","StatusArchived"],"x-speakeasy-name-override":"Status"},"symbol":{"type":"string"},"tenant_id":{"type":"string"},"updated_at":{"type":"string","format":"date-time"},"updated_by":{"type":"string"}}},"sequence":{"type":"integer","description":"Sequence is the monotonic stamp bumped on every state change that\nsubscription line items need to react to. Read by the plan-price sync;\nset by the database (DEFAULT nextval) on create and by the price\nrepository on termination / compatibility-affecting edits."},"start_date":{"type":"string","description":"StartDate is the start date of the price","format":"date-time"},"status":{"type":"string","enum":["published","deleted","archived"],"x-enum-varnames":["StatusPublished","StatusDeleted","StatusArchived"],"x-speakeasy-name-override":"Status"},"tenant_id":{"type":"string"},"tier_mode":{"type":"string","enum":["VOLUME","SLAB"],"x-enum-varnames":["BILLING_TIER_VOLUME","BILLING_TIER_SLAB"],"x-speakeasy-name-override":"BillingTier"},"tiers":{"type":"array","items":{"type":"object","properties":{"flat_amount":{"type":"string","description":"flat_amount is the flat amount for the given tier (optional)\nApplied on top of unit_amount*quantity. Useful for cases like \"2.7$ + 5c\""},"unit_amount":{"type":"string","description":"unit_amount is the amount per unit for the given tier"},"up_to":{"type":"integer","description":"up_to is the quantity up to which this tier applies. It is null for the last tier.\nIMPORTANT: Tier boundaries are INCLUSIVE.\n- If up_to is 1000, then quantity less than or equal to 1000 belongs to this tier\n- This behavior is consistent across both VOLUME and SLAB tier modes"}}}},"transform_quantity":{"type":"object","properties":{"divide_by":{"type":"integer","description":"Divide quantity by this number"},"round":{"type":"string","enum":["up","down"],"x-enum-varnames":["ROUND_UP","ROUND_DOWN"],"x-speakeasy-name-override":"RoundType"}}},"trial_period_days":{"type":"integer","description":"TrialPeriodDays is the number of days for the trial period\nNote: This is only applicable for recurring prices (BILLING_CADENCE_RECURRING)"},"type":{"type":"string","enum":["USAGE","FIXED"],"x-enum-varnames":["PRICE_TYPE_USAGE","PRICE_TYPE_FIXED"],"x-speakeasy-name-override":"PriceType"},"updated_at":{"type":"string","format":"date-time"},"updated_by":{"type":"string"}}}},"status":{"type":"string","enum":["published","deleted","archived"],"x-enum-varnames":["StatusPublished","StatusDeleted","StatusArchived"],"x-speakeasy-name-override":"Status"},"tenant_id":{"type":"string"},"updated_at":{"type":"string","format":"date-time"},"updated_by":{"type":"string"}}},"aggregation_mode":{"type":"string","enum":["additive","parallel"],"x-enum-varnames":["EntitlementAggregationModeAdditive","EntitlementAggregationModeParallel"],"x-speakeasy-name-override":"EntitlementAggregationMode"},"config_value":{"type":"object","additionalProperties":true},"created_at":{"type":"string","format":"date-time"},"created_by":{"type":"string"},"display_order":{"type":"integer"},"end_date":{"type":"string","format":"date-time"},"entity_id":{"type":"string"},"entity_type":{"type":"string","enum":["PLAN","SUBSCRIPTION","ADDON"],"x-enum-varnames":["ENTITLEMENT_ENTITY_TYPE_PLAN","ENTITLEMENT_ENTITY_TYPE_SUBSCRIPTION","ENTITLEMENT_ENTITY_TYPE_ADDON"],"x-speakeasy-name-override":"EntitlementEntityType"},"environment_id":{"type":"string"},"feature":{"type":"object","properties":{"alert_settings":{"type":"object","properties":{"alert_enabled":{"type":"boolean"},"alert_threshold_type":{"type":"string","enum":["absolute","percentage"],"x-enum-varnames":["AlertThresholdTypeAbsolute","AlertThresholdTypePercentage"],"x-speakeasy-name-override":"AlertThresholdType"},"critical":{"type":"object","properties":{"condition":{"type":"string","enum":["above","below"],"x-enum-varnames":["AlertConditionAbove","AlertConditionBelow"],"x-speakeasy-name-override":"AlertCondition"},"threshold":{"type":"string"}},"x-speakeasy-name-override":"AlertThreshold"},"info":{"type":"object","properties":{"condition":{"type":"string","enum":["above","below"],"x-enum-varnames":["AlertConditionAbove","AlertConditionBelow"],"x-speakeasy-name-override":"AlertCondition"},"threshold":{"type":"string"}},"x-speakeasy-name-override":"AlertThreshold"},"warning":{"type":"object","properties":{"condition":{"type":"string","enum":["above","below"],"x-enum-varnames":["AlertConditionAbove","AlertConditionBelow"],"x-speakeasy-name-override":"AlertCondition"},"threshold":{"type":"string"}},"x-speakeasy-name-override":"AlertThreshold"}},"x-speakeasy-name-override":"AlertSettings"},"created_at":{"type":"string","format":"date-time"},"created_by":{"type":"string"},"description":{"type":"string"},"environment_id":{"type":"string"},"group":{"type":"object","properties":{"created_at":{"type":"string","format":"date-time"},"entity_ids":{"type":"array","items":{"type":"string"}},"entity_type":{"type":"string"},"id":{"type":"string"},"lookup_key":{"type":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string"}},"name":{"type":"string"},"status":{"type":"string"},"updated_at":{"type":"string","format":"date-time"}}},"group_id":{"type":"string"},"id":{"type":"string"},"lookup_key":{"type":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string"},"x-speakeasy-name-override":"Metadata"},"meter":{"type":"object","properties":{"aggregation":{"type":"object","properties":{"bucket_size":{"type":"string","enum":["MINUTE","15MIN","30MIN","HOUR","3HOUR","6HOUR","12HOUR","DAY","WEEK","MONTH"],"x-enum-varnames":["WindowSizeMinute","WindowSize15Min","WindowSize30Min","WindowSizeHour","WindowSize3Hour","WindowSize6Hour","WindowSize12Hour","WindowSizeDay","WindowSizeWeek","WindowSizeMonth"],"x-speakeasy-name-override":"WindowSize"},"expression":{"type":"string","description":"Expression is an optional CEL expression to compute per-event quantity from event.properties.\nWhen set, it replaces Field-based extraction. Property names are used directly (e.g., token * duration * pixel)."},"field":{"type":"string","description":"Field is the key in $event.properties on which the aggregation is to be applied\nFor ex if the aggregation type is sum for API usage, the field could be \"duration_ms\"\nIgnored when Expression is set."},"group_by":{"type":"string","description":"GroupBy is the property name in event.properties to group by before aggregating.\nRequires MAX aggregation. Windowing comes from the price, so this no longer\nimplies a meter-level bucket_size.\nWhen set, aggregation is applied per unique value of this property within each bucket,\nthen the per-group results are summed to produce the bucket total."},"multiplier":{"type":"string","description":"Multiplier is the multiplier for the aggregation\nFor ex if the aggregation type is sum_with_multiplier for API usage, the multiplier could be 1000\nto scale up by a factor of 1000. If not provided, it will be null."},"type":{"type":"string","enum":["COUNT","SUM","AVG","COUNT_UNIQUE","LATEST","SUM_WITH_MULTIPLIER","MAX","WEIGHTED_SUM"],"x-enum-comments":{"AggregationSumWithMultiplier":"Sum with a multiplier - [sum(value) * multiplier]"},"x-enum-varnames":["AggregationCount","AggregationSum","AggregationAvg","AggregationCountUnique","AggregationLatest","AggregationSumWithMultiplier","AggregationMax","AggregationWeightedSum"],"x-speakeasy-name-override":"AggregationType"}}},"created_at":{"type":"string","example":"2024-03-20T15:04:05Z","format":"date-time"},"event_name":{"type":"string","example":"api_request"},"filters":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":"Key is the key for the filter from $event.properties\nCurrently we support only first level keys in the properties and not nested keys"},"values":{"type":"array","description":"Values are the possible values for the filter to be considered for the meter\nFor ex \"model_name\" could have values \"o1-mini\", \"gpt-4o\" etc","items":{"type":"string"}}}}},"id":{"type":"string","example":"550e8400-e29b-41d4-a716-446655440000"},"name":{"type":"string","example":"API Usage Meter"},"reset_usage":{"type":"string","enum":["BILLING_PERIOD","NEVER"],"x-enum-varnames":["ResetUsageBillingPeriod","ResetUsageNever"],"x-speakeasy-name-override":"ResetUsage"},"status":{"type":"string","example":"published"},"tenant_id":{"type":"string","example":"tenant123"},"updated_at":{"type":"string","example":"2024-03-20T15:04:05Z","format":"date-time"}}},"meter_id":{"type":"string"},"name":{"type":"string"},"reporting_unit":{"type":"object","properties":{"conversion_rate":{"type":"number","description":"Multiplier: reporting_unit_value = unit_value * conversion_rate; must be > 0"},"unit_plural":{"type":"string","description":"Display unit label, plural (e.g. \"seconds\")"},"unit_singular":{"type":"string","description":"Display unit label, singular (e.g. \"second\")"}},"x-speakeasy-name-override":"ReportingUnit"},"status":{"type":"string","enum":["published","deleted","archived"],"x-enum-varnames":["StatusPublished","StatusDeleted","StatusArchived"],"x-speakeasy-name-override":"Status"},"tenant_id":{"type":"string"},"type":{"type":"string","enum":["metered","boolean","static","config"],"x-enum-varnames":["FeatureTypeMetered","FeatureTypeBoolean","FeatureTypeStatic","FeatureTypeConfig"],"x-speakeasy-name-override":"FeatureType"},"unit_plural":{"type":"string"},"unit_singular":{"type":"string"},"updated_at":{"type":"string","format":"date-time"},"updated_by":{"type":"string"}}},"feature_id":{"type":"string"},"feature_type":{"type":"string","enum":["metered","boolean","static","config"],"x-enum-varnames":["FeatureTypeMetered","FeatureTypeBoolean","FeatureTypeStatic","FeatureTypeConfig"],"x-speakeasy-name-override":"FeatureType"},"grant_allocation_behavior":{"type":"string","enum":["first_usage","unit_start"],"x-enum-varnames":["EntitlementGrantAllocationBehaviorFirstUsage","EntitlementGrantAllocationBehaviorUnitStart"],"x-speakeasy-name-override":"EntitlementGrantAllocationBehavior"},"grant_duration_unit":{"type":"string","enum":["hour","day","week","subscription_period"],"x-enum-varnames":["EntitlementGrantDurationUnitHour","EntitlementGrantDurationUnitDay","EntitlementGrantDurationUnitWeek","EntitlementGrantDurationUnitSubscriptionPeriod"],"x-speakeasy-name-override":"EntitlementGrantDurationUnit"},"grant_duration_value":{"type":"integer"},"grant_measure":{"type":"string","enum":["quantity","amount"],"x-enum-varnames":["EntitlementGrantMeasureQuantity","EntitlementGrantMeasureAmount"],"x-speakeasy-name-override":"EntitlementGrantMeasure"},"grant_quota":{"type":"string"},"id":{"type":"string"},"is_enabled":{"type":"boolean"},"is_soft_limit":{"type":"boolean"},"parent_entitlement_id":{"type":"string"},"plan":{"type":"object","properties":{"created_at":{"type":"string","format":"date-time"},"created_by":{"type":"string"},"credit_grants":{"type":"array","items":{"type":"object","properties":{"addon_id":{"type":"string"},"cadence":{"type":"string","enum":["ONETIME","RECURRING"],"x-enum-varnames":["CreditGrantCadenceOneTime","CreditGrantCadenceRecurring"],"x-speakeasy-name-override":"CreditGrantCadence"},"conversion_rate":{"type":"string","description":"amount in the currency = number of credits * conversion_rate\nex if conversion_rate is 1, then 1 USD = 1 credit\nex if conversion_rate is 2, then 1 USD = 0.5 credits\nex if conversion_rate is 0.5, then 1 USD = 2 credits"},"created_at":{"type":"string","format":"date-time"},"created_by":{"type":"string"},"credit_grant_anchor":{"type":"string","format":"date-time"},"credits":{"type":"string"},"end_date":{"type":"string","format":"date-time"},"environment_id":{"type":"string"},"expiration_duration":{"type":"integer"},"expiration_duration_unit":{"type":"string","enum":["DAY","WEEK","MONTH","YEAR"],"x-enum-varnames":["CreditGrantExpiryDurationUnitDays","CreditGrantExpiryDurationUnitWeeks","CreditGrantExpiryDurationUnitMonths","CreditGrantExpiryDurationUnitYears"],"x-speakeasy-name-override":"CreditGrantExpiryDurationUnit"},"expiration_type":{"type":"string","enum":["NEVER","DURATION","BILLING_CYCLE"],"x-enum-varnames":["CreditGrantExpiryTypeNever","CreditGrantExpiryTypeDuration","CreditGrantExpiryTypeBillingCycle"],"x-speakeasy-name-override":"CreditGrantExpiryType"},"id":{"type":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string"},"x-speakeasy-name-override":"Metadata"},"name":{"type":"string"},"period":{"type":"string","enum":["DAILY","WEEKLY","MONTHLY","ANNUAL","QUARTERLY","HALF_YEARLY"],"x-enum-varnames":["CREDIT_GRANT_PERIOD_DAILY","CREDIT_GRANT_PERIOD_WEEKLY","CREDIT_GRANT_PERIOD_MONTHLY","CREDIT_GRANT_PERIOD_ANNUAL","CREDIT_GRANT_PERIOD_QUARTER","CREDIT_GRANT_PERIOD_HALF_YEARLY"],"x-speakeasy-name-override":"CreditGrantPeriod"},"period_count":{"type":"integer"},"plan_id":{"type":"string"},"priority":{"type":"integer"},"scope":{"type":"string","enum":["PLAN","SUBSCRIPTION","ADDON"],"x-enum-varnames":["CreditGrantScopePlan","CreditGrantScopeSubscription","CreditGrantScopeAddon"],"x-speakeasy-name-override":"CreditGrantScope"},"start_date":{"type":"string","format":"date-time"},"status":{"type":"string","enum":["published","deleted","archived"],"x-enum-varnames":["StatusPublished","StatusDeleted","StatusArchived"],"x-speakeasy-name-override":"Status"},"subscription_id":{"type":"string"},"tenant_id":{"type":"string"},"topup_conversion_rate":{"type":"string","description":"topup_conversion_rate is the conversion rate for the topup to the currency\nex if topup_conversion_rate is 1, then 1 USD = 1 credit\nex if topup_conversion_rate is 2, then 1 USD = 0.5 credits\nex if topup_conversion_rate is 0.5, then 1 USD = 2 credits"},"updated_at":{"type":"string","format":"date-time"},"updated_by":{"type":"string"}}}},"description":{"type":"string"},"display_order":{"type":"integer"},"entitlements":{"type":"array","items":{"$circularRef":"1c99a94f-ba2d-4aeb-aec5-928f5daeddec"}},"environment_id":{"type":"string"},"id":{"type":"string"},"lookup_key":{"type":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string"},"x-speakeasy-name-override":"Metadata"},"name":{"type":"string"},"price_sync_status":{"type":"object","properties":{"current_sequence":{"type":"integer"},"synced":{"type":"boolean"},"unsynced_subscription_count":{"type":"integer"}}},"prices":{"type":"array","description":"TODO: Add inline addons","items":{"$circularRef":"0dc125d7-6bd8-40a5-8d18-2c0190dcf082"}},"status":{"type":"string","enum":["published","deleted","archived"],"x-enum-varnames":["StatusPublished","StatusDeleted","StatusArchived"],"x-speakeasy-name-override":"Status"},"tenant_id":{"type":"string"},"updated_at":{"type":"string","format":"date-time"},"updated_by":{"type":"string"}}},"plan_id":{"type":"string","description":"TODO: Remove this once we have a proper entitlement entity type"},"start_date":{"type":"string","format":"date-time"},"static_value":{"type":"string"},"status":{"type":"string","enum":["published","deleted","archived"],"x-enum-varnames":["StatusPublished","StatusDeleted","StatusArchived"],"x-speakeasy-name-override":"Status"},"tenant_id":{"type":"string"},"updated_at":{"type":"string","format":"date-time"},"updated_by":{"type":"string"},"usage_limit":{"type":"integer"},"usage_reset_period":{"type":"string","enum":["MONTHLY","ANNUAL","WEEKLY","DAILY","QUARTERLY","HALF_YEARLY","NEVER"],"x-enum-varnames":["ENTITLEMENT_USAGE_RESET_PERIOD_MONTHLY","ENTITLEMENT_USAGE_RESET_PERIOD_ANNUAL","ENTITLEMENT_USAGE_RESET_PERIOD_WEEKLY","ENTITLEMENT_USAGE_RESET_PERIOD_DAILY","ENTITLEMENT_USAGE_RESET_PERIOD_QUARTER","ENTITLEMENT_USAGE_RESET_PERIOD_HALF_YEAR","ENTITLEMENT_USAGE_RESET_PERIOD_NEVER"],"x-speakeasy-name-override":"EntitlementUsageResetPeriod"}}}},"1c99a94f-ba2d-4aeb-aec5-928f5daeddec":{"type":"object","properties":{"addon":{"type":"object","properties":{"created_at":{"type":"string","format":"date-time"},"created_by":{"type":"string"},"credit_grants":{"type":"array","items":{"type":"object","properties":{"addon_id":{"type":"string"},"cadence":{"type":"string","enum":["ONETIME","RECURRING"],"x-enum-varnames":["CreditGrantCadenceOneTime","CreditGrantCadenceRecurring"],"x-speakeasy-name-override":"CreditGrantCadence"},"conversion_rate":{"type":"string","description":"amount in the currency = number of credits * conversion_rate\nex if conversion_rate is 1, then 1 USD = 1 credit\nex if conversion_rate is 2, then 1 USD = 0.5 credits\nex if conversion_rate is 0.5, then 1 USD = 2 credits"},"created_at":{"type":"string","format":"date-time"},"created_by":{"type":"string"},"credit_grant_anchor":{"type":"string","format":"date-time"},"credits":{"type":"string"},"end_date":{"type":"string","format":"date-time"},"environment_id":{"type":"string"},"expiration_duration":{"type":"integer"},"expiration_duration_unit":{"type":"string","enum":["DAY","WEEK","MONTH","YEAR"],"x-enum-varnames":["CreditGrantExpiryDurationUnitDays","CreditGrantExpiryDurationUnitWeeks","CreditGrantExpiryDurationUnitMonths","CreditGrantExpiryDurationUnitYears"],"x-speakeasy-name-override":"CreditGrantExpiryDurationUnit"},"expiration_type":{"type":"string","enum":["NEVER","DURATION","BILLING_CYCLE"],"x-enum-varnames":["CreditGrantExpiryTypeNever","CreditGrantExpiryTypeDuration","CreditGrantExpiryTypeBillingCycle"],"x-speakeasy-name-override":"CreditGrantExpiryType"},"id":{"type":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string"},"x-speakeasy-name-override":"Metadata"},"name":{"type":"string"},"period":{"type":"string","enum":["DAILY","WEEKLY","MONTHLY","ANNUAL","QUARTERLY","HALF_YEARLY"],"x-enum-varnames":["CREDIT_GRANT_PERIOD_DAILY","CREDIT_GRANT_PERIOD_WEEKLY","CREDIT_GRANT_PERIOD_MONTHLY","CREDIT_GRANT_PERIOD_ANNUAL","CREDIT_GRANT_PERIOD_QUARTER","CREDIT_GRANT_PERIOD_HALF_YEARLY"],"x-speakeasy-name-override":"CreditGrantPeriod"},"period_count":{"type":"integer"},"plan_id":{"type":"string"},"priority":{"type":"integer"},"scope":{"type":"string","enum":["PLAN","SUBSCRIPTION","ADDON"],"x-enum-varnames":["CreditGrantScopePlan","CreditGrantScopeSubscription","CreditGrantScopeAddon"],"x-speakeasy-name-override":"CreditGrantScope"},"start_date":{"type":"string","format":"date-time"},"status":{"type":"string","enum":["published","deleted","archived"],"x-enum-varnames":["StatusPublished","StatusDeleted","StatusArchived"],"x-speakeasy-name-override":"Status"},"subscription_id":{"type":"string"},"tenant_id":{"type":"string"},"topup_conversion_rate":{"type":"string","description":"topup_conversion_rate is the conversion rate for the topup to the currency\nex if topup_conversion_rate is 1, then 1 USD = 1 credit\nex if topup_conversion_rate is 2, then 1 USD = 0.5 credits\nex if topup_conversion_rate is 0.5, then 1 USD = 2 credits"},"updated_at":{"type":"string","format":"date-time"},"updated_by":{"type":"string"}}}},"description":{"type":"string"},"entitlements":{"type":"array","items":{"$circularRef":"1c99a94f-ba2d-4aeb-aec5-928f5daeddec"}},"environment_id":{"type":"string"},"id":{"type":"string"},"lookup_key":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"name":{"type":"string"},"price_sync_status":{"type":"object","properties":{"current_sequence":{"type":"integer"},"synced":{"type":"boolean"},"unsynced_association_count":{"type":"integer"}}},"prices":{"type":"array","description":"Optional expanded fields","items":{"type":"object","properties":{"addon":{"oneOf":[{}]},"amount":{"type":"string","description":"Amount stored in main currency units (e.g., dollars, not cents)\nFor USD: 12.50 means $12.50"},"billing_cadence":{"type":"string","enum":["RECURRING"],"x-enum-varnames":["BILLING_CADENCE_RECURRING"],"x-speakeasy-name-override":"BillingCadence"},"billing_model":{"type":"string","enum":["FLAT_FEE","PACKAGE","TIERED"],"x-enum-varnames":["BILLING_MODEL_FLAT_FEE","BILLING_MODEL_PACKAGE","BILLING_MODEL_TIERED"],"x-speakeasy-name-override":"BillingModel"},"billing_period":{"type":"string","enum":["MONTHLY","ANNUAL","WEEKLY","DAILY","QUARTERLY","HALF_YEARLY","ONETIME"],"x-enum-varnames":["BILLING_PERIOD_MONTHLY","BILLING_PERIOD_ANNUAL","BILLING_PERIOD_WEEKLY","BILLING_PERIOD_DAILY","BILLING_PERIOD_QUARTER","BILLING_PERIOD_HALF_YEAR","BILLING_PERIOD_ONETIME"],"x-speakeasy-name-override":"BillingPeriod"},"billing_period_count":{"type":"integer","description":"BillingPeriodCount is the count of the billing period ex 1, 3, 6, 12"},"bucket_size":{"type":"string","enum":["MINUTE","15MIN","30MIN","HOUR","3HOUR","6HOUR","12HOUR","DAY","WEEK","MONTH"],"x-enum-varnames":["WindowSizeMinute","WindowSize15Min","WindowSize30Min","WindowSizeHour","WindowSize3Hour","WindowSize6Hour","WindowSize12Hour","WindowSizeDay","WindowSizeWeek","WindowSizeMonth"],"x-speakeasy-name-override":"WindowSize"},"conversion_rate":{"type":"string","description":"ConversionRate is the conversion rate of the price unit to the fiat currency"},"created_at":{"type":"string","format":"date-time"},"created_by":{"type":"string"},"currency":{"type":"string","description":"Currency 3 digit ISO currency code in lowercase ex usd, eur, gbp"},"description":{"type":"string","description":"Description of the price"},"display_amount":{"type":"string","description":"DisplayAmount is the formatted amount with currency symbol\nFor USD: $12.50"},"display_name":{"type":"string","description":"DisplayName is the name of the price"},"display_price_unit_amount":{"type":"string","description":"DisplayPriceUnitAmount is the formatted amount of the price unit"},"end_date":{"type":"string","description":"EndDate is the end date of the price","format":"date-time"},"entity_id":{"type":"string","description":"EntityID holds the value of the \"entity_id\" field."},"entity_type":{"type":"string","enum":["PLAN","SUBSCRIPTION","ADDON","PRICE","COSTSHEET"],"x-enum-varnames":["PRICE_ENTITY_TYPE_PLAN","PRICE_ENTITY_TYPE_SUBSCRIPTION","PRICE_ENTITY_TYPE_ADDON","PRICE_ENTITY_TYPE_PRICE","PRICE_ENTITY_TYPE_COSTSHEET"],"x-speakeasy-name-override":"PriceEntityType"},"environment_id":{"type":"string","description":"EnvironmentID is the environment identifier for the price"},"feature":{"type":"object","properties":{"reporting_unit":{"type":"object","properties":{"conversion_rate":{"type":"number","description":"Multiplier: reporting_unit_value = unit_value * conversion_rate; must be > 0"},"unit_plural":{"type":"string","description":"Display unit label, plural (e.g. \"seconds\")"},"unit_singular":{"type":"string","description":"Display unit label, singular (e.g. \"second\")"}},"x-speakeasy-name-override":"ReportingUnit"}}},"group":{"type":"object","properties":{"created_at":{"type":"string","format":"date-time"},"entity_ids":{"type":"array","items":{"type":"string"}},"entity_type":{"type":"string"},"id":{"type":"string"},"lookup_key":{"type":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string"}},"name":{"type":"string"},"status":{"type":"string"},"updated_at":{"type":"string","format":"date-time"}}},"group_id":{"type":"string","description":"GroupID references the group this price belongs to"},"id":{"type":"string","description":"ID uuid identifier for the price"},"invoice_cadence":{"type":"string","enum":["ARREAR","ADVANCE"],"x-enum-varnames":["InvoiceCadenceArrear","InvoiceCadenceAdvance"],"x-speakeasy-name-override":"InvoiceCadence"},"lookup_key":{"type":"string","description":"LookupKey used for looking up the price in the database"},"metadata":{"type":"object","additionalProperties":{"type":"string"}},"meter":{"type":"object","properties":{"aggregation":{"type":"object","properties":{"bucket_size":{"type":"string","enum":["MINUTE","15MIN","30MIN","HOUR","3HOUR","6HOUR","12HOUR","DAY","WEEK","MONTH"],"x-enum-varnames":["WindowSizeMinute","WindowSize15Min","WindowSize30Min","WindowSizeHour","WindowSize3Hour","WindowSize6Hour","WindowSize12Hour","WindowSizeDay","WindowSizeWeek","WindowSizeMonth"],"x-speakeasy-name-override":"WindowSize"},"expression":{"type":"string","description":"Expression is an optional CEL expression to compute per-event quantity from event.properties.\nWhen set, it replaces Field-based extraction. Property names are used directly (e.g., token * duration * pixel)."},"field":{"type":"string","description":"Field is the key in $event.properties on which the aggregation is to be applied\nFor ex if the aggregation type is sum for API usage, the field could be \"duration_ms\"\nIgnored when Expression is set."},"group_by":{"type":"string","description":"GroupBy is the property name in event.properties to group by before aggregating.\nRequires MAX aggregation. Windowing comes from the price, so this no longer\nimplies a meter-level bucket_size.\nWhen set, aggregation is applied per unique value of this property within each bucket,\nthen the per-group results are summed to produce the bucket total."},"multiplier":{"type":"string","description":"Multiplier is the multiplier for the aggregation\nFor ex if the aggregation type is sum_with_multiplier for API usage, the multiplier could be 1000\nto scale up by a factor of 1000. If not provided, it will be null."},"type":{"type":"string","enum":["COUNT","SUM","AVG","COUNT_UNIQUE","LATEST","SUM_WITH_MULTIPLIER","MAX","WEIGHTED_SUM"],"x-enum-comments":{"AggregationSumWithMultiplier":"Sum with a multiplier - [sum(value) * multiplier]"},"x-enum-varnames":["AggregationCount","AggregationSum","AggregationAvg","AggregationCountUnique","AggregationLatest","AggregationSumWithMultiplier","AggregationMax","AggregationWeightedSum"],"x-speakeasy-name-override":"AggregationType"}}},"created_at":{"type":"string","example":"2024-03-20T15:04:05Z","format":"date-time"},"event_name":{"type":"string","example":"api_request"},"filters":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":"Key is the key for the filter from $event.properties\nCurrently we support only first level keys in the properties and not nested keys"},"values":{"type":"array","description":"Values are the possible values for the filter to be considered for the meter\nFor ex \"model_name\" could have values \"o1-mini\", \"gpt-4o\" etc","items":{"type":"string"}}}}},"id":{"type":"string","example":"550e8400-e29b-41d4-a716-446655440000"},"name":{"type":"string","example":"API Usage Meter"},"reset_usage":{"type":"string","enum":["BILLING_PERIOD","NEVER"],"x-enum-varnames":["ResetUsageBillingPeriod","ResetUsageNever"],"x-speakeasy-name-override":"ResetUsage"},"status":{"type":"string","example":"published"},"tenant_id":{"type":"string","example":"tenant123"},"updated_at":{"type":"string","example":"2024-03-20T15:04:05Z","format":"date-time"}}},"meter_id":{"type":"string","description":"MeterID is the id of the meter for usage based pricing"},"min_quantity":{"oneOf":[{"type":"string","description":"MinQuantity is the minimum quantity of the price"},{"type":"null","description":"MinQuantity is the minimum quantity of the price"}]},"parent_price_id":{"type":"string","description":"ParentPriceID references the root price (always set for price lineage tracking)"},"plan":{"type":"object","properties":{"created_at":{"type":"string","format":"date-time"},"created_by":{"type":"string"},"credit_grants":{"type":"array","items":{"type":"object","properties":{"addon_id":{"type":"string"},"cadence":{"type":"string","enum":["ONETIME","RECURRING"],"x-enum-varnames":["CreditGrantCadenceOneTime","CreditGrantCadenceRecurring"],"x-speakeasy-name-override":"CreditGrantCadence"},"conversion_rate":{"type":"string","description":"amount in the currency = number of credits * conversion_rate\nex if conversion_rate is 1, then 1 USD = 1 credit\nex if conversion_rate is 2, then 1 USD = 0.5 credits\nex if conversion_rate is 0.5, then 1 USD = 2 credits"},"created_at":{"type":"string","format":"date-time"},"created_by":{"type":"string"},"credit_grant_anchor":{"type":"string","format":"date-time"},"credits":{"type":"string"},"end_date":{"type":"string","format":"date-time"},"environment_id":{"type":"string"},"expiration_duration":{"type":"integer"},"expiration_duration_unit":{"type":"string","enum":["DAY","WEEK","MONTH","YEAR"],"x-enum-varnames":["CreditGrantExpiryDurationUnitDays","CreditGrantExpiryDurationUnitWeeks","CreditGrantExpiryDurationUnitMonths","CreditGrantExpiryDurationUnitYears"],"x-speakeasy-name-override":"CreditGrantExpiryDurationUnit"},"expiration_type":{"type":"string","enum":["NEVER","DURATION","BILLING_CYCLE"],"x-enum-varnames":["CreditGrantExpiryTypeNever","CreditGrantExpiryTypeDuration","CreditGrantExpiryTypeBillingCycle"],"x-speakeasy-name-override":"CreditGrantExpiryType"},"id":{"type":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string"},"x-speakeasy-name-override":"Metadata"},"name":{"type":"string"},"period":{"type":"string","enum":["DAILY","WEEKLY","MONTHLY","ANNUAL","QUARTERLY","HALF_YEARLY"],"x-enum-varnames":["CREDIT_GRANT_PERIOD_DAILY","CREDIT_GRANT_PERIOD_WEEKLY","CREDIT_GRANT_PERIOD_MONTHLY","CREDIT_GRANT_PERIOD_ANNUAL","CREDIT_GRANT_PERIOD_QUARTER","CREDIT_GRANT_PERIOD_HALF_YEARLY"],"x-speakeasy-name-override":"CreditGrantPeriod"},"period_count":{"type":"integer"},"plan_id":{"type":"string"},"priority":{"type":"integer"},"scope":{"type":"string","enum":["PLAN","SUBSCRIPTION","ADDON"],"x-enum-varnames":["CreditGrantScopePlan","CreditGrantScopeSubscription","CreditGrantScopeAddon"],"x-speakeasy-name-override":"CreditGrantScope"},"start_date":{"type":"string","format":"date-time"},"status":{"type":"string","enum":["published","deleted","archived"],"x-enum-varnames":["StatusPublished","StatusDeleted","StatusArchived"],"x-speakeasy-name-override":"Status"},"subscription_id":{"type":"string"},"tenant_id":{"type":"string"},"topup_conversion_rate":{"type":"string","description":"topup_conversion_rate is the conversion rate for the topup to the currency\nex if topup_conversion_rate is 1, then 1 USD = 1 credit\nex if topup_conversion_rate is 2, then 1 USD = 0.5 credits\nex if topup_conversion_rate is 0.5, then 1 USD = 2 credits"},"updated_at":{"type":"string","format":"date-time"},"updated_by":{"type":"string"}}}},"description":{"type":"string"},"display_order":{"type":"integer"},"entitlements":{"type":"array","items":{"$circularRef":"1c99a94f-ba2d-4aeb-aec5-928f5daeddec"}},"environment_id":{"type":"string"},"id":{"type":"string"},"lookup_key":{"type":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string"},"x-speakeasy-name-override":"Metadata"},"name":{"type":"string"},"price_sync_status":{"type":"object","properties":{"current_sequence":{"type":"integer"},"synced":{"type":"boolean"},"unsynced_subscription_count":{"type":"integer"}}},"prices":{"type":"array","description":"TODO: Add inline addons","items":{"$circularRef":"0dc125d7-6bd8-40a5-8d18-2c0190dcf082"}},"status":{"type":"string","enum":["published","deleted","archived"],"x-enum-varnames":["StatusPublished","StatusDeleted","StatusArchived"],"x-speakeasy-name-override":"Status"},"tenant_id":{"type":"string"},"updated_at":{"type":"string","format":"date-time"},"updated_by":{"type":"string"}}},"price_unit":{"type":"string","description":"PriceUnit is the code of the price unit (e.g., 'btc', 'eth')"},"price_unit_amount":{"type":"string","description":"PriceUnitAmount is the amount of the price unit"},"price_unit_id":{"type":"string","description":"PriceUnitID is the id of the price unit (for CUSTOM type)"},"price_unit_tiers":{"type":"array","description":"PriceUnitTiers are the tiers for the price unit when BillingModel is TIERED","items":{"type":"object","properties":{"flat_amount":{"type":"string","description":"flat_amount is the flat amount for the given tier (optional)\nApplied on top of unit_amount*quantity. Useful for cases like \"2.7$ + 5c\""},"unit_amount":{"type":"string","description":"unit_amount is the amount per unit for the given tier"},"up_to":{"type":"integer","description":"up_to is the quantity up to which this tier applies. It is null for the last tier.\nIMPORTANT: Tier boundaries are INCLUSIVE.\n- If up_to is 1000, then quantity less than or equal to 1000 belongs to this tier\n- This behavior is consistent across both VOLUME and SLAB tier modes"}}}},"price_unit_type":{"type":"string","enum":["FIAT","CUSTOM"],"x-enum-varnames":["PRICE_UNIT_TYPE_FIAT","PRICE_UNIT_TYPE_CUSTOM"],"x-speakeasy-name-override":"PriceUnitType"},"pricing_unit":{"type":"object","properties":{"base_currency":{"type":"string"},"code":{"type":"string"},"conversion_rate":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"created_by":{"type":"string"},"environment_id":{"type":"string"},"id":{"type":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string"},"x-speakeasy-name-override":"Metadata"},"name":{"type":"string"},"status":{"type":"string","enum":["published","deleted","archived"],"x-enum-varnames":["StatusPublished","StatusDeleted","StatusArchived"],"x-speakeasy-name-override":"Status"},"symbol":{"type":"string"},"tenant_id":{"type":"string"},"updated_at":{"type":"string","format":"date-time"},"updated_by":{"type":"string"}}},"sequence":{"type":"integer","description":"Sequence is the monotonic stamp bumped on every state change that\nsubscription line items need to react to. Read by the plan-price sync;\nset by the database (DEFAULT nextval) on create and by the price\nrepository on termination / compatibility-affecting edits."},"start_date":{"type":"string","description":"StartDate is the start date of the price","format":"date-time"},"status":{"type":"string","enum":["published","deleted","archived"],"x-enum-varnames":["StatusPublished","StatusDeleted","StatusArchived"],"x-speakeasy-name-override":"Status"},"tenant_id":{"type":"string"},"tier_mode":{"type":"string","enum":["VOLUME","SLAB"],"x-enum-varnames":["BILLING_TIER_VOLUME","BILLING_TIER_SLAB"],"x-speakeasy-name-override":"BillingTier"},"tiers":{"type":"array","items":{"type":"object","properties":{"flat_amount":{"type":"string","description":"flat_amount is the flat amount for the given tier (optional)\nApplied on top of unit_amount*quantity. Useful for cases like \"2.7$ + 5c\""},"unit_amount":{"type":"string","description":"unit_amount is the amount per unit for the given tier"},"up_to":{"type":"integer","description":"up_to is the quantity up to which this tier applies. It is null for the last tier.\nIMPORTANT: Tier boundaries are INCLUSIVE.\n- If up_to is 1000, then quantity less than or equal to 1000 belongs to this tier\n- This behavior is consistent across both VOLUME and SLAB tier modes"}}}},"transform_quantity":{"type":"object","properties":{"divide_by":{"type":"integer","description":"Divide quantity by this number"},"round":{"type":"string","enum":["up","down"],"x-enum-varnames":["ROUND_UP","ROUND_DOWN"],"x-speakeasy-name-override":"RoundType"}}},"trial_period_days":{"type":"integer","description":"TrialPeriodDays is the number of days for the trial period\nNote: This is only applicable for recurring prices (BILLING_CADENCE_RECURRING)"},"type":{"type":"string","enum":["USAGE","FIXED"],"x-enum-varnames":["PRICE_TYPE_USAGE","PRICE_TYPE_FIXED"],"x-speakeasy-name-override":"PriceType"},"updated_at":{"type":"string","format":"date-time"},"updated_by":{"type":"string"}}}},"status":{"type":"string","enum":["published","deleted","archived"],"x-enum-varnames":["StatusPublished","StatusDeleted","StatusArchived"],"x-speakeasy-name-override":"Status"},"tenant_id":{"type":"string"},"updated_at":{"type":"string","format":"date-time"},"updated_by":{"type":"string"}}},"aggregation_mode":{"type":"string","enum":["additive","parallel"],"x-enum-varnames":["EntitlementAggregationModeAdditive","EntitlementAggregationModeParallel"],"x-speakeasy-name-override":"EntitlementAggregationMode"},"config_value":{"type":"object","additionalProperties":true},"created_at":{"type":"string","format":"date-time"},"created_by":{"type":"string"},"display_order":{"type":"integer"},"end_date":{"type":"string","format":"date-time"},"entity_id":{"type":"string"},"entity_type":{"type":"string","enum":["PLAN","SUBSCRIPTION","ADDON"],"x-enum-varnames":["ENTITLEMENT_ENTITY_TYPE_PLAN","ENTITLEMENT_ENTITY_TYPE_SUBSCRIPTION","ENTITLEMENT_ENTITY_TYPE_ADDON"],"x-speakeasy-name-override":"EntitlementEntityType"},"environment_id":{"type":"string"},"feature":{"type":"object","properties":{"alert_settings":{"type":"object","properties":{"alert_enabled":{"type":"boolean"},"alert_threshold_type":{"type":"string","enum":["absolute","percentage"],"x-enum-varnames":["AlertThresholdTypeAbsolute","AlertThresholdTypePercentage"],"x-speakeasy-name-override":"AlertThresholdType"},"critical":{"type":"object","properties":{"condition":{"type":"string","enum":["above","below"],"x-enum-varnames":["AlertConditionAbove","AlertConditionBelow"],"x-speakeasy-name-override":"AlertCondition"},"threshold":{"type":"string"}},"x-speakeasy-name-override":"AlertThreshold"},"info":{"type":"object","properties":{"condition":{"type":"string","enum":["above","below"],"x-enum-varnames":["AlertConditionAbove","AlertConditionBelow"],"x-speakeasy-name-override":"AlertCondition"},"threshold":{"type":"string"}},"x-speakeasy-name-override":"AlertThreshold"},"warning":{"type":"object","properties":{"condition":{"type":"string","enum":["above","below"],"x-enum-varnames":["AlertConditionAbove","AlertConditionBelow"],"x-speakeasy-name-override":"AlertCondition"},"threshold":{"type":"string"}},"x-speakeasy-name-override":"AlertThreshold"}},"x-speakeasy-name-override":"AlertSettings"},"created_at":{"type":"string","format":"date-time"},"created_by":{"type":"string"},"description":{"type":"string"},"environment_id":{"type":"string"},"group":{"type":"object","properties":{"created_at":{"type":"string","format":"date-time"},"entity_ids":{"type":"array","items":{"type":"string"}},"entity_type":{"type":"string"},"id":{"type":"string"},"lookup_key":{"type":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string"}},"name":{"type":"string"},"status":{"type":"string"},"updated_at":{"type":"string","format":"date-time"}}},"group_id":{"type":"string"},"id":{"type":"string"},"lookup_key":{"type":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string"},"x-speakeasy-name-override":"Metadata"},"meter":{"type":"object","properties":{"aggregation":{"type":"object","properties":{"bucket_size":{"type":"string","enum":["MINUTE","15MIN","30MIN","HOUR","3HOUR","6HOUR","12HOUR","DAY","WEEK","MONTH"],"x-enum-varnames":["WindowSizeMinute","WindowSize15Min","WindowSize30Min","WindowSizeHour","WindowSize3Hour","WindowSize6Hour","WindowSize12Hour","WindowSizeDay","WindowSizeWeek","WindowSizeMonth"],"x-speakeasy-name-override":"WindowSize"},"expression":{"type":"string","description":"Expression is an optional CEL expression to compute per-event quantity from event.properties.\nWhen set, it replaces Field-based extraction. Property names are used directly (e.g., token * duration * pixel)."},"field":{"type":"string","description":"Field is the key in $event.properties on which the aggregation is to be applied\nFor ex if the aggregation type is sum for API usage, the field could be \"duration_ms\"\nIgnored when Expression is set."},"group_by":{"type":"string","description":"GroupBy is the property name in event.properties to group by before aggregating.\nRequires MAX aggregation. Windowing comes from the price, so this no longer\nimplies a meter-level bucket_size.\nWhen set, aggregation is applied per unique value of this property within each bucket,\nthen the per-group results are summed to produce the bucket total."},"multiplier":{"type":"string","description":"Multiplier is the multiplier for the aggregation\nFor ex if the aggregation type is sum_with_multiplier for API usage, the multiplier could be 1000\nto scale up by a factor of 1000. If not provided, it will be null."},"type":{"type":"string","enum":["COUNT","SUM","AVG","COUNT_UNIQUE","LATEST","SUM_WITH_MULTIPLIER","MAX","WEIGHTED_SUM"],"x-enum-comments":{"AggregationSumWithMultiplier":"Sum with a multiplier - [sum(value) * multiplier]"},"x-enum-varnames":["AggregationCount","AggregationSum","AggregationAvg","AggregationCountUnique","AggregationLatest","AggregationSumWithMultiplier","AggregationMax","AggregationWeightedSum"],"x-speakeasy-name-override":"AggregationType"}}},"created_at":{"type":"string","example":"2024-03-20T15:04:05Z","format":"date-time"},"event_name":{"type":"string","example":"api_request"},"filters":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":"Key is the key for the filter from $event.properties\nCurrently we support only first level keys in the properties and not nested keys"},"values":{"type":"array","description":"Values are the possible values for the filter to be considered for the meter\nFor ex \"model_name\" could have values \"o1-mini\", \"gpt-4o\" etc","items":{"type":"string"}}}}},"id":{"type":"string","example":"550e8400-e29b-41d4-a716-446655440000"},"name":{"type":"string","example":"API Usage Meter"},"reset_usage":{"type":"string","enum":["BILLING_PERIOD","NEVER"],"x-enum-varnames":["ResetUsageBillingPeriod","ResetUsageNever"],"x-speakeasy-name-override":"ResetUsage"},"status":{"type":"string","example":"published"},"tenant_id":{"type":"string","example":"tenant123"},"updated_at":{"type":"string","example":"2024-03-20T15:04:05Z","format":"date-time"}}},"meter_id":{"type":"string"},"name":{"type":"string"},"reporting_unit":{"type":"object","properties":{"conversion_rate":{"type":"number","description":"Multiplier: reporting_unit_value = unit_value * conversion_rate; must be > 0"},"unit_plural":{"type":"string","description":"Display unit label, plural (e.g. \"seconds\")"},"unit_singular":{"type":"string","description":"Display unit label, singular (e.g. \"second\")"}},"x-speakeasy-name-override":"ReportingUnit"},"status":{"type":"string","enum":["published","deleted","archived"],"x-enum-varnames":["StatusPublished","StatusDeleted","StatusArchived"],"x-speakeasy-name-override":"Status"},"tenant_id":{"type":"string"},"type":{"type":"string","enum":["metered","boolean","static","config"],"x-enum-varnames":["FeatureTypeMetered","FeatureTypeBoolean","FeatureTypeStatic","FeatureTypeConfig"],"x-speakeasy-name-override":"FeatureType"},"unit_plural":{"type":"string"},"unit_singular":{"type":"string"},"updated_at":{"type":"string","format":"date-time"},"updated_by":{"type":"string"}}},"feature_id":{"type":"string"},"feature_type":{"type":"string","enum":["metered","boolean","static","config"],"x-enum-varnames":["FeatureTypeMetered","FeatureTypeBoolean","FeatureTypeStatic","FeatureTypeConfig"],"x-speakeasy-name-override":"FeatureType"},"grant_allocation_behavior":{"type":"string","enum":["first_usage","unit_start"],"x-enum-varnames":["EntitlementGrantAllocationBehaviorFirstUsage","EntitlementGrantAllocationBehaviorUnitStart"],"x-speakeasy-name-override":"EntitlementGrantAllocationBehavior"},"grant_duration_unit":{"type":"string","enum":["hour","day","week","subscription_period"],"x-enum-varnames":["EntitlementGrantDurationUnitHour","EntitlementGrantDurationUnitDay","EntitlementGrantDurationUnitWeek","EntitlementGrantDurationUnitSubscriptionPeriod"],"x-speakeasy-name-override":"EntitlementGrantDurationUnit"},"grant_duration_value":{"type":"integer"},"grant_measure":{"type":"string","enum":["quantity","amount"],"x-enum-varnames":["EntitlementGrantMeasureQuantity","EntitlementGrantMeasureAmount"],"x-speakeasy-name-override":"EntitlementGrantMeasure"},"grant_quota":{"type":"string"},"id":{"type":"string"},"is_enabled":{"type":"boolean"},"is_soft_limit":{"type":"boolean"},"parent_entitlement_id":{"type":"string"},"plan":{"type":"object","properties":{"created_at":{"type":"string","format":"date-time"},"created_by":{"type":"string"},"credit_grants":{"type":"array","items":{"type":"object","properties":{"addon_id":{"type":"string"},"cadence":{"type":"string","enum":["ONETIME","RECURRING"],"x-enum-varnames":["CreditGrantCadenceOneTime","CreditGrantCadenceRecurring"],"x-speakeasy-name-override":"CreditGrantCadence"},"conversion_rate":{"type":"string","description":"amount in the currency = number of credits * conversion_rate\nex if conversion_rate is 1, then 1 USD = 1 credit\nex if conversion_rate is 2, then 1 USD = 0.5 credits\nex if conversion_rate is 0.5, then 1 USD = 2 credits"},"created_at":{"type":"string","format":"date-time"},"created_by":{"type":"string"},"credit_grant_anchor":{"type":"string","format":"date-time"},"credits":{"type":"string"},"end_date":{"type":"string","format":"date-time"},"environment_id":{"type":"string"},"expiration_duration":{"type":"integer"},"expiration_duration_unit":{"type":"string","enum":["DAY","WEEK","MONTH","YEAR"],"x-enum-varnames":["CreditGrantExpiryDurationUnitDays","CreditGrantExpiryDurationUnitWeeks","CreditGrantExpiryDurationUnitMonths","CreditGrantExpiryDurationUnitYears"],"x-speakeasy-name-override":"CreditGrantExpiryDurationUnit"},"expiration_type":{"type":"string","enum":["NEVER","DURATION","BILLING_CYCLE"],"x-enum-varnames":["CreditGrantExpiryTypeNever","CreditGrantExpiryTypeDuration","CreditGrantExpiryTypeBillingCycle"],"x-speakeasy-name-override":"CreditGrantExpiryType"},"id":{"type":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string"},"x-speakeasy-name-override":"Metadata"},"name":{"type":"string"},"period":{"type":"string","enum":["DAILY","WEEKLY","MONTHLY","ANNUAL","QUARTERLY","HALF_YEARLY"],"x-enum-varnames":["CREDIT_GRANT_PERIOD_DAILY","CREDIT_GRANT_PERIOD_WEEKLY","CREDIT_GRANT_PERIOD_MONTHLY","CREDIT_GRANT_PERIOD_ANNUAL","CREDIT_GRANT_PERIOD_QUARTER","CREDIT_GRANT_PERIOD_HALF_YEARLY"],"x-speakeasy-name-override":"CreditGrantPeriod"},"period_count":{"type":"integer"},"plan_id":{"type":"string"},"priority":{"type":"integer"},"scope":{"type":"string","enum":["PLAN","SUBSCRIPTION","ADDON"],"x-enum-varnames":["CreditGrantScopePlan","CreditGrantScopeSubscription","CreditGrantScopeAddon"],"x-speakeasy-name-override":"CreditGrantScope"},"start_date":{"type":"string","format":"date-time"},"status":{"type":"string","enum":["published","deleted","archived"],"x-enum-varnames":["StatusPublished","StatusDeleted","StatusArchived"],"x-speakeasy-name-override":"Status"},"subscription_id":{"type":"string"},"tenant_id":{"type":"string"},"topup_conversion_rate":{"type":"string","description":"topup_conversion_rate is the conversion rate for the topup to the currency\nex if topup_conversion_rate is 1, then 1 USD = 1 credit\nex if topup_conversion_rate is 2, then 1 USD = 0.5 credits\nex if topup_conversion_rate is 0.5, then 1 USD = 2 credits"},"updated_at":{"type":"string","format":"date-time"},"updated_by":{"type":"string"}}}},"description":{"type":"string"},"display_order":{"type":"integer"},"entitlements":{"type":"array","items":{"$circularRef":"1c99a94f-ba2d-4aeb-aec5-928f5daeddec"}},"environment_id":{"type":"string"},"id":{"type":"string"},"lookup_key":{"type":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string"},"x-speakeasy-name-override":"Metadata"},"name":{"type":"string"},"price_sync_status":{"type":"object","properties":{"current_sequence":{"type":"integer"},"synced":{"type":"boolean"},"unsynced_subscription_count":{"type":"integer"}}},"prices":{"type":"array","description":"TODO: Add inline addons","items":{"$circularRef":"0dc125d7-6bd8-40a5-8d18-2c0190dcf082"}},"status":{"type":"string","enum":["published","deleted","archived"],"x-enum-varnames":["StatusPublished","StatusDeleted","StatusArchived"],"x-speakeasy-name-override":"Status"},"tenant_id":{"type":"string"},"updated_at":{"type":"string","format":"date-time"},"updated_by":{"type":"string"}}},"plan_id":{"type":"string","description":"TODO: Remove this once we have a proper entitlement entity type"},"start_date":{"type":"string","format":"date-time"},"static_value":{"type":"string"},"status":{"type":"string","enum":["published","deleted","archived"],"x-enum-varnames":["StatusPublished","StatusDeleted","StatusArchived"],"x-speakeasy-name-override":"Status"},"tenant_id":{"type":"string"},"updated_at":{"type":"string","format":"date-time"},"updated_by":{"type":"string"},"usage_limit":{"type":"integer"},"usage_reset_period":{"type":"string","enum":["MONTHLY","ANNUAL","WEEKLY","DAILY","QUARTERLY","HALF_YEARLY","NEVER"],"x-enum-varnames":["ENTITLEMENT_USAGE_RESET_PERIOD_MONTHLY","ENTITLEMENT_USAGE_RESET_PERIOD_ANNUAL","ENTITLEMENT_USAGE_RESET_PERIOD_WEEKLY","ENTITLEMENT_USAGE_RESET_PERIOD_DAILY","ENTITLEMENT_USAGE_RESET_PERIOD_QUARTER","ENTITLEMENT_USAGE_RESET_PERIOD_HALF_YEAR","ENTITLEMENT_USAGE_RESET_PERIOD_NEVER"],"x-speakeasy-name-override":"EntitlementUsageResetPeriod"}}},"0dc125d7-6bd8-40a5-8d18-2c0190dcf082":{"type":"object","properties":{"addon":{"type":"object","properties":{"created_at":{"type":"string","format":"date-time"},"created_by":{"type":"string"},"credit_grants":{"type":"array","items":{"type":"object","properties":{"addon_id":{"type":"string"},"cadence":{"type":"string","enum":["ONETIME","RECURRING"],"x-enum-varnames":["CreditGrantCadenceOneTime","CreditGrantCadenceRecurring"],"x-speakeasy-name-override":"CreditGrantCadence"},"conversion_rate":{"type":"string","description":"amount in the currency = number of credits * conversion_rate\nex if conversion_rate is 1, then 1 USD = 1 credit\nex if conversion_rate is 2, then 1 USD = 0.5 credits\nex if conversion_rate is 0.5, then 1 USD = 2 credits"},"created_at":{"type":"string","format":"date-time"},"created_by":{"type":"string"},"credit_grant_anchor":{"type":"string","format":"date-time"},"credits":{"type":"string"},"end_date":{"type":"string","format":"date-time"},"environment_id":{"type":"string"},"expiration_duration":{"type":"integer"},"expiration_duration_unit":{"type":"string","enum":["DAY","WEEK","MONTH","YEAR"],"x-enum-varnames":["CreditGrantExpiryDurationUnitDays","CreditGrantExpiryDurationUnitWeeks","CreditGrantExpiryDurationUnitMonths","CreditGrantExpiryDurationUnitYears"],"x-speakeasy-name-override":"CreditGrantExpiryDurationUnit"},"expiration_type":{"type":"string","enum":["NEVER","DURATION","BILLING_CYCLE"],"x-enum-varnames":["CreditGrantExpiryTypeNever","CreditGrantExpiryTypeDuration","CreditGrantExpiryTypeBillingCycle"],"x-speakeasy-name-override":"CreditGrantExpiryType"},"id":{"type":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string"},"x-speakeasy-name-override":"Metadata"},"name":{"type":"string"},"period":{"type":"string","enum":["DAILY","WEEKLY","MONTHLY","ANNUAL","QUARTERLY","HALF_YEARLY"],"x-enum-varnames":["CREDIT_GRANT_PERIOD_DAILY","CREDIT_GRANT_PERIOD_WEEKLY","CREDIT_GRANT_PERIOD_MONTHLY","CREDIT_GRANT_PERIOD_ANNUAL","CREDIT_GRANT_PERIOD_QUARTER","CREDIT_GRANT_PERIOD_HALF_YEARLY"],"x-speakeasy-name-override":"CreditGrantPeriod"},"period_count":{"type":"integer"},"plan_id":{"type":"string"},"priority":{"type":"integer"},"scope":{"type":"string","enum":["PLAN","SUBSCRIPTION","ADDON"],"x-enum-varnames":["CreditGrantScopePlan","CreditGrantScopeSubscription","CreditGrantScopeAddon"],"x-speakeasy-name-override":"CreditGrantScope"},"start_date":{"type":"string","format":"date-time"},"status":{"type":"string","enum":["published","deleted","archived"],"x-enum-varnames":["StatusPublished","StatusDeleted","StatusArchived"],"x-speakeasy-name-override":"Status"},"subscription_id":{"type":"string"},"tenant_id":{"type":"string"},"topup_conversion_rate":{"type":"string","description":"topup_conversion_rate is the conversion rate for the topup to the currency\nex if topup_conversion_rate is 1, then 1 USD = 1 credit\nex if topup_conversion_rate is 2, then 1 USD = 0.5 credits\nex if topup_conversion_rate is 0.5, then 1 USD = 2 credits"},"updated_at":{"type":"string","format":"date-time"},"updated_by":{"type":"string"}}}},"description":{"type":"string"},"entitlements":{"type":"array","items":{"type":"object","properties":{"addon":{"oneOf":[{}]},"aggregation_mode":{"type":"string","enum":["additive","parallel"],"x-enum-varnames":["EntitlementAggregationModeAdditive","EntitlementAggregationModeParallel"],"x-speakeasy-name-override":"EntitlementAggregationMode"},"config_value":{"type":"object","additionalProperties":true},"created_at":{"type":"string","format":"date-time"},"created_by":{"type":"string"},"display_order":{"type":"integer"},"end_date":{"type":"string","format":"date-time"},"entity_id":{"type":"string"},"entity_type":{"type":"string","enum":["PLAN","SUBSCRIPTION","ADDON"],"x-enum-varnames":["ENTITLEMENT_ENTITY_TYPE_PLAN","ENTITLEMENT_ENTITY_TYPE_SUBSCRIPTION","ENTITLEMENT_ENTITY_TYPE_ADDON"],"x-speakeasy-name-override":"EntitlementEntityType"},"environment_id":{"type":"string"},"feature":{"type":"object","properties":{"alert_settings":{"type":"object","properties":{"alert_enabled":{"type":"boolean"},"alert_threshold_type":{"type":"string","enum":["absolute","percentage"],"x-enum-varnames":["AlertThresholdTypeAbsolute","AlertThresholdTypePercentage"],"x-speakeasy-name-override":"AlertThresholdType"},"critical":{"type":"object","properties":{"condition":{"type":"string","enum":["above","below"],"x-enum-varnames":["AlertConditionAbove","AlertConditionBelow"],"x-speakeasy-name-override":"AlertCondition"},"threshold":{"type":"string"}},"x-speakeasy-name-override":"AlertThreshold"},"info":{"type":"object","properties":{"condition":{"type":"string","enum":["above","below"],"x-enum-varnames":["AlertConditionAbove","AlertConditionBelow"],"x-speakeasy-name-override":"AlertCondition"},"threshold":{"type":"string"}},"x-speakeasy-name-override":"AlertThreshold"},"warning":{"type":"object","properties":{"condition":{"type":"string","enum":["above","below"],"x-enum-varnames":["AlertConditionAbove","AlertConditionBelow"],"x-speakeasy-name-override":"AlertCondition"},"threshold":{"type":"string"}},"x-speakeasy-name-override":"AlertThreshold"}},"x-speakeasy-name-override":"AlertSettings"},"created_at":{"type":"string","format":"date-time"},"created_by":{"type":"string"},"description":{"type":"string"},"environment_id":{"type":"string"},"group":{"type":"object","properties":{"created_at":{"type":"string","format":"date-time"},"entity_ids":{"type":"array","items":{"type":"string"}},"entity_type":{"type":"string"},"id":{"type":"string"},"lookup_key":{"type":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string"}},"name":{"type":"string"},"status":{"type":"string"},"updated_at":{"type":"string","format":"date-time"}}},"group_id":{"type":"string"},"id":{"type":"string"},"lookup_key":{"type":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string"},"x-speakeasy-name-override":"Metadata"},"meter":{"type":"object","properties":{"aggregation":{"type":"object","properties":{"bucket_size":{"type":"string","enum":["MINUTE","15MIN","30MIN","HOUR","3HOUR","6HOUR","12HOUR","DAY","WEEK","MONTH"],"x-enum-varnames":["WindowSizeMinute","WindowSize15Min","WindowSize30Min","WindowSizeHour","WindowSize3Hour","WindowSize6Hour","WindowSize12Hour","WindowSizeDay","WindowSizeWeek","WindowSizeMonth"],"x-speakeasy-name-override":"WindowSize"},"expression":{"type":"string","description":"Expression is an optional CEL expression to compute per-event quantity from event.properties.\nWhen set, it replaces Field-based extraction. Property names are used directly (e.g., token * duration * pixel)."},"field":{"type":"string","description":"Field is the key in $event.properties on which the aggregation is to be applied\nFor ex if the aggregation type is sum for API usage, the field could be \"duration_ms\"\nIgnored when Expression is set."},"group_by":{"type":"string","description":"GroupBy is the property name in event.properties to group by before aggregating.\nRequires MAX aggregation. Windowing comes from the price, so this no longer\nimplies a meter-level bucket_size.\nWhen set, aggregation is applied per unique value of this property within each bucket,\nthen the per-group results are summed to produce the bucket total."},"multiplier":{"type":"string","description":"Multiplier is the multiplier for the aggregation\nFor ex if the aggregation type is sum_with_multiplier for API usage, the multiplier could be 1000\nto scale up by a factor of 1000. If not provided, it will be null."},"type":{"type":"string","enum":["COUNT","SUM","AVG","COUNT_UNIQUE","LATEST","SUM_WITH_MULTIPLIER","MAX","WEIGHTED_SUM"],"x-enum-comments":{"AggregationSumWithMultiplier":"Sum with a multiplier - [sum(value) * multiplier]"},"x-enum-varnames":["AggregationCount","AggregationSum","AggregationAvg","AggregationCountUnique","AggregationLatest","AggregationSumWithMultiplier","AggregationMax","AggregationWeightedSum"],"x-speakeasy-name-override":"AggregationType"}}},"created_at":{"type":"string","example":"2024-03-20T15:04:05Z","format":"date-time"},"event_name":{"type":"string","example":"api_request"},"filters":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":"Key is the key for the filter from $event.properties\nCurrently we support only first level keys in the properties and not nested keys"},"values":{"type":"array","description":"Values are the possible values for the filter to be considered for the meter\nFor ex \"model_name\" could have values \"o1-mini\", \"gpt-4o\" etc","items":{"type":"string"}}}}},"id":{"type":"string","example":"550e8400-e29b-41d4-a716-446655440000"},"name":{"type":"string","example":"API Usage Meter"},"reset_usage":{"type":"string","enum":["BILLING_PERIOD","NEVER"],"x-enum-varnames":["ResetUsageBillingPeriod","ResetUsageNever"],"x-speakeasy-name-override":"ResetUsage"},"status":{"type":"string","example":"published"},"tenant_id":{"type":"string","example":"tenant123"},"updated_at":{"type":"string","example":"2024-03-20T15:04:05Z","format":"date-time"}}},"meter_id":{"type":"string"},"name":{"type":"string"},"reporting_unit":{"type":"object","properties":{"conversion_rate":{"type":"number","description":"Multiplier: reporting_unit_value = unit_value * conversion_rate; must be > 0"},"unit_plural":{"type":"string","description":"Display unit label, plural (e.g. \"seconds\")"},"unit_singular":{"type":"string","description":"Display unit label, singular (e.g. \"second\")"}},"x-speakeasy-name-override":"ReportingUnit"},"status":{"type":"string","enum":["published","deleted","archived"],"x-enum-varnames":["StatusPublished","StatusDeleted","StatusArchived"],"x-speakeasy-name-override":"Status"},"tenant_id":{"type":"string"},"type":{"type":"string","enum":["metered","boolean","static","config"],"x-enum-varnames":["FeatureTypeMetered","FeatureTypeBoolean","FeatureTypeStatic","FeatureTypeConfig"],"x-speakeasy-name-override":"FeatureType"},"unit_plural":{"type":"string"},"unit_singular":{"type":"string"},"updated_at":{"type":"string","format":"date-time"},"updated_by":{"type":"string"}}},"feature_id":{"type":"string"},"feature_type":{"type":"string","enum":["metered","boolean","static","config"],"x-enum-varnames":["FeatureTypeMetered","FeatureTypeBoolean","FeatureTypeStatic","FeatureTypeConfig"],"x-speakeasy-name-override":"FeatureType"},"grant_allocation_behavior":{"type":"string","enum":["first_usage","unit_start"],"x-enum-varnames":["EntitlementGrantAllocationBehaviorFirstUsage","EntitlementGrantAllocationBehaviorUnitStart"],"x-speakeasy-name-override":"EntitlementGrantAllocationBehavior"},"grant_duration_unit":{"type":"string","enum":["hour","day","week","subscription_period"],"x-enum-varnames":["EntitlementGrantDurationUnitHour","EntitlementGrantDurationUnitDay","EntitlementGrantDurationUnitWeek","EntitlementGrantDurationUnitSubscriptionPeriod"],"x-speakeasy-name-override":"EntitlementGrantDurationUnit"},"grant_duration_value":{"type":"integer"},"grant_measure":{"type":"string","enum":["quantity","amount"],"x-enum-varnames":["EntitlementGrantMeasureQuantity","EntitlementGrantMeasureAmount"],"x-speakeasy-name-override":"EntitlementGrantMeasure"},"grant_quota":{"type":"string"},"id":{"type":"string"},"is_enabled":{"type":"boolean"},"is_soft_limit":{"type":"boolean"},"parent_entitlement_id":{"type":"string"},"plan":{"type":"object","properties":{"created_at":{"type":"string","format":"date-time"},"created_by":{"type":"string"},"credit_grants":{"type":"array","items":{"type":"object","properties":{"addon_id":{"type":"string"},"cadence":{"type":"string","enum":["ONETIME","RECURRING"],"x-enum-varnames":["CreditGrantCadenceOneTime","CreditGrantCadenceRecurring"],"x-speakeasy-name-override":"CreditGrantCadence"},"conversion_rate":{"type":"string","description":"amount in the currency = number of credits * conversion_rate\nex if conversion_rate is 1, then 1 USD = 1 credit\nex if conversion_rate is 2, then 1 USD = 0.5 credits\nex if conversion_rate is 0.5, then 1 USD = 2 credits"},"created_at":{"type":"string","format":"date-time"},"created_by":{"type":"string"},"credit_grant_anchor":{"type":"string","format":"date-time"},"credits":{"type":"string"},"end_date":{"type":"string","format":"date-time"},"environment_id":{"type":"string"},"expiration_duration":{"type":"integer"},"expiration_duration_unit":{"type":"string","enum":["DAY","WEEK","MONTH","YEAR"],"x-enum-varnames":["CreditGrantExpiryDurationUnitDays","CreditGrantExpiryDurationUnitWeeks","CreditGrantExpiryDurationUnitMonths","CreditGrantExpiryDurationUnitYears"],"x-speakeasy-name-override":"CreditGrantExpiryDurationUnit"},"expiration_type":{"type":"string","enum":["NEVER","DURATION","BILLING_CYCLE"],"x-enum-varnames":["CreditGrantExpiryTypeNever","CreditGrantExpiryTypeDuration","CreditGrantExpiryTypeBillingCycle"],"x-speakeasy-name-override":"CreditGrantExpiryType"},"id":{"type":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string"},"x-speakeasy-name-override":"Metadata"},"name":{"type":"string"},"period":{"type":"string","enum":["DAILY","WEEKLY","MONTHLY","ANNUAL","QUARTERLY","HALF_YEARLY"],"x-enum-varnames":["CREDIT_GRANT_PERIOD_DAILY","CREDIT_GRANT_PERIOD_WEEKLY","CREDIT_GRANT_PERIOD_MONTHLY","CREDIT_GRANT_PERIOD_ANNUAL","CREDIT_GRANT_PERIOD_QUARTER","CREDIT_GRANT_PERIOD_HALF_YEARLY"],"x-speakeasy-name-override":"CreditGrantPeriod"},"period_count":{"type":"integer"},"plan_id":{"type":"string"},"priority":{"type":"integer"},"scope":{"type":"string","enum":["PLAN","SUBSCRIPTION","ADDON"],"x-enum-varnames":["CreditGrantScopePlan","CreditGrantScopeSubscription","CreditGrantScopeAddon"],"x-speakeasy-name-override":"CreditGrantScope"},"start_date":{"type":"string","format":"date-time"},"status":{"type":"string","enum":["published","deleted","archived"],"x-enum-varnames":["StatusPublished","StatusDeleted","StatusArchived"],"x-speakeasy-name-override":"Status"},"subscription_id":{"type":"string"},"tenant_id":{"type":"string"},"topup_conversion_rate":{"type":"string","description":"topup_conversion_rate is the conversion rate for the topup to the currency\nex if topup_conversion_rate is 1, then 1 USD = 1 credit\nex if topup_conversion_rate is 2, then 1 USD = 0.5 credits\nex if topup_conversion_rate is 0.5, then 1 USD = 2 credits"},"updated_at":{"type":"string","format":"date-time"},"updated_by":{"type":"string"}}}},"description":{"type":"string"},"display_order":{"type":"integer"},"entitlements":{"type":"array","items":{"$circularRef":"1c99a94f-ba2d-4aeb-aec5-928f5daeddec"}},"environment_id":{"type":"string"},"id":{"type":"string"},"lookup_key":{"type":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string"},"x-speakeasy-name-override":"Metadata"},"name":{"type":"string"},"price_sync_status":{"type":"object","properties":{"current_sequence":{"type":"integer"},"synced":{"type":"boolean"},"unsynced_subscription_count":{"type":"integer"}}},"prices":{"type":"array","description":"TODO: Add inline addons","items":{"$circularRef":"0dc125d7-6bd8-40a5-8d18-2c0190dcf082"}},"status":{"type":"string","enum":["published","deleted","archived"],"x-enum-varnames":["StatusPublished","StatusDeleted","StatusArchived"],"x-speakeasy-name-override":"Status"},"tenant_id":{"type":"string"},"updated_at":{"type":"string","format":"date-time"},"updated_by":{"type":"string"}}},"plan_id":{"type":"string","description":"TODO: Remove this once we have a proper entitlement entity type"},"start_date":{"type":"string","format":"date-time"},"static_value":{"type":"string"},"status":{"type":"string","enum":["published","deleted","archived"],"x-enum-varnames":["StatusPublished","StatusDeleted","StatusArchived"],"x-speakeasy-name-override":"Status"},"tenant_id":{"type":"string"},"updated_at":{"type":"string","format":"date-time"},"updated_by":{"type":"string"},"usage_limit":{"type":"integer"},"usage_reset_period":{"type":"string","enum":["MONTHLY","ANNUAL","WEEKLY","DAILY","QUARTERLY","HALF_YEARLY","NEVER"],"x-enum-varnames":["ENTITLEMENT_USAGE_RESET_PERIOD_MONTHLY","ENTITLEMENT_USAGE_RESET_PERIOD_ANNUAL","ENTITLEMENT_USAGE_RESET_PERIOD_WEEKLY","ENTITLEMENT_USAGE_RESET_PERIOD_DAILY","ENTITLEMENT_USAGE_RESET_PERIOD_QUARTER","ENTITLEMENT_USAGE_RESET_PERIOD_HALF_YEAR","ENTITLEMENT_USAGE_RESET_PERIOD_NEVER"],"x-speakeasy-name-override":"EntitlementUsageResetPeriod"}}}},"environment_id":{"type":"string"},"id":{"type":"string"},"lookup_key":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"name":{"type":"string"},"price_sync_status":{"type":"object","properties":{"current_sequence":{"type":"integer"},"synced":{"type":"boolean"},"unsynced_association_count":{"type":"integer"}}},"prices":{"type":"array","description":"Optional expanded fields","items":{"$circularRef":"0dc125d7-6bd8-40a5-8d18-2c0190dcf082"}},"status":{"type":"string","enum":["published","deleted","archived"],"x-enum-varnames":["StatusPublished","StatusDeleted","StatusArchived"],"x-speakeasy-name-override":"Status"},"tenant_id":{"type":"string"},"updated_at":{"type":"string","format":"date-time"},"updated_by":{"type":"string"}}},"amount":{"type":"string","description":"Amount stored in main currency units (e.g., dollars, not cents)\nFor USD: 12.50 means $12.50"},"billing_cadence":{"type":"string","enum":["RECURRING"],"x-enum-varnames":["BILLING_CADENCE_RECURRING"],"x-speakeasy-name-override":"BillingCadence"},"billing_model":{"type":"string","enum":["FLAT_FEE","PACKAGE","TIERED"],"x-enum-varnames":["BILLING_MODEL_FLAT_FEE","BILLING_MODEL_PACKAGE","BILLING_MODEL_TIERED"],"x-speakeasy-name-override":"BillingModel"},"billing_period":{"type":"string","enum":["MONTHLY","ANNUAL","WEEKLY","DAILY","QUARTERLY","HALF_YEARLY","ONETIME"],"x-enum-varnames":["BILLING_PERIOD_MONTHLY","BILLING_PERIOD_ANNUAL","BILLING_PERIOD_WEEKLY","BILLING_PERIOD_DAILY","BILLING_PERIOD_QUARTER","BILLING_PERIOD_HALF_YEAR","BILLING_PERIOD_ONETIME"],"x-speakeasy-name-override":"BillingPeriod"},"billing_period_count":{"type":"integer","description":"BillingPeriodCount is the count of the billing period ex 1, 3, 6, 12"},"bucket_size":{"type":"string","enum":["MINUTE","15MIN","30MIN","HOUR","3HOUR","6HOUR","12HOUR","DAY","WEEK","MONTH"],"x-enum-varnames":["WindowSizeMinute","WindowSize15Min","WindowSize30Min","WindowSizeHour","WindowSize3Hour","WindowSize6Hour","WindowSize12Hour","WindowSizeDay","WindowSizeWeek","WindowSizeMonth"],"x-speakeasy-name-override":"WindowSize"},"conversion_rate":{"type":"string","description":"ConversionRate is the conversion rate of the price unit to the fiat currency"},"created_at":{"type":"string","format":"date-time"},"created_by":{"type":"string"},"currency":{"type":"string","description":"Currency 3 digit ISO currency code in lowercase ex usd, eur, gbp"},"description":{"type":"string","description":"Description of the price"},"display_amount":{"type":"string","description":"DisplayAmount is the formatted amount with currency symbol\nFor USD: $12.50"},"display_name":{"type":"string","description":"DisplayName is the name of the price"},"display_price_unit_amount":{"type":"string","description":"DisplayPriceUnitAmount is the formatted amount of the price unit"},"end_date":{"type":"string","description":"EndDate is the end date of the price","format":"date-time"},"entity_id":{"type":"string","description":"EntityID holds the value of the \"entity_id\" field."},"entity_type":{"type":"string","enum":["PLAN","SUBSCRIPTION","ADDON","PRICE","COSTSHEET"],"x-enum-varnames":["PRICE_ENTITY_TYPE_PLAN","PRICE_ENTITY_TYPE_SUBSCRIPTION","PRICE_ENTITY_TYPE_ADDON","PRICE_ENTITY_TYPE_PRICE","PRICE_ENTITY_TYPE_COSTSHEET"],"x-speakeasy-name-override":"PriceEntityType"},"environment_id":{"type":"string","description":"EnvironmentID is the environment identifier for the price"},"feature":{"type":"object","properties":{"reporting_unit":{"type":"object","properties":{"conversion_rate":{"type":"number","description":"Multiplier: reporting_unit_value = unit_value * conversion_rate; must be > 0"},"unit_plural":{"type":"string","description":"Display unit label, plural (e.g. \"seconds\")"},"unit_singular":{"type":"string","description":"Display unit label, singular (e.g. \"second\")"}},"x-speakeasy-name-override":"ReportingUnit"}}},"group":{"type":"object","properties":{"created_at":{"type":"string","format":"date-time"},"entity_ids":{"type":"array","items":{"type":"string"}},"entity_type":{"type":"string"},"id":{"type":"string"},"lookup_key":{"type":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string"}},"name":{"type":"string"},"status":{"type":"string"},"updated_at":{"type":"string","format":"date-time"}}},"group_id":{"type":"string","description":"GroupID references the group this price belongs to"},"id":{"type":"string","description":"ID uuid identifier for the price"},"invoice_cadence":{"type":"string","enum":["ARREAR","ADVANCE"],"x-enum-varnames":["InvoiceCadenceArrear","InvoiceCadenceAdvance"],"x-speakeasy-name-override":"InvoiceCadence"},"lookup_key":{"type":"string","description":"LookupKey used for looking up the price in the database"},"metadata":{"type":"object","additionalProperties":{"type":"string"}},"meter":{"type":"object","properties":{"aggregation":{"type":"object","properties":{"bucket_size":{"type":"string","enum":["MINUTE","15MIN","30MIN","HOUR","3HOUR","6HOUR","12HOUR","DAY","WEEK","MONTH"],"x-enum-varnames":["WindowSizeMinute","WindowSize15Min","WindowSize30Min","WindowSizeHour","WindowSize3Hour","WindowSize6Hour","WindowSize12Hour","WindowSizeDay","WindowSizeWeek","WindowSizeMonth"],"x-speakeasy-name-override":"WindowSize"},"expression":{"type":"string","description":"Expression is an optional CEL expression to compute per-event quantity from event.properties.\nWhen set, it replaces Field-based extraction. Property names are used directly (e.g., token * duration * pixel)."},"field":{"type":"string","description":"Field is the key in $event.properties on which the aggregation is to be applied\nFor ex if the aggregation type is sum for API usage, the field could be \"duration_ms\"\nIgnored when Expression is set."},"group_by":{"type":"string","description":"GroupBy is the property name in event.properties to group by before aggregating.\nRequires MAX aggregation. Windowing comes from the price, so this no longer\nimplies a meter-level bucket_size.\nWhen set, aggregation is applied per unique value of this property within each bucket,\nthen the per-group results are summed to produce the bucket total."},"multiplier":{"type":"string","description":"Multiplier is the multiplier for the aggregation\nFor ex if the aggregation type is sum_with_multiplier for API usage, the multiplier could be 1000\nto scale up by a factor of 1000. If not provided, it will be null."},"type":{"type":"string","enum":["COUNT","SUM","AVG","COUNT_UNIQUE","LATEST","SUM_WITH_MULTIPLIER","MAX","WEIGHTED_SUM"],"x-enum-comments":{"AggregationSumWithMultiplier":"Sum with a multiplier - [sum(value) * multiplier]"},"x-enum-varnames":["AggregationCount","AggregationSum","AggregationAvg","AggregationCountUnique","AggregationLatest","AggregationSumWithMultiplier","AggregationMax","AggregationWeightedSum"],"x-speakeasy-name-override":"AggregationType"}}},"created_at":{"type":"string","example":"2024-03-20T15:04:05Z","format":"date-time"},"event_name":{"type":"string","example":"api_request"},"filters":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":"Key is the key for the filter from $event.properties\nCurrently we support only first level keys in the properties and not nested keys"},"values":{"type":"array","description":"Values are the possible values for the filter to be considered for the meter\nFor ex \"model_name\" could have values \"o1-mini\", \"gpt-4o\" etc","items":{"type":"string"}}}}},"id":{"type":"string","example":"550e8400-e29b-41d4-a716-446655440000"},"name":{"type":"string","example":"API Usage Meter"},"reset_usage":{"type":"string","enum":["BILLING_PERIOD","NEVER"],"x-enum-varnames":["ResetUsageBillingPeriod","ResetUsageNever"],"x-speakeasy-name-override":"ResetUsage"},"status":{"type":"string","example":"published"},"tenant_id":{"type":"string","example":"tenant123"},"updated_at":{"type":"string","example":"2024-03-20T15:04:05Z","format":"date-time"}}},"meter_id":{"type":"string","description":"MeterID is the id of the meter for usage based pricing"},"min_quantity":{"oneOf":[{"type":"string","description":"MinQuantity is the minimum quantity of the price"},{"type":"null","description":"MinQuantity is the minimum quantity of the price"}]},"parent_price_id":{"type":"string","description":"ParentPriceID references the root price (always set for price lineage tracking)"},"plan":{"type":"object","properties":{"created_at":{"type":"string","format":"date-time"},"created_by":{"type":"string"},"credit_grants":{"type":"array","items":{"type":"object","properties":{"addon_id":{"type":"string"},"cadence":{"type":"string","enum":["ONETIME","RECURRING"],"x-enum-varnames":["CreditGrantCadenceOneTime","CreditGrantCadenceRecurring"],"x-speakeasy-name-override":"CreditGrantCadence"},"conversion_rate":{"type":"string","description":"amount in the currency = number of credits * conversion_rate\nex if conversion_rate is 1, then 1 USD = 1 credit\nex if conversion_rate is 2, then 1 USD = 0.5 credits\nex if conversion_rate is 0.5, then 1 USD = 2 credits"},"created_at":{"type":"string","format":"date-time"},"created_by":{"type":"string"},"credit_grant_anchor":{"type":"string","format":"date-time"},"credits":{"type":"string"},"end_date":{"type":"string","format":"date-time"},"environment_id":{"type":"string"},"expiration_duration":{"type":"integer"},"expiration_duration_unit":{"type":"string","enum":["DAY","WEEK","MONTH","YEAR"],"x-enum-varnames":["CreditGrantExpiryDurationUnitDays","CreditGrantExpiryDurationUnitWeeks","CreditGrantExpiryDurationUnitMonths","CreditGrantExpiryDurationUnitYears"],"x-speakeasy-name-override":"CreditGrantExpiryDurationUnit"},"expiration_type":{"type":"string","enum":["NEVER","DURATION","BILLING_CYCLE"],"x-enum-varnames":["CreditGrantExpiryTypeNever","CreditGrantExpiryTypeDuration","CreditGrantExpiryTypeBillingCycle"],"x-speakeasy-name-override":"CreditGrantExpiryType"},"id":{"type":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string"},"x-speakeasy-name-override":"Metadata"},"name":{"type":"string"},"period":{"type":"string","enum":["DAILY","WEEKLY","MONTHLY","ANNUAL","QUARTERLY","HALF_YEARLY"],"x-enum-varnames":["CREDIT_GRANT_PERIOD_DAILY","CREDIT_GRANT_PERIOD_WEEKLY","CREDIT_GRANT_PERIOD_MONTHLY","CREDIT_GRANT_PERIOD_ANNUAL","CREDIT_GRANT_PERIOD_QUARTER","CREDIT_GRANT_PERIOD_HALF_YEARLY"],"x-speakeasy-name-override":"CreditGrantPeriod"},"period_count":{"type":"integer"},"plan_id":{"type":"string"},"priority":{"type":"integer"},"scope":{"type":"string","enum":["PLAN","SUBSCRIPTION","ADDON"],"x-enum-varnames":["CreditGrantScopePlan","CreditGrantScopeSubscription","CreditGrantScopeAddon"],"x-speakeasy-name-override":"CreditGrantScope"},"start_date":{"type":"string","format":"date-time"},"status":{"type":"string","enum":["published","deleted","archived"],"x-enum-varnames":["StatusPublished","StatusDeleted","StatusArchived"],"x-speakeasy-name-override":"Status"},"subscription_id":{"type":"string"},"tenant_id":{"type":"string"},"topup_conversion_rate":{"type":"string","description":"topup_conversion_rate is the conversion rate for the topup to the currency\nex if topup_conversion_rate is 1, then 1 USD = 1 credit\nex if topup_conversion_rate is 2, then 1 USD = 0.5 credits\nex if topup_conversion_rate is 0.5, then 1 USD = 2 credits"},"updated_at":{"type":"string","format":"date-time"},"updated_by":{"type":"string"}}}},"description":{"type":"string"},"display_order":{"type":"integer"},"entitlements":{"type":"array","items":{"$circularRef":"1c99a94f-ba2d-4aeb-aec5-928f5daeddec"}},"environment_id":{"type":"string"},"id":{"type":"string"},"lookup_key":{"type":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string"},"x-speakeasy-name-override":"Metadata"},"name":{"type":"string"},"price_sync_status":{"type":"object","properties":{"current_sequence":{"type":"integer"},"synced":{"type":"boolean"},"unsynced_subscription_count":{"type":"integer"}}},"prices":{"type":"array","description":"TODO: Add inline addons","items":{"$circularRef":"0dc125d7-6bd8-40a5-8d18-2c0190dcf082"}},"status":{"type":"string","enum":["published","deleted","archived"],"x-enum-varnames":["StatusPublished","StatusDeleted","StatusArchived"],"x-speakeasy-name-override":"Status"},"tenant_id":{"type":"string"},"updated_at":{"type":"string","format":"date-time"},"updated_by":{"type":"string"}}},"price_unit":{"type":"string","description":"PriceUnit is the code of the price unit (e.g., 'btc', 'eth')"},"price_unit_amount":{"type":"string","description":"PriceUnitAmount is the amount of the price unit"},"price_unit_id":{"type":"string","description":"PriceUnitID is the id of the price unit (for CUSTOM type)"},"price_unit_tiers":{"type":"array","description":"PriceUnitTiers are the tiers for the price unit when BillingModel is TIERED","items":{"type":"object","properties":{"flat_amount":{"type":"string","description":"flat_amount is the flat amount for the given tier (optional)\nApplied on top of unit_amount*quantity. Useful for cases like \"2.7$ + 5c\""},"unit_amount":{"type":"string","description":"unit_amount is the amount per unit for the given tier"},"up_to":{"type":"integer","description":"up_to is the quantity up to which this tier applies. It is null for the last tier.\nIMPORTANT: Tier boundaries are INCLUSIVE.\n- If up_to is 1000, then quantity less than or equal to 1000 belongs to this tier\n- This behavior is consistent across both VOLUME and SLAB tier modes"}}}},"price_unit_type":{"type":"string","enum":["FIAT","CUSTOM"],"x-enum-varnames":["PRICE_UNIT_TYPE_FIAT","PRICE_UNIT_TYPE_CUSTOM"],"x-speakeasy-name-override":"PriceUnitType"},"pricing_unit":{"type":"object","properties":{"base_currency":{"type":"string"},"code":{"type":"string"},"conversion_rate":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"created_by":{"type":"string"},"environment_id":{"type":"string"},"id":{"type":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string"},"x-speakeasy-name-override":"Metadata"},"name":{"type":"string"},"status":{"type":"string","enum":["published","deleted","archived"],"x-enum-varnames":["StatusPublished","StatusDeleted","StatusArchived"],"x-speakeasy-name-override":"Status"},"symbol":{"type":"string"},"tenant_id":{"type":"string"},"updated_at":{"type":"string","format":"date-time"},"updated_by":{"type":"string"}}},"sequence":{"type":"integer","description":"Sequence is the monotonic stamp bumped on every state change that\nsubscription line items need to react to. Read by the plan-price sync;\nset by the database (DEFAULT nextval) on create and by the price\nrepository on termination / compatibility-affecting edits."},"start_date":{"type":"string","description":"StartDate is the start date of the price","format":"date-time"},"status":{"type":"string","enum":["published","deleted","archived"],"x-enum-varnames":["StatusPublished","StatusDeleted","StatusArchived"],"x-speakeasy-name-override":"Status"},"tenant_id":{"type":"string"},"tier_mode":{"type":"string","enum":["VOLUME","SLAB"],"x-enum-varnames":["BILLING_TIER_VOLUME","BILLING_TIER_SLAB"],"x-speakeasy-name-override":"BillingTier"},"tiers":{"type":"array","items":{"type":"object","properties":{"flat_amount":{"type":"string","description":"flat_amount is the flat amount for the given tier (optional)\nApplied on top of unit_amount*quantity. Useful for cases like \"2.7$ + 5c\""},"unit_amount":{"type":"string","description":"unit_amount is the amount per unit for the given tier"},"up_to":{"type":"integer","description":"up_to is the quantity up to which this tier applies. It is null for the last tier.\nIMPORTANT: Tier boundaries are INCLUSIVE.\n- If up_to is 1000, then quantity less than or equal to 1000 belongs to this tier\n- This behavior is consistent across both VOLUME and SLAB tier modes"}}}},"transform_quantity":{"type":"object","properties":{"divide_by":{"type":"integer","description":"Divide quantity by this number"},"round":{"type":"string","enum":["up","down"],"x-enum-varnames":["ROUND_UP","ROUND_DOWN"],"x-speakeasy-name-override":"RoundType"}}},"trial_period_days":{"type":"integer","description":"TrialPeriodDays is the number of days for the trial period\nNote: This is only applicable for recurring prices (BILLING_CADENCE_RECURRING)"},"type":{"type":"string","enum":["USAGE","FIXED"],"x-enum-varnames":["PRICE_TYPE_USAGE","PRICE_TYPE_FIXED"],"x-speakeasy-name-override":"PriceType"},"updated_at":{"type":"string","format":"date-time"},"updated_by":{"type":"string"}}},"6c04a6f7-e9a8-4aa6-bb72-c876420f4348":{"type":"object","properties":{"created_at":{"type":"string","format":"date-time"},"created_by":{"type":"string"},"credit_grants":{"type":"array","items":{"type":"object","properties":{"addon_id":{"type":"string"},"cadence":{"type":"string","enum":["ONETIME","RECURRING"],"x-enum-varnames":["CreditGrantCadenceOneTime","CreditGrantCadenceRecurring"],"x-speakeasy-name-override":"CreditGrantCadence"},"conversion_rate":{"type":"string","description":"amount in the currency = number of credits * conversion_rate\nex if conversion_rate is 1, then 1 USD = 1 credit\nex if conversion_rate is 2, then 1 USD = 0.5 credits\nex if conversion_rate is 0.5, then 1 USD = 2 credits"},"created_at":{"type":"string","format":"date-time"},"created_by":{"type":"string"},"credit_grant_anchor":{"type":"string","format":"date-time"},"credits":{"type":"string"},"end_date":{"type":"string","format":"date-time"},"environment_id":{"type":"string"},"expiration_duration":{"type":"integer"},"expiration_duration_unit":{"type":"string","enum":["DAY","WEEK","MONTH","YEAR"],"x-enum-varnames":["CreditGrantExpiryDurationUnitDays","CreditGrantExpiryDurationUnitWeeks","CreditGrantExpiryDurationUnitMonths","CreditGrantExpiryDurationUnitYears"],"x-speakeasy-name-override":"CreditGrantExpiryDurationUnit"},"expiration_type":{"type":"string","enum":["NEVER","DURATION","BILLING_CYCLE"],"x-enum-varnames":["CreditGrantExpiryTypeNever","CreditGrantExpiryTypeDuration","CreditGrantExpiryTypeBillingCycle"],"x-speakeasy-name-override":"CreditGrantExpiryType"},"id":{"type":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string"},"x-speakeasy-name-override":"Metadata"},"name":{"type":"string"},"period":{"type":"string","enum":["DAILY","WEEKLY","MONTHLY","ANNUAL","QUARTERLY","HALF_YEARLY"],"x-enum-varnames":["CREDIT_GRANT_PERIOD_DAILY","CREDIT_GRANT_PERIOD_WEEKLY","CREDIT_GRANT_PERIOD_MONTHLY","CREDIT_GRANT_PERIOD_ANNUAL","CREDIT_GRANT_PERIOD_QUARTER","CREDIT_GRANT_PERIOD_HALF_YEARLY"],"x-speakeasy-name-override":"CreditGrantPeriod"},"period_count":{"type":"integer"},"plan_id":{"type":"string"},"priority":{"type":"integer"},"scope":{"type":"string","enum":["PLAN","SUBSCRIPTION","ADDON"],"x-enum-varnames":["CreditGrantScopePlan","CreditGrantScopeSubscription","CreditGrantScopeAddon"],"x-speakeasy-name-override":"CreditGrantScope"},"start_date":{"type":"string","format":"date-time"},"status":{"type":"string","enum":["published","deleted","archived"],"x-enum-varnames":["StatusPublished","StatusDeleted","StatusArchived"],"x-speakeasy-name-override":"Status"},"subscription_id":{"type":"string"},"tenant_id":{"type":"string"},"topup_conversion_rate":{"type":"string","description":"topup_conversion_rate is the conversion rate for the topup to the currency\nex if topup_conversion_rate is 1, then 1 USD = 1 credit\nex if topup_conversion_rate is 2, then 1 USD = 0.5 credits\nex if topup_conversion_rate is 0.5, then 1 USD = 2 credits"},"updated_at":{"type":"string","format":"date-time"},"updated_by":{"type":"string"}}}},"description":{"type":"string"},"entitlements":{"type":"array","items":{"type":"object","properties":{"addon":{"oneOf":[{}]},"aggregation_mode":{"type":"string","enum":["additive","parallel"],"x-enum-varnames":["EntitlementAggregationModeAdditive","EntitlementAggregationModeParallel"],"x-speakeasy-name-override":"EntitlementAggregationMode"},"config_value":{"type":"object","additionalProperties":true},"created_at":{"type":"string","format":"date-time"},"created_by":{"type":"string"},"display_order":{"type":"integer"},"end_date":{"type":"string","format":"date-time"},"entity_id":{"type":"string"},"entity_type":{"type":"string","enum":["PLAN","SUBSCRIPTION","ADDON"],"x-enum-varnames":["ENTITLEMENT_ENTITY_TYPE_PLAN","ENTITLEMENT_ENTITY_TYPE_SUBSCRIPTION","ENTITLEMENT_ENTITY_TYPE_ADDON"],"x-speakeasy-name-override":"EntitlementEntityType"},"environment_id":{"type":"string"},"feature":{"type":"object","properties":{"alert_settings":{"type":"object","properties":{"alert_enabled":{"type":"boolean"},"alert_threshold_type":{"type":"string","enum":["absolute","percentage"],"x-enum-varnames":["AlertThresholdTypeAbsolute","AlertThresholdTypePercentage"],"x-speakeasy-name-override":"AlertThresholdType"},"critical":{"type":"object","properties":{"condition":{"type":"string","enum":["above","below"],"x-enum-varnames":["AlertConditionAbove","AlertConditionBelow"],"x-speakeasy-name-override":"AlertCondition"},"threshold":{"type":"string"}},"x-speakeasy-name-override":"AlertThreshold"},"info":{"type":"object","properties":{"condition":{"type":"string","enum":["above","below"],"x-enum-varnames":["AlertConditionAbove","AlertConditionBelow"],"x-speakeasy-name-override":"AlertCondition"},"threshold":{"type":"string"}},"x-speakeasy-name-override":"AlertThreshold"},"warning":{"type":"object","properties":{"condition":{"type":"string","enum":["above","below"],"x-enum-varnames":["AlertConditionAbove","AlertConditionBelow"],"x-speakeasy-name-override":"AlertCondition"},"threshold":{"type":"string"}},"x-speakeasy-name-override":"AlertThreshold"}},"x-speakeasy-name-override":"AlertSettings"},"created_at":{"type":"string","format":"date-time"},"created_by":{"type":"string"},"description":{"type":"string"},"environment_id":{"type":"string"},"group":{"type":"object","properties":{"created_at":{"type":"string","format":"date-time"},"entity_ids":{"type":"array","items":{"type":"string"}},"entity_type":{"type":"string"},"id":{"type":"string"},"lookup_key":{"type":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string"}},"name":{"type":"string"},"status":{"type":"string"},"updated_at":{"type":"string","format":"date-time"}}},"group_id":{"type":"string"},"id":{"type":"string"},"lookup_key":{"type":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string"},"x-speakeasy-name-override":"Metadata"},"meter":{"type":"object","properties":{"aggregation":{"type":"object","properties":{"bucket_size":{"type":"string","enum":["MINUTE","15MIN","30MIN","HOUR","3HOUR","6HOUR","12HOUR","DAY","WEEK","MONTH"],"x-enum-varnames":["WindowSizeMinute","WindowSize15Min","WindowSize30Min","WindowSizeHour","WindowSize3Hour","WindowSize6Hour","WindowSize12Hour","WindowSizeDay","WindowSizeWeek","WindowSizeMonth"],"x-speakeasy-name-override":"WindowSize"},"expression":{"type":"string","description":"Expression is an optional CEL expression to compute per-event quantity from event.properties.\nWhen set, it replaces Field-based extraction. Property names are used directly (e.g., token * duration * pixel)."},"field":{"type":"string","description":"Field is the key in $event.properties on which the aggregation is to be applied\nFor ex if the aggregation type is sum for API usage, the field could be \"duration_ms\"\nIgnored when Expression is set."},"group_by":{"type":"string","description":"GroupBy is the property name in event.properties to group by before aggregating.\nRequires MAX aggregation. Windowing comes from the price, so this no longer\nimplies a meter-level bucket_size.\nWhen set, aggregation is applied per unique value of this property within each bucket,\nthen the per-group results are summed to produce the bucket total."},"multiplier":{"type":"string","description":"Multiplier is the multiplier for the aggregation\nFor ex if the aggregation type is sum_with_multiplier for API usage, the multiplier could be 1000\nto scale up by a factor of 1000. If not provided, it will be null."},"type":{"type":"string","enum":["COUNT","SUM","AVG","COUNT_UNIQUE","LATEST","SUM_WITH_MULTIPLIER","MAX","WEIGHTED_SUM"],"x-enum-comments":{"AggregationSumWithMultiplier":"Sum with a multiplier - [sum(value) * multiplier]"},"x-enum-varnames":["AggregationCount","AggregationSum","AggregationAvg","AggregationCountUnique","AggregationLatest","AggregationSumWithMultiplier","AggregationMax","AggregationWeightedSum"],"x-speakeasy-name-override":"AggregationType"}}},"created_at":{"type":"string","example":"2024-03-20T15:04:05Z","format":"date-time"},"event_name":{"type":"string","example":"api_request"},"filters":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":"Key is the key for the filter from $event.properties\nCurrently we support only first level keys in the properties and not nested keys"},"values":{"type":"array","description":"Values are the possible values for the filter to be considered for the meter\nFor ex \"model_name\" could have values \"o1-mini\", \"gpt-4o\" etc","items":{"type":"string"}}}}},"id":{"type":"string","example":"550e8400-e29b-41d4-a716-446655440000"},"name":{"type":"string","example":"API Usage Meter"},"reset_usage":{"type":"string","enum":["BILLING_PERIOD","NEVER"],"x-enum-varnames":["ResetUsageBillingPeriod","ResetUsageNever"],"x-speakeasy-name-override":"ResetUsage"},"status":{"type":"string","example":"published"},"tenant_id":{"type":"string","example":"tenant123"},"updated_at":{"type":"string","example":"2024-03-20T15:04:05Z","format":"date-time"}}},"meter_id":{"type":"string"},"name":{"type":"string"},"reporting_unit":{"type":"object","properties":{"conversion_rate":{"type":"number","description":"Multiplier: reporting_unit_value = unit_value * conversion_rate; must be > 0"},"unit_plural":{"type":"string","description":"Display unit label, plural (e.g. \"seconds\")"},"unit_singular":{"type":"string","description":"Display unit label, singular (e.g. \"second\")"}},"x-speakeasy-name-override":"ReportingUnit"},"status":{"type":"string","enum":["published","deleted","archived"],"x-enum-varnames":["StatusPublished","StatusDeleted","StatusArchived"],"x-speakeasy-name-override":"Status"},"tenant_id":{"type":"string"},"type":{"type":"string","enum":["metered","boolean","static","config"],"x-enum-varnames":["FeatureTypeMetered","FeatureTypeBoolean","FeatureTypeStatic","FeatureTypeConfig"],"x-speakeasy-name-override":"FeatureType"},"unit_plural":{"type":"string"},"unit_singular":{"type":"string"},"updated_at":{"type":"string","format":"date-time"},"updated_by":{"type":"string"}}},"feature_id":{"type":"string"},"feature_type":{"type":"string","enum":["metered","boolean","static","config"],"x-enum-varnames":["FeatureTypeMetered","FeatureTypeBoolean","FeatureTypeStatic","FeatureTypeConfig"],"x-speakeasy-name-override":"FeatureType"},"grant_allocation_behavior":{"type":"string","enum":["first_usage","unit_start"],"x-enum-varnames":["EntitlementGrantAllocationBehaviorFirstUsage","EntitlementGrantAllocationBehaviorUnitStart"],"x-speakeasy-name-override":"EntitlementGrantAllocationBehavior"},"grant_duration_unit":{"type":"string","enum":["hour","day","week","subscription_period"],"x-enum-varnames":["EntitlementGrantDurationUnitHour","EntitlementGrantDurationUnitDay","EntitlementGrantDurationUnitWeek","EntitlementGrantDurationUnitSubscriptionPeriod"],"x-speakeasy-name-override":"EntitlementGrantDurationUnit"},"grant_duration_value":{"type":"integer"},"grant_measure":{"type":"string","enum":["quantity","amount"],"x-enum-varnames":["EntitlementGrantMeasureQuantity","EntitlementGrantMeasureAmount"],"x-speakeasy-name-override":"EntitlementGrantMeasure"},"grant_quota":{"type":"string"},"id":{"type":"string"},"is_enabled":{"type":"boolean"},"is_soft_limit":{"type":"boolean"},"parent_entitlement_id":{"type":"string"},"plan":{"type":"object","properties":{"created_at":{"type":"string","format":"date-time"},"created_by":{"type":"string"},"credit_grants":{"type":"array","items":{"type":"object","properties":{"addon_id":{"type":"string"},"cadence":{"type":"string","enum":["ONETIME","RECURRING"],"x-enum-varnames":["CreditGrantCadenceOneTime","CreditGrantCadenceRecurring"],"x-speakeasy-name-override":"CreditGrantCadence"},"conversion_rate":{"type":"string","description":"amount in the currency = number of credits * conversion_rate\nex if conversion_rate is 1, then 1 USD = 1 credit\nex if conversion_rate is 2, then 1 USD = 0.5 credits\nex if conversion_rate is 0.5, then 1 USD = 2 credits"},"created_at":{"type":"string","format":"date-time"},"created_by":{"type":"string"},"credit_grant_anchor":{"type":"string","format":"date-time"},"credits":{"type":"string"},"end_date":{"type":"string","format":"date-time"},"environment_id":{"type":"string"},"expiration_duration":{"type":"integer"},"expiration_duration_unit":{"type":"string","enum":["DAY","WEEK","MONTH","YEAR"],"x-enum-varnames":["CreditGrantExpiryDurationUnitDays","CreditGrantExpiryDurationUnitWeeks","CreditGrantExpiryDurationUnitMonths","CreditGrantExpiryDurationUnitYears"],"x-speakeasy-name-override":"CreditGrantExpiryDurationUnit"},"expiration_type":{"type":"string","enum":["NEVER","DURATION","BILLING_CYCLE"],"x-enum-varnames":["CreditGrantExpiryTypeNever","CreditGrantExpiryTypeDuration","CreditGrantExpiryTypeBillingCycle"],"x-speakeasy-name-override":"CreditGrantExpiryType"},"id":{"type":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string"},"x-speakeasy-name-override":"Metadata"},"name":{"type":"string"},"period":{"type":"string","enum":["DAILY","WEEKLY","MONTHLY","ANNUAL","QUARTERLY","HALF_YEARLY"],"x-enum-varnames":["CREDIT_GRANT_PERIOD_DAILY","CREDIT_GRANT_PERIOD_WEEKLY","CREDIT_GRANT_PERIOD_MONTHLY","CREDIT_GRANT_PERIOD_ANNUAL","CREDIT_GRANT_PERIOD_QUARTER","CREDIT_GRANT_PERIOD_HALF_YEARLY"],"x-speakeasy-name-override":"CreditGrantPeriod"},"period_count":{"type":"integer"},"plan_id":{"type":"string"},"priority":{"type":"integer"},"scope":{"type":"string","enum":["PLAN","SUBSCRIPTION","ADDON"],"x-enum-varnames":["CreditGrantScopePlan","CreditGrantScopeSubscription","CreditGrantScopeAddon"],"x-speakeasy-name-override":"CreditGrantScope"},"start_date":{"type":"string","format":"date-time"},"status":{"type":"string","enum":["published","deleted","archived"],"x-enum-varnames":["StatusPublished","StatusDeleted","StatusArchived"],"x-speakeasy-name-override":"Status"},"subscription_id":{"type":"string"},"tenant_id":{"type":"string"},"topup_conversion_rate":{"type":"string","description":"topup_conversion_rate is the conversion rate for the topup to the currency\nex if topup_conversion_rate is 1, then 1 USD = 1 credit\nex if topup_conversion_rate is 2, then 1 USD = 0.5 credits\nex if topup_conversion_rate is 0.5, then 1 USD = 2 credits"},"updated_at":{"type":"string","format":"date-time"},"updated_by":{"type":"string"}}}},"description":{"type":"string"},"display_order":{"type":"integer"},"entitlements":{"type":"array","items":{"$circularRef":"1c99a94f-ba2d-4aeb-aec5-928f5daeddec"}},"environment_id":{"type":"string"},"id":{"type":"string"},"lookup_key":{"type":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string"},"x-speakeasy-name-override":"Metadata"},"name":{"type":"string"},"price_sync_status":{"type":"object","properties":{"current_sequence":{"type":"integer"},"synced":{"type":"boolean"},"unsynced_subscription_count":{"type":"integer"}}},"prices":{"type":"array","description":"TODO: Add inline addons","items":{"type":"object","properties":{"addon":{"oneOf":[{}]},"amount":{"type":"string","description":"Amount stored in main currency units (e.g., dollars, not cents)\nFor USD: 12.50 means $12.50"},"billing_cadence":{"type":"string","enum":["RECURRING"],"x-enum-varnames":["BILLING_CADENCE_RECURRING"],"x-speakeasy-name-override":"BillingCadence"},"billing_model":{"type":"string","enum":["FLAT_FEE","PACKAGE","TIERED"],"x-enum-varnames":["BILLING_MODEL_FLAT_FEE","BILLING_MODEL_PACKAGE","BILLING_MODEL_TIERED"],"x-speakeasy-name-override":"BillingModel"},"billing_period":{"type":"string","enum":["MONTHLY","ANNUAL","WEEKLY","DAILY","QUARTERLY","HALF_YEARLY","ONETIME"],"x-enum-varnames":["BILLING_PERIOD_MONTHLY","BILLING_PERIOD_ANNUAL","BILLING_PERIOD_WEEKLY","BILLING_PERIOD_DAILY","BILLING_PERIOD_QUARTER","BILLING_PERIOD_HALF_YEAR","BILLING_PERIOD_ONETIME"],"x-speakeasy-name-override":"BillingPeriod"},"billing_period_count":{"type":"integer","description":"BillingPeriodCount is the count of the billing period ex 1, 3, 6, 12"},"bucket_size":{"type":"string","enum":["MINUTE","15MIN","30MIN","HOUR","3HOUR","6HOUR","12HOUR","DAY","WEEK","MONTH"],"x-enum-varnames":["WindowSizeMinute","WindowSize15Min","WindowSize30Min","WindowSizeHour","WindowSize3Hour","WindowSize6Hour","WindowSize12Hour","WindowSizeDay","WindowSizeWeek","WindowSizeMonth"],"x-speakeasy-name-override":"WindowSize"},"conversion_rate":{"type":"string","description":"ConversionRate is the conversion rate of the price unit to the fiat currency"},"created_at":{"type":"string","format":"date-time"},"created_by":{"type":"string"},"currency":{"type":"string","description":"Currency 3 digit ISO currency code in lowercase ex usd, eur, gbp"},"description":{"type":"string","description":"Description of the price"},"display_amount":{"type":"string","description":"DisplayAmount is the formatted amount with currency symbol\nFor USD: $12.50"},"display_name":{"type":"string","description":"DisplayName is the name of the price"},"display_price_unit_amount":{"type":"string","description":"DisplayPriceUnitAmount is the formatted amount of the price unit"},"end_date":{"type":"string","description":"EndDate is the end date of the price","format":"date-time"},"entity_id":{"type":"string","description":"EntityID holds the value of the \"entity_id\" field."},"entity_type":{"type":"string","enum":["PLAN","SUBSCRIPTION","ADDON","PRICE","COSTSHEET"],"x-enum-varnames":["PRICE_ENTITY_TYPE_PLAN","PRICE_ENTITY_TYPE_SUBSCRIPTION","PRICE_ENTITY_TYPE_ADDON","PRICE_ENTITY_TYPE_PRICE","PRICE_ENTITY_TYPE_COSTSHEET"],"x-speakeasy-name-override":"PriceEntityType"},"environment_id":{"type":"string","description":"EnvironmentID is the environment identifier for the price"},"feature":{"type":"object","properties":{"reporting_unit":{"type":"object","properties":{"conversion_rate":{"type":"number","description":"Multiplier: reporting_unit_value = unit_value * conversion_rate; must be > 0"},"unit_plural":{"type":"string","description":"Display unit label, plural (e.g. \"seconds\")"},"unit_singular":{"type":"string","description":"Display unit label, singular (e.g. \"second\")"}},"x-speakeasy-name-override":"ReportingUnit"}}},"group":{"type":"object","properties":{"created_at":{"type":"string","format":"date-time"},"entity_ids":{"type":"array","items":{"type":"string"}},"entity_type":{"type":"string"},"id":{"type":"string"},"lookup_key":{"type":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string"}},"name":{"type":"string"},"status":{"type":"string"},"updated_at":{"type":"string","format":"date-time"}}},"group_id":{"type":"string","description":"GroupID references the group this price belongs to"},"id":{"type":"string","description":"ID uuid identifier for the price"},"invoice_cadence":{"type":"string","enum":["ARREAR","ADVANCE"],"x-enum-varnames":["InvoiceCadenceArrear","InvoiceCadenceAdvance"],"x-speakeasy-name-override":"InvoiceCadence"},"lookup_key":{"type":"string","description":"LookupKey used for looking up the price in the database"},"metadata":{"type":"object","additionalProperties":{"type":"string"}},"meter":{"type":"object","properties":{"aggregation":{"type":"object","properties":{"bucket_size":{"type":"string","enum":["MINUTE","15MIN","30MIN","HOUR","3HOUR","6HOUR","12HOUR","DAY","WEEK","MONTH"],"x-enum-varnames":["WindowSizeMinute","WindowSize15Min","WindowSize30Min","WindowSizeHour","WindowSize3Hour","WindowSize6Hour","WindowSize12Hour","WindowSizeDay","WindowSizeWeek","WindowSizeMonth"],"x-speakeasy-name-override":"WindowSize"},"expression":{"type":"string","description":"Expression is an optional CEL expression to compute per-event quantity from event.properties.\nWhen set, it replaces Field-based extraction. Property names are used directly (e.g., token * duration * pixel)."},"field":{"type":"string","description":"Field is the key in $event.properties on which the aggregation is to be applied\nFor ex if the aggregation type is sum for API usage, the field could be \"duration_ms\"\nIgnored when Expression is set."},"group_by":{"type":"string","description":"GroupBy is the property name in event.properties to group by before aggregating.\nRequires MAX aggregation. Windowing comes from the price, so this no longer\nimplies a meter-level bucket_size.\nWhen set, aggregation is applied per unique value of this property within each bucket,\nthen the per-group results are summed to produce the bucket total."},"multiplier":{"type":"string","description":"Multiplier is the multiplier for the aggregation\nFor ex if the aggregation type is sum_with_multiplier for API usage, the multiplier could be 1000\nto scale up by a factor of 1000. If not provided, it will be null."},"type":{"type":"string","enum":["COUNT","SUM","AVG","COUNT_UNIQUE","LATEST","SUM_WITH_MULTIPLIER","MAX","WEIGHTED_SUM"],"x-enum-comments":{"AggregationSumWithMultiplier":"Sum with a multiplier - [sum(value) * multiplier]"},"x-enum-varnames":["AggregationCount","AggregationSum","AggregationAvg","AggregationCountUnique","AggregationLatest","AggregationSumWithMultiplier","AggregationMax","AggregationWeightedSum"],"x-speakeasy-name-override":"AggregationType"}}},"created_at":{"type":"string","example":"2024-03-20T15:04:05Z","format":"date-time"},"event_name":{"type":"string","example":"api_request"},"filters":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":"Key is the key for the filter from $event.properties\nCurrently we support only first level keys in the properties and not nested keys"},"values":{"type":"array","description":"Values are the possible values for the filter to be considered for the meter\nFor ex \"model_name\" could have values \"o1-mini\", \"gpt-4o\" etc","items":{"type":"string"}}}}},"id":{"type":"string","example":"550e8400-e29b-41d4-a716-446655440000"},"name":{"type":"string","example":"API Usage Meter"},"reset_usage":{"type":"string","enum":["BILLING_PERIOD","NEVER"],"x-enum-varnames":["ResetUsageBillingPeriod","ResetUsageNever"],"x-speakeasy-name-override":"ResetUsage"},"status":{"type":"string","example":"published"},"tenant_id":{"type":"string","example":"tenant123"},"updated_at":{"type":"string","example":"2024-03-20T15:04:05Z","format":"date-time"}}},"meter_id":{"type":"string","description":"MeterID is the id of the meter for usage based pricing"},"min_quantity":{"oneOf":[{"type":"string","description":"MinQuantity is the minimum quantity of the price"},{"type":"null","description":"MinQuantity is the minimum quantity of the price"}]},"parent_price_id":{"type":"string","description":"ParentPriceID references the root price (always set for price lineage tracking)"},"plan":{"oneOf":[{}]},"price_unit":{"type":"string","description":"PriceUnit is the code of the price unit (e.g., 'btc', 'eth')"},"price_unit_amount":{"type":"string","description":"PriceUnitAmount is the amount of the price unit"},"price_unit_id":{"type":"string","description":"PriceUnitID is the id of the price unit (for CUSTOM type)"},"price_unit_tiers":{"type":"array","description":"PriceUnitTiers are the tiers for the price unit when BillingModel is TIERED","items":{"type":"object","properties":{"flat_amount":{"type":"string","description":"flat_amount is the flat amount for the given tier (optional)\nApplied on top of unit_amount*quantity. Useful for cases like \"2.7$ + 5c\""},"unit_amount":{"type":"string","description":"unit_amount is the amount per unit for the given tier"},"up_to":{"type":"integer","description":"up_to is the quantity up to which this tier applies. It is null for the last tier.\nIMPORTANT: Tier boundaries are INCLUSIVE.\n- If up_to is 1000, then quantity less than or equal to 1000 belongs to this tier\n- This behavior is consistent across both VOLUME and SLAB tier modes"}}}},"price_unit_type":{"type":"string","enum":["FIAT","CUSTOM"],"x-enum-varnames":["PRICE_UNIT_TYPE_FIAT","PRICE_UNIT_TYPE_CUSTOM"],"x-speakeasy-name-override":"PriceUnitType"},"pricing_unit":{"type":"object","properties":{"base_currency":{"type":"string"},"code":{"type":"string"},"conversion_rate":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"created_by":{"type":"string"},"environment_id":{"type":"string"},"id":{"type":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string"},"x-speakeasy-name-override":"Metadata"},"name":{"type":"string"},"status":{"type":"string","enum":["published","deleted","archived"],"x-enum-varnames":["StatusPublished","StatusDeleted","StatusArchived"],"x-speakeasy-name-override":"Status"},"symbol":{"type":"string"},"tenant_id":{"type":"string"},"updated_at":{"type":"string","format":"date-time"},"updated_by":{"type":"string"}}},"sequence":{"type":"integer","description":"Sequence is the monotonic stamp bumped on every state change that\nsubscription line items need to react to. Read by the plan-price sync;\nset by the database (DEFAULT nextval) on create and by the price\nrepository on termination / compatibility-affecting edits."},"start_date":{"type":"string","description":"StartDate is the start date of the price","format":"date-time"},"status":{"type":"string","enum":["published","deleted","archived"],"x-enum-varnames":["StatusPublished","StatusDeleted","StatusArchived"],"x-speakeasy-name-override":"Status"},"tenant_id":{"type":"string"},"tier_mode":{"type":"string","enum":["VOLUME","SLAB"],"x-enum-varnames":["BILLING_TIER_VOLUME","BILLING_TIER_SLAB"],"x-speakeasy-name-override":"BillingTier"},"tiers":{"type":"array","items":{"type":"object","properties":{"flat_amount":{"type":"string","description":"flat_amount is the flat amount for the given tier (optional)\nApplied on top of unit_amount*quantity. Useful for cases like \"2.7$ + 5c\""},"unit_amount":{"type":"string","description":"unit_amount is the amount per unit for the given tier"},"up_to":{"type":"integer","description":"up_to is the quantity up to which this tier applies. It is null for the last tier.\nIMPORTANT: Tier boundaries are INCLUSIVE.\n- If up_to is 1000, then quantity less than or equal to 1000 belongs to this tier\n- This behavior is consistent across both VOLUME and SLAB tier modes"}}}},"transform_quantity":{"type":"object","properties":{"divide_by":{"type":"integer","description":"Divide quantity by this number"},"round":{"type":"string","enum":["up","down"],"x-enum-varnames":["ROUND_UP","ROUND_DOWN"],"x-speakeasy-name-override":"RoundType"}}},"trial_period_days":{"type":"integer","description":"TrialPeriodDays is the number of days for the trial period\nNote: This is only applicable for recurring prices (BILLING_CADENCE_RECURRING)"},"type":{"type":"string","enum":["USAGE","FIXED"],"x-enum-varnames":["PRICE_TYPE_USAGE","PRICE_TYPE_FIXED"],"x-speakeasy-name-override":"PriceType"},"updated_at":{"type":"string","format":"date-time"},"updated_by":{"type":"string"}}}},"status":{"type":"string","enum":["published","deleted","archived"],"x-enum-varnames":["StatusPublished","StatusDeleted","StatusArchived"],"x-speakeasy-name-override":"Status"},"tenant_id":{"type":"string"},"updated_at":{"type":"string","format":"date-time"},"updated_by":{"type":"string"}}},"plan_id":{"type":"string","description":"TODO: Remove this once we have a proper entitlement entity type"},"start_date":{"type":"string","format":"date-time"},"static_value":{"type":"string"},"status":{"type":"string","enum":["published","deleted","archived"],"x-enum-varnames":["StatusPublished","StatusDeleted","StatusArchived"],"x-speakeasy-name-override":"Status"},"tenant_id":{"type":"string"},"updated_at":{"type":"string","format":"date-time"},"updated_by":{"type":"string"},"usage_limit":{"type":"integer"},"usage_reset_period":{"type":"string","enum":["MONTHLY","ANNUAL","WEEKLY","DAILY","QUARTERLY","HALF_YEARLY","NEVER"],"x-enum-varnames":["ENTITLEMENT_USAGE_RESET_PERIOD_MONTHLY","ENTITLEMENT_USAGE_RESET_PERIOD_ANNUAL","ENTITLEMENT_USAGE_RESET_PERIOD_WEEKLY","ENTITLEMENT_USAGE_RESET_PERIOD_DAILY","ENTITLEMENT_USAGE_RESET_PERIOD_QUARTER","ENTITLEMENT_USAGE_RESET_PERIOD_HALF_YEAR","ENTITLEMENT_USAGE_RESET_PERIOD_NEVER"],"x-speakeasy-name-override":"EntitlementUsageResetPeriod"}}}},"environment_id":{"type":"string"},"id":{"type":"string"},"lookup_key":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"name":{"type":"string"},"price_sync_status":{"type":"object","properties":{"current_sequence":{"type":"integer"},"synced":{"type":"boolean"},"unsynced_association_count":{"type":"integer"}}},"prices":{"type":"array","description":"Optional expanded fields","items":{"type":"object","properties":{"addon":{"oneOf":[{}]},"amount":{"type":"string","description":"Amount stored in main currency units (e.g., dollars, not cents)\nFor USD: 12.50 means $12.50"},"billing_cadence":{"type":"string","enum":["RECURRING"],"x-enum-varnames":["BILLING_CADENCE_RECURRING"],"x-speakeasy-name-override":"BillingCadence"},"billing_model":{"type":"string","enum":["FLAT_FEE","PACKAGE","TIERED"],"x-enum-varnames":["BILLING_MODEL_FLAT_FEE","BILLING_MODEL_PACKAGE","BILLING_MODEL_TIERED"],"x-speakeasy-name-override":"BillingModel"},"billing_period":{"type":"string","enum":["MONTHLY","ANNUAL","WEEKLY","DAILY","QUARTERLY","HALF_YEARLY","ONETIME"],"x-enum-varnames":["BILLING_PERIOD_MONTHLY","BILLING_PERIOD_ANNUAL","BILLING_PERIOD_WEEKLY","BILLING_PERIOD_DAILY","BILLING_PERIOD_QUARTER","BILLING_PERIOD_HALF_YEAR","BILLING_PERIOD_ONETIME"],"x-speakeasy-name-override":"BillingPeriod"},"billing_period_count":{"type":"integer","description":"BillingPeriodCount is the count of the billing period ex 1, 3, 6, 12"},"bucket_size":{"type":"string","enum":["MINUTE","15MIN","30MIN","HOUR","3HOUR","6HOUR","12HOUR","DAY","WEEK","MONTH"],"x-enum-varnames":["WindowSizeMinute","WindowSize15Min","WindowSize30Min","WindowSizeHour","WindowSize3Hour","WindowSize6Hour","WindowSize12Hour","WindowSizeDay","WindowSizeWeek","WindowSizeMonth"],"x-speakeasy-name-override":"WindowSize"},"conversion_rate":{"type":"string","description":"ConversionRate is the conversion rate of the price unit to the fiat currency"},"created_at":{"type":"string","format":"date-time"},"created_by":{"type":"string"},"currency":{"type":"string","description":"Currency 3 digit ISO currency code in lowercase ex usd, eur, gbp"},"description":{"type":"string","description":"Description of the price"},"display_amount":{"type":"string","description":"DisplayAmount is the formatted amount with currency symbol\nFor USD: $12.50"},"display_name":{"type":"string","description":"DisplayName is the name of the price"},"display_price_unit_amount":{"type":"string","description":"DisplayPriceUnitAmount is the formatted amount of the price unit"},"end_date":{"type":"string","description":"EndDate is the end date of the price","format":"date-time"},"entity_id":{"type":"string","description":"EntityID holds the value of the \"entity_id\" field."},"entity_type":{"type":"string","enum":["PLAN","SUBSCRIPTION","ADDON","PRICE","COSTSHEET"],"x-enum-varnames":["PRICE_ENTITY_TYPE_PLAN","PRICE_ENTITY_TYPE_SUBSCRIPTION","PRICE_ENTITY_TYPE_ADDON","PRICE_ENTITY_TYPE_PRICE","PRICE_ENTITY_TYPE_COSTSHEET"],"x-speakeasy-name-override":"PriceEntityType"},"environment_id":{"type":"string","description":"EnvironmentID is the environment identifier for the price"},"feature":{"type":"object","properties":{"reporting_unit":{"type":"object","properties":{"conversion_rate":{"type":"number","description":"Multiplier: reporting_unit_value = unit_value * conversion_rate; must be > 0"},"unit_plural":{"type":"string","description":"Display unit label, plural (e.g. \"seconds\")"},"unit_singular":{"type":"string","description":"Display unit label, singular (e.g. \"second\")"}},"x-speakeasy-name-override":"ReportingUnit"}}},"group":{"type":"object","properties":{"created_at":{"type":"string","format":"date-time"},"entity_ids":{"type":"array","items":{"type":"string"}},"entity_type":{"type":"string"},"id":{"type":"string"},"lookup_key":{"type":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string"}},"name":{"type":"string"},"status":{"type":"string"},"updated_at":{"type":"string","format":"date-time"}}},"group_id":{"type":"string","description":"GroupID references the group this price belongs to"},"id":{"type":"string","description":"ID uuid identifier for the price"},"invoice_cadence":{"type":"string","enum":["ARREAR","ADVANCE"],"x-enum-varnames":["InvoiceCadenceArrear","InvoiceCadenceAdvance"],"x-speakeasy-name-override":"InvoiceCadence"},"lookup_key":{"type":"string","description":"LookupKey used for looking up the price in the database"},"metadata":{"type":"object","additionalProperties":{"type":"string"}},"meter":{"type":"object","properties":{"aggregation":{"type":"object","properties":{"bucket_size":{"type":"string","enum":["MINUTE","15MIN","30MIN","HOUR","3HOUR","6HOUR","12HOUR","DAY","WEEK","MONTH"],"x-enum-varnames":["WindowSizeMinute","WindowSize15Min","WindowSize30Min","WindowSizeHour","WindowSize3Hour","WindowSize6Hour","WindowSize12Hour","WindowSizeDay","WindowSizeWeek","WindowSizeMonth"],"x-speakeasy-name-override":"WindowSize"},"expression":{"type":"string","description":"Expression is an optional CEL expression to compute per-event quantity from event.properties.\nWhen set, it replaces Field-based extraction. Property names are used directly (e.g., token * duration * pixel)."},"field":{"type":"string","description":"Field is the key in $event.properties on which the aggregation is to be applied\nFor ex if the aggregation type is sum for API usage, the field could be \"duration_ms\"\nIgnored when Expression is set."},"group_by":{"type":"string","description":"GroupBy is the property name in event.properties to group by before aggregating.\nRequires MAX aggregation. Windowing comes from the price, so this no longer\nimplies a meter-level bucket_size.\nWhen set, aggregation is applied per unique value of this property within each bucket,\nthen the per-group results are summed to produce the bucket total."},"multiplier":{"type":"string","description":"Multiplier is the multiplier for the aggregation\nFor ex if the aggregation type is sum_with_multiplier for API usage, the multiplier could be 1000\nto scale up by a factor of 1000. If not provided, it will be null."},"type":{"type":"string","enum":["COUNT","SUM","AVG","COUNT_UNIQUE","LATEST","SUM_WITH_MULTIPLIER","MAX","WEIGHTED_SUM"],"x-enum-comments":{"AggregationSumWithMultiplier":"Sum with a multiplier - [sum(value) * multiplier]"},"x-enum-varnames":["AggregationCount","AggregationSum","AggregationAvg","AggregationCountUnique","AggregationLatest","AggregationSumWithMultiplier","AggregationMax","AggregationWeightedSum"],"x-speakeasy-name-override":"AggregationType"}}},"created_at":{"type":"string","example":"2024-03-20T15:04:05Z","format":"date-time"},"event_name":{"type":"string","example":"api_request"},"filters":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":"Key is the key for the filter from $event.properties\nCurrently we support only first level keys in the properties and not nested keys"},"values":{"type":"array","description":"Values are the possible values for the filter to be considered for the meter\nFor ex \"model_name\" could have values \"o1-mini\", \"gpt-4o\" etc","items":{"type":"string"}}}}},"id":{"type":"string","example":"550e8400-e29b-41d4-a716-446655440000"},"name":{"type":"string","example":"API Usage Meter"},"reset_usage":{"type":"string","enum":["BILLING_PERIOD","NEVER"],"x-enum-varnames":["ResetUsageBillingPeriod","ResetUsageNever"],"x-speakeasy-name-override":"ResetUsage"},"status":{"type":"string","example":"published"},"tenant_id":{"type":"string","example":"tenant123"},"updated_at":{"type":"string","example":"2024-03-20T15:04:05Z","format":"date-time"}}},"meter_id":{"type":"string","description":"MeterID is the id of the meter for usage based pricing"},"min_quantity":{"oneOf":[{"type":"string","description":"MinQuantity is the minimum quantity of the price"},{"type":"null","description":"MinQuantity is the minimum quantity of the price"}]},"parent_price_id":{"type":"string","description":"ParentPriceID references the root price (always set for price lineage tracking)"},"plan":{"oneOf":[{}]},"price_unit":{"type":"string","description":"PriceUnit is the code of the price unit (e.g., 'btc', 'eth')"},"price_unit_amount":{"type":"string","description":"PriceUnitAmount is the amount of the price unit"},"price_unit_id":{"type":"string","description":"PriceUnitID is the id of the price unit (for CUSTOM type)"},"price_unit_tiers":{"type":"array","description":"PriceUnitTiers are the tiers for the price unit when BillingModel is TIERED","items":{"type":"object","properties":{"flat_amount":{"type":"string","description":"flat_amount is the flat amount for the given tier (optional)\nApplied on top of unit_amount*quantity. Useful for cases like \"2.7$ + 5c\""},"unit_amount":{"type":"string","description":"unit_amount is the amount per unit for the given tier"},"up_to":{"type":"integer","description":"up_to is the quantity up to which this tier applies. It is null for the last tier.\nIMPORTANT: Tier boundaries are INCLUSIVE.\n- If up_to is 1000, then quantity less than or equal to 1000 belongs to this tier\n- This behavior is consistent across both VOLUME and SLAB tier modes"}}}},"price_unit_type":{"type":"string","enum":["FIAT","CUSTOM"],"x-enum-varnames":["PRICE_UNIT_TYPE_FIAT","PRICE_UNIT_TYPE_CUSTOM"],"x-speakeasy-name-override":"PriceUnitType"},"pricing_unit":{"type":"object","properties":{"base_currency":{"type":"string"},"code":{"type":"string"},"conversion_rate":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"created_by":{"type":"string"},"environment_id":{"type":"string"},"id":{"type":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string"},"x-speakeasy-name-override":"Metadata"},"name":{"type":"string"},"status":{"type":"string","enum":["published","deleted","archived"],"x-enum-varnames":["StatusPublished","StatusDeleted","StatusArchived"],"x-speakeasy-name-override":"Status"},"symbol":{"type":"string"},"tenant_id":{"type":"string"},"updated_at":{"type":"string","format":"date-time"},"updated_by":{"type":"string"}}},"sequence":{"type":"integer","description":"Sequence is the monotonic stamp bumped on every state change that\nsubscription line items need to react to. Read by the plan-price sync;\nset by the database (DEFAULT nextval) on create and by the price\nrepository on termination / compatibility-affecting edits."},"start_date":{"type":"string","description":"StartDate is the start date of the price","format":"date-time"},"status":{"type":"string","enum":["published","deleted","archived"],"x-enum-varnames":["StatusPublished","StatusDeleted","StatusArchived"],"x-speakeasy-name-override":"Status"},"tenant_id":{"type":"string"},"tier_mode":{"type":"string","enum":["VOLUME","SLAB"],"x-enum-varnames":["BILLING_TIER_VOLUME","BILLING_TIER_SLAB"],"x-speakeasy-name-override":"BillingTier"},"tiers":{"type":"array","items":{"type":"object","properties":{"flat_amount":{"type":"string","description":"flat_amount is the flat amount for the given tier (optional)\nApplied on top of unit_amount*quantity. Useful for cases like \"2.7$ + 5c\""},"unit_amount":{"type":"string","description":"unit_amount is the amount per unit for the given tier"},"up_to":{"type":"integer","description":"up_to is the quantity up to which this tier applies. It is null for the last tier.\nIMPORTANT: Tier boundaries are INCLUSIVE.\n- If up_to is 1000, then quantity less than or equal to 1000 belongs to this tier\n- This behavior is consistent across both VOLUME and SLAB tier modes"}}}},"transform_quantity":{"type":"object","properties":{"divide_by":{"type":"integer","description":"Divide quantity by this number"},"round":{"type":"string","enum":["up","down"],"x-enum-varnames":["ROUND_UP","ROUND_DOWN"],"x-speakeasy-name-override":"RoundType"}}},"trial_period_days":{"type":"integer","description":"TrialPeriodDays is the number of days for the trial period\nNote: This is only applicable for recurring prices (BILLING_CADENCE_RECURRING)"},"type":{"type":"string","enum":["USAGE","FIXED"],"x-enum-varnames":["PRICE_TYPE_USAGE","PRICE_TYPE_FIXED"],"x-speakeasy-name-override":"PriceType"},"updated_at":{"type":"string","format":"date-time"},"updated_by":{"type":"string"}}}},"status":{"type":"string","enum":["published","deleted","archived"],"x-enum-varnames":["StatusPublished","StatusDeleted","StatusArchived"],"x-speakeasy-name-override":"Status"},"tenant_id":{"type":"string"},"updated_at":{"type":"string","format":"date-time"},"updated_by":{"type":"string"}}}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","description":"Enter your API key in the format *x-api-key \u0026lt;api-key\u0026gt;**","name":"x-api-key","in":"header","scopes":[],"schemeName":"ApiKeyAuth"},"schema":{"title":"x-api-key","type":"string","description":"Enter your API key in the format *x-api-key \u0026lt;api-key\u0026gt;**","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"x-api-key"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"https://swagger.flexprice.io"},"subdomain":"flexprice","siteName":"Flexprice","title":"Create addon - Flexprice","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-23T12:45:15.113Z","originalFileLocation":"api-reference/addons/create-addon.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=\"Use when defining an optional purchasable item (e.g. extra storage or support tier). Ideal for add-ons that customers can attach to a subscription.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Flexprice\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/flexprice/7xM46OYu1enH2rig/_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/flexprice/7xM46OYu1enH2rig/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/flexprice/7xM46OYu1enH2rig/_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/flexprice/7xM46OYu1enH2rig/_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/flexprice/7xM46OYu1enH2rig/_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/flexprice/7xM46OYu1enH2rig/_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/flexprice/7xM46OYu1enH2rig/_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/flexprice/7xM46OYu1enH2rig/_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/flexprice/7xM46OYu1enH2rig/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create addon - Flexprice\">\u003cmeta data-mint-head property=\"og:description\" content=\"Use when defining an optional purchasable item (e.g. extra storage or support tier). Ideal for add-ons that customers can attach to a subscription.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Flexprice\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.flexprice.io/api-reference/addons/create-addon\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://flexprice.mintlify.app/_mintlify/api/og/v2?division=Addons\u0026amp;title=Create+addon\u0026amp;description=Use+when+defining+an+optional+purchasable+item+%28e.g.+extra+storage+or+support+tier%29.+Ideal+for+add-ons+that+customers+can+attach+to+a+subscription.\u0026amp;theme=792146983879b831a3a27cee\u0026amp;signature=b690dc7a65314fd9851b128c086147d52603c671814c31e53fb5183031ad932d\">\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=\"Create addon - Flexprice\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Use when defining an optional purchasable item (e.g. extra storage or support tier). Ideal for add-ons that customers can attach to a subscription.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://flexprice.mintlify.app/_mintlify/api/og/v2?division=Addons\u0026amp;title=Create+addon\u0026amp;description=Use+when+defining+an+optional+purchasable+item+%28e.g.+extra+storage+or+support+tier%29.+Ideal+for+add-ons+that+customers+can+attach+to+a+subscription.\u0026amp;theme=792146983879b831a3a27cee\u0026amp;signature=b690dc7a65314fd9851b128c086147d52603c671814c31e53fb5183031ad932d\">\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/flexprice/7xM46OYu1enH2rig/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Flexprice\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#15547c\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.flexprice.io/api-reference/addons/create-addon\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/addons/create-addon.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.flexprice.io/#organization\",\"name\":\"Flexprice\",\"url\":\"https://docs.flexprice.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/flexprice/Qokjirde4CQUcFy8/images/FlexpriceWordMarkDark.png?fit=max\u0026auto=format\u0026n=Qokjirde4CQUcFy8\u0026q=85\u0026s=d706a1b6139418c2d57ba902fb0b6de4\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.flexprice.io#website\",\"name\":\"Flexprice\",\"url\":\"https://docs.flexprice.io\",\"publisher\":{\"@id\":\"https://docs.flexprice.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.flexprice.io/api-reference/addons/create-addon#webpage\",\"url\":\"https://docs.flexprice.io/api-reference/addons/create-addon\",\"name\":\"Create addon\",\"description\":\"Use when defining an optional purchasable item (e.g. extra storage or support tier). Ideal for add-ons that customers can attach to a subscription.\",\"dateModified\":\"2026-10-23T12:45:15.113Z\",\"isPartOf\":{\"@id\":\"https://docs.flexprice.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.flexprice.io/api-reference/addons/create-addon#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.flexprice.io/api-reference/addons/create-addon#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Resources\",\"item\":\"https://docs.flexprice.io/api-reference/activity/list-activity\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create addon\",\"item\":\"https://docs.flexprice.io/api-reference/addons/create-addon\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.flexprice.io/api-reference/addons/create-addon#apireference\",\"headline\":\"Create addon\",\"name\":\"Create addon\",\"description\":\"Use when defining an optional purchasable item (e.g. extra storage or support tier). Ideal for add-ons that customers can attach to a subscription.\",\"url\":\"https://docs.flexprice.io/api-reference/addons/create-addon\",\"mainEntityOfPage\":{\"@id\":\"https://docs.flexprice.io/api-reference/addons/create-addon#webpage\"},\"dateModified\":\"2026-10-23T12:45:15.113Z\",\"publisher\":{\"@id\":\"https://docs.flexprice.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.flexprice.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Flexprice\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Flexprice","nav":{"global":{"anchors":[{"anchor":"Support","icon":"https://mintlify.s3.us-west-1.amazonaws.com/flexprice/images/anchors/mail.svg","href":"mailto:support@flexprice.io"},{"anchor":"Community","icon":"https://mintlify.s3.us-west-1.amazonaws.com/flexprice/images/anchors/slack.svg","href":"https://join.slack.com/t/flexpricecommunity/shared_invite/zt-39uat51l0-n8JmSikHZP~bHJNXladeaQ"},{"anchor":"Website","icon":"https://mintlify.s3.us-west-1.amazonaws.com/flexprice/images/anchors/flexprice.svg","href":"https://flexprice.io/"}]},"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/docs/welcome-to-flexprice"}]},{"tab":"Cookbooks","pages":[{"title":"Cookbooks","href":"/cookbooks/billing-recipes/usage-based-pricing"}]},{"tab":"API Reference","groups":[{"group":"API Documentation","pages":[{"title":"REST API","href":"/api-reference/introduction"},{"title":"Pagination","href":"/api-reference/pagination"},{"title":"Error responses","href":"/api-reference/error-responses"}]},{"group":"Resources","pages":[{"group":"Activity","pages":[{"title":"List activity","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /activity","href":"/api-reference/activity/list-activity"},{"title":"Get activity","description":"Use when you need one activity entry with the state of the entity right after the change.","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io get /activity/{id}","href":"/api-reference/activity/get-activity"}]},{"group":"Addons","pages":[{"title":"Create addon","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /addons","href":"/api-reference/addons/create-addon"},{"title":"Get addon by lookup key","description":"Use when resolving an addon by external id (e.g. from your product catalog). Ideal for integrations.","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io get /addons/lookup/{lookup_key}","href":"/api-reference/addons/get-addon-by-lookup-key"},{"title":"Query addons","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /addons/search","href":"/api-reference/addons/query-addons"},{"title":"Get addon","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io get /addons/{id}","href":"/api-reference/addons/get-addon"},{"title":"Update addon","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io put /addons/{id}","href":"/api-reference/addons/update-addon"},{"title":"Delete addon","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io delete /addons/{id}","href":"/api-reference/addons/delete-addon"},{"title":"Synchronize addon prices","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /addons/{id}/sync/subscriptions","href":"/api-reference/addons/synchronize-addon-prices"}]},{"group":"Credit Grants","pages":[{"title":"Get addon credit grants","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io get /addons/{id}/creditgrants","href":"/api-reference/credit-grants/get-addon-credit-grants"},{"title":"Create credit grant","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /creditgrants","href":"/api-reference/credit-grants/create-credit-grant"},{"title":"Get credit grant","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io get /creditgrants/{id}","href":"/api-reference/credit-grants/get-credit-grant"},{"title":"Update credit grant","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io put /creditgrants/{id}","href":"/api-reference/credit-grants/update-credit-grant"},{"title":"Delete credit grant","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io delete /creditgrants/{id}","href":"/api-reference/credit-grants/delete-credit-grant"},{"title":"Get plan credit grants","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io get /plans/{id}/creditgrants","href":"/api-reference/credit-grants/get-plan-credit-grants"}]},{"group":"Entitlements","pages":[{"title":"Get addon entitlements","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io get /addons/{id}/entitlements","href":"/api-reference/entitlements/get-addon-entitlements"},{"title":"Create entitlement","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /entitlements","href":"/api-reference/entitlements/create-entitlement"},{"title":"Create entitlements in bulk","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /entitlements/bulk","href":"/api-reference/entitlements/create-entitlements-in-bulk"},{"title":"Query entitlements","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /entitlements/search","href":"/api-reference/entitlements/query-entitlements"},{"title":"Get entitlement","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io get /entitlements/{id}","href":"/api-reference/entitlements/get-entitlement"},{"title":"Update entitlement","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io put /entitlements/{id}","href":"/api-reference/entitlements/update-entitlement"},{"title":"Delete entitlement","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io delete /entitlements/{id}","href":"/api-reference/entitlements/delete-entitlement"},{"title":"Get plan entitlements","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io get /plans/{id}/entitlements","href":"/api-reference/entitlements/get-plan-entitlements"}]},{"group":"Alerts","pages":[{"title":"Query alert logs","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /alerts/search","href":"/api-reference/alerts/query-alert-logs"}]},{"group":"AlertSettings","pages":[{"title":"Create alert settings","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /alerts/setting","href":"/api-reference/alertsettings/create-alert-settings"},{"title":"Query alert settings","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /alerts/setting/search","href":"/api-reference/alertsettings/query-alert-settings"},{"title":"Get alert settings","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io get /alerts/setting/{id}","href":"/api-reference/alertsettings/get-alert-settings"},{"title":"Update alert settings","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io put /alerts/setting/{id}","href":"/api-reference/alertsettings/update-alert-settings"},{"title":"Delete alert settings","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io delete /alerts/setting/{id}","href":"/api-reference/alertsettings/delete-alert-settings"}]},{"group":"Analytics","pages":[{"title":"Run an ad-hoc analytics query","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /analytics/query","href":"/api-reference/analytics/run-an-ad-hoc-analytics-query"},{"title":"List financial reports","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io get /analytics/reports","href":"/api-reference/analytics/list-financial-reports"},{"title":"Run a financial report","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /analytics/reports/{key}/query","href":"/api-reference/analytics/run-a-financial-report"},{"title":"Query revenue analytics","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /analytics/revenue","href":"/api-reference/analytics/query-revenue-analytics"},{"title":"List analytics views","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io get /analytics/views","href":"/api-reference/analytics/list-analytics-views"},{"title":"Create an analytics view","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /analytics/views","href":"/api-reference/analytics/create-an-analytics-view"},{"title":"Get an analytics view","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io get /analytics/views/{id}","href":"/api-reference/analytics/get-an-analytics-view"},{"title":"Update an analytics view","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io put /analytics/views/{id}","href":"/api-reference/analytics/update-an-analytics-view"},{"title":"Delete an analytics view","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io delete /analytics/views/{id}","href":"/api-reference/analytics/delete-an-analytics-view"},{"title":"Query an analytics view","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /analytics/views/{id}/query","href":"/api-reference/analytics/query-an-analytics-view"}]},{"group":"Checkout","pages":[{"title":"Create checkout session","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /checkout/sessions","href":"/api-reference/checkout/create-checkout-session"},{"title":"Get checkout session","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io get /checkout/sessions/{id}","href":"/api-reference/checkout/get-checkout-session"},{"title":"Delete checkout session","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io delete /checkout/sessions/{id}","href":"/api-reference/checkout/delete-checkout-session"},{"title":"Cancel checkout session","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /checkout/sessions/{id}/cancel","href":"/api-reference/checkout/cancel-checkout-session"}]},{"group":"Costs","pages":[{"title":"Create costsheet","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /costs","href":"/api-reference/costs/create-costsheet"},{"title":"Get active costsheet","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io get /costs/active","href":"/api-reference/costs/get-active-costsheet"},{"title":"Get combined revenue and cost analytics","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /costs/analytics","href":"/api-reference/costs/get-combined-revenue-and-cost-analytics"},{"title":"Query costsheets","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /costs/search","href":"/api-reference/costs/query-costsheets"},{"title":"Get costsheet","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io get /costs/{id}","href":"/api-reference/costs/get-costsheet"},{"title":"Update costsheet","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io put /costs/{id}","href":"/api-reference/costs/update-costsheet"},{"title":"Delete costsheet","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io delete /costs/{id}","href":"/api-reference/costs/delete-costsheet"}]},{"group":"Coupons","pages":[{"title":"Create coupon","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /coupons","href":"/api-reference/coupons/create-coupon"},{"title":"Get coupon by code","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io get /coupons/code/{code}","href":"/api-reference/coupons/get-coupon-by-code"},{"title":"Query coupons","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /coupons/search","href":"/api-reference/coupons/query-coupons"},{"title":"Get coupon","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io get /coupons/{id}","href":"/api-reference/coupons/get-coupon"},{"title":"Update coupon","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io put /coupons/{id}","href":"/api-reference/coupons/update-coupon"},{"title":"Delete coupon","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io delete /coupons/{id}","href":"/api-reference/coupons/delete-coupon"}]},{"group":"Coupon Associations","pages":[{"title":"List coupon associations","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io get /coupons/associations","href":"/api-reference/coupon-associations/list-coupon-associations"},{"title":"Get coupon association","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io get /coupons/associations/{id}","href":"/api-reference/coupon-associations/get-coupon-association"}]},{"group":"Credit Notes","pages":[{"title":"Create credit note","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /creditnotes","href":"/api-reference/credit-notes/create-credit-note"},{"title":"Get credit note","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io get /creditnotes/{id}","href":"/api-reference/credit-notes/get-credit-note"},{"title":"Finalize credit note","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /creditnotes/{id}/finalize","href":"/api-reference/credit-notes/finalize-credit-note"},{"title":"Void credit note","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /creditnotes/{id}/void","href":"/api-reference/credit-notes/void-credit-note"}]},{"group":"Customers","pages":[{"title":"Update customer","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io put /customers","href":"/api-reference/customers/update-customer"},{"title":"Create customer","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /customers","href":"/api-reference/customers/create-customer"},{"title":"Get customer by external ID","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io get /customers/external/{external_id}","href":"/api-reference/customers/get-customer-by-external-id"},{"title":"Get customer entitlements by external ID","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io get /customers/external/{external_id}/entitlements","href":"/api-reference/customers/get-customer-entitlements-by-external-id"},{"title":"Get subscriptions for customer by external ID","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io get /customers/external/{external_id}/subscriptions","href":"/api-reference/customers/get-subscriptions-for-customer-by-external-id"},{"title":"Create customer portal session","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io get /customers/portal/{external_id}","href":"/api-reference/customers/create-customer-portal-session"},{"title":"Query customers","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /customers/search","href":"/api-reference/customers/query-customers"},{"title":"Get customer usage summary","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io get /customers/usage","href":"/api-reference/customers/get-customer-usage-summary"},{"title":"Get customer","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io get /customers/{id}","href":"/api-reference/customers/get-customer"},{"title":"Delete customer","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io delete /customers/{id}","href":"/api-reference/customers/delete-customer"},{"title":"Get customer entitlements","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io get /customers/{id}/entitlements","href":"/api-reference/customers/get-customer-entitlements"},{"title":"Get upcoming credit grant applications","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io get /customers/{id}/grants/upcoming","href":"/api-reference/customers/get-upcoming-credit-grant-applications"},{"title":"List customer payment methods","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io get /customers/{id}/payment-methods","href":"/api-reference/customers/list-customer-payment-methods"}]},{"group":"Wallets","pages":[{"title":"Get Customer Wallets","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io get /customers/wallets","href":"/api-reference/wallets/get-customer-wallets"},{"title":"Get wallets by customer ID","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io get /customers/{id}/wallets","href":"/api-reference/wallets/get-wallets-by-customer-id"},{"title":"Create a new wallet","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /wallets","href":"/api-reference/wallets/create-a-new-wallet"},{"title":"Query wallets","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /wallets/search","href":"/api-reference/wallets/query-wallets"},{"title":"Query wallet transactions","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /wallets/transactions/search","href":"/api-reference/wallets/query-wallet-transactions"},{"title":"Get wallet","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io get /wallets/{id}","href":"/api-reference/wallets/get-wallet"},{"title":"Update a wallet","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io put /wallets/{id}","href":"/api-reference/wallets/update-a-wallet"},{"title":"Get wallet balance","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io get /wallets/{id}/balance/real-time","href":"/api-reference/wallets/get-wallet-balance"},{"title":"Terminate a wallet","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /wallets/{id}/terminate","href":"/api-reference/wallets/terminate-a-wallet"},{"title":"Top up wallet","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /wallets/{id}/top-up","href":"/api-reference/wallets/top-up-wallet"},{"title":"Get wallet transactions","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io get /wallets/{id}/transactions","href":"/api-reference/wallets/get-wallet-transactions"}]},{"group":"Invoices","pages":[{"title":"Get customer invoice summary","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io get /customers/{id}/invoices/summary","href":"/api-reference/invoices/get-customer-invoice-summary"},{"title":"Create one-off invoice","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /invoices","href":"/api-reference/invoices/create-one-off-invoice"},{"title":"Get invoice preview","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /invoices/preview","href":"/api-reference/invoices/get-invoice-preview"},{"title":"Query invoices","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /invoices/search","href":"/api-reference/invoices/query-invoices"},{"title":"Get invoice","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io get /invoices/{id}","href":"/api-reference/invoices/get-invoice"},{"title":"Update invoice","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io put /invoices/{id}","href":"/api-reference/invoices/update-invoice"},{"title":"Trigger invoice communication webhook","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /invoices/{id}/comms/trigger","href":"/api-reference/invoices/trigger-invoice-communication-webhook"},{"title":"Finalize invoice","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /invoices/{id}/finalize","href":"/api-reference/invoices/finalize-invoice"},{"title":"Execute invoice modification","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /invoices/{id}/modify/execute","href":"/api-reference/invoices/execute-invoice-modification"},{"title":"Update invoice payment status","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io put /invoices/{id}/payment","href":"/api-reference/invoices/update-invoice-payment-status"},{"title":"Attempt invoice payment","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /invoices/{id}/payment/attempt","href":"/api-reference/invoices/attempt-invoice-payment"},{"title":"Get invoice PDF","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io get /invoices/{id}/pdf","href":"/api-reference/invoices/get-invoice-pdf"},{"title":"Recalculate invoice (voided invoice)","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /invoices/{id}/recalculate","href":"/api-reference/invoices/recalculate-invoice-voided-invoice"},{"title":"Recalculate draft invoice (v2)","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /invoices/{id}/recalculate-v2","href":"/api-reference/invoices/recalculate-draft-invoice-v2"},{"title":"Void invoice","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /invoices/{id}/void","href":"/api-reference/invoices/void-invoice"}]},{"group":"Environments","pages":[{"title":"Clone an environment","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /environments/{id}/clone","href":"/api-reference/environments/clone-an-environment"}]},{"group":"Events","pages":[{"title":"Ingest event","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /events","href":"/api-reference/events/ingest-event"},{"title":"Get usage analytics","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /events/analytics","href":"/api-reference/events/get-usage-analytics"},{"title":"Bulk ingest events","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /events/bulk","href":"/api-reference/events/bulk-ingest-events"},{"title":"Get event","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io get /events/lookup","href":"/api-reference/events/get-event"},{"title":"List raw events","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /events/query","href":"/api-reference/events/list-raw-events"},{"title":"Get usage statistics","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /events/usage","href":"/api-reference/events/get-usage-statistics"},{"title":"Get usage by meter","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /events/usage/meter","href":"/api-reference/events/get-usage-by-meter"}]},{"group":"Features","pages":[{"title":"Create feature","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /features","href":"/api-reference/features/create-feature"},{"title":"Query features","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /features/search","href":"/api-reference/features/query-features"},{"title":"Update feature","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io put /features/{id}","href":"/api-reference/features/update-feature"},{"title":"Delete feature","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io delete /features/{id}","href":"/api-reference/features/delete-feature"},{"title":"Clone a feature","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /features/{id}/clone","href":"/api-reference/features/clone-a-feature"}]},{"group":"FX Rates","pages":[{"title":"Create an FX rate","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /forex","href":"/api-reference/fx-rates/create-an-fx-rate"},{"title":"Query FX rates","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /forex/query","href":"/api-reference/fx-rates/query-fx-rates"},{"title":"Get an FX rate","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io get /forex/{id}","href":"/api-reference/fx-rates/get-an-fx-rate"},{"title":"Update an FX rate","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io put /forex/{id}","href":"/api-reference/fx-rates/update-an-fx-rate"},{"title":"Delete an FX rate","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io delete /forex/{id}","href":"/api-reference/fx-rates/delete-an-fx-rate"}]},{"group":"Groups","pages":[{"title":"Create group","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /groups","href":"/api-reference/groups/create-group"},{"title":"Query groups","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /groups/search","href":"/api-reference/groups/query-groups"},{"title":"Get group","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io get /groups/{id}","href":"/api-reference/groups/get-group"},{"title":"Delete group","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io delete /groups/{id}","href":"/api-reference/groups/delete-group"}]},{"group":"Integrations","pages":[{"title":"Get integration configurations","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io get /integrations/config","href":"/api-reference/integrations/get-integration-configurations"},{"title":"Link integration mapping","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /integrations/link","href":"/api-reference/integrations/link-integration-mapping"},{"title":"Delink integration mapping","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io delete /integrations/link","href":"/api-reference/integrations/delink-integration-mapping"},{"title":"Get entity integration mappings","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io get /integrations/mappings","href":"/api-reference/integrations/get-entity-integration-mappings"}]},{"group":"Marketplace","pages":[{"title":"Register an AWS Marketplace agreement","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /marketplace/agreements","href":"/api-reference/marketplace/register-an-aws-marketplace-agreement"}]},{"group":"Payments","pages":[{"title":"List payments","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io get /payments","href":"/api-reference/payments/list-payments"},{"title":"Create payment","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /payments","href":"/api-reference/payments/create-payment"},{"title":"Get payment","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io get /payments/{id}","href":"/api-reference/payments/get-payment"},{"title":"Update payment","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io put /payments/{id}","href":"/api-reference/payments/update-payment"},{"title":"Delete payment","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io delete /payments/{id}","href":"/api-reference/payments/delete-payment"},{"title":"Process payment","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /payments/{id}/process","href":"/api-reference/payments/process-payment"}]},{"group":"Plans","pages":[{"title":"Create plan","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /plans","href":"/api-reference/plans/create-plan"},{"title":"Query plans","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /plans/search","href":"/api-reference/plans/query-plans"},{"title":"Get plan","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io get /plans/{id}","href":"/api-reference/plans/get-plan"},{"title":"Update plan","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io put /plans/{id}","href":"/api-reference/plans/update-plan"},{"title":"Delete plan","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io delete /plans/{id}","href":"/api-reference/plans/delete-plan"},{"title":"Clone a plan","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /plans/{id}/clone","href":"/api-reference/plans/clone-a-plan"},{"title":"Synchronize plan prices","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /plans/{id}/sync/subscriptions","href":"/api-reference/plans/synchronize-plan-prices"}]},{"group":"SelfBilling","pages":[{"title":"Start self-billing checkout","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /portal/billing/checkout","href":"/api-reference/selfbilling/start-self-billing-checkout"},{"title":"Poll self-billing checkout","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io get /portal/billing/checkout/{id}","href":"/api-reference/selfbilling/poll-self-billing-checkout"},{"title":"Cancel self-billing checkout","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /portal/billing/checkout/{id}/cancel","href":"/api-reference/selfbilling/cancel-self-billing-checkout"},{"title":"Create self-billing portal session","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /portal/billing/portal-session","href":"/api-reference/selfbilling/create-self-billing-portal-session"},{"title":"Get self-billing status","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io get /portal/billing/status","href":"/api-reference/selfbilling/get-self-billing-status"},{"title":"Get self-billing summary","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io get /portal/billing/summary","href":"/api-reference/selfbilling/get-self-billing-summary"},{"title":"Get tenant billing summary","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io get /tenants/billing","href":"/api-reference/selfbilling/get-tenant-billing-summary"}]},{"group":"Prices","pages":[{"title":"Create price","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /prices","href":"/api-reference/prices/create-price"},{"title":"Create prices in bulk","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /prices/bulk","href":"/api-reference/prices/create-prices-in-bulk"},{"title":"Get price by lookup key","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io get /prices/lookup/{lookup_key}","href":"/api-reference/prices/get-price-by-lookup-key"},{"title":"Query prices","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /prices/search","href":"/api-reference/prices/query-prices"},{"title":"Get price","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io get /prices/{id}","href":"/api-reference/prices/get-price"},{"title":"Update price","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io put /prices/{id}","href":"/api-reference/prices/update-price"},{"title":"Delete price","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io delete /prices/{id}","href":"/api-reference/prices/delete-price"}]},{"group":"Price Units","pages":[{"title":"List price units","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io get /prices/units","href":"/api-reference/price-units/list-price-units"},{"title":"Create price unit","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /prices/units","href":"/api-reference/price-units/create-price-unit"},{"title":"Get price unit by code","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io get /prices/units/code/{code}","href":"/api-reference/price-units/get-price-unit-by-code"},{"title":"Query price units","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /prices/units/search","href":"/api-reference/price-units/query-price-units"},{"title":"Get price unit","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io get /prices/units/{id}","href":"/api-reference/price-units/get-price-unit"},{"title":"Update price unit","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io put /prices/units/{id}","href":"/api-reference/price-units/update-price-unit"},{"title":"Delete price unit","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io delete /prices/units/{id}","href":"/api-reference/price-units/delete-price-unit"}]},{"group":"RBAC","pages":[{"title":"List all RBAC roles","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io get /rbac/roles","href":"/api-reference/rbac/list-all-rbac-roles"},{"title":"Get a specific RBAC role","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io get /rbac/roles/{id}","href":"/api-reference/rbac/get-a-specific-rbac-role"}]},{"group":"Refunds","pages":[{"title":"List refunds","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io get /refunds","href":"/api-reference/refunds/list-refunds"},{"title":"Get refund","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io get /refunds/{id}","href":"/api-reference/refunds/get-refund"},{"title":"Retry refund","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /refunds/{id}/retry","href":"/api-reference/refunds/retry-refund"}]},{"group":"Secrets","pages":[{"title":"List API keys","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io get /secrets/api/keys","href":"/api-reference/secrets/list-api-keys"},{"title":"Create a new API key","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /secrets/api/keys","href":"/api-reference/secrets/create-a-new-api-key"},{"title":"Delete an API key","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io delete /secrets/api/keys/{id}","href":"/api-reference/secrets/delete-an-api-key"}]},{"group":"Subscriptions","pages":[{"title":"Create subscription","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /subscriptions","href":"/api-reference/subscriptions/create-subscription"},{"title":"Add addon to subscription","deprecated":true,"version":null,"openapi":"https://swagger.flexprice.io post /subscriptions/addon","href":"/api-reference/subscriptions/add-addon-to-subscription"},{"title":"Remove addon from subscription","deprecated":true,"version":null,"openapi":"https://swagger.flexprice.io delete /subscriptions/addon","href":"/api-reference/subscriptions/remove-addon-from-subscription"},{"title":"Search subscription line items","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /subscriptions/lineitems/search","href":"/api-reference/subscriptions/search-subscription-line-items"},{"title":"Update subscription line item","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io put /subscriptions/lineitems/{id}","href":"/api-reference/subscriptions/update-subscription-line-item"},{"title":"Delete subscription line item","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io delete /subscriptions/lineitems/{id}","href":"/api-reference/subscriptions/delete-subscription-line-item"},{"title":"List all subscription schedules","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io get /subscriptions/schedules","href":"/api-reference/subscriptions/list-all-subscription-schedules"},{"title":"Get subscription schedule","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io get /subscriptions/schedules/{schedule_id}","href":"/api-reference/subscriptions/get-subscription-schedule"},{"title":"Cancel subscription schedule","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /subscriptions/schedules/{schedule_id}/cancel","href":"/api-reference/subscriptions/cancel-subscription-schedule"},{"title":"Query subscriptions","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /subscriptions/search","href":"/api-reference/subscriptions/query-subscriptions"},{"title":"Get usage by subscription","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /subscriptions/usage","href":"/api-reference/subscriptions/get-usage-by-subscription"},{"title":"Get subscription","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io get /subscriptions/{id}","href":"/api-reference/subscriptions/get-subscription"},{"title":"Update subscription","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io put /subscriptions/{id}","href":"/api-reference/subscriptions/update-subscription"},{"title":"Activate draft subscription","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /subscriptions/{id}/activate","href":"/api-reference/subscriptions/activate-draft-subscription"},{"title":"Get active addon associations","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io get /subscriptions/{id}/addons/associations","href":"/api-reference/subscriptions/get-active-addon-associations"},{"title":"Cancel subscription","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /subscriptions/{id}/cancel","href":"/api-reference/subscriptions/cancel-subscription"},{"title":"Execute subscription plan change","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /subscriptions/{id}/change/execute","href":"/api-reference/subscriptions/execute-subscription-plan-change"},{"title":"Preview subscription plan change","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /subscriptions/{id}/change/preview","href":"/api-reference/subscriptions/preview-subscription-plan-change"},{"title":"Execute a plan change (v2, swap in place)","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /subscriptions/{id}/change/v2/execute","href":"/api-reference/subscriptions/execute-a-plan-change-v2-swap-in-place"},{"title":"Preview a plan change (v2, swap in place)","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /subscriptions/{id}/change/v2/preview","href":"/api-reference/subscriptions/preview-a-plan-change-v2-swap-in-place"},{"title":"Get subscription entitlements","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io get /subscriptions/{id}/entitlements","href":"/api-reference/subscriptions/get-subscription-entitlements"},{"title":"Get upcoming credit grant applications","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io get /subscriptions/{id}/grants/upcoming","href":"/api-reference/subscriptions/get-upcoming-credit-grant-applications"},{"title":"Create subscription line item","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /subscriptions/{id}/lineitems","href":"/api-reference/subscriptions/create-subscription-line-item"},{"title":"Execute subscription modification","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /subscriptions/{id}/modify/execute","href":"/api-reference/subscriptions/execute-subscription-modification"},{"title":"Preview subscription modification","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /subscriptions/{id}/modify/preview","href":"/api-reference/subscriptions/preview-subscription-modification"},{"title":"Pause subscription","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /subscriptions/{id}/pause","href":"/api-reference/subscriptions/pause-subscription"},{"title":"Resume subscription","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /subscriptions/{id}/resume","href":"/api-reference/subscriptions/resume-subscription"},{"title":"List subscription schedules","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io get /subscriptions/{id}/schedules","href":"/api-reference/subscriptions/list-subscription-schedules"},{"title":"Get subscription (V2)","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io get /subscriptions/{id}/v2","href":"/api-reference/subscriptions/get-subscription-v2"}]},{"group":"Tasks","pages":[{"title":"List tasks","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io get /tasks","href":"/api-reference/tasks/list-tasks"},{"title":"Import a CSV of usage events","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /tasks","href":"/api-reference/tasks/import-a-csv-of-usage-events"},{"title":"Get task processing result","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io get /tasks/result","href":"/api-reference/tasks/get-task-processing-result"},{"title":"Get a task","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io get /tasks/{id}","href":"/api-reference/tasks/get-a-task"},{"title":"Download task export file","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io get /tasks/{id}/download","href":"/api-reference/tasks/download-task-export-file"},{"title":"Update task status","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io put /tasks/{id}/status","href":"/api-reference/tasks/update-task-status"}]},{"group":"Scheduled Tasks","pages":[{"title":"List scheduled tasks","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io get /tasks/scheduled","href":"/api-reference/scheduled-tasks/list-scheduled-tasks"},{"title":"Create scheduled task","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /tasks/scheduled","href":"/api-reference/scheduled-tasks/create-scheduled-task"},{"title":"Schedule draft finalization","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /tasks/scheduled/schedule-draft-finalization","href":"/api-reference/scheduled-tasks/schedule-draft-finalization"},{"title":"Schedule update billing period","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /tasks/scheduled/schedule-update-billing-period","href":"/api-reference/scheduled-tasks/schedule-update-billing-period"},{"title":"Get scheduled task","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io get /tasks/scheduled/{id}","href":"/api-reference/scheduled-tasks/get-scheduled-task"},{"title":"Update a scheduled task","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io put /tasks/scheduled/{id}","href":"/api-reference/scheduled-tasks/update-a-scheduled-task"},{"title":"Delete a scheduled task","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io delete /tasks/scheduled/{id}","href":"/api-reference/scheduled-tasks/delete-a-scheduled-task"},{"title":"Trigger force run","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /tasks/scheduled/{id}/run","href":"/api-reference/scheduled-tasks/trigger-force-run"}]},{"group":"Tax Associations","pages":[{"title":"List tax associations","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io get /taxes/associations","href":"/api-reference/tax-associations/list-tax-associations"},{"title":"Create Tax Association","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /taxes/associations","href":"/api-reference/tax-associations/create-tax-association"},{"title":"Get Tax Association","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io get /taxes/associations/{id}","href":"/api-reference/tax-associations/get-tax-association"},{"title":"Update tax association","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io put /taxes/associations/{id}","href":"/api-reference/tax-associations/update-tax-association"},{"title":"Delete tax association","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io delete /taxes/associations/{id}","href":"/api-reference/tax-associations/delete-tax-association"}]},{"group":"Tax Rates","pages":[{"title":"Get tax rates","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io get /taxes/rates","href":"/api-reference/tax-rates/get-tax-rates"},{"title":"Create a tax rate","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /taxes/rates","href":"/api-reference/tax-rates/create-a-tax-rate"},{"title":"Get a tax rate","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io get /taxes/rates/{id}","href":"/api-reference/tax-rates/get-a-tax-rate"},{"title":"Update a tax rate","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io put /taxes/rates/{id}","href":"/api-reference/tax-rates/update-a-tax-rate"},{"title":"Delete a tax rate","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io delete /taxes/rates/{id}","href":"/api-reference/tax-rates/delete-a-tax-rate"}]},{"group":"Tenants","pages":[{"title":"Update a tenant","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io put /tenants/update","href":"/api-reference/tenants/update-a-tenant"},{"title":"Get tenant by ID","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io get /tenants/{id}","href":"/api-reference/tenants/get-tenant-by-id"}]},{"group":"Usage Records","pages":[{"title":"List usage records","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /usage-records/search","href":"/api-reference/usage-records/list-usage-records"}]},{"group":"Users","pages":[{"title":"Create user or service account","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /users","href":"/api-reference/users/create-user-or-service-account"},{"title":"Get current user","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io get /users/me","href":"/api-reference/users/get-current-user"},{"title":"Update current user","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io put /users/me","href":"/api-reference/users/update-current-user"},{"title":"Query users","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /users/search","href":"/api-reference/users/query-users"},{"title":"Update service account","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io put /users/{id}","href":"/api-reference/users/update-service-account"},{"title":"Delete service account","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io delete /users/{id}","href":"/api-reference/users/delete-service-account"},{"title":"Remove user from tenant","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /users/{id}/remove","href":"/api-reference/users/remove-user-from-tenant"},{"title":"Update user roles","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io put /users/{id}/roles","href":"/api-reference/users/update-user-roles"}]},{"group":"Webhook Events","pages":[{"title":"checkout.session.completed","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /webhook-events/checkout.session.completed","href":"/api-reference/webhook-events/checkoutsessioncompleted"},{"title":"checkout.session.expired","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /webhook-events/checkout.session.expired","href":"/api-reference/webhook-events/checkoutsessionexpired"},{"title":"checkout.session.failed","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /webhook-events/checkout.session.failed","href":"/api-reference/webhook-events/checkoutsessionfailed"},{"title":"checkout.session.initiated","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /webhook-events/checkout.session.initiated","href":"/api-reference/webhook-events/checkoutsessioninitiated"},{"title":"credit_note.created","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /webhook-events/credit_note.created","href":"/api-reference/webhook-events/credit_notecreated"},{"title":"credit_note.updated","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /webhook-events/credit_note.updated","href":"/api-reference/webhook-events/credit_noteupdated"},{"title":"customer.created","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /webhook-events/customer.created","href":"/api-reference/webhook-events/customercreated"},{"title":"customer.deleted","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /webhook-events/customer.deleted","href":"/api-reference/webhook-events/customerdeleted"},{"title":"customer.updated","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /webhook-events/customer.updated","href":"/api-reference/webhook-events/customerupdated"},{"title":"entitlement.created","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /webhook-events/entitlement.created","href":"/api-reference/webhook-events/entitlementcreated"},{"title":"entitlement.deleted","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /webhook-events/entitlement.deleted","href":"/api-reference/webhook-events/entitlementdeleted"},{"title":"entitlement.updated","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /webhook-events/entitlement.updated","href":"/api-reference/webhook-events/entitlementupdated"},{"title":"event.rejected","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /webhook-events/event.rejected","href":"/api-reference/webhook-events/eventrejected"},{"title":"feature.created","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /webhook-events/feature.created","href":"/api-reference/webhook-events/featurecreated"},{"title":"feature.deleted","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /webhook-events/feature.deleted","href":"/api-reference/webhook-events/featuredeleted"},{"title":"feature.updated","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /webhook-events/feature.updated","href":"/api-reference/webhook-events/featureupdated"},{"title":"feature.wallet_balance.alert","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /webhook-events/feature.wallet_balance.alert","href":"/api-reference/webhook-events/featurewallet_balancealert"},{"title":"invoice.communication.triggered","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /webhook-events/invoice.communication.triggered","href":"/api-reference/webhook-events/invoicecommunicationtriggered"},{"title":"invoice.create.drafted","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /webhook-events/invoice.create.drafted","href":"/api-reference/webhook-events/invoicecreatedrafted"},{"title":"invoice.payment.overdue","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /webhook-events/invoice.payment.overdue","href":"/api-reference/webhook-events/invoicepaymentoverdue"},{"title":"invoice.sync.failed","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /webhook-events/invoice.sync.failed","href":"/api-reference/webhook-events/invoicesyncfailed"},{"title":"invoice.sync.success","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /webhook-events/invoice.sync.success","href":"/api-reference/webhook-events/invoicesyncsuccess"},{"title":"invoice.update","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /webhook-events/invoice.update","href":"/api-reference/webhook-events/invoiceupdate"},{"title":"invoice.update.finalized","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /webhook-events/invoice.update.finalized","href":"/api-reference/webhook-events/invoiceupdatefinalized"},{"title":"invoice.update.payment","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /webhook-events/invoice.update.payment","href":"/api-reference/webhook-events/invoiceupdatepayment"},{"title":"invoice.update.voided","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /webhook-events/invoice.update.voided","href":"/api-reference/webhook-events/invoiceupdatevoided"},{"title":"payment.created","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /webhook-events/payment.created","href":"/api-reference/webhook-events/paymentcreated"},{"title":"payment.failed","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /webhook-events/payment.failed","href":"/api-reference/webhook-events/paymentfailed"},{"title":"payment.pending","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /webhook-events/payment.pending","href":"/api-reference/webhook-events/paymentpending"},{"title":"payment.success","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /webhook-events/payment.success","href":"/api-reference/webhook-events/paymentsuccess"},{"title":"payment.updated","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /webhook-events/payment.updated","href":"/api-reference/webhook-events/paymentupdated"},{"title":"refund.created","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /webhook-events/refund.created","href":"/api-reference/webhook-events/refundcreated"},{"title":"refund.failed","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /webhook-events/refund.failed","href":"/api-reference/webhook-events/refundfailed"},{"title":"refund.succeeded","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /webhook-events/refund.succeeded","href":"/api-reference/webhook-events/refundsucceeded"},{"title":"subscription.activated","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /webhook-events/subscription.activated","href":"/api-reference/webhook-events/subscriptionactivated"},{"title":"subscription.cancelled","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /webhook-events/subscription.cancelled","href":"/api-reference/webhook-events/subscriptioncancelled"},{"title":"subscription.created","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /webhook-events/subscription.created","href":"/api-reference/webhook-events/subscriptioncreated"},{"title":"subscription.draft.created","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /webhook-events/subscription.draft.created","href":"/api-reference/webhook-events/subscriptiondraftcreated"},{"title":"subscription.group_spend.threshold_reached","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /webhook-events/subscription.group_spend.threshold_reached","href":"/api-reference/webhook-events/subscriptiongroup_spendthreshold_reached"},{"title":"subscription.group_spend.threshold_recovered","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /webhook-events/subscription.group_spend.threshold_recovered","href":"/api-reference/webhook-events/subscriptiongroup_spendthreshold_recovered"},{"title":"subscription.line_item_spend.threshold_reached","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /webhook-events/subscription.line_item_spend.threshold_reached","href":"/api-reference/webhook-events/subscriptionline_item_spendthreshold_reached"},{"title":"subscription.line_item_spend.threshold_recovered","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /webhook-events/subscription.line_item_spend.threshold_recovered","href":"/api-reference/webhook-events/subscriptionline_item_spendthreshold_recovered"},{"title":"subscription.paused","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /webhook-events/subscription.paused","href":"/api-reference/webhook-events/subscriptionpaused"},{"title":"subscription.phase.created","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /webhook-events/subscription.phase.created","href":"/api-reference/webhook-events/subscriptionphasecreated"},{"title":"subscription.phase.deleted","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /webhook-events/subscription.phase.deleted","href":"/api-reference/webhook-events/subscriptionphasedeleted"},{"title":"subscription.phase.updated","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /webhook-events/subscription.phase.updated","href":"/api-reference/webhook-events/subscriptionphaseupdated"},{"title":"subscription.plan_changed","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /webhook-events/subscription.plan_changed","href":"/api-reference/webhook-events/subscriptionplan_changed"},{"title":"subscription.renewal.due","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /webhook-events/subscription.renewal.due","href":"/api-reference/webhook-events/subscriptionrenewaldue"},{"title":"subscription.resumed","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /webhook-events/subscription.resumed","href":"/api-reference/webhook-events/subscriptionresumed"},{"title":"subscription.spend.threshold_reached","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /webhook-events/subscription.spend.threshold_reached","href":"/api-reference/webhook-events/subscriptionspendthreshold_reached"},{"title":"subscription.spend.threshold_recovered","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /webhook-events/subscription.spend.threshold_recovered","href":"/api-reference/webhook-events/subscriptionspendthreshold_recovered"},{"title":"subscription.updated","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /webhook-events/subscription.updated","href":"/api-reference/webhook-events/subscriptionupdated"},{"title":"wallet.created","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /webhook-events/wallet.created","href":"/api-reference/webhook-events/walletcreated"},{"title":"wallet.credit_balance.dropped","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /webhook-events/wallet.credit_balance.dropped","href":"/api-reference/webhook-events/walletcredit_balancedropped"},{"title":"wallet.credit_balance.recovered","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /webhook-events/wallet.credit_balance.recovered","href":"/api-reference/webhook-events/walletcredit_balancerecovered"},{"title":"wallet.ongoing_balance.dropped","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /webhook-events/wallet.ongoing_balance.dropped","href":"/api-reference/webhook-events/walletongoing_balancedropped"},{"title":"wallet.ongoing_balance.recovered","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /webhook-events/wallet.ongoing_balance.recovered","href":"/api-reference/webhook-events/walletongoing_balancerecovered"},{"title":"wallet.ongoing_balance.updated","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /webhook-events/wallet.ongoing_balance.updated","href":"/api-reference/webhook-events/walletongoing_balanceupdated"},{"title":"wallet.terminated","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /webhook-events/wallet.terminated","href":"/api-reference/webhook-events/walletterminated"},{"title":"wallet.transaction.created","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /webhook-events/wallet.transaction.created","href":"/api-reference/webhook-events/wallettransactioncreated"},{"title":"wallet.transaction.updated","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /webhook-events/wallet.transaction.updated","href":"/api-reference/webhook-events/wallettransactionupdated"},{"title":"wallet.updated","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /webhook-events/wallet.updated","href":"/api-reference/webhook-events/walletupdated"}]},{"group":"Workflows","pages":[{"title":"Query workflows","deprecated":null,"version":null,"openapi":"https://swagger.flexprice.io post /workflows/search","href":"/api-reference/workflows/query-workflows"}]}]}]},{"tab":"Developers","pages":[{"title":"Developers","href":"/developers/overview"}]},{"tab":"Integrations","pages":[{"title":"Integrations","href":"/integrations/introduction"}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/docs/changelog"}]}]},"title":"Create addon - Flexprice","buildId":"dpl_HcHmUS6i3UwswnTHJUEdcTtwfdTQ","deploymentId":"dpl_HcHmUS6i3UwswnTHJUEdcTtwfdTQ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-BRm_l__d.js","utils-f1l1Oc-G.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BlhqDhJO.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DHCB7rsC.js","snippetPresets-CYXLx6Hv.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-B78P2dEq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C4YLPVAh.js","shallow-vlLnTDkQ.js","getApiPlaygroundDisplay-D_98hhvf.js","CodeSnippet-DtnZHGqq.js","CodeSnippets-CLFb8KJt.js","Page-kQh739Uz.js","getPastedJson-Cq-zlbnU.js","icon-sN3t983t.js","MethodPill-P_YQ2s09.js","DuplicateIcon-BVzyNsGJ.js","createIcon-B3jqgqC6.js","DynamicMarkdown-Crwq6WG_.js","SectionHeading-C7pGS2Bb.js","axios-vUo_bRtp.js","Markdown-BuPH8yuW.js","clsx-CCOYKgaU.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BnkC_6oA.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BM4S31-f.js"]}