This option can be enabled while creating a price plan to opt for deferred revenue finalization.
i.e, Togai will assume that the price plan may change any time during the pricing cycle and
thereby does not compute the revenue in near-real time.
This gives the flexibility of editing rate cards in price plan from beginning of the pricing cycle.
Enabling this mode comes with the following limitations.
Following rate cards are not supported under a deferredRevenue plan
creditGrantRateCards,
billingEntitlementRateCards,
entitlementOverageRateCards,
IN_ADVANCE fixedFeeRateCards,
IN_ADVANCE licenseRateCards
Metrics API return revenue metrics only after the grace period of the account's pricing cycle
(i.e, only once the invoice becomes DUE)
This option can be enabled while creating a price plan to opt for deferred revenue finalization.
i.e, Togai will assume that the price plan may change any time during the pricing cycle and
thereby does not compute the revenue in near-real time.
This gives the flexibility of editing rate cards in price plan from beginning of the pricing cycle.
Enabling this mode comes with the following limitations.
Following rate cards are not supported under a deferredRevenue plan
creditGrantRateCards,
billingEntitlementRateCards,
entitlementOverageRateCards,
IN_ADVANCE fixedFeeRateCards,
IN_ADVANCE licenseRateCards
Metrics API return revenue metrics only after the grace period of the account's pricing cycle
(i.e, only once the invoice becomes DUE)
Allow changes to price plan from the beginning of the ongoing cycle.
{"docsConfig":{"$schema":"https://mintlify.com/docs.json","theme":"mint","name":"Togai documentation","colors":{"primary":"#2853C2","light":"#2563EB","dark":"#2563EB"},"favicon":"/images/togai-logo-light.svg","logo":{"light":"https://mintcdn.com/zuora-togai/gpDI_SmUijp8C7vA/images/togai-light.png?fit=max\u0026auto=format\u0026n=gpDI_SmUijp8C7vA\u0026q=85\u0026s=f564a808b1f89a7be82bef2effbcbeea","dark":"https://mintcdn.com/zuora-togai/gpDI_SmUijp8C7vA/images/togai-dark.svg?fit=max\u0026auto=format\u0026n=gpDI_SmUijp8C7vA\u0026q=85\u0026s=32fc4951a4bf9381284ec120bc163c72"},"api":{"openapi":["openapi.yaml"],"playground":{"display":"simple"},"mdx":{"server":["https://sandbox-api.togai.com","https://api.togai.com"],"auth":{"method":"bearer","name":null}}},"background":{"image":"https://mintlify.s3.us-west-1.amazonaws.com/zuora-togai/images/background-documentation-min.png","decoration":null,"color":{"light":"#F8FAFC","dark":"#0D101F"}},"navbar":{"links":[{"label":"Demo app","href":"https://demo.togai.com"},{"label":"Login","href":"https://app.togai.com/login"}],"primary":{"type":"button","label":"Try for free","href":"https://app.togai.com/onboarding"}},"footer":{"socials":{"website":"https://togai.com","twitter":"https://twitter.com/togaiHQ","github":"https://github.com/TogaiHQ/","linkedin":"https://www.linkedin.com/company/togai"}},"integrations":{"ga4":{"measurementId":"G-Q0BLXR7WX5"},"gtm":{"tagId":"GTM-TS4BK7Z"}},"navigation":{"global":{"anchors":[{"anchor":"Postman collection","href":"https://www.postman.com/togai-workspace/workspace/togai-public","icon":"folder-open"},{"anchor":"Open API spec","href":"https://github.com/TogaiHQ/togai-mintlify-docs/blob/main/openapi.yaml","icon":{"name":"brackets-curly","style":"solid"}}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"zuora-togai","hasAudioNarration":false,"actualSubdomain":"zuora-togai","customDomains":["docs.togai.com"],"gitSource":{"type":"github","owner":"zuora","repo":"togai-mintlify-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a21e64ff325d2bf1006031a","collectionId":"4133aab6-8f92-457d-b1b7-2c069657b8f2","schemaVersion":"v2"},"feedback":{"edits":true,"issues":true},"entitlements":{},"buildId":"6a21e64ff325d2bf1006031a:success","clientVersion":"0.0.3964","searchFilterCounts":[{"language":"default","tag":"API Reference","count":147},{"language":"default","tag":"APIs","count":144},{"language":"default","tag":"Documentation","count":73},{"language":"default","tag":"Integrations","count":36},{"language":"default","tag":"Accounts","count":27},{"language":"default","tag":"How-To's","count":18},{"language":"default","tag":"Price Plan V2","count":13},{"language":"default","tag":"Manage customers","count":12},{"language":"default","tag":"Alerts","count":9},{"language":"default","tag":"Invoices","count":9}]},"assistantConfig":{},"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}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/priceplanv2/create-a-price-plan","slug":"/api-reference/priceplanv2/create-a-price-plan","pageMetadata":{"openapi":"post /v2/price_plans","title":"Create a price plan","description":"Create a price plan","href":"/api-reference/priceplanv2/create-a-price-plan"},"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: \"Create a price plan\"\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":{"openapi":"post /v2/price_plans","title":"Create a price plan","description":"Create a price plan","href":"/api-reference/priceplanv2/create-a-price-plan"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["PricePlanV2"],"summary":"Create a price plan","description":"Create a price plan","operationId":"createPricePlanV2","requestBody":"7cb90d44-6916-4694-85c3-aa7a92ecead6","responses":{"200":"6620edc3-95bf-414c-9d1b-3e904a6003f0","default":"c15711a2-00fb-4759-a001-bd9283c25b4b"},"method":"post","type":"path","servers":["b517a395-a163-43f7-af0b-3e4ebe6efe76","9589ebc2-f0a7-4d5f-9437-c1f8f01bd941"],"security":["899f1d41-fe4e-43f8-88d3-8402ebff54f4"],"path":"/v2/price_plans","baseUrlOptions":["https://api.togai.com/","https://sandbox-api.togai.com/"],"title":"Create a price plan","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"description":"Payload to create price plan","required":true,"content":{"application/json":{"schema":{"description":"Request to create a price plan","type":"object","additionalProperties":false,"required":["name","type","supportedCurrencies"],"properties":{"name":{"type":"string","description":"Name of the price plan","maxLength":50,"isRequired":true,"uniqueKey":"name","typeLabel":"string"},"type":{"type":"string","description":"Type of price plan","enum":["BILLING","PURCHASE"],"isRequired":true,"uniqueKey":"type","typeLabel":"enum\u003cstring>"},"supportedCurrencies":{"description":"List of currencies supported by the price plan","type":"array","uniqueItems":true,"items":{"type":"string","uniqueKey":"supportedCurrencies.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"supportedCurrencies","typeLabel":"string[]"},"description":{"description":"Description of price plan","type":"string","maxLength":255,"uniqueKey":"description","typeLabel":"string"},"pricingCycleConfig":{"type":"object","description":"Represents configurations related to pricing cycle","required":["interval","gracePeriod"],"properties":{"interval":{"type":"string","description":"Interval field allow you to define the billing interval you would like to set","enum":["WEEKLY","MONTHLY","QUARTERLY","HALF_YEARLY","ANNUALLY"],"isRequired":true,"uniqueKey":"pricingCycleConfig.interval","typeLabel":"enum\u003cstring>"},"gracePeriod":{"type":"integer","description":"Togai allows you to ingest past dated events that will be processed by a pricing cycle till the end grace period. \nFor example: Pricing cycle is Monthly from 1st to 30th and gracePeriod is 5 days which next month 1 to 5th date, you can ingest past dated events during this grace period.\n","format":"int32","example":3,"isRequired":true,"uniqueKey":"pricingCycleConfig.gracePeriod","typeLabel":"integer\u003cint32>"},"startOffset":{"type":"object","description":"Represents the start of pricing cycle in terms of\n - dayOffset - number of days from beginning of week / month and\n - monthOffset - number of months from beginning of interval (quarter, half-year or year)\nNote: If a day with offset doesn't exist for a month, closest previous day is considered\nExamples:\nWEEKLY -\n - {dayOffset: 1, monthOffset: NIL} - First day of every week (Monday)\n - {dayOffset: 3, monthOffset: NIL} - 3rd day of every week (Wednesday)\n - {dayOffset: LAST, monthOffset: NIL} - Last day of every week (Sunday)\nMONTHLY -\n - {dayOffset: 1, monthOffset: NIL} - First day of every month\n - {dayOffset: 12, monthOffset: NIL} - 12th of every month\n - {dayOffset: 28, monthOffset: NIL} - 28th of every month. i.e, 28th of Jan, 28th of Feb, ...\n - {dayOffset: 30, monthOffset: NIL} - 30th of every month. i.e, 28th of Jan, 28th of Feb, ...\n - {dayOffset: LAST, monthOffset: NIL} - Last day of every month. i.e, 31st of Jan, 28th of Feb, ...\nQUARTERLY\n - {dayOffset: 15, monthOffset: FIRST} - 15th Jan, 15th Apr, 15th Jul and 15th Oct\n - {dayOffset: 15, monthOffset: 2} - 15th Feb, 15th May, 15th Aug and 15th Nov\n - {dayOffset: 15, monthOffset: LAST} - 15th Mar, 15th Jun, 15th Sep and 15th Dec\n - {dayOffset: LAST, monthOffset: FIRST} - 31st Jan, 30th Apr, 30th Jul and 31th Oct\nHALF_YEARLY\n - {dayOffset: 15, monthOffset: FIRST} - 15th Jan and 15th Jul\n - {dayOffset: 15, monthOffset: 4} - 15th Apr and 15th Oct\n - {dayOffset: 15, monthOffset: LAST} - 15th Jun and 15th Dec\nANNUALLY\n - {dayOffset: 15, monthOffset: FIRST} - 15th Jan\n - {dayOffset: 15, monthOffset: 1} - 15th Jan\n - {dayOffset: LAST, monthOffset: 2} - 29th Feb on Leap year, 28th otherwise \n - {dayOffset: 15, monthOffset: 8} - 15th Aug\n - {dayOffset: 15, monthOffset: LAST} - 15th Dec\n","required":["dayOffset","monthOffset"],"properties":{"dayOffset":{"type":"string","description":"If interval is WEEKLY, min: \"1\" and max: \"7\" as strings. Spl. string allowed: LAST\nOtherwise, min: \"1\" and max: \"31\" as strings. Spl. string allowed: LAST\n","isRequired":true,"uniqueKey":"pricingCycleConfig.startOffset.dayOffset","typeLabel":"string"},"monthOffset":{"type":"string","description":"min: \"1\" and max: \"12\". Spl. string allowed: FIRST / LAST.\nFor QUARTERLY only 1 - 3 is allowed and for HALF_YEARLY 1 - 6. This being an optional field, shouldn't be passed for MONTHLY.\n","isRequired":true,"uniqueKey":"pricingCycleConfig.startOffset.monthOffset","typeLabel":"string"}},"uniqueKey":"pricingCycleConfig.startOffset","typeLabel":"object"},"anniversaryCycle":{"type":"boolean","description":"Togai calculates the startOffsets based on the date of association instead of requiring from the user and \nthese offsets will be applied as an override if this flag is enabled.\nExamples:\nWEEKLY -\n - 23/10/2023 (Monday) - {dayOffset: 1, monthOffset: NIL} \n - 25/10/2023 (Wednesday) - {dayOffset: 3, monthOffset: NIL} \n - 29/10/2023 (Sunday) - {dayOffset: 7, monthOffset: NIL}\nMONTHLY -\n - 1st Oct - {dayOffset: 1, monthOffset: NIL}\n - 12th Oct - {dayOffset: 12, monthOffset: NIL}\n - 28th Oct - {dayOffset: 28, monthOffset: NIL}\n - 30th Oct - {dayOffset: 30, monthOffset: NIL}\n - 31th Oct - {dayOffset: LAST, monthOffset: NIL}\nQUARTERLY\n - 15th Jan, 15th Apr, 15th Jul and 15th Oct - {dayOffset: 15, monthOffset: 1}\n - 15th Feb, 15th May, 15th Aug and 15th Nov - {dayOffset: 15, monthOffset: 2} \n - 15th Mar, 15th Jun, 15th Sep and 15th Dec - {dayOffset: 15, monthOffset: 3}\nHALF_YEARLY\n - 15th Jan and 15th Jul - {dayOffset: 15, monthOffset: 1} \n - 15th Apr and 15th Oct - {dayOffset: 15, monthOffset: 4} \n - 15th Jun and 15th Dec - {dayOffset: 15, monthOffset: 6}\nANNUALLY\n - 15th Jan - {dayOffset: 15, monthOffset: 1}\n - 29th Feb on Leap year - {dayOffset: LAST, monthOffset: 2}\n - 28th Feb - {dayOffset: LAST, monthOffset: 2}\n - 15th Aug - {dayOffset: 15, monthOffset: 8}\n - 15th Dec - {dayOffset: 15, monthOffset: 12}\n","uniqueKey":"pricingCycleConfig.anniversaryCycle","typeLabel":"boolean"}},"uniqueKey":"pricingCycleConfig","typeLabel":"object"},"deferredRevenue":{"description":"This option can be enabled while creating a price plan to opt for deferred revenue finalization.\ni.e, Togai will assume that the price plan may change any time during the pricing cycle and \nthereby does not compute the revenue in near-real time. \nThis gives the flexibility of editing rate cards in price plan from beginning of the pricing cycle.\nEnabling this mode comes with the following limitations.\n1. Following rate cards are not supported under a `deferredRevenue` plan\n * creditGrantRateCards,\n * billingEntitlementRateCards,\n * entitlementOverageRateCards,\n * IN_ADVANCE fixedFeeRateCards,\n * IN_ADVANCE licenseRateCards\n2. Metrics API return revenue metrics only after the grace period of the account's pricing cycle \n(i.e, only once the invoice becomes DUE)\n","type":"boolean","uniqueKey":"deferredRevenue","typeLabel":"boolean"},"allowOngoingCycleUpdates":{"description":"Allow changes to price plan from the beginning of the ongoing cycle.\n","type":"boolean","uniqueKey":"allowOngoingCycleUpdates","typeLabel":"boolean"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"name":"\u003cstring>","supportedCurrencies":["\u003cstring>"],"description":"\u003cstring>","deferredRevenue":true,"allowOngoingCycleUpdates":true}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"6620edc3-95bf-414c-9d1b-3e904a6003f0":{"description":"Response for Create and Get price plan requests","content":{"application/json":{"schema":{"type":"object","description":"Request to create a price plan","required":["id","referenceId","version","status","createdAt","updatedAt","name","type","supportedCurrencies"],"properties":{"name":{"type":"string","description":"Name of the price plan","maxLength":50,"isRequired":true,"uniqueKey":"name","typeLabel":"string"},"type":{"type":"string","description":"Type of price plan","enum":["BILLING","PURCHASE"],"isRequired":true,"uniqueKey":"type","typeLabel":"enum\u003cstring>"},"supportedCurrencies":{"description":"List of currencies supported by the price plan","type":"array","uniqueItems":true,"items":{"type":"string","uniqueKey":"supportedCurrencies.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"supportedCurrencies","typeLabel":"string[]"},"id":{"type":"string","maxLength":50,"isRequired":true,"uniqueKey":"id","typeLabel":"string"},"referenceId":{"type":"string","maxLength":50,"isRequired":true,"uniqueKey":"referenceId","typeLabel":"string"},"version":{"type":"integer","isRequired":true,"uniqueKey":"version","typeLabel":"integer"},"status":{"type":"string","enum":["DRAFT","ACTIVE"],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"createdAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"updatedAt","typeLabel":"string\u003cdate-time>"},"description":{"description":"Description of price plan","type":"string","maxLength":255,"uniqueKey":"description","typeLabel":"string"},"pricingCycleConfig":{"type":"object","description":"Represents configurations related to pricing cycle","required":["interval","gracePeriod"],"properties":{"interval":{"type":"string","description":"Interval field allow you to define the billing interval you would like to set","enum":["WEEKLY","MONTHLY","QUARTERLY","HALF_YEARLY","ANNUALLY"],"isRequired":true,"uniqueKey":"pricingCycleConfig.interval","typeLabel":"enum\u003cstring>"},"gracePeriod":{"type":"integer","description":"Togai allows you to ingest past dated events that will be processed by a pricing cycle till the end grace period. \nFor example: Pricing cycle is Monthly from 1st to 30th and gracePeriod is 5 days which next month 1 to 5th date, you can ingest past dated events during this grace period.\n","format":"int32","example":3,"isRequired":true,"uniqueKey":"pricingCycleConfig.gracePeriod","typeLabel":"integer\u003cint32>"},"startOffset":{"type":"object","description":"Represents the start of pricing cycle in terms of\n - dayOffset - number of days from beginning of week / month and\n - monthOffset - number of months from beginning of interval (quarter, half-year or year)\nNote: If a day with offset doesn't exist for a month, closest previous day is considered\nExamples:\nWEEKLY -\n - {dayOffset: 1, monthOffset: NIL} - First day of every week (Monday)\n - {dayOffset: 3, monthOffset: NIL} - 3rd day of every week (Wednesday)\n - {dayOffset: LAST, monthOffset: NIL} - Last day of every week (Sunday)\nMONTHLY -\n - {dayOffset: 1, monthOffset: NIL} - First day of every month\n - {dayOffset: 12, monthOffset: NIL} - 12th of every month\n - {dayOffset: 28, monthOffset: NIL} - 28th of every month. i.e, 28th of Jan, 28th of Feb, ...\n - {dayOffset: 30, monthOffset: NIL} - 30th of every month. i.e, 28th of Jan, 28th of Feb, ...\n - {dayOffset: LAST, monthOffset: NIL} - Last day of every month. i.e, 31st of Jan, 28th of Feb, ...\nQUARTERLY\n - {dayOffset: 15, monthOffset: FIRST} - 15th Jan, 15th Apr, 15th Jul and 15th Oct\n - {dayOffset: 15, monthOffset: 2} - 15th Feb, 15th May, 15th Aug and 15th Nov\n - {dayOffset: 15, monthOffset: LAST} - 15th Mar, 15th Jun, 15th Sep and 15th Dec\n - {dayOffset: LAST, monthOffset: FIRST} - 31st Jan, 30th Apr, 30th Jul and 31th Oct\nHALF_YEARLY\n - {dayOffset: 15, monthOffset: FIRST} - 15th Jan and 15th Jul\n - {dayOffset: 15, monthOffset: 4} - 15th Apr and 15th Oct\n - {dayOffset: 15, monthOffset: LAST} - 15th Jun and 15th Dec\nANNUALLY\n - {dayOffset: 15, monthOffset: FIRST} - 15th Jan\n - {dayOffset: 15, monthOffset: 1} - 15th Jan\n - {dayOffset: LAST, monthOffset: 2} - 29th Feb on Leap year, 28th otherwise \n - {dayOffset: 15, monthOffset: 8} - 15th Aug\n - {dayOffset: 15, monthOffset: LAST} - 15th Dec\n","required":["dayOffset","monthOffset"],"properties":{"dayOffset":{"type":"string","description":"If interval is WEEKLY, min: \"1\" and max: \"7\" as strings. Spl. string allowed: LAST\nOtherwise, min: \"1\" and max: \"31\" as strings. Spl. string allowed: LAST\n","isRequired":true,"uniqueKey":"pricingCycleConfig.startOffset.dayOffset","typeLabel":"string"},"monthOffset":{"type":"string","description":"min: \"1\" and max: \"12\". Spl. string allowed: FIRST / LAST.\nFor QUARTERLY only 1 - 3 is allowed and for HALF_YEARLY 1 - 6. This being an optional field, shouldn't be passed for MONTHLY.\n","isRequired":true,"uniqueKey":"pricingCycleConfig.startOffset.monthOffset","typeLabel":"string"}},"uniqueKey":"pricingCycleConfig.startOffset","typeLabel":"object"},"anniversaryCycle":{"type":"boolean","description":"Togai calculates the startOffsets based on the date of association instead of requiring from the user and \nthese offsets will be applied as an override if this flag is enabled.\nExamples:\nWEEKLY -\n - 23/10/2023 (Monday) - {dayOffset: 1, monthOffset: NIL} \n - 25/10/2023 (Wednesday) - {dayOffset: 3, monthOffset: NIL} \n - 29/10/2023 (Sunday) - {dayOffset: 7, monthOffset: NIL}\nMONTHLY -\n - 1st Oct - {dayOffset: 1, monthOffset: NIL}\n - 12th Oct - {dayOffset: 12, monthOffset: NIL}\n - 28th Oct - {dayOffset: 28, monthOffset: NIL}\n - 30th Oct - {dayOffset: 30, monthOffset: NIL}\n - 31th Oct - {dayOffset: LAST, monthOffset: NIL}\nQUARTERLY\n - 15th Jan, 15th Apr, 15th Jul and 15th Oct - {dayOffset: 15, monthOffset: 1}\n - 15th Feb, 15th May, 15th Aug and 15th Nov - {dayOffset: 15, monthOffset: 2} \n - 15th Mar, 15th Jun, 15th Sep and 15th Dec - {dayOffset: 15, monthOffset: 3}\nHALF_YEARLY\n - 15th Jan and 15th Jul - {dayOffset: 15, monthOffset: 1} \n - 15th Apr and 15th Oct - {dayOffset: 15, monthOffset: 4} \n - 15th Jun and 15th Dec - {dayOffset: 15, monthOffset: 6}\nANNUALLY\n - 15th Jan - {dayOffset: 15, monthOffset: 1}\n - 29th Feb on Leap year - {dayOffset: LAST, monthOffset: 2}\n - 28th Feb - {dayOffset: LAST, monthOffset: 2}\n - 15th Aug - {dayOffset: 15, monthOffset: 8}\n - 15th Dec - {dayOffset: 15, monthOffset: 12}\n","uniqueKey":"pricingCycleConfig.anniversaryCycle","typeLabel":"boolean"}},"uniqueKey":"pricingCycleConfig","typeLabel":"object"},"deferredRevenue":{"description":"This option can be enabled while creating a price plan to opt for deferred revenue finalization.\ni.e, Togai will assume that the price plan may change any time during the pricing cycle and \nthereby does not compute the revenue in near-real time. \nThis gives the flexibility of editing rate cards in price plan from beginning of the pricing cycle.\nEnabling this mode comes with the following limitations.\n1. Following rate cards are not supported under a `deferredRevenue` plan\n * creditGrantRateCards,\n * billingEntitlementRateCards,\n * entitlementOverageRateCards,\n * IN_ADVANCE fixedFeeRateCards,\n * IN_ADVANCE licenseRateCards\n2. Metrics API return revenue metrics only after the grace period of the account's pricing cycle \n(i.e, only once the invoice becomes DUE)\n","type":"boolean","uniqueKey":"deferredRevenue","typeLabel":"boolean"},"allowOngoingCycleUpdates":{"description":"Allow changes to price plan from the beginning of the ongoing cycle.\n","type":"boolean","uniqueKey":"allowOngoingCycleUpdates","typeLabel":"boolean"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"name":"\u003cstring>","type":"BILLING","supportedCurrencies":["\u003cstring>"],"id":"\u003cstring>","referenceId":"\u003cstring>","version":123,"status":"DRAFT","createdAt":"2023-11-07T05:31:56Z","updatedAt":"2023-11-07T05:31:56Z","description":"\u003cstring>","pricingCycleConfig":{"interval":"WEEKLY","gracePeriod":3,"startOffset":{"dayOffset":"\u003cstring>","monthOffset":"\u003cstring>"},"anniversaryCycle":true},"deferredRevenue":true,"allowOngoingCycleUpdates":true}}},"exampleType":"generated"}},"exampleType":"generated"},"c15711a2-00fb-4759-a001-bd9283c25b4b":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["message"],"properties":{"message":{"type":"string","description":"error description","maxLength":500,"isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"ErrorResponse":{"title":"ErrorResponse","value":{"message":"\u003cReason message>"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"899f1d41-fe4e-43f8-88d3-8402ebff54f4":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"Bearer \u003ccredential>","scopes":[]}}},"servers":{"b517a395-a163-43f7-af0b-3e4ebe6efe76":{"description":"Api endpoint","url":"https://api.togai.com/"},"9589ebc2-f0a7-4d5f-9437-c1f8f01bd941":{"description":"Sandbox api endpoint","url":"https://sandbox-api.togai.com/"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"Bearer \u003ccredential>","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"openapi.yaml"},"subdomain":"zuora-togai","siteName":"Togai documentation","title":"Create a price plan - Togai documentation","navMaps":{"firstHrefInVersion":{"v1":{"href":"/api-reference/priceplanv2/create-a-price-plan","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-01-07T03:50:04.833Z","originalFileLocation":"api-reference/priceplanv2/create-a-price-plan.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=\"Create a price plan\">\u003cmeta data-mint-head name=\"application-name\" content=\"Togai documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/zuora-togai/-3_qRbhWsDYhfzjO/_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/zuora-togai/-3_qRbhWsDYhfzjO/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/zuora-togai/-3_qRbhWsDYhfzjO/_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/zuora-togai/-3_qRbhWsDYhfzjO/_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/zuora-togai/-3_qRbhWsDYhfzjO/_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/zuora-togai/-3_qRbhWsDYhfzjO/_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/zuora-togai/-3_qRbhWsDYhfzjO/_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/zuora-togai/-3_qRbhWsDYhfzjO/_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/zuora-togai/-3_qRbhWsDYhfzjO/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create a price plan - Togai documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Create a price plan\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Togai documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.togai.com/api-reference/priceplanv2/create-a-price-plan\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://zuora-togai.mintlify.app/_mintlify/api/og/v2?division=Price+Plan+V2\u0026amp;title=Create+a+price+plan\u0026amp;description=Create+a+price+plan\u0026amp;theme=c6fa32643e3d775f05465dbc\u0026amp;signature=a627d55d35dfd282f88376f79ef7077610a47aa496349c2bc9fd7550ab7cd0ac\">\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 a price plan - Togai documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Create a price plan\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://zuora-togai.mintlify.app/_mintlify/api/og/v2?division=Price+Plan+V2\u0026amp;title=Create+a+price+plan\u0026amp;description=Create+a+price+plan\u0026amp;theme=c6fa32643e3d775f05465dbc\u0026amp;signature=a627d55d35dfd282f88376f79ef7077610a47aa496349c2bc9fd7550ab7cd0ac\">\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/zuora-togai/-3_qRbhWsDYhfzjO/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Togai documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#2853C2\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.togai.com/api-reference/priceplanv2/create-a-price-plan\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/priceplanv2/create-a-price-plan.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.togai.com/#organization\",\"name\":\"Togai documentation\",\"url\":\"https://docs.togai.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/zuora-togai/gpDI_SmUijp8C7vA/images/togai-light.png?fit=max\u0026auto=format\u0026n=gpDI_SmUijp8C7vA\u0026q=85\u0026s=f564a808b1f89a7be82bef2effbcbeea\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.togai.com#website\",\"name\":\"Togai documentation\",\"url\":\"https://docs.togai.com\",\"publisher\":{\"@id\":\"https://docs.togai.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.togai.com/api-reference/priceplanv2/create-a-price-plan#webpage\",\"url\":\"https://docs.togai.com/api-reference/priceplanv2/create-a-price-plan\",\"name\":\"Create a price plan\",\"description\":\"Create a price plan\",\"dateModified\":\"2026-01-07T03:50:04.833Z\",\"isPartOf\":{\"@id\":\"https://docs.togai.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.togai.com/api-reference/priceplanv2/create-a-price-plan#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.togai.com/api-reference/priceplanv2/create-a-price-plan#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"APIs\",\"item\":\"https://docs.togai.com/api-reference/authentication/get-bearer-token\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Price Plan V2\",\"item\":\"https://docs.togai.com/api-reference/priceplanv2/list-price-plans\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Create a price plan\",\"item\":\"https://docs.togai.com/api-reference/priceplanv2/create-a-price-plan\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.togai.com/api-reference/priceplanv2/create-a-price-plan#apireference\",\"headline\":\"Create a price plan\",\"name\":\"Create a price plan\",\"description\":\"Create a price plan\",\"url\":\"https://docs.togai.com/api-reference/priceplanv2/create-a-price-plan\",\"mainEntityOfPage\":{\"@id\":\"https://docs.togai.com/api-reference/priceplanv2/create-a-price-plan#webpage\"},\"dateModified\":\"2026-01-07T03:50:04.833Z\",\"publisher\":{\"@id\":\"https://docs.togai.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.togai.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Togai documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Togai documentation","nav":{"global":{"anchors":[{"anchor":"Postman collection","href":"https://www.postman.com/togai-workspace/workspace/togai-public","icon":"folder-open"},{"anchor":"Open API spec","href":"https://github.com/TogaiHQ/togai-mintlify-docs/blob/main/openapi.yaml","icon":{"name":"brackets-curly","style":"solid"}}]},"versions":[{"version":"v1","tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/docs/introduction"}]},{"tab":"API Reference","groups":[{"group":"Introduction","pages":[{"title":"Getting Started","href":"/api-reference/getting-started"},{"title":"Authentication 🔐","href":"/api-reference/authentication"},{"title":"Pagination 📄","href":"/api-reference/pagination"}]},{"group":"APIs","pages":[{"group":"Authentication","pages":[{"openapi":"post /authenticate","title":"Generate short lived bearer token","href":"/api-reference/authentication/get-bearer-token"},{"title":"Generate portal token","api":"post /organizations/{organization_id}/token","href":"/api-reference/authentication/customer-portal-auth"},{"openapi":"post /portal/token","title":"Get delegate token for customer portal","href":"/api-reference/authentication/get-delegate-token-for-customer-portal"}]},{"group":"Customers","pages":[{"openapi":"get /customers","title":"List customers","href":"/api-reference/customers/list-customers"},{"openapi":"post /customers","title":"Create a customer","href":"/api-reference/customers/create-a-customer"},{"openapi":"get /customers/{customer_id}","title":"Get a customer","href":"/api-reference/customers/get-a-customer"},{"openapi":"delete /customers/{customer_id}","title":"Delete a customer","href":"/api-reference/customers/delete-a-customer"},{"openapi":"patch /customers/{customer_id}","title":"Update a customer","href":"/api-reference/customers/update-a-customer"}]},{"group":"Accounts","pages":[{"openapi":"get /accounts","title":"List accounts of customer","href":"/api-reference/accounts/list-accounts-of-customer"},{"openapi":"post /accounts","title":"Create an account","href":"/api-reference/accounts/create-an-account"},{"openapi":"get /accounts/{account_id}","title":"Get an account","href":"/api-reference/accounts/get-an-account"},{"openapi":"delete /accounts/{account_id}","title":"Delete an account","href":"/api-reference/accounts/delete-an-account"},{"openapi":"patch /accounts/{account_id}","title":"Update an account","href":"/api-reference/accounts/update-an-account"},{"group":"Account Aliases","pages":[{"openapi":"get /accounts/{account_id}/account_aliases","title":"Get all aliases of an account","href":"/api-reference/accounts/account-aliases/get-all-aliases-of-an-account"},{"openapi":"post /accounts/{account_id}/add_aliases","title":"Add Aliases to account","href":"/api-reference/accounts/account-aliases/add-aliases-to-account"},{"openapi":"post /accounts/{account_id}/remove_aliases","title":"Remove Aliases to account","href":"/api-reference/accounts/account-aliases/remove-aliases-to-account"}]},{"group":"(Deprecated) Plan Associations","pages":[{"openapi":"get /accounts/{account_id}/pricing_schedules","title":"(DEPRECATED) List pricing schedules of an account","href":"/api-reference/accounts/plan-association/list-pricing-schedules-of-an-account"},{"openapi":"post /accounts/{account_id}/edit_schedules","title":"(DEPRECATED) Edit schedules of an account.","href":"/api-reference/accounts/plan-association/edit-schedules-of-an-account"},{"openapi":"post /accounts/{account_id}/price_plans","title":"(DEPRECATED) Dissociate or associate a price plan with an account","href":"/api-reference/accounts/plan-association/disassociate-a-plan-fromto-an-account"}]},{"group":"(Deprecated) Purchases","pages":[{"openapi":"get /accounts/{account_id}/purchases","title":"(DEPRECATED) Get all purchases for an account","href":"/api-reference/accounts/purchases/get-all-purchases-for-an-account"},{"openapi":"post /accounts/{account_id}/purchases","title":"(DEPRECATED) Initiate a purchase","href":"/api-reference/accounts/purchases/initiate-a-purchase"},{"openapi":"get /purchases/{purchase_id}","title":"(DEPRECATED) Get a specific purchase of an account","href":"/api-reference/accounts/purchases/get-a-specific-purchase-of-an-account"}]},{"group":"(Deprecated) Proposals","pages":[{"openapi":"get /accounts/{account_id}/purchase_proposals","title":"(DEPRECATED) List all proposals of an account","href":"/api-reference/accounts/proposals/list-all-proposals-of-an-account"},{"openapi":"post /accounts/{account_id}/purchase_proposals","title":"(DEPRECATED) Propose a purchase of a plan","href":"/api-reference/accounts/proposals/propose-a-purchase-of-a-plan"},{"openapi":"get /purchase_proposals/{purchase_proposal_id}","title":"(DEPRECATED) Get proposal information","href":"/api-reference/accounts/proposals/get-proposal-information"},{"openapi":"post /purchase_proposals/{purchase_proposal_id}/update_status","title":"(DEPRECATED) Approve or decline a purchase of a billing plan","href":"/api-reference/accounts/proposals/approve-or-decline-a-purchase-of-a-billing-plan"}]},{"group":"Schedules","pages":[{"openapi":"get /v2/schedules/{schedule_id}/rate_cards","title":"List rate cards","href":"/api-reference/schedules/list-rate-cards"},{"openapi":"post /v2/schedules/{schedule_id}/rate_cards","title":"Bulk rate card operations on a schedule","href":"/api-reference/schedules/bulk-rate-card-operations-on-a-schedule"},{"openapi":"post /v2/accounts/{account_id}/edit_schedules","title":"Bulk edit schedules of an account","href":"/api-reference/schedules/bulk-edit-schedules-of-an-account"},{"openapi":"get /v2/accounts/{account_id}/schedules","title":"List pricing schedules of an account","href":"/api-reference/schedules/list-pricing-schedules-of-an-account"},{"openapi":"get /v2/schedules/{schedule_id}/errors","title":"Get list of errors of a acc schedule","href":"/api-reference/schedules/get-list-of-errors-of-a-acc-schedule"},{"openapi":"delete /v2/accounts/{account_id}/discard_schedules","title":"Discard schedules of an account","href":"/api-reference/schedules/discard-schedules-of-an-account"},{"openapi":"post /v2/accounts/{account_id}/finalize_schedules","title":"Finalize schedules of an account","href":"/api-reference/schedules/finalize-schedules-of-an-account"},{"openapi":"get /v2/schedules/{schedule_id}/pricing_rules","title":"List pricing rules of a account schedule","href":"/api-reference/schedules/list-pricing-rules-of-a-account-schedule"},{"openapi":"put /v2/schedules/{schedule_id}/pricing_rules","title":"Update pricing rules of a account schedule","href":"/api-reference/schedules/update-pricing-rules-of-a-account-schedule"}]}]},{"group":"Aliases","pages":[{"openapi":"get /aliases","title":"List all aliases","href":"/api-reference/aliases/list-all-aliases"},{"openapi":"post /aliases","title":"Create an alias","href":"/api-reference/aliases/create-an-alias"},{"openapi":"get /aliases/{alias}","title":"Get an alias","href":"/api-reference/aliases/get-an-alias"},{"openapi":"delete /aliases/{alias}","title":"Delete an alias","href":"/api-reference/aliases/delete-an-alias"}]},{"group":"Event Schemas","pages":[{"openapi":"get /event_schema","title":"List event schemas","href":"/api-reference/event-schemas/list-event-schemas"},{"openapi":"post /event_schema","title":"Create an event schema","href":"/api-reference/event-schemas/create-an-event-schema"},{"openapi":"get /event_schema/{event_schema_name}","title":"Get an event schema","href":"/api-reference/event-schemas/get-an-event-schema"},{"openapi":"delete /event_schema/{event_schema_name}","title":"Delete an event schema","href":"/api-reference/event-schemas/delete-an-event-schema"},{"openapi":"patch /event_schema/{event_schema_name}","title":"Update an event schema","href":"/api-reference/event-schemas/update-an-event-schema"},{"openapi":"get /event_schema/{event_schema_name}/versions","title":"List all event schema versions","href":"/api-reference/event-schemas/list-all-event-schema-versions"},{"openapi":"post /event_schema/{event_schema_name}/activate","title":"Activate an event schema","href":"/api-reference/event-schemas/activate-an-event-schema"},{"openapi":"post /event_schema/{event_schema_name}/deactivate","title":"Deactivate an event schema","href":"/api-reference/event-schemas/deactivate-an-event-schema"}]},{"group":"Usage Meters","pages":[{"openapi":"get /usage_meters","title":"List usage meters for event schema","href":"/api-reference/usage-meters/list-usage-meters-for-event-schema"},{"openapi":"post /usage_meters","title":"Create an usage meter","href":"/api-reference/usage-meters/create-an-usage-meter"},{"openapi":"get /usage_meters/{usage_meter_id}","title":"Get usage meter","href":"/api-reference/usage-meters/get-usage-meter"},{"openapi":"delete /usage_meters/{usage_meter_id}","title":"Delete an Usage Meter","href":"/api-reference/usage-meters/delete-an-usage-meter"},{"openapi":"patch /usage_meters/{usage_meter_id}","title":"Update an usage meter","href":"/api-reference/usage-meters/update-an-usage-meter"},{"openapi":"post /usage_meters/{usage_meter_id}/activate","title":"Activate usage meter","href":"/api-reference/usage-meters/activate-usage-meter"},{"openapi":"post /usage_meters/{usage_meter_id}/deactivate","title":"Deactivate usage meter","href":"/api-reference/usage-meters/deactivate-usage-meter"}]},{"group":"AddOns","pages":[{"openapi":"get /addons","title":"List addOns","href":"/api-reference/addons/list-addons"},{"openapi":"post /addons","title":"Create an AddOn","href":"/api-reference/addons/create-an-addon"},{"openapi":"get /addons/{addon_id}","title":"Get an addon","href":"/api-reference/addons/get-an-addon"},{"openapi":"delete /addons/{addon_id}","title":"Delete an addon","href":"/api-reference/addons/delete-an-addon"},{"openapi":"patch /addons/{addon_id}","title":"Update an addon","href":"/api-reference/addons/update-an-addon"}]},{"group":"Licenses","pages":[{"openapi":"get /license_updates","title":"Get a list of licenses updates","href":"/api-reference/licenses/get-a-list-of-licenses-updates"},{"openapi":"post /license_updates","title":"Update a license entry","href":"/api-reference/licenses/update-a-license-entry"},{"openapi":"get /named_license_updates","title":"Get a list of named licenses updates","href":"/api-reference/licenses/get-a-list-of-named-licenses-updates"}]},{"group":"Feature","pages":[{"openapi":"get /features","title":"List Feature","href":"/api-reference/feature/list-feature"},{"openapi":"post /features","title":"Create a Feature and optionally associate with one or more event_schemas","href":"/api-reference/feature/create-a-feature-and-optionally-associate-with-one-or-more-event_schemas"},{"openapi":"get /features/{feature_id}","title":"Get a Feature","href":"/api-reference/feature/get-a-feature"},{"openapi":"patch /features/{feature_id}","title":"Update a Feature","href":"/api-reference/feature/update-a-feature"}]},{"group":"(Deprecated) Price Plans","pages":[{"openapi":"get /price_plans","title":"(DEPRECATED) List price plans","href":"/api-reference/price-plans/list-price-plans"},{"openapi":"post /price_plans","title":"(DEPRECATED) Create a price plan","href":"/api-reference/price-plans/create-a-price-plan"},{"openapi":"get /price_plans/{price_plan_id}","title":"(DEPRECATED) Get a price plan","href":"/api-reference/price-plans/get-a-price-plan"},{"openapi":"patch /price_plans/{price_plan_id}","title":"(DEPRECATED) Update a price plan","href":"/api-reference/price-plans/update-a-price-plan"},{"openapi":"post /price_plans/{price_plan_id}/activate","title":"(DEPRECATED) Activate a price plan","href":"/api-reference/price-plans/activate-a-price-plan"},{"openapi":"post /price_plans/migration","title":"(DEPRECATED) Create a price plan migration","href":"/api-reference/price-plans/create-a-price-plan-migration"},{"openapi":"delete /price_plans/{price_plan_id}","title":"(DEPRECATED) Archive a price plan","href":"/api-reference/price-plans/archive-a-price-plan"}]},{"group":"Price Plan V2","pages":[{"openapi":"get /v2/price_plans","title":"List price plans","description":"List price plans","href":"/api-reference/priceplanv2/list-price-plans"},{"openapi":"post /v2/price_plans","title":"Create a price plan","href":"/api-reference/priceplanv2/create-a-price-plan"},{"openapi":"get /v2/price_plans/{price_plan_id}","title":"Get a price plan","description":"Get a price plan","href":"/api-reference/priceplanv2/get-a-price-plan"},{"openapi":"patch /v2/price_plans/{price_plan_id}","title":"Update a price plan","href":"/api-reference/priceplanv2/update-a-price-plan"},{"openapi":"delete /v2/price_plans/{price_plan_id}/discard","title":"Discard a price plan","href":"/api-reference/priceplanv2/discard-a-price-plan"},{"openapi":"post /v2/price_plans/{price_plan_id}/finalize","title":"Finalize a price plan","href":"/api-reference/priceplanv2/finalize-a-price-plan"},{"openapi":"get /v2/price_plans/{price_plan_id}/rate_cards","title":"List rate cards of a price plan","href":"/api-reference/priceplanv2/list-rate-cards-of-a-price-plan"},{"openapi":"post /v2/price_plans/{price_plan_id}/rate_cards","title":"Bulk rate card operations of a price plan","href":"/api-reference/priceplanv2/bulk-rate-card-operations-of-a-price-plan"},{"openapi":"get /v2/price_plans/{price_plan_id}/pricing_rules","title":"List pricing rules of a price plan","href":"/api-reference/priceplanv2/list-pricing-rules-of-a-price-plan"},{"openapi":"put /v2/price_plans/{price_plan_id}/pricing_rules","title":"Update pricing rules of a price plan","href":"/api-reference/priceplanv2/update-pricing-rules-of-a-price-plan"},{"openapi":"get /v2/price_plans/{price_plan_id}/errors","title":"Get list of errors of a price plan","href":"/api-reference/priceplanv2/get-list-of-errors-of-a-price-plan"},{"openapi":"get /v2/price_plans/{price_plan_id}/versions","title":"List price plan versions","href":"/api-reference/priceplanv2/list-price-plan-versions"},{"openapi":"post /v2/price_plans/migration","title":"Create a price plan v2 migration","href":"/api-reference/priceplanv2/create-a-price-plan-v2-migration"}]},{"group":"Settings","pages":[{"openapi":"get /settings","title":"Lists settings","href":"/api-reference/settings/lists-settings"},{"openapi":"post /settings","title":"Create a setting","href":"/api-reference/settings/create-a-setting"},{"openapi":"get /settings/{setting_id_str}","title":"Get a setting","href":"/api-reference/settings/get-a-setting"},{"openapi":"patch /settings/{setting_id_str}","title":"Update a setting","href":"/api-reference/settings/update-a-setting"}]},{"group":"Price Experimentation","pages":[{"openapi":"post /revenue_calculator","title":"(DEPRECATED) Calculate and return the revenue for a existing or new price plan","href":"/api-reference/price-experimentation/calculate-and-return-the-revenue-for-a-existing-or-new-price-plan"}]},{"group":"Jobs","pages":[{"openapi":"get /jobs/{job_id}","title":"Get the status of a job","href":"/api-reference/jobs/get-the-status-of-a-job"},{"openapi":"get /jobs","title":"List jobs","href":"/api-reference/jobs/list-jobs"},{"openapi":"post /jobs/{job_id}/confirm","title":"Confirm a job","href":"/api-reference/jobs/confirm-a-job"},{"openapi":"post /jobs/{job_id}/reject","title":"Reject a job","href":"/api-reference/jobs/reject-a-job"},{"openapi":"get /jobs/{job_id}/entries","title":"List job entries","href":"/api-reference/jobs/list-job-entries"}]},{"group":"Event Ingestion","pages":[{"openapi":"post /ingest","title":"Ingest events to Togai","href":"/api-reference/event-ingestion/ingest-events-to-togai"},{"openapi":"post /ingestBatch","title":"Ingest events to Togai in batch","href":"/api-reference/event-ingestion/ingest-events-to-togai-in-batch"}]},{"group":"Entitlements","pages":[{"openapi":"post /entitled","title":"Ingest event if a user is entitled to a feature","href":"/api-reference/entitlements/ingest-event-if-a-user-is-entitled-to-a-feature"},{"openapi":"get /accounts/{account_id}/features/{feature_id}","title":"Get Feature credits balance","href":"/api-reference/entitlements/get-feature-credits-balance"},{"openapi":"get /accounts/{account_id}/features/{feature_id}/entries","title":"List feature credits entries of a feature for an account","href":"/api-reference/entitlements/list-feature-credits-entries-of-a-feature-for-an-account"},{"openapi":"patch /accounts/{account_id}/features/{feature_id}/entries/{entry_id}","title":"Update a feature credits entry","href":"/api-reference/entitlements/update-a-feature-credits-entry-of-a-feature-for-an-account"},{"openapi":"post /accounts/{account_id}/features/{feature_id}/entries/{entry_id}/void","title":"Void a feature credits entry of a feature for an account","href":"/api-reference/entitlements/void-a-feature-credits-entry-of-a-feature-for-an-account"},{"openapi":"get /accounts/{account_id}/entitlements","title":"Get entitlements for a account","href":"/api-reference/entitlements/get-entitlements-for-a-account"},{"openapi":"post /accounts/{account_id}/entitlements/{feature_id}","title":"Check entitlement value for a account","href":"/api-reference/entitlements/check-entitlement-value-for-a-account"},{"openapi":"get /accounts/{account_id}/entitlements/{feature_id}","title":"Get entitlement value for a account","href":"/api-reference/entitlements/get-entitlement-value-for-a-account"}]},{"group":"Event Management","pages":[{"openapi":"get /events","title":"Get a list of usage events with multiple query options","href":"/api-reference/event-management/get-a-list-of-usage-events-with-multiple-query-options"},{"openapi":"get /events/{event_id}","title":"Get an event using event id","href":"/api-reference/event-management/get-an-usage-event-using-event-id"},{"openapi":"post /events/correction","title":"Correct an ingested event","href":"/api-reference/event-management/correct-an-ingested-event"}]},{"group":"Metrics","pages":[{"openapi":"post /metrics","title":"Get Togai Metrics","href":"/api-reference/metrics/get-togai-metrics"}]},{"group":"Credits","pages":[{"openapi":"get /credits","title":"List credits","href":"/api-reference/credits/list-credits"},{"openapi":"post /credits","title":"Grant credit","href":"/api-reference/credits/grant-credit"},{"openapi":"get /credits/{credit_id}","title":"Get credit details","href":"/api-reference/credits/get-credit-details"},{"openapi":"post /credits/{credit_id}/void","title":"Void credit","href":"/api-reference/credits/void-credit"},{"openapi":"get /accounts/{account_id}/credit_balance","title":"Credit balance for Account","href":"/api-reference/credits/credit-balance-for-account"}]},{"group":"Invoices","pages":[{"openapi":"get /invoices","title":"List invoices","href":"/api-reference/invoices/list-invoices"},{"openapi":"get /invoices/{invoice_id}","title":"Get an invoice","href":"/api-reference/invoices/get-an-invoice"},{"openapi":"get /invoice/{invoice_id}/pricing_rules_logs","title":"List pricing rule logs","href":"/api-reference/invoices/list-pricing-rule-logs"},{"openapi":"put /invoices/{invoice_id}/miscellaneous_charges","title":"Add or update miscellaneous charges in Invoice","href":"/api-reference/invoices/add-or-update-miscellaneous-charges-in-invoice"},{"openapi":"put /accounts/{account_id}/miscellaneous_charges","title":"Add or update miscellaneous charges in upcoming Invoice for a account","href":"/api-reference/invoices/add-or-update-miscellaneous-charges-in-upcoming-invoice-for-a-account"},{"openapi":"post /invoices","title":"Create a custom invoice for an account","href":"/api-reference/invoices/create-a-custom-invoice-for-an-account"},{"openapi":"delete /invoices/{invoice_id}","title":"Delete a custom invoice in DRAFT state","href":"/api-reference/invoices/delete-a-custom-invoice-in-draft-state"},{"openapi":"get /invoices/bill_runs","title":"List invoices eligible for bill run","href":"/api-reference/invoices/list-invoices-eligible-for-bill-run"},{"openapi":"post /invoices/bill_runs","title":"Create a bill run job request","href":"/api-reference/invoices/create-a-bill-run-job-request"}]},{"group":"Payments","pages":[{"openapi":"get /payments","title":"List all payments","href":"/api-reference/payments/list-all-payments"},{"openapi":"get /payments/{payment_id}","title":"Get a payment","href":"/api-reference/payments/get-a-payment"},{"openapi":"post /payments","title":"create payments","href":"/api-reference/payments/create-payments"}]},{"group":"Wallet","pages":[{"openapi":"get /accounts/{account_id}/wallet","title":"Wallet balance for Account","href":"/api-reference/wallet/wallet-balance-for-account"},{"openapi":"get /accounts/{account_id}/wallet/entries","title":"Wallet entries for Account","href":"/api-reference/wallet/wallet-entries-for-account"}]},{"group":"InvoiceGroups","pages":[{"openapi":"get /invoice_groups","title":"List Invoice Groups","href":"/api-reference/invoicegroups/list-invoice-groups"},{"openapi":"post /invoice_groups","title":"Create an invoice group","href":"/api-reference/invoicegroups/create-an-invoice-group"},{"openapi":"get /invoice_groups/{invoice_group_id}","title":"Get information of an invoice group","href":"/api-reference/invoicegroups/get-information-of-an-invoice-group"},{"openapi":"post /invoice_groups/{invoice_group_id}/add_accounts","title":"Add accounts to an invoice group","href":"/api-reference/invoicegroups/add-accounts-to-an-invoice-group"},{"openapi":"post /invoice_groups/{invoice_group_id}/remove_accounts","title":"Remove accounts from an invoice group. Removing all accounts will also delete the invoice group","href":"/api-reference/invoicegroups/remove-accounts-from-an-invoice-group-removing-all-accounts-will-also-delete-the-invoice-group"}]},{"group":"Alerts","pages":[{"title":"Introduction","href":"/api-reference/alerts/introduction"},{"openapi":"get /alert_templates","title":"List alert templates","href":"/api-reference/alerts/list-alert-templates"},{"openapi":"get /alert_templates/{alert_template_id}","title":"Get an alert template","href":"/api-reference/alerts/get-an-alert-template"},{"openapi":"post /alerts","title":"Create an alert","href":"/api-reference/alerts/create-an-alert"},{"openapi":"get /alerts","title":"List alerts","href":"/api-reference/alerts/list-alerts"},{"openapi":"patch /alerts/{alert_id}","title":"Update an alert","href":"/api-reference/alerts/update-an-alert"},{"openapi":"get /incidents","title":"List incidents","href":"/api-reference/alerts/list-incidents"},{"openapi":"get /incidents/{incident_id}","title":"Get an incident","href":"/api-reference/alerts/get-an-incident"},{"openapi":"put /incidents/{incident_id}/status","title":"Update an incident status","href":"/api-reference/alerts/update-an-incident-status"}]},{"group":"Reports","pages":[{"openapi":"get /reports","title":"List reports","href":"/api-reference/reports/list-reports"}]}]}]},{"tab":"Change log","pages":[{"title":"Change log","href":"/changelog/change-log"}]},{"tab":"How-To's","pages":[{"title":"How-To's","href":"/how-tos/overview"}]}]}]},"title":"Create a price plan - Togai documentation","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"]}