{"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.3971","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":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/priceplanv2/bulk-rate-card-operations-of-a-price-plan","slug":"/api-reference/priceplanv2/bulk-rate-card-operations-of-a-price-plan","pageMetadata":{"openapi":"post /v2/price_plans/{price_plan_id}/rate_cards","title":"Bulk rate card operations of a price plan","description":"Bulk rate card operations of a price plan","href":"/api-reference/priceplanv2/bulk-rate-card-operations-of-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: \"Bulk rate card operations of 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/{price_plan_id}/rate_cards","title":"Bulk rate card operations of a price plan","description":"Bulk rate card operations of a price plan","href":"/api-reference/priceplanv2/bulk-rate-card-operations-of-a-price-plan"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["PricePlanV2"],"summary":"Bulk rate card operations of a price plan","description":"Bulk rate card operations of a price plan","operationId":"bulkPricePlanRateCardOperations","parameters":["924d76d2-c824-4ab6-b96b-94df79c73be4"],"requestBody":"5fe4ac11-ee4f-40d7-9a12-9a2e454f79b8","responses":{"200":"6d29bb8d-9289-4bc7-bf0b-584b4a16c12a","default":"f4e3f268-bbf2-4fc7-a4f2-4e9ab0b2b228"},"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/{price_plan_id}/rate_cards","baseUrlOptions":["https://api.togai.com/","https://sandbox-api.togai.com/"],"title":"Bulk rate card operations of a price plan","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"924d76d2-c824-4ab6-b96b-94df79c73be4":{"in":"path","name":"price_plan_id","required":true,"schema":{"type":"string","maxLength":50,"example":"pp.1zYnCiM9Bpg.lv25y","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"requestBody":{"description":"Payload to bulk rate card operations","required":true,"content":{"application/json":{"schema":{"description":"Bulk rate card operations for price plan","type":"object","required":["operations"],"properties":{"operations":{"type":"array","items":{"description":"Rate card operation","type":"object","required":["actionType","rateCardName"],"properties":{"actionType":{"description":"Operation type","type":"string","enum":["CREATE","UPDATE","DELETE"],"isRequired":true,"uniqueKey":"operations.items.[INDEX].actionType","typeLabel":"enum\u003cstring>"},"rateCardName":{"type":"string","description":"Required for UPDATE and DELETE operations","maxLength":50,"isRequired":true,"uniqueKey":"operations.items.[INDEX].rateCardName","typeLabel":"string"},"rateCard":{"description":"Request to create a rate card","type":"object","additionalProperties":false,"required":["billableId","invoiceTiming","rateCardDetails","type"],"properties":{"billableId":{"description":"Billable identifier","type":"string","maxLength":50,"isRequired":true,"uniqueKey":"operations.items.[INDEX].rateCard.billableId","typeLabel":"string"},"type":{"description":"Rate card type","type":"string","enum":["MINIMUM_COMMITMENT","BILLING_ENTITLEMENT","CREDIT_GRANT","ENTITLEMENT_OVERAGE","FIXED_FEE","LICENSE","USAGE"],"isRequired":true,"uniqueKey":"operations.items.[INDEX].rateCard.type","typeLabel":"enum\u003cstring>"},"invoiceTiming":{"type":"string","enum":["IN_ADVANCE","IN_ARREARS","PREPAID"],"x-enum-varnames":["IN_ADVANCE","IN_ARREARS","PREPAID"],"description":"If IN_ADVANCE, the rate card will be invoiced in the previous billing cycle.\nIf IN_ARREARS, the rate card will be invoiced in the current billing cycle.\nIf PREPAID, credits/entitlements will be granted only after invoice is paid\n","isRequired":true,"uniqueKey":"operations.items.[INDEX].rateCard.invoiceTiming","typeLabel":"enum\u003cstring>"},"rateCardDetails":{"description":"Rate card details","type":"object","additionalProperties":false,"properties":{"fixedFeeRateCard":{"title":"FixedFeeRateCard","type":"object","required":["id","rateValues","enableProration"],"properties":{"id":{"description":"Unique Identifier of the attached AddOn","type":"string","maxLength":50,"isRequired":true,"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.fixedFeeRateCard.id","typeLabel":"string"},"rateValues":{"type":"array","items":{"type":"object","required":["currency","rate"],"properties":{"currency":{"type":"string","isRequired":true,"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.fixedFeeRateCard.rateValues.items.[INDEX].currency","typeLabel":"string"},"rate":{"type":"number","isRequired":true,"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.fixedFeeRateCard.rateValues.items.[INDEX].rate","typeLabel":"number"}},"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.fixedFeeRateCard.rateValues.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.fixedFeeRateCard.rateValues","typeLabel":"object[]"},"enableProration":{"type":"boolean","example":false,"isRequired":true,"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.fixedFeeRateCard.enableProration","typeLabel":"boolean"},"displayName":{"type":"string","description":"Name of the attached AddOn","uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.fixedFeeRateCard.displayName","typeLabel":"string"},"name":{"type":"string","description":"Unique identifier for the rate card in a price plan. If left null it is auto-generated.","uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.fixedFeeRateCard.name","typeLabel":"string"},"tag":{"type":"string","description":"A tag string to group fixedFeeRateCards","uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.fixedFeeRateCard.tag","typeLabel":"string"},"invoiceTiming":{"type":"string","enum":["IN_ADVANCE","IN_ARREARS","PREPAID"],"x-enum-varnames":["IN_ADVANCE","IN_ARREARS","PREPAID"],"description":"If IN_ADVANCE, the rate card will be invoiced in the previous billing cycle.\nIf IN_ARREARS, the rate card will be invoiced in the current billing cycle.\nIf PREPAID, credits/entitlements will be granted only after invoice is paid\n","uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.fixedFeeRateCard.invoiceTiming","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["ONE_TIME","RECURRING"],"description":"Fixed fee applies either for a one-time occurrence or for each cycle.","uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.fixedFeeRateCard.type","typeLabel":"enum\u003cstring>"},"recurrenceConfig":{"type":"object","properties":{"interval":{"description":"Represents the number of pricing cycles after which the rate card will be charged","type":"integer","format":"int64","example":3,"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.fixedFeeRateCard.recurrenceConfig.interval","typeLabel":"integer\u003cint64>"},"offset":{"description":"Represents the offset for pricing cycles after which the rate card will be charged","type":"integer","format":"int64","example":5,"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.fixedFeeRateCard.recurrenceConfig.offset","typeLabel":"integer\u003cint64>"}},"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.fixedFeeRateCard.recurrenceConfig","typeLabel":"object"}},"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.fixedFeeRateCard","typeLabel":"FixedFeeRateCard ยท object"},"billingEntitlementRateCard":{"description":"Billing Entitlement rate card","type":"object","additionalProperties":false,"required":["featureId","featureConfigs","ratePlan","rateValues","invoiceTiming"],"properties":{"featureId":{"type":"string","isRequired":true,"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.billingEntitlementRateCard.featureId","typeLabel":"string"},"featureConfigs":{"type":"array","minItems":1,"items":{"description":"Feature configuration object","type":"object","additionalProperties":false,"required":["effectiveUntil","featureCreditLimit"],"properties":{"effectiveUntil":{"type":"string","format":"duration","isRequired":true,"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.billingEntitlementRateCard.featureConfigs.items.[INDEX].effectiveUntil","typeLabel":"string\u003cduration>"},"featureCreditLimit":{"type":"number","minimum":0,"isRequired":true,"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.billingEntitlementRateCard.featureConfigs.items.[INDEX].featureCreditLimit","typeLabel":"number"},"effectiveFrom":{"type":"string","format":"duration","uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.billingEntitlementRateCard.featureConfigs.items.[INDEX].effectiveFrom","typeLabel":"string\u003cduration>"}},"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.billingEntitlementRateCard.featureConfigs.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.billingEntitlementRateCard.featureConfigs","typeLabel":"object[]"},"invoiceTiming":{"type":"string","enum":["IN_ADVANCE","IN_ARREARS","PREPAID"],"x-enum-varnames":["IN_ADVANCE","IN_ARREARS","PREPAID"],"description":"If IN_ADVANCE, the rate card will be invoiced in the previous billing cycle.\nIf IN_ARREARS, the rate card will be invoiced in the current billing cycle.\nIf PREPAID, credits/entitlements will be granted only after invoice is paid\n","isRequired":true,"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.billingEntitlementRateCard.invoiceTiming","typeLabel":"enum\u003cstring>"},"ratePlan":{"type":"object","description":"Contains all rate related configurations","required":["pricingModel","slabs"],"properties":{"pricingModel":{"type":"string","description":"Togai supports two type of pricing model Tiered and Volume. Tiered pricing model applies respective slab and its rate to the usage value while volume pricing model applies the latest matching slab of the usage value and applies respective rate. \nFor more understanding read [Rate Cards](https://docs.togai.com/docs/priceplan#setting-up-multiple-rate-cards)\n","enum":["TIERED","VOLUME"],"isRequired":true,"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.billingEntitlementRateCard.ratePlan.pricingModel","typeLabel":"enum\u003cstring>"},"slabs":{"description":"Rate cards can have single or multiple slab up to 100.","type":"array","minItems":1,"items":{"type":"object","description":"Represents a pricing priceType (rates + slabs) for usage price plan","required":["order","startAfter","priceType"],"properties":{"order":{"type":"integer","format":"int32","minimum":1,"maximum":10,"isRequired":true,"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.billingEntitlementRateCard.ratePlan.slabs.items.[INDEX].order","typeLabel":"integer\u003cint32>"},"startAfter":{"type":"number","isRequired":true,"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.billingEntitlementRateCard.ratePlan.slabs.items.[INDEX].startAfter","typeLabel":"number"},"priceType":{"type":"string","enum":["FLAT","PER_UNIT","PACKAGE"],"isRequired":true,"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.billingEntitlementRateCard.ratePlan.slabs.items.[INDEX].priceType","typeLabel":"enum\u003cstring>"},"slabConfig":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.billingEntitlementRateCard.ratePlan.slabs.items.[INDEX].slabConfig.additionalProperties","typeLabel":"string"},"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.billingEntitlementRateCard.ratePlan.slabs.items.[INDEX].slabConfig","typeLabel":"object"}},"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.billingEntitlementRateCard.ratePlan.slabs.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.billingEntitlementRateCard.ratePlan.slabs","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.billingEntitlementRateCard.ratePlan","typeLabel":"object"},"rateValues":{"type":"array","items":{"type":"object","description":"Represents a rate","required":["currency","slabRates"],"properties":{"currency":{"type":"string","isRequired":true,"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.billingEntitlementRateCard.rateValues.items.[INDEX].currency","typeLabel":"string"},"slabRates":{"type":"array","minItems":1,"items":{"type":"object","description":"Represents a rate for a slab","required":["order","rate"],"properties":{"order":{"type":"integer","format":"int32","isRequired":true,"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.billingEntitlementRateCard.rateValues.items.[INDEX].slabRates.items.[INDEX].order","typeLabel":"integer\u003cint32>"},"rate":{"type":"number","isRequired":true,"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.billingEntitlementRateCard.rateValues.items.[INDEX].slabRates.items.[INDEX].rate","typeLabel":"number"},"slabRateConfig":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.billingEntitlementRateCard.rateValues.items.[INDEX].slabRates.items.[INDEX].slabRateConfig.additionalProperties","typeLabel":"string"},"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.billingEntitlementRateCard.rateValues.items.[INDEX].slabRates.items.[INDEX].slabRateConfig","typeLabel":"object"}},"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.billingEntitlementRateCard.rateValues.items.[INDEX].slabRates.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.billingEntitlementRateCard.rateValues.items.[INDEX].slabRates","typeLabel":"object[]"},"rateConfig":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.billingEntitlementRateCard.rateValues.items.[INDEX].rateConfig.additionalProperties","typeLabel":"string"},"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.billingEntitlementRateCard.rateValues.items.[INDEX].rateConfig","typeLabel":"object"}},"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.billingEntitlementRateCard.rateValues.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.billingEntitlementRateCard.rateValues","typeLabel":"object[]"},"tag":{"type":"string","description":"A tag string to group rate cards","uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.billingEntitlementRateCard.tag","typeLabel":"string"},"displayName":{"type":"string","description":"Name your rate card, this will be used in invoice","uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.billingEntitlementRateCard.displayName","typeLabel":"string"},"name":{"type":"string","description":"Unique identifier for the rate card in a price plan. If left null it is auto-generated.","uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.billingEntitlementRateCard.name","typeLabel":"string"},"recurrenceConfig":{"type":"object","properties":{"interval":{"description":"Represents the number of pricing cycles after which the rate card will be charged","type":"integer","format":"int64","example":3,"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.billingEntitlementRateCard.recurrenceConfig.interval","typeLabel":"integer\u003cint64>"},"offset":{"description":"Represents the offset for pricing cycles after which the rate card will be charged","type":"integer","format":"int64","example":5,"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.billingEntitlementRateCard.recurrenceConfig.offset","typeLabel":"integer\u003cint64>"}},"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.billingEntitlementRateCard.recurrenceConfig","typeLabel":"object"}},"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.billingEntitlementRateCard","typeLabel":"object"},"creditGrantRateCard":{"description":"Credit grant rate card","type":"object","additionalProperties":false,"required":["id","rateDetails","grantDetails"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.creditGrantRateCard.id","typeLabel":"string"},"grantDetails":{"description":"Grant details of Credit Grant Rate Card","type":"object","additionalProperties":false,"required":["priority","expiryType"],"properties":{"priority":{"type":"integer","minimum":0,"isRequired":true,"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.creditGrantRateCard.grantDetails.priority","typeLabel":"integer"},"expiryType":{"type":"string","description":"Expiry type of grant","enum":["PRICING_CYCLE","NO_EXPIRY","CUSTOM"],"isRequired":true,"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.creditGrantRateCard.grantDetails.expiryType","typeLabel":"enum\u003cstring>"},"expiryDuration":{"type":"string","format":"duration","uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.creditGrantRateCard.grantDetails.expiryDuration","typeLabel":"string\u003cduration>"},"applicableEntityIds":{"type":"array","items":{"type":"string","uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.creditGrantRateCard.grantDetails.applicableEntityIds.items.[INDEX]","typeLabel":"string"},"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.creditGrantRateCard.grantDetails.applicableEntityIds","typeLabel":"string[]"}},"isRequired":true,"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.creditGrantRateCard.grantDetails","typeLabel":"object"},"rateDetails":{"type":"object","description":"Amount to be credited","additionalProperties":false,"required":["pricingModel","currencySlabRateDetails"],"properties":{"pricingModel":{"type":"string","description":"Togai supports two type of pricing model Tiered and Volume. Tiered pricing model applies respective slab and its rate to the usage value while volume pricing model applies the latest matching slab of the usage value and applies respective rate. \nFor more understanding read [Rate Cards](https://docs.togai.com/docs/priceplan#setting-up-multiple-rate-cards)\n","enum":["TIERED","VOLUME"],"isRequired":true,"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.creditGrantRateCard.rateDetails.pricingModel","typeLabel":"enum\u003cstring>"},"currencySlabRateDetails":{"type":"array","items":{"type":"object","description":"The association of a currency along with its slab detail","additionalProperties":false,"required":["currency","creditAmount","slabDetails"],"properties":{"currency":{"type":"string","isRequired":true,"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.creditGrantRateCard.rateDetails.currencySlabRateDetails.items.[INDEX].currency","typeLabel":"string"},"creditAmount":{"type":"number","description":"The amount of credit that needs to be credited","minimum":0,"isRequired":true,"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.creditGrantRateCard.rateDetails.currencySlabRateDetails.items.[INDEX].creditAmount","typeLabel":"number"},"slabDetails":{"type":"array","items":{"type":"object","description":"The details of a slab","additionalProperties":false,"required":["startAfter","priceType","rate"],"properties":{"startAfter":{"type":"number","isRequired":true,"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.creditGrantRateCard.rateDetails.currencySlabRateDetails.items.[INDEX].slabDetails.items.[INDEX].startAfter","typeLabel":"number"},"priceType":{"type":"string","enum":["FLAT","PER_UNIT","PACKAGE"],"isRequired":true,"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.creditGrantRateCard.rateDetails.currencySlabRateDetails.items.[INDEX].slabDetails.items.[INDEX].priceType","typeLabel":"enum\u003cstring>"},"rate":{"type":"number","isRequired":true,"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.creditGrantRateCard.rateDetails.currencySlabRateDetails.items.[INDEX].slabDetails.items.[INDEX].rate","typeLabel":"number"},"slabConfig":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.creditGrantRateCard.rateDetails.currencySlabRateDetails.items.[INDEX].slabDetails.items.[INDEX].slabConfig.additionalProperties","typeLabel":"string"},"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.creditGrantRateCard.rateDetails.currencySlabRateDetails.items.[INDEX].slabDetails.items.[INDEX].slabConfig","typeLabel":"object"},"slabRateConfig":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.creditGrantRateCard.rateDetails.currencySlabRateDetails.items.[INDEX].slabDetails.items.[INDEX].slabRateConfig.additionalProperties","typeLabel":"string"},"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.creditGrantRateCard.rateDetails.currencySlabRateDetails.items.[INDEX].slabDetails.items.[INDEX].slabRateConfig","typeLabel":"object"}},"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.creditGrantRateCard.rateDetails.currencySlabRateDetails.items.[INDEX].slabDetails.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.creditGrantRateCard.rateDetails.currencySlabRateDetails.items.[INDEX].slabDetails","typeLabel":"object[]"},"rateConfig":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.creditGrantRateCard.rateDetails.currencySlabRateDetails.items.[INDEX].rateConfig.additionalProperties","typeLabel":"string"},"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.creditGrantRateCard.rateDetails.currencySlabRateDetails.items.[INDEX].rateConfig","typeLabel":"object"}},"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.creditGrantRateCard.rateDetails.currencySlabRateDetails.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.creditGrantRateCard.rateDetails.currencySlabRateDetails","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.creditGrantRateCard.rateDetails","typeLabel":"object"},"displayName":{"type":"string","uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.creditGrantRateCard.displayName","typeLabel":"string"},"name":{"type":"string","description":"Unique identifier for the rate card in a price plan. If left null it is auto-generated.","uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.creditGrantRateCard.name","typeLabel":"string"},"tag":{"type":"string","description":"A tag string to group creditGrantRateCard","uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.creditGrantRateCard.tag","typeLabel":"string"},"invoiceTiming":{"type":"string","enum":["IN_ADVANCE","IN_ARREARS","PREPAID"],"x-enum-varnames":["IN_ADVANCE","IN_ARREARS","PREPAID"],"description":"If IN_ADVANCE, the rate card will be invoiced in the previous billing cycle.\nIf IN_ARREARS, the rate card will be invoiced in the current billing cycle.\nIf PREPAID, credits/entitlements will be granted only after invoice is paid\n","uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.creditGrantRateCard.invoiceTiming","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["ONE_TIME","RECURRING"],"description":"Credit grant applies either for a one-time occurrence or for each cycle.","uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.creditGrantRateCard.type","typeLabel":"enum\u003cstring>"},"recurrenceConfig":{"type":"object","properties":{"interval":{"description":"Represents the number of pricing cycles after which the rate card will be charged","type":"integer","format":"int64","example":3,"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.creditGrantRateCard.recurrenceConfig.interval","typeLabel":"integer\u003cint64>"},"offset":{"description":"Represents the offset for pricing cycles after which the rate card will be charged","type":"integer","format":"int64","example":5,"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.creditGrantRateCard.recurrenceConfig.offset","typeLabel":"integer\u003cint64>"}},"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.creditGrantRateCard.recurrenceConfig","typeLabel":"object"}},"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.creditGrantRateCard","typeLabel":"object"},"usageRateCard":{"type":"object","required":["usageMeterId","ratePlan","rateValues"],"properties":{"usageMeterId":{"type":"string","example":"um.1zYnCiM9Bpg.1zYn","isRequired":true,"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.usageRateCard.usageMeterId","typeLabel":"string"},"ratePlan":{"type":"object","description":"Contains all rate related configurations","required":["pricingModel","slabs"],"properties":{"pricingModel":{"type":"string","description":"Togai supports two type of pricing model Tiered and Volume. Tiered pricing model applies respective slab and its rate to the usage value while volume pricing model applies the latest matching slab of the usage value and applies respective rate. \nFor more understanding read [Rate Cards](https://docs.togai.com/docs/priceplan#setting-up-multiple-rate-cards)\n","enum":["TIERED","VOLUME"],"isRequired":true,"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.usageRateCard.ratePlan.pricingModel","typeLabel":"enum\u003cstring>"},"slabs":{"description":"Rate cards can have single or multiple slab up to 100.","type":"array","minItems":1,"items":{"type":"object","description":"Represents a pricing priceType (rates + slabs) for usage price plan","required":["order","startAfter","priceType"],"properties":{"order":{"type":"integer","format":"int32","minimum":1,"maximum":10,"isRequired":true,"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.usageRateCard.ratePlan.slabs.items.[INDEX].order","typeLabel":"integer\u003cint32>"},"startAfter":{"type":"number","isRequired":true,"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.usageRateCard.ratePlan.slabs.items.[INDEX].startAfter","typeLabel":"number"},"priceType":{"type":"string","enum":["FLAT","PER_UNIT","PACKAGE"],"isRequired":true,"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.usageRateCard.ratePlan.slabs.items.[INDEX].priceType","typeLabel":"enum\u003cstring>"},"slabConfig":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.usageRateCard.ratePlan.slabs.items.[INDEX].slabConfig.additionalProperties","typeLabel":"string"},"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.usageRateCard.ratePlan.slabs.items.[INDEX].slabConfig","typeLabel":"object"}},"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.usageRateCard.ratePlan.slabs.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.usageRateCard.ratePlan.slabs","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.usageRateCard.ratePlan","typeLabel":"object"},"rateValues":{"type":"array","items":{"type":"object","description":"Represents a rate","required":["currency","slabRates"],"properties":{"currency":{"type":"string","isRequired":true,"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.usageRateCard.rateValues.items.[INDEX].currency","typeLabel":"string"},"slabRates":{"type":"array","minItems":1,"items":{"type":"object","description":"Represents a rate for a slab","required":["order","rate"],"properties":{"order":{"type":"integer","format":"int32","isRequired":true,"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.usageRateCard.rateValues.items.[INDEX].slabRates.items.[INDEX].order","typeLabel":"integer\u003cint32>"},"rate":{"type":"number","isRequired":true,"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.usageRateCard.rateValues.items.[INDEX].slabRates.items.[INDEX].rate","typeLabel":"number"},"slabRateConfig":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.usageRateCard.rateValues.items.[INDEX].slabRates.items.[INDEX].slabRateConfig.additionalProperties","typeLabel":"string"},"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.usageRateCard.rateValues.items.[INDEX].slabRates.items.[INDEX].slabRateConfig","typeLabel":"object"}},"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.usageRateCard.rateValues.items.[INDEX].slabRates.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.usageRateCard.rateValues.items.[INDEX].slabRates","typeLabel":"object[]"},"rateConfig":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.usageRateCard.rateValues.items.[INDEX].rateConfig.additionalProperties","typeLabel":"string"},"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.usageRateCard.rateValues.items.[INDEX].rateConfig","typeLabel":"object"}},"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.usageRateCard.rateValues.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.usageRateCard.rateValues","typeLabel":"object[]"},"displayName":{"type":"string","description":"Name your rate card, this will be displayed in the Togai App","uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.usageRateCard.displayName","typeLabel":"string"},"name":{"type":"string","description":"Unique identifier for the rate card in a price plan. If left null it is auto-generated.","uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.usageRateCard.name","typeLabel":"string"},"tag":{"type":"string","description":"A tag string to group usageRateCards","uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.usageRateCard.tag","typeLabel":"string"}},"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.usageRateCard","typeLabel":"object"},"licenseRateCard":{"title":"LicenseRateCard","type":"object","required":["id","rateValues","ratePlan","enableProration"],"properties":{"id":{"description":"Unique Identifier of the attached AddOn","type":"string","maxLength":50,"isRequired":true,"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.licenseRateCard.id","typeLabel":"string"},"enableProration":{"type":"boolean","example":false,"isRequired":true,"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.licenseRateCard.enableProration","typeLabel":"boolean"},"ratePlan":{"type":"object","description":"Contains all rate related configurations","required":["pricingModel","slabs"],"properties":{"pricingModel":{"type":"string","description":"Togai supports two type of pricing model Tiered and Volume. Tiered pricing model applies respective slab and its rate to the usage value while volume pricing model applies the latest matching slab of the usage value and applies respective rate. \nFor more understanding read [Rate Cards](https://docs.togai.com/docs/priceplan#setting-up-multiple-rate-cards)\n","enum":["TIERED","VOLUME"],"isRequired":true,"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.licenseRateCard.ratePlan.pricingModel","typeLabel":"enum\u003cstring>"},"slabs":{"description":"Rate cards can have single or multiple slab up to 100.","type":"array","minItems":1,"items":{"type":"object","description":"Represents a pricing priceType (rates + slabs) for usage price plan","required":["order","startAfter","priceType"],"properties":{"order":{"type":"integer","format":"int32","minimum":1,"maximum":10,"isRequired":true,"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.licenseRateCard.ratePlan.slabs.items.[INDEX].order","typeLabel":"integer\u003cint32>"},"startAfter":{"type":"number","isRequired":true,"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.licenseRateCard.ratePlan.slabs.items.[INDEX].startAfter","typeLabel":"number"},"priceType":{"type":"string","enum":["FLAT","PER_UNIT","PACKAGE"],"isRequired":true,"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.licenseRateCard.ratePlan.slabs.items.[INDEX].priceType","typeLabel":"enum\u003cstring>"},"slabConfig":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.licenseRateCard.ratePlan.slabs.items.[INDEX].slabConfig.additionalProperties","typeLabel":"string"},"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.licenseRateCard.ratePlan.slabs.items.[INDEX].slabConfig","typeLabel":"object"}},"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.licenseRateCard.ratePlan.slabs.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.licenseRateCard.ratePlan.slabs","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.licenseRateCard.ratePlan","typeLabel":"object"},"rateValues":{"type":"array","items":{"type":"object","description":"Represents a rate","required":["currency","slabRates"],"properties":{"currency":{"type":"string","isRequired":true,"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.licenseRateCard.rateValues.items.[INDEX].currency","typeLabel":"string"},"slabRates":{"type":"array","minItems":1,"items":{"type":"object","description":"Represents a rate for a slab","required":["order","rate"],"properties":{"order":{"type":"integer","format":"int32","isRequired":true,"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.licenseRateCard.rateValues.items.[INDEX].slabRates.items.[INDEX].order","typeLabel":"integer\u003cint32>"},"rate":{"type":"number","isRequired":true,"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.licenseRateCard.rateValues.items.[INDEX].slabRates.items.[INDEX].rate","typeLabel":"number"},"slabRateConfig":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.licenseRateCard.rateValues.items.[INDEX].slabRates.items.[INDEX].slabRateConfig.additionalProperties","typeLabel":"string"},"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.licenseRateCard.rateValues.items.[INDEX].slabRates.items.[INDEX].slabRateConfig","typeLabel":"object"}},"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.licenseRateCard.rateValues.items.[INDEX].slabRates.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.licenseRateCard.rateValues.items.[INDEX].slabRates","typeLabel":"object[]"},"rateConfig":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.licenseRateCard.rateValues.items.[INDEX].rateConfig.additionalProperties","typeLabel":"string"},"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.licenseRateCard.rateValues.items.[INDEX].rateConfig","typeLabel":"object"}},"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.licenseRateCard.rateValues.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.licenseRateCard.rateValues","typeLabel":"object[]"},"type":{"type":"string","enum":["LICENSE","FIXED_FEE","CREDIT_GRANT","NAMED_LICENSE"],"description":"LICENSE: Addon can be used in license rate cards\nFIXED_FEE: Addon can be used in fixed fee rate cards\nCREDIT_GRANT: Addon can be used in credit grant rate cards\nNAMED_LICENSE: Addon can be used in license rate cards\n","uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.licenseRateCard.type","typeLabel":"enum\u003cstring>"},"displayName":{"type":"string","description":"Name of the attached AddOn","uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.licenseRateCard.displayName","typeLabel":"string"},"name":{"type":"string","description":"Unique identifier for the rate card in a price plan. If left null it is auto-generated.","uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.licenseRateCard.name","typeLabel":"string"},"tag":{"type":"string","description":"A tag string to group licenseRateCards","uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.licenseRateCard.tag","typeLabel":"string"},"invoiceTiming":{"type":"string","enum":["IN_ADVANCE","IN_ARREARS","PREPAID"],"x-enum-varnames":["IN_ADVANCE","IN_ARREARS","PREPAID"],"description":"If IN_ADVANCE, the rate card will be invoiced in the previous billing cycle.\nIf IN_ARREARS, the rate card will be invoiced in the current billing cycle.\nIf PREPAID, credits/entitlements will be granted only after invoice is paid\n","uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.licenseRateCard.invoiceTiming","typeLabel":"enum\u003cstring>"},"usageCycle":{"type":"string","description":"UsageCycleInterval field allows you to treat the billing interval as many smaller windows. Revenue is calculated for\neach of the windows (usage cycles) and their sum is considered as the billing interval revenue.\nExample: 1 Named License being used across entire billing interval. Rate Value: $1/license\nCASE 1: Without usage cycle. $1 is charged for the entire billing cycle.\nCASE 2: Usage cycle is configure to be WEEKLY and the billing interval has 4 weeks. In this case $1 is charged \nfor each week totalling to $4 across for the billing interval\n","enum":["WEEKLY","MONTHLY","QUARTERLY","HALF_YEARLY","ANNUALLY"],"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.licenseRateCard.usageCycle","typeLabel":"enum\u003cstring>"},"config":{"title":"LicenseRateCardConfig","type":"object","properties":{"maxQuantity":{"description":"Max allowed quantity for a particular license in a price plan","type":"integer","format":"int64","example":100,"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.licenseRateCard.config.maxQuantity","typeLabel":"integer\u003cint64>"},"maxQuantityBreachAction":{"type":"string","enum":["DO_NOTHING"],"description":"Action to be taken when the license maxQuantity is breached: \n- `DO_NOTHING`: Refrain from granting any new licenses.\n","uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.licenseRateCard.config.maxQuantityBreachAction","typeLabel":"enum\u003cstring>"}},"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.licenseRateCard.config","typeLabel":"LicenseRateCardConfig ยท object"},"proratedRefundMode":{"type":"string","enum":["NONE","CREDITS","PAYMENT","WALLET"],"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.licenseRateCard.proratedRefundMode","typeLabel":"enum\u003cstring>"}},"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.licenseRateCard","typeLabel":"LicenseRateCard ยท object"},"entitlementOverageRateCard":{"type":"object","required":["ratePlan","rateValues","featureId"],"properties":{"featureId":{"type":"string","description":"Unique Identifier of the attached Feature","maxLength":50,"isRequired":true,"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.entitlementOverageRateCard.featureId","typeLabel":"string"},"ratePlan":{"type":"object","description":"Contains all rate related configurations","required":["pricingModel","slabs"],"properties":{"pricingModel":{"type":"string","description":"Togai supports two type of pricing model Tiered and Volume. Tiered pricing model applies respective slab and its rate to the usage value while volume pricing model applies the latest matching slab of the usage value and applies respective rate. \nFor more understanding read [Rate Cards](https://docs.togai.com/docs/priceplan#setting-up-multiple-rate-cards)\n","enum":["TIERED","VOLUME"],"isRequired":true,"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.entitlementOverageRateCard.ratePlan.pricingModel","typeLabel":"enum\u003cstring>"},"slabs":{"description":"Rate cards can have single or multiple slab up to 100.","type":"array","minItems":1,"items":{"type":"object","description":"Represents a pricing priceType (rates + slabs) for usage price plan","required":["order","startAfter","priceType"],"properties":{"order":{"type":"integer","format":"int32","minimum":1,"maximum":10,"isRequired":true,"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.entitlementOverageRateCard.ratePlan.slabs.items.[INDEX].order","typeLabel":"integer\u003cint32>"},"startAfter":{"type":"number","isRequired":true,"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.entitlementOverageRateCard.ratePlan.slabs.items.[INDEX].startAfter","typeLabel":"number"},"priceType":{"type":"string","enum":["FLAT","PER_UNIT","PACKAGE"],"isRequired":true,"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.entitlementOverageRateCard.ratePlan.slabs.items.[INDEX].priceType","typeLabel":"enum\u003cstring>"},"slabConfig":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.entitlementOverageRateCard.ratePlan.slabs.items.[INDEX].slabConfig.additionalProperties","typeLabel":"string"},"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.entitlementOverageRateCard.ratePlan.slabs.items.[INDEX].slabConfig","typeLabel":"object"}},"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.entitlementOverageRateCard.ratePlan.slabs.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.entitlementOverageRateCard.ratePlan.slabs","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.entitlementOverageRateCard.ratePlan","typeLabel":"object"},"rateValues":{"type":"array","items":{"type":"object","description":"Represents a rate","required":["currency","slabRates"],"properties":{"currency":{"type":"string","isRequired":true,"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.entitlementOverageRateCard.rateValues.items.[INDEX].currency","typeLabel":"string"},"slabRates":{"type":"array","minItems":1,"items":{"type":"object","description":"Represents a rate for a slab","required":["order","rate"],"properties":{"order":{"type":"integer","format":"int32","isRequired":true,"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.entitlementOverageRateCard.rateValues.items.[INDEX].slabRates.items.[INDEX].order","typeLabel":"integer\u003cint32>"},"rate":{"type":"number","isRequired":true,"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.entitlementOverageRateCard.rateValues.items.[INDEX].slabRates.items.[INDEX].rate","typeLabel":"number"},"slabRateConfig":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.entitlementOverageRateCard.rateValues.items.[INDEX].slabRates.items.[INDEX].slabRateConfig.additionalProperties","typeLabel":"string"},"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.entitlementOverageRateCard.rateValues.items.[INDEX].slabRates.items.[INDEX].slabRateConfig","typeLabel":"object"}},"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.entitlementOverageRateCard.rateValues.items.[INDEX].slabRates.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.entitlementOverageRateCard.rateValues.items.[INDEX].slabRates","typeLabel":"object[]"},"rateConfig":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.entitlementOverageRateCard.rateValues.items.[INDEX].rateConfig.additionalProperties","typeLabel":"string"},"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.entitlementOverageRateCard.rateValues.items.[INDEX].rateConfig","typeLabel":"object"}},"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.entitlementOverageRateCard.rateValues.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.entitlementOverageRateCard.rateValues","typeLabel":"object[]"},"displayName":{"type":"string","description":"Name to be displayed during invoice","uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.entitlementOverageRateCard.displayName","typeLabel":"string"},"name":{"type":"string","description":"Unique identifier for the rate card in a price plan. If left null it is auto-generated.","uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.entitlementOverageRateCard.name","typeLabel":"string"},"tag":{"type":"string","description":"A tag string to group rate cards","uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.entitlementOverageRateCard.tag","typeLabel":"string"},"maxQuantity":{"type":"number","description":"Maximum quantity allowed for the feature, if not specified, unlimited quantity is allowed","uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.entitlementOverageRateCard.maxQuantity","typeLabel":"number"},"billingConfig":{"type":"object","properties":{"interval":{"description":"Represents the number of pricing cycles after which the rate card will be billed","type":"integer","format":"int64","example":3,"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.entitlementOverageRateCard.billingConfig.interval","typeLabel":"integer\u003cint64>"},"startOffset":{"description":"Represents the offset for pricing cycles after which the rate card will be billed","type":"integer","format":"int64","example":5,"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.entitlementOverageRateCard.billingConfig.startOffset","typeLabel":"integer\u003cint64>"}},"description":"Represents the billing config of the entitlement overage rate card. If not specified interval:1 and startOffset:0 is taken as default value","uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.entitlementOverageRateCard.billingConfig","typeLabel":"object"}},"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.entitlementOverageRateCard","typeLabel":"object"},"minimumCommitmentRateCard":{"title":"MinimumCommitment","type":"object","required":["displayName","rateValues"],"properties":{"displayName":{"type":"string","isRequired":true,"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.minimumCommitmentRateCard.displayName","typeLabel":"string"},"rateValues":{"type":"array","minItems":1,"items":{"type":"object","required":["currency","rate"],"properties":{"currency":{"type":"string","isRequired":true,"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.minimumCommitmentRateCard.rateValues.items.[INDEX].currency","typeLabel":"string"},"rate":{"type":"number","isRequired":true,"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.minimumCommitmentRateCard.rateValues.items.[INDEX].rate","typeLabel":"number"}},"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.minimumCommitmentRateCard.rateValues.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.minimumCommitmentRateCard.rateValues","typeLabel":"object[]"}},"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails.minimumCommitmentRateCard","typeLabel":"MinimumCommitment ยท object"}},"isRequired":true,"uniqueKey":"operations.items.[INDEX].rateCard.rateCardDetails","typeLabel":"object"},"displayName":{"type":"string","description":"Display name of the rate card","maxLength":255,"uniqueKey":"operations.items.[INDEX].rateCard.displayName","typeLabel":"string"},"tag":{"type":"string","description":"Tag for rate card","maxLength":50,"uniqueKey":"operations.items.[INDEX].rateCard.tag","typeLabel":"string"}},"uniqueKey":"operations.items.[INDEX].rateCard","typeLabel":"object"}},"uniqueKey":"operations.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"operations","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"operations":[{"rateCardName":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"6d29bb8d-9289-4bc7-bf0b-584b4a16c12a":{"description":"Response for bulk rate card operations of a price plan","content":{"application/json":{"schema":{"description":"Bulk rate card operations response","type":"object","required":["rateCards"],"properties":{"rateCards":{"type":"array","items":{"type":"object","description":"Request to create a rate card","required":["name","pricePlanId","displayName","referenceId","referenceType","billableId","invoiceTiming","rateCardDetails","type"],"properties":{"billableId":{"description":"Billable identifier","type":"string","maxLength":50,"isRequired":true,"uniqueKey":"rateCards.items.[INDEX].billableId","typeLabel":"string"},"type":{"description":"Rate card type","type":"string","enum":["MINIMUM_COMMITMENT","BILLING_ENTITLEMENT","CREDIT_GRANT","ENTITLEMENT_OVERAGE","FIXED_FEE","LICENSE","USAGE"],"isRequired":true,"uniqueKey":"rateCards.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"displayName":{"type":"string","description":"Display name of the rate card","maxLength":255,"isRequired":true,"uniqueKey":"rateCards.items.[INDEX].displayName","typeLabel":"string"},"invoiceTiming":{"type":"string","enum":["IN_ADVANCE","IN_ARREARS","PREPAID"],"x-enum-varnames":["IN_ADVANCE","IN_ARREARS","PREPAID"],"description":"If IN_ADVANCE, the rate card will be invoiced in the previous billing cycle.\nIf IN_ARREARS, the rate card will be invoiced in the current billing cycle.\nIf PREPAID, credits/entitlements will be granted only after invoice is paid\n","isRequired":true,"uniqueKey":"rateCards.items.[INDEX].invoiceTiming","typeLabel":"enum\u003cstring>"},"rateCardDetails":{"description":"Rate card details","type":"object","additionalProperties":false,"properties":{"fixedFeeRateCard":{"title":"FixedFeeRateCard","type":"object","required":["id","rateValues","enableProration"],"properties":{"id":{"description":"Unique Identifier of the attached AddOn","type":"string","maxLength":50,"isRequired":true,"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.fixedFeeRateCard.id","typeLabel":"string"},"rateValues":{"type":"array","items":{"type":"object","required":["currency","rate"],"properties":{"currency":{"type":"string","isRequired":true,"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.fixedFeeRateCard.rateValues.items.[INDEX].currency","typeLabel":"string"},"rate":{"type":"number","isRequired":true,"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.fixedFeeRateCard.rateValues.items.[INDEX].rate","typeLabel":"number"}},"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.fixedFeeRateCard.rateValues.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.fixedFeeRateCard.rateValues","typeLabel":"object[]"},"enableProration":{"type":"boolean","example":false,"isRequired":true,"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.fixedFeeRateCard.enableProration","typeLabel":"boolean"},"displayName":{"type":"string","description":"Name of the attached AddOn","uniqueKey":"rateCards.items.[INDEX].rateCardDetails.fixedFeeRateCard.displayName","typeLabel":"string"},"name":{"type":"string","description":"Unique identifier for the rate card in a price plan. If left null it is auto-generated.","uniqueKey":"rateCards.items.[INDEX].rateCardDetails.fixedFeeRateCard.name","typeLabel":"string"},"tag":{"type":"string","description":"A tag string to group fixedFeeRateCards","uniqueKey":"rateCards.items.[INDEX].rateCardDetails.fixedFeeRateCard.tag","typeLabel":"string"},"invoiceTiming":{"type":"string","enum":["IN_ADVANCE","IN_ARREARS","PREPAID"],"x-enum-varnames":["IN_ADVANCE","IN_ARREARS","PREPAID"],"description":"If IN_ADVANCE, the rate card will be invoiced in the previous billing cycle.\nIf IN_ARREARS, the rate card will be invoiced in the current billing cycle.\nIf PREPAID, credits/entitlements will be granted only after invoice is paid\n","uniqueKey":"rateCards.items.[INDEX].rateCardDetails.fixedFeeRateCard.invoiceTiming","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["ONE_TIME","RECURRING"],"description":"Fixed fee applies either for a one-time occurrence or for each cycle.","uniqueKey":"rateCards.items.[INDEX].rateCardDetails.fixedFeeRateCard.type","typeLabel":"enum\u003cstring>"},"recurrenceConfig":{"type":"object","properties":{"interval":{"description":"Represents the number of pricing cycles after which the rate card will be charged","type":"integer","format":"int64","example":3,"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.fixedFeeRateCard.recurrenceConfig.interval","typeLabel":"integer\u003cint64>"},"offset":{"description":"Represents the offset for pricing cycles after which the rate card will be charged","type":"integer","format":"int64","example":5,"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.fixedFeeRateCard.recurrenceConfig.offset","typeLabel":"integer\u003cint64>"}},"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.fixedFeeRateCard.recurrenceConfig","typeLabel":"object"}},"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.fixedFeeRateCard","typeLabel":"FixedFeeRateCard ยท object"},"billingEntitlementRateCard":{"description":"Billing Entitlement rate card","type":"object","additionalProperties":false,"required":["featureId","featureConfigs","ratePlan","rateValues","invoiceTiming"],"properties":{"featureId":{"type":"string","isRequired":true,"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.billingEntitlementRateCard.featureId","typeLabel":"string"},"featureConfigs":{"type":"array","minItems":1,"items":{"description":"Feature configuration object","type":"object","additionalProperties":false,"required":["effectiveUntil","featureCreditLimit"],"properties":{"effectiveUntil":{"type":"string","format":"duration","isRequired":true,"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.billingEntitlementRateCard.featureConfigs.items.[INDEX].effectiveUntil","typeLabel":"string\u003cduration>"},"featureCreditLimit":{"type":"number","minimum":0,"isRequired":true,"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.billingEntitlementRateCard.featureConfigs.items.[INDEX].featureCreditLimit","typeLabel":"number"},"effectiveFrom":{"type":"string","format":"duration","uniqueKey":"rateCards.items.[INDEX].rateCardDetails.billingEntitlementRateCard.featureConfigs.items.[INDEX].effectiveFrom","typeLabel":"string\u003cduration>"}},"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.billingEntitlementRateCard.featureConfigs.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.billingEntitlementRateCard.featureConfigs","typeLabel":"object[]"},"invoiceTiming":{"type":"string","enum":["IN_ADVANCE","IN_ARREARS","PREPAID"],"x-enum-varnames":["IN_ADVANCE","IN_ARREARS","PREPAID"],"description":"If IN_ADVANCE, the rate card will be invoiced in the previous billing cycle.\nIf IN_ARREARS, the rate card will be invoiced in the current billing cycle.\nIf PREPAID, credits/entitlements will be granted only after invoice is paid\n","isRequired":true,"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.billingEntitlementRateCard.invoiceTiming","typeLabel":"enum\u003cstring>"},"ratePlan":{"type":"object","description":"Contains all rate related configurations","required":["pricingModel","slabs"],"properties":{"pricingModel":{"type":"string","description":"Togai supports two type of pricing model Tiered and Volume. Tiered pricing model applies respective slab and its rate to the usage value while volume pricing model applies the latest matching slab of the usage value and applies respective rate. \nFor more understanding read [Rate Cards](https://docs.togai.com/docs/priceplan#setting-up-multiple-rate-cards)\n","enum":["TIERED","VOLUME"],"isRequired":true,"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.billingEntitlementRateCard.ratePlan.pricingModel","typeLabel":"enum\u003cstring>"},"slabs":{"description":"Rate cards can have single or multiple slab up to 100.","type":"array","minItems":1,"items":{"type":"object","description":"Represents a pricing priceType (rates + slabs) for usage price plan","required":["order","startAfter","priceType"],"properties":{"order":{"type":"integer","format":"int32","minimum":1,"maximum":10,"isRequired":true,"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.billingEntitlementRateCard.ratePlan.slabs.items.[INDEX].order","typeLabel":"integer\u003cint32>"},"startAfter":{"type":"number","isRequired":true,"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.billingEntitlementRateCard.ratePlan.slabs.items.[INDEX].startAfter","typeLabel":"number"},"priceType":{"type":"string","enum":["FLAT","PER_UNIT","PACKAGE"],"isRequired":true,"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.billingEntitlementRateCard.ratePlan.slabs.items.[INDEX].priceType","typeLabel":"enum\u003cstring>"},"slabConfig":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"rateCards.items.[INDEX].rateCardDetails.billingEntitlementRateCard.ratePlan.slabs.items.[INDEX].slabConfig.additionalProperties","typeLabel":"string"},"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.billingEntitlementRateCard.ratePlan.slabs.items.[INDEX].slabConfig","typeLabel":"object"}},"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.billingEntitlementRateCard.ratePlan.slabs.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.billingEntitlementRateCard.ratePlan.slabs","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.billingEntitlementRateCard.ratePlan","typeLabel":"object"},"rateValues":{"type":"array","items":{"type":"object","description":"Represents a rate","required":["currency","slabRates"],"properties":{"currency":{"type":"string","isRequired":true,"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.billingEntitlementRateCard.rateValues.items.[INDEX].currency","typeLabel":"string"},"slabRates":{"type":"array","minItems":1,"items":{"type":"object","description":"Represents a rate for a slab","required":["order","rate"],"properties":{"order":{"type":"integer","format":"int32","isRequired":true,"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.billingEntitlementRateCard.rateValues.items.[INDEX].slabRates.items.[INDEX].order","typeLabel":"integer\u003cint32>"},"rate":{"type":"number","isRequired":true,"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.billingEntitlementRateCard.rateValues.items.[INDEX].slabRates.items.[INDEX].rate","typeLabel":"number"},"slabRateConfig":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"rateCards.items.[INDEX].rateCardDetails.billingEntitlementRateCard.rateValues.items.[INDEX].slabRates.items.[INDEX].slabRateConfig.additionalProperties","typeLabel":"string"},"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.billingEntitlementRateCard.rateValues.items.[INDEX].slabRates.items.[INDEX].slabRateConfig","typeLabel":"object"}},"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.billingEntitlementRateCard.rateValues.items.[INDEX].slabRates.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.billingEntitlementRateCard.rateValues.items.[INDEX].slabRates","typeLabel":"object[]"},"rateConfig":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"rateCards.items.[INDEX].rateCardDetails.billingEntitlementRateCard.rateValues.items.[INDEX].rateConfig.additionalProperties","typeLabel":"string"},"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.billingEntitlementRateCard.rateValues.items.[INDEX].rateConfig","typeLabel":"object"}},"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.billingEntitlementRateCard.rateValues.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.billingEntitlementRateCard.rateValues","typeLabel":"object[]"},"tag":{"type":"string","description":"A tag string to group rate cards","uniqueKey":"rateCards.items.[INDEX].rateCardDetails.billingEntitlementRateCard.tag","typeLabel":"string"},"displayName":{"type":"string","description":"Name your rate card, this will be used in invoice","uniqueKey":"rateCards.items.[INDEX].rateCardDetails.billingEntitlementRateCard.displayName","typeLabel":"string"},"name":{"type":"string","description":"Unique identifier for the rate card in a price plan. If left null it is auto-generated.","uniqueKey":"rateCards.items.[INDEX].rateCardDetails.billingEntitlementRateCard.name","typeLabel":"string"},"recurrenceConfig":{"type":"object","properties":{"interval":{"description":"Represents the number of pricing cycles after which the rate card will be charged","type":"integer","format":"int64","example":3,"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.billingEntitlementRateCard.recurrenceConfig.interval","typeLabel":"integer\u003cint64>"},"offset":{"description":"Represents the offset for pricing cycles after which the rate card will be charged","type":"integer","format":"int64","example":5,"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.billingEntitlementRateCard.recurrenceConfig.offset","typeLabel":"integer\u003cint64>"}},"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.billingEntitlementRateCard.recurrenceConfig","typeLabel":"object"}},"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.billingEntitlementRateCard","typeLabel":"object"},"creditGrantRateCard":{"description":"Credit grant rate card","type":"object","additionalProperties":false,"required":["id","rateDetails","grantDetails"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.creditGrantRateCard.id","typeLabel":"string"},"grantDetails":{"description":"Grant details of Credit Grant Rate Card","type":"object","additionalProperties":false,"required":["priority","expiryType"],"properties":{"priority":{"type":"integer","minimum":0,"isRequired":true,"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.creditGrantRateCard.grantDetails.priority","typeLabel":"integer"},"expiryType":{"type":"string","description":"Expiry type of grant","enum":["PRICING_CYCLE","NO_EXPIRY","CUSTOM"],"isRequired":true,"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.creditGrantRateCard.grantDetails.expiryType","typeLabel":"enum\u003cstring>"},"expiryDuration":{"type":"string","format":"duration","uniqueKey":"rateCards.items.[INDEX].rateCardDetails.creditGrantRateCard.grantDetails.expiryDuration","typeLabel":"string\u003cduration>"},"applicableEntityIds":{"type":"array","items":{"type":"string","uniqueKey":"rateCards.items.[INDEX].rateCardDetails.creditGrantRateCard.grantDetails.applicableEntityIds.items.[INDEX]","typeLabel":"string"},"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.creditGrantRateCard.grantDetails.applicableEntityIds","typeLabel":"string[]"}},"isRequired":true,"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.creditGrantRateCard.grantDetails","typeLabel":"object"},"rateDetails":{"type":"object","description":"Amount to be credited","additionalProperties":false,"required":["pricingModel","currencySlabRateDetails"],"properties":{"pricingModel":{"type":"string","description":"Togai supports two type of pricing model Tiered and Volume. Tiered pricing model applies respective slab and its rate to the usage value while volume pricing model applies the latest matching slab of the usage value and applies respective rate. \nFor more understanding read [Rate Cards](https://docs.togai.com/docs/priceplan#setting-up-multiple-rate-cards)\n","enum":["TIERED","VOLUME"],"isRequired":true,"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.creditGrantRateCard.rateDetails.pricingModel","typeLabel":"enum\u003cstring>"},"currencySlabRateDetails":{"type":"array","items":{"type":"object","description":"The association of a currency along with its slab detail","additionalProperties":false,"required":["currency","creditAmount","slabDetails"],"properties":{"currency":{"type":"string","isRequired":true,"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.creditGrantRateCard.rateDetails.currencySlabRateDetails.items.[INDEX].currency","typeLabel":"string"},"creditAmount":{"type":"number","description":"The amount of credit that needs to be credited","minimum":0,"isRequired":true,"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.creditGrantRateCard.rateDetails.currencySlabRateDetails.items.[INDEX].creditAmount","typeLabel":"number"},"slabDetails":{"type":"array","items":{"type":"object","description":"The details of a slab","additionalProperties":false,"required":["startAfter","priceType","rate"],"properties":{"startAfter":{"type":"number","isRequired":true,"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.creditGrantRateCard.rateDetails.currencySlabRateDetails.items.[INDEX].slabDetails.items.[INDEX].startAfter","typeLabel":"number"},"priceType":{"type":"string","enum":["FLAT","PER_UNIT","PACKAGE"],"isRequired":true,"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.creditGrantRateCard.rateDetails.currencySlabRateDetails.items.[INDEX].slabDetails.items.[INDEX].priceType","typeLabel":"enum\u003cstring>"},"rate":{"type":"number","isRequired":true,"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.creditGrantRateCard.rateDetails.currencySlabRateDetails.items.[INDEX].slabDetails.items.[INDEX].rate","typeLabel":"number"},"slabConfig":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"rateCards.items.[INDEX].rateCardDetails.creditGrantRateCard.rateDetails.currencySlabRateDetails.items.[INDEX].slabDetails.items.[INDEX].slabConfig.additionalProperties","typeLabel":"string"},"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.creditGrantRateCard.rateDetails.currencySlabRateDetails.items.[INDEX].slabDetails.items.[INDEX].slabConfig","typeLabel":"object"},"slabRateConfig":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"rateCards.items.[INDEX].rateCardDetails.creditGrantRateCard.rateDetails.currencySlabRateDetails.items.[INDEX].slabDetails.items.[INDEX].slabRateConfig.additionalProperties","typeLabel":"string"},"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.creditGrantRateCard.rateDetails.currencySlabRateDetails.items.[INDEX].slabDetails.items.[INDEX].slabRateConfig","typeLabel":"object"}},"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.creditGrantRateCard.rateDetails.currencySlabRateDetails.items.[INDEX].slabDetails.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.creditGrantRateCard.rateDetails.currencySlabRateDetails.items.[INDEX].slabDetails","typeLabel":"object[]"},"rateConfig":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"rateCards.items.[INDEX].rateCardDetails.creditGrantRateCard.rateDetails.currencySlabRateDetails.items.[INDEX].rateConfig.additionalProperties","typeLabel":"string"},"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.creditGrantRateCard.rateDetails.currencySlabRateDetails.items.[INDEX].rateConfig","typeLabel":"object"}},"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.creditGrantRateCard.rateDetails.currencySlabRateDetails.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.creditGrantRateCard.rateDetails.currencySlabRateDetails","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.creditGrantRateCard.rateDetails","typeLabel":"object"},"displayName":{"type":"string","uniqueKey":"rateCards.items.[INDEX].rateCardDetails.creditGrantRateCard.displayName","typeLabel":"string"},"name":{"type":"string","description":"Unique identifier for the rate card in a price plan. If left null it is auto-generated.","uniqueKey":"rateCards.items.[INDEX].rateCardDetails.creditGrantRateCard.name","typeLabel":"string"},"tag":{"type":"string","description":"A tag string to group creditGrantRateCard","uniqueKey":"rateCards.items.[INDEX].rateCardDetails.creditGrantRateCard.tag","typeLabel":"string"},"invoiceTiming":{"type":"string","enum":["IN_ADVANCE","IN_ARREARS","PREPAID"],"x-enum-varnames":["IN_ADVANCE","IN_ARREARS","PREPAID"],"description":"If IN_ADVANCE, the rate card will be invoiced in the previous billing cycle.\nIf IN_ARREARS, the rate card will be invoiced in the current billing cycle.\nIf PREPAID, credits/entitlements will be granted only after invoice is paid\n","uniqueKey":"rateCards.items.[INDEX].rateCardDetails.creditGrantRateCard.invoiceTiming","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["ONE_TIME","RECURRING"],"description":"Credit grant applies either for a one-time occurrence or for each cycle.","uniqueKey":"rateCards.items.[INDEX].rateCardDetails.creditGrantRateCard.type","typeLabel":"enum\u003cstring>"},"recurrenceConfig":{"type":"object","properties":{"interval":{"description":"Represents the number of pricing cycles after which the rate card will be charged","type":"integer","format":"int64","example":3,"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.creditGrantRateCard.recurrenceConfig.interval","typeLabel":"integer\u003cint64>"},"offset":{"description":"Represents the offset for pricing cycles after which the rate card will be charged","type":"integer","format":"int64","example":5,"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.creditGrantRateCard.recurrenceConfig.offset","typeLabel":"integer\u003cint64>"}},"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.creditGrantRateCard.recurrenceConfig","typeLabel":"object"}},"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.creditGrantRateCard","typeLabel":"object"},"usageRateCard":{"type":"object","required":["usageMeterId","ratePlan","rateValues"],"properties":{"usageMeterId":{"type":"string","example":"um.1zYnCiM9Bpg.1zYn","isRequired":true,"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.usageRateCard.usageMeterId","typeLabel":"string"},"ratePlan":{"type":"object","description":"Contains all rate related configurations","required":["pricingModel","slabs"],"properties":{"pricingModel":{"type":"string","description":"Togai supports two type of pricing model Tiered and Volume. Tiered pricing model applies respective slab and its rate to the usage value while volume pricing model applies the latest matching slab of the usage value and applies respective rate. \nFor more understanding read [Rate Cards](https://docs.togai.com/docs/priceplan#setting-up-multiple-rate-cards)\n","enum":["TIERED","VOLUME"],"isRequired":true,"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.usageRateCard.ratePlan.pricingModel","typeLabel":"enum\u003cstring>"},"slabs":{"description":"Rate cards can have single or multiple slab up to 100.","type":"array","minItems":1,"items":{"type":"object","description":"Represents a pricing priceType (rates + slabs) for usage price plan","required":["order","startAfter","priceType"],"properties":{"order":{"type":"integer","format":"int32","minimum":1,"maximum":10,"isRequired":true,"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.usageRateCard.ratePlan.slabs.items.[INDEX].order","typeLabel":"integer\u003cint32>"},"startAfter":{"type":"number","isRequired":true,"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.usageRateCard.ratePlan.slabs.items.[INDEX].startAfter","typeLabel":"number"},"priceType":{"type":"string","enum":["FLAT","PER_UNIT","PACKAGE"],"isRequired":true,"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.usageRateCard.ratePlan.slabs.items.[INDEX].priceType","typeLabel":"enum\u003cstring>"},"slabConfig":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"rateCards.items.[INDEX].rateCardDetails.usageRateCard.ratePlan.slabs.items.[INDEX].slabConfig.additionalProperties","typeLabel":"string"},"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.usageRateCard.ratePlan.slabs.items.[INDEX].slabConfig","typeLabel":"object"}},"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.usageRateCard.ratePlan.slabs.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.usageRateCard.ratePlan.slabs","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.usageRateCard.ratePlan","typeLabel":"object"},"rateValues":{"type":"array","items":{"type":"object","description":"Represents a rate","required":["currency","slabRates"],"properties":{"currency":{"type":"string","isRequired":true,"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.usageRateCard.rateValues.items.[INDEX].currency","typeLabel":"string"},"slabRates":{"type":"array","minItems":1,"items":{"type":"object","description":"Represents a rate for a slab","required":["order","rate"],"properties":{"order":{"type":"integer","format":"int32","isRequired":true,"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.usageRateCard.rateValues.items.[INDEX].slabRates.items.[INDEX].order","typeLabel":"integer\u003cint32>"},"rate":{"type":"number","isRequired":true,"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.usageRateCard.rateValues.items.[INDEX].slabRates.items.[INDEX].rate","typeLabel":"number"},"slabRateConfig":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"rateCards.items.[INDEX].rateCardDetails.usageRateCard.rateValues.items.[INDEX].slabRates.items.[INDEX].slabRateConfig.additionalProperties","typeLabel":"string"},"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.usageRateCard.rateValues.items.[INDEX].slabRates.items.[INDEX].slabRateConfig","typeLabel":"object"}},"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.usageRateCard.rateValues.items.[INDEX].slabRates.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.usageRateCard.rateValues.items.[INDEX].slabRates","typeLabel":"object[]"},"rateConfig":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"rateCards.items.[INDEX].rateCardDetails.usageRateCard.rateValues.items.[INDEX].rateConfig.additionalProperties","typeLabel":"string"},"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.usageRateCard.rateValues.items.[INDEX].rateConfig","typeLabel":"object"}},"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.usageRateCard.rateValues.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.usageRateCard.rateValues","typeLabel":"object[]"},"displayName":{"type":"string","description":"Name your rate card, this will be displayed in the Togai App","uniqueKey":"rateCards.items.[INDEX].rateCardDetails.usageRateCard.displayName","typeLabel":"string"},"name":{"type":"string","description":"Unique identifier for the rate card in a price plan. If left null it is auto-generated.","uniqueKey":"rateCards.items.[INDEX].rateCardDetails.usageRateCard.name","typeLabel":"string"},"tag":{"type":"string","description":"A tag string to group usageRateCards","uniqueKey":"rateCards.items.[INDEX].rateCardDetails.usageRateCard.tag","typeLabel":"string"}},"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.usageRateCard","typeLabel":"object"},"licenseRateCard":{"title":"LicenseRateCard","type":"object","required":["id","rateValues","ratePlan","enableProration"],"properties":{"id":{"description":"Unique Identifier of the attached AddOn","type":"string","maxLength":50,"isRequired":true,"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.licenseRateCard.id","typeLabel":"string"},"enableProration":{"type":"boolean","example":false,"isRequired":true,"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.licenseRateCard.enableProration","typeLabel":"boolean"},"ratePlan":{"type":"object","description":"Contains all rate related configurations","required":["pricingModel","slabs"],"properties":{"pricingModel":{"type":"string","description":"Togai supports two type of pricing model Tiered and Volume. Tiered pricing model applies respective slab and its rate to the usage value while volume pricing model applies the latest matching slab of the usage value and applies respective rate. \nFor more understanding read [Rate Cards](https://docs.togai.com/docs/priceplan#setting-up-multiple-rate-cards)\n","enum":["TIERED","VOLUME"],"isRequired":true,"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.licenseRateCard.ratePlan.pricingModel","typeLabel":"enum\u003cstring>"},"slabs":{"description":"Rate cards can have single or multiple slab up to 100.","type":"array","minItems":1,"items":{"type":"object","description":"Represents a pricing priceType (rates + slabs) for usage price plan","required":["order","startAfter","priceType"],"properties":{"order":{"type":"integer","format":"int32","minimum":1,"maximum":10,"isRequired":true,"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.licenseRateCard.ratePlan.slabs.items.[INDEX].order","typeLabel":"integer\u003cint32>"},"startAfter":{"type":"number","isRequired":true,"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.licenseRateCard.ratePlan.slabs.items.[INDEX].startAfter","typeLabel":"number"},"priceType":{"type":"string","enum":["FLAT","PER_UNIT","PACKAGE"],"isRequired":true,"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.licenseRateCard.ratePlan.slabs.items.[INDEX].priceType","typeLabel":"enum\u003cstring>"},"slabConfig":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"rateCards.items.[INDEX].rateCardDetails.licenseRateCard.ratePlan.slabs.items.[INDEX].slabConfig.additionalProperties","typeLabel":"string"},"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.licenseRateCard.ratePlan.slabs.items.[INDEX].slabConfig","typeLabel":"object"}},"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.licenseRateCard.ratePlan.slabs.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.licenseRateCard.ratePlan.slabs","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.licenseRateCard.ratePlan","typeLabel":"object"},"rateValues":{"type":"array","items":{"type":"object","description":"Represents a rate","required":["currency","slabRates"],"properties":{"currency":{"type":"string","isRequired":true,"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.licenseRateCard.rateValues.items.[INDEX].currency","typeLabel":"string"},"slabRates":{"type":"array","minItems":1,"items":{"type":"object","description":"Represents a rate for a slab","required":["order","rate"],"properties":{"order":{"type":"integer","format":"int32","isRequired":true,"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.licenseRateCard.rateValues.items.[INDEX].slabRates.items.[INDEX].order","typeLabel":"integer\u003cint32>"},"rate":{"type":"number","isRequired":true,"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.licenseRateCard.rateValues.items.[INDEX].slabRates.items.[INDEX].rate","typeLabel":"number"},"slabRateConfig":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"rateCards.items.[INDEX].rateCardDetails.licenseRateCard.rateValues.items.[INDEX].slabRates.items.[INDEX].slabRateConfig.additionalProperties","typeLabel":"string"},"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.licenseRateCard.rateValues.items.[INDEX].slabRates.items.[INDEX].slabRateConfig","typeLabel":"object"}},"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.licenseRateCard.rateValues.items.[INDEX].slabRates.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.licenseRateCard.rateValues.items.[INDEX].slabRates","typeLabel":"object[]"},"rateConfig":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"rateCards.items.[INDEX].rateCardDetails.licenseRateCard.rateValues.items.[INDEX].rateConfig.additionalProperties","typeLabel":"string"},"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.licenseRateCard.rateValues.items.[INDEX].rateConfig","typeLabel":"object"}},"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.licenseRateCard.rateValues.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.licenseRateCard.rateValues","typeLabel":"object[]"},"type":{"type":"string","enum":["LICENSE","FIXED_FEE","CREDIT_GRANT","NAMED_LICENSE"],"description":"LICENSE: Addon can be used in license rate cards\nFIXED_FEE: Addon can be used in fixed fee rate cards\nCREDIT_GRANT: Addon can be used in credit grant rate cards\nNAMED_LICENSE: Addon can be used in license rate cards\n","uniqueKey":"rateCards.items.[INDEX].rateCardDetails.licenseRateCard.type","typeLabel":"enum\u003cstring>"},"displayName":{"type":"string","description":"Name of the attached AddOn","uniqueKey":"rateCards.items.[INDEX].rateCardDetails.licenseRateCard.displayName","typeLabel":"string"},"name":{"type":"string","description":"Unique identifier for the rate card in a price plan. If left null it is auto-generated.","uniqueKey":"rateCards.items.[INDEX].rateCardDetails.licenseRateCard.name","typeLabel":"string"},"tag":{"type":"string","description":"A tag string to group licenseRateCards","uniqueKey":"rateCards.items.[INDEX].rateCardDetails.licenseRateCard.tag","typeLabel":"string"},"invoiceTiming":{"type":"string","enum":["IN_ADVANCE","IN_ARREARS","PREPAID"],"x-enum-varnames":["IN_ADVANCE","IN_ARREARS","PREPAID"],"description":"If IN_ADVANCE, the rate card will be invoiced in the previous billing cycle.\nIf IN_ARREARS, the rate card will be invoiced in the current billing cycle.\nIf PREPAID, credits/entitlements will be granted only after invoice is paid\n","uniqueKey":"rateCards.items.[INDEX].rateCardDetails.licenseRateCard.invoiceTiming","typeLabel":"enum\u003cstring>"},"usageCycle":{"type":"string","description":"UsageCycleInterval field allows you to treat the billing interval as many smaller windows. Revenue is calculated for\neach of the windows (usage cycles) and their sum is considered as the billing interval revenue.\nExample: 1 Named License being used across entire billing interval. Rate Value: $1/license\nCASE 1: Without usage cycle. $1 is charged for the entire billing cycle.\nCASE 2: Usage cycle is configure to be WEEKLY and the billing interval has 4 weeks. In this case $1 is charged \nfor each week totalling to $4 across for the billing interval\n","enum":["WEEKLY","MONTHLY","QUARTERLY","HALF_YEARLY","ANNUALLY"],"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.licenseRateCard.usageCycle","typeLabel":"enum\u003cstring>"},"config":{"title":"LicenseRateCardConfig","type":"object","properties":{"maxQuantity":{"description":"Max allowed quantity for a particular license in a price plan","type":"integer","format":"int64","example":100,"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.licenseRateCard.config.maxQuantity","typeLabel":"integer\u003cint64>"},"maxQuantityBreachAction":{"type":"string","enum":["DO_NOTHING"],"description":"Action to be taken when the license maxQuantity is breached: \n- `DO_NOTHING`: Refrain from granting any new licenses.\n","uniqueKey":"rateCards.items.[INDEX].rateCardDetails.licenseRateCard.config.maxQuantityBreachAction","typeLabel":"enum\u003cstring>"}},"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.licenseRateCard.config","typeLabel":"LicenseRateCardConfig ยท object"},"proratedRefundMode":{"type":"string","enum":["NONE","CREDITS","PAYMENT","WALLET"],"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.licenseRateCard.proratedRefundMode","typeLabel":"enum\u003cstring>"}},"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.licenseRateCard","typeLabel":"LicenseRateCard ยท object"},"entitlementOverageRateCard":{"type":"object","required":["ratePlan","rateValues","featureId"],"properties":{"featureId":{"type":"string","description":"Unique Identifier of the attached Feature","maxLength":50,"isRequired":true,"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.entitlementOverageRateCard.featureId","typeLabel":"string"},"ratePlan":{"type":"object","description":"Contains all rate related configurations","required":["pricingModel","slabs"],"properties":{"pricingModel":{"type":"string","description":"Togai supports two type of pricing model Tiered and Volume. Tiered pricing model applies respective slab and its rate to the usage value while volume pricing model applies the latest matching slab of the usage value and applies respective rate. \nFor more understanding read [Rate Cards](https://docs.togai.com/docs/priceplan#setting-up-multiple-rate-cards)\n","enum":["TIERED","VOLUME"],"isRequired":true,"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.entitlementOverageRateCard.ratePlan.pricingModel","typeLabel":"enum\u003cstring>"},"slabs":{"description":"Rate cards can have single or multiple slab up to 100.","type":"array","minItems":1,"items":{"type":"object","description":"Represents a pricing priceType (rates + slabs) for usage price plan","required":["order","startAfter","priceType"],"properties":{"order":{"type":"integer","format":"int32","minimum":1,"maximum":10,"isRequired":true,"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.entitlementOverageRateCard.ratePlan.slabs.items.[INDEX].order","typeLabel":"integer\u003cint32>"},"startAfter":{"type":"number","isRequired":true,"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.entitlementOverageRateCard.ratePlan.slabs.items.[INDEX].startAfter","typeLabel":"number"},"priceType":{"type":"string","enum":["FLAT","PER_UNIT","PACKAGE"],"isRequired":true,"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.entitlementOverageRateCard.ratePlan.slabs.items.[INDEX].priceType","typeLabel":"enum\u003cstring>"},"slabConfig":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"rateCards.items.[INDEX].rateCardDetails.entitlementOverageRateCard.ratePlan.slabs.items.[INDEX].slabConfig.additionalProperties","typeLabel":"string"},"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.entitlementOverageRateCard.ratePlan.slabs.items.[INDEX].slabConfig","typeLabel":"object"}},"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.entitlementOverageRateCard.ratePlan.slabs.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.entitlementOverageRateCard.ratePlan.slabs","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.entitlementOverageRateCard.ratePlan","typeLabel":"object"},"rateValues":{"type":"array","items":{"type":"object","description":"Represents a rate","required":["currency","slabRates"],"properties":{"currency":{"type":"string","isRequired":true,"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.entitlementOverageRateCard.rateValues.items.[INDEX].currency","typeLabel":"string"},"slabRates":{"type":"array","minItems":1,"items":{"type":"object","description":"Represents a rate for a slab","required":["order","rate"],"properties":{"order":{"type":"integer","format":"int32","isRequired":true,"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.entitlementOverageRateCard.rateValues.items.[INDEX].slabRates.items.[INDEX].order","typeLabel":"integer\u003cint32>"},"rate":{"type":"number","isRequired":true,"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.entitlementOverageRateCard.rateValues.items.[INDEX].slabRates.items.[INDEX].rate","typeLabel":"number"},"slabRateConfig":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"rateCards.items.[INDEX].rateCardDetails.entitlementOverageRateCard.rateValues.items.[INDEX].slabRates.items.[INDEX].slabRateConfig.additionalProperties","typeLabel":"string"},"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.entitlementOverageRateCard.rateValues.items.[INDEX].slabRates.items.[INDEX].slabRateConfig","typeLabel":"object"}},"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.entitlementOverageRateCard.rateValues.items.[INDEX].slabRates.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.entitlementOverageRateCard.rateValues.items.[INDEX].slabRates","typeLabel":"object[]"},"rateConfig":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"rateCards.items.[INDEX].rateCardDetails.entitlementOverageRateCard.rateValues.items.[INDEX].rateConfig.additionalProperties","typeLabel":"string"},"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.entitlementOverageRateCard.rateValues.items.[INDEX].rateConfig","typeLabel":"object"}},"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.entitlementOverageRateCard.rateValues.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.entitlementOverageRateCard.rateValues","typeLabel":"object[]"},"displayName":{"type":"string","description":"Name to be displayed during invoice","uniqueKey":"rateCards.items.[INDEX].rateCardDetails.entitlementOverageRateCard.displayName","typeLabel":"string"},"name":{"type":"string","description":"Unique identifier for the rate card in a price plan. If left null it is auto-generated.","uniqueKey":"rateCards.items.[INDEX].rateCardDetails.entitlementOverageRateCard.name","typeLabel":"string"},"tag":{"type":"string","description":"A tag string to group rate cards","uniqueKey":"rateCards.items.[INDEX].rateCardDetails.entitlementOverageRateCard.tag","typeLabel":"string"},"maxQuantity":{"type":"number","description":"Maximum quantity allowed for the feature, if not specified, unlimited quantity is allowed","uniqueKey":"rateCards.items.[INDEX].rateCardDetails.entitlementOverageRateCard.maxQuantity","typeLabel":"number"},"billingConfig":{"type":"object","properties":{"interval":{"description":"Represents the number of pricing cycles after which the rate card will be billed","type":"integer","format":"int64","example":3,"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.entitlementOverageRateCard.billingConfig.interval","typeLabel":"integer\u003cint64>"},"startOffset":{"description":"Represents the offset for pricing cycles after which the rate card will be billed","type":"integer","format":"int64","example":5,"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.entitlementOverageRateCard.billingConfig.startOffset","typeLabel":"integer\u003cint64>"}},"description":"Represents the billing config of the entitlement overage rate card. If not specified interval:1 and startOffset:0 is taken as default value","uniqueKey":"rateCards.items.[INDEX].rateCardDetails.entitlementOverageRateCard.billingConfig","typeLabel":"object"}},"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.entitlementOverageRateCard","typeLabel":"object"},"minimumCommitmentRateCard":{"title":"MinimumCommitment","type":"object","required":["displayName","rateValues"],"properties":{"displayName":{"type":"string","isRequired":true,"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.minimumCommitmentRateCard.displayName","typeLabel":"string"},"rateValues":{"type":"array","minItems":1,"items":{"type":"object","required":["currency","rate"],"properties":{"currency":{"type":"string","isRequired":true,"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.minimumCommitmentRateCard.rateValues.items.[INDEX].currency","typeLabel":"string"},"rate":{"type":"number","isRequired":true,"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.minimumCommitmentRateCard.rateValues.items.[INDEX].rate","typeLabel":"number"}},"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.minimumCommitmentRateCard.rateValues.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.minimumCommitmentRateCard.rateValues","typeLabel":"object[]"}},"uniqueKey":"rateCards.items.[INDEX].rateCardDetails.minimumCommitmentRateCard","typeLabel":"MinimumCommitment ยท object"}},"isRequired":true,"uniqueKey":"rateCards.items.[INDEX].rateCardDetails","typeLabel":"object"},"name":{"type":"string","maxLength":50,"isRequired":true,"uniqueKey":"rateCards.items.[INDEX].name","typeLabel":"string"},"referenceId":{"type":"string","maxLength":50,"isRequired":true,"uniqueKey":"rateCards.items.[INDEX].referenceId","typeLabel":"string"},"referenceType":{"type":"string","maxLength":50,"isRequired":true,"uniqueKey":"rateCards.items.[INDEX].referenceType","typeLabel":"string"},"pricePlanId":{"description":"Price plan identifier","type":"string","maxLength":50,"isRequired":true,"uniqueKey":"rateCards.items.[INDEX].pricePlanId","typeLabel":"string"},"tag":{"type":"string","description":"Tag for rate card","maxLength":50,"uniqueKey":"rateCards.items.[INDEX].tag","typeLabel":"string"},"currencies":{"description":"List of currencies supported by the rate card","type":"array","uniqueItems":true,"items":{"type":"string","uniqueKey":"rateCards.items.[INDEX].currencies.items.[INDEX]","typeLabel":"string"},"uniqueKey":"rateCards.items.[INDEX].currencies","typeLabel":"string[]"},"accountId":{"description":"Account identifier","type":"string","uniqueKey":"rateCards.items.[INDEX].accountId","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"rateCards.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"rateCards","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"rateCards":[{"billableId":"\u003cstring>","type":"MINIMUM_COMMITMENT","displayName":"\u003cstring>","invoiceTiming":"IN_ADVANCE","rateCardDetails":{"fixedFeeRateCard":{"id":"\u003cstring>","rateValues":[{"currency":"\u003cstring>","rate":123}],"enableProration":false,"displayName":"\u003cstring>","name":"\u003cstring>","tag":"\u003cstring>","invoiceTiming":"IN_ADVANCE","type":"ONE_TIME","recurrenceConfig":{"interval":3,"offset":5}},"billingEntitlementRateCard":{"featureId":"\u003cstring>","featureConfigs":[{"effectiveUntil":"\u003cstring>","featureCreditLimit":1,"effectiveFrom":"\u003cstring>"}],"invoiceTiming":"IN_ADVANCE","ratePlan":{"pricingModel":"TIERED","slabs":[{"order":5,"startAfter":123,"priceType":"FLAT","slabConfig":{}}]},"rateValues":[{"currency":"\u003cstring>","slabRates":[{"order":123,"rate":123,"slabRateConfig":{}}],"rateConfig":{}}],"tag":"\u003cstring>","displayName":"\u003cstring>","name":"\u003cstring>","recurrenceConfig":{"interval":3,"offset":5}},"creditGrantRateCard":{"id":"\u003cstring>","grantDetails":{"priority":1,"expiryType":"PRICING_CYCLE","expiryDuration":"\u003cstring>","applicableEntityIds":["\u003cstring>"]},"rateDetails":{"pricingModel":"TIERED","currencySlabRateDetails":[{"currency":"\u003cstring>","creditAmount":1,"slabDetails":[{"startAfter":123,"priceType":"FLAT","rate":123,"slabConfig":{},"slabRateConfig":{}}],"rateConfig":{}}]},"displayName":"\u003cstring>","name":"\u003cstring>","tag":"\u003cstring>","invoiceTiming":"IN_ADVANCE","type":"ONE_TIME","recurrenceConfig":{"interval":3,"offset":5}},"usageRateCard":{"usageMeterId":"um.1zYnCiM9Bpg.1zYn","ratePlan":{"pricingModel":"TIERED","slabs":[{"order":5,"startAfter":123,"priceType":"FLAT","slabConfig":{}}]},"rateValues":[{"currency":"\u003cstring>","slabRates":[{"order":123,"rate":123,"slabRateConfig":{}}],"rateConfig":{}}],"displayName":"\u003cstring>","name":"\u003cstring>","tag":"\u003cstring>"},"licenseRateCard":{"id":"\u003cstring>","enableProration":false,"ratePlan":{"pricingModel":"TIERED","slabs":[{"order":5,"startAfter":123,"priceType":"FLAT","slabConfig":{}}]},"rateValues":[{"currency":"\u003cstring>","slabRates":[{"order":123,"rate":123,"slabRateConfig":{}}],"rateConfig":{}}],"type":"LICENSE","displayName":"\u003cstring>","name":"\u003cstring>","tag":"\u003cstring>","invoiceTiming":"IN_ADVANCE","usageCycle":"WEEKLY","config":{"maxQuantity":100,"maxQuantityBreachAction":"DO_NOTHING"},"proratedRefundMode":"NONE"},"entitlementOverageRateCard":{"featureId":"\u003cstring>","ratePlan":{"pricingModel":"TIERED","slabs":[{"order":5,"startAfter":123,"priceType":"FLAT","slabConfig":{}}]},"rateValues":[{"currency":"\u003cstring>","slabRates":[{"order":123,"rate":123,"slabRateConfig":{}}],"rateConfig":{}}],"displayName":"\u003cstring>","name":"\u003cstring>","tag":"\u003cstring>","maxQuantity":123,"billingConfig":{"interval":3,"startOffset":5}},"minimumCommitmentRateCard":{"displayName":"\u003cstring>","rateValues":[{"currency":"\u003cstring>","rate":123}]}},"name":"\u003cstring>","referenceId":"\u003cstring>","referenceType":"\u003cstring>","pricePlanId":"\u003cstring>","tag":"\u003cstring>","currencies":["\u003cstring>"],"accountId":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"f4e3f268-bbf2-4fc7-a4f2-4e9ab0b2b228":{"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":"Bulk rate card operations of a price plan - Togai documentation","navMaps":{"firstHrefInVersion":{"v1":{"href":"/api-reference/priceplanv2/bulk-rate-card-operations-of-a-price-plan","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-01-07T03:50:04.835Z","originalFileLocation":"api-reference/priceplanv2/bulk-rate-card-operations-of-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=\"Bulk rate card operations of 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=\"Bulk rate card operations of a price plan - Togai documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Bulk rate card operations of 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/bulk-rate-card-operations-of-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=Bulk+rate+card+operations+of+a+price+plan\u0026amp;description=Bulk+rate+card+operations+of+a+price+plan\u0026amp;theme=c6fa32643e3d775f05465dbc\u0026amp;signature=059cfd933ea8a149bc63f11c3354c0e0f1aa8e5ec2bb7a45263c11a0e316e046\">\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=\"Bulk rate card operations of a price plan - Togai documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Bulk rate card operations of 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=Bulk+rate+card+operations+of+a+price+plan\u0026amp;description=Bulk+rate+card+operations+of+a+price+plan\u0026amp;theme=c6fa32643e3d775f05465dbc\u0026amp;signature=059cfd933ea8a149bc63f11c3354c0e0f1aa8e5ec2bb7a45263c11a0e316e046\">\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/bulk-rate-card-operations-of-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/bulk-rate-card-operations-of-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/bulk-rate-card-operations-of-a-price-plan#webpage\",\"url\":\"https://docs.togai.com/api-reference/priceplanv2/bulk-rate-card-operations-of-a-price-plan\",\"name\":\"Bulk rate card operations of a price plan\",\"description\":\"Bulk rate card operations of a price plan\",\"dateModified\":\"2026-01-07T03:50:04.835Z\",\"isPartOf\":{\"@id\":\"https://docs.togai.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.togai.com/api-reference/priceplanv2/bulk-rate-card-operations-of-a-price-plan#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.togai.com/api-reference/priceplanv2/bulk-rate-card-operations-of-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\":\"Bulk rate card operations of a price plan\",\"item\":\"https://docs.togai.com/api-reference/priceplanv2/bulk-rate-card-operations-of-a-price-plan\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.togai.com/api-reference/priceplanv2/bulk-rate-card-operations-of-a-price-plan#apireference\",\"headline\":\"Bulk rate card operations of a price plan\",\"name\":\"Bulk rate card operations of a price plan\",\"description\":\"Bulk rate card operations of a price plan\",\"url\":\"https://docs.togai.com/api-reference/priceplanv2/bulk-rate-card-operations-of-a-price-plan\",\"mainEntityOfPage\":{\"@id\":\"https://docs.togai.com/api-reference/priceplanv2/bulk-rate-card-operations-of-a-price-plan#webpage\"},\"dateModified\":\"2026-01-07T03:50:04.835Z\",\"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","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","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","description":"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","description":"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":"Bulk rate card operations of a price plan - Togai documentation","buildId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","deploymentId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-rfhihCWU.js","utils-BmH1XFxk.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BcNsxPKB.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BAES3tkd.js","snippetPresets-DCMQBKLP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D6l_bzE9.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BOktbnNh.js","shallow-BCs8SgM7.js","getApiPlaygroundDisplay-DEmW5bJB.js","CodeSnippet-CpZOpB9C.js","CodeSnippets-BOBDqibl.js","Page-D5fEM6aW.js","getPastedJson-DH2JBvmr.js","icon-BBJH-kKh.js","MethodPill-D2Sd5NLC.js","DuplicateIcon-CGgfL2qN.js","createIcon-BKudBBzi.js","DynamicMarkdown-85clUA0i.js","SectionHeading-D0JiMgDx.js","axios-vUo_bRtp.js","Markdown-Cfiy0xZO.js","clsx-rL8ZCCw4.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-aeztFa9U.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BywkCr5C.js"]}