Use the API key created under your merchant account from the HyperSwitch dashboard. API key is used to authenticate API requests from your merchant server only. Don't expose this key on a website or embed it in a mobile application.
A type for customer_id that can be used for customer ids
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"BirrPay","colors":{"primary":"#4F8EFF","light":"#6BA3FF","dark":"#2563EB"},"logo":{"light":"https://mintcdn.com/birrpay/YnpImjYt65LKI-RI/logo/light.svg?fit=max\u0026auto=format\u0026n=YnpImjYt65LKI-RI\u0026q=85\u0026s=410fca5e1e3112fa410bfe0f1bc67731","dark":"https://mintcdn.com/birrpay/541dDB4gOfow0DxB/logo/dark.svg?fit=max\u0026auto=format\u0026n=541dDB4gOfow0DxB\u0026q=85\u0026s=e38313db04f8e480c019afc36f86deed"},"favicon":"/favicon.svg","api":{"openapi":["v1/openapi_spec_v1.json","v2/openapi_spec_v2.json","rust_locker_open_api_spec.yml"]},"background":{"color":{"light":"#FAFBFC","dark":"#1d1d1d"}},"navbar":{"links":[{"href":"https://birrpay.io/contactus","label":"Contact Us"}]},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/birrpay-ethiopia"}},"integrations":{"gtm":{"tagId":"GTM-NQNN2JG5"},"mixpanel":{"projectToken":"b637c4588c180272bf586c5376e524e6"}},"contextual":{"options":["copy","claude","chatgpt","view"]},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"birrpay","hasAudioNarration":false,"actualSubdomain":"birrpay","customDomains":["docs.birrpay.io"],"gitSource":{"type":"gitlab","owner":"birrpay","repo":"hyperswitch","projectId":77700133,"deployBranch":"develop","contentDirectory":"api-reference","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a21eaf12fb2a99bab92c3fd","collectionId":"e126846c-3fdf-4d9b-8ab0-45d072d25e19","schemaVersion":"v2"},"entitlements":{},"buildId":"6a21eaf12fb2a99bab92c3fd:success","clientVersion":"0.0.3965","searchFilterCounts":[{"language":"default","tag":"Documentation","count":183},{"language":"default","tag":"Payments Core APIs","count":53},{"language":"default","tag":"Other APIs","count":35},{"language":"default","tag":"Payments Core APIs [BETA]","count":32},{"language":"default","tag":"Account management APIs","count":28},{"language":"default","tag":"Account management APIs [BETA]","count":27},{"language":"default","tag":"Payments","count":26},{"language":"default","tag":"API Reference","count":24},{"language":"default","tag":"Routing","count":17},{"language":"default","tag":"Payment Methods","count":16}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"v1/subscriptions/estimate","slug":"/v1/subscriptions/estimate","pageMetadata":{"openapi":"get /subscriptions/estimate","title":"Subscription - Get Estimate","description":"Gets pricing estimate for a subscription.","href":"/v1/subscriptions/estimate","hidden":false},"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: \"Gets pricing estimate for a subscription.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi":"get /subscriptions/estimate","title":"Subscription - Get Estimate","description":"Gets pricing estimate for a subscription.","href":"/v1/subscriptions/estimate","hidden":false}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Subscriptions"],"summary":"Subscription - Get Estimate","description":"Gets pricing estimate for a subscription.","operationId":"Get Subscription Estimate","parameters":["d251e5ad-cddd-4201-a830-3a7a5714dffb","0168fe0e-a966-4bac-ad47-630a3ac1db5d","f82a3d81-7ebc-4be3-9aaf-369f4573939d","a11f6dec-f0bf-42cb-932f-7fc879ae46ab","a47d1ada-22cb-44e8-956a-2a477de22708"],"responses":{"200":"96e32d6d-e325-45d8-8ee1-f1f9f8efae33","400":"8b2e5c44-2c18-47ab-af47-d329f439bb0f","404":"80c7684f-c4e7-408a-950f-a46ed092d952"},"security":["12163795-0919-4574-ba93-08e6e595423b"],"method":"get","type":"path","servers":["792875b0-3b61-48a0-ab23-731c1218999a"],"path":"/subscriptions/estimate","baseUrlOptions":["https://sandbox.birrpay.io"],"title":"Subscription - Get Estimate","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"d251e5ad-cddd-4201-a830-3a7a5714dffb":{"name":"X-Profile-Id","in":"header","description":"Profile ID for authentication","required":true,"schema":{"type":"string","isRequired":true,"description":"Profile ID for authentication","uniqueKey":"","typeLabel":"string"}},"0168fe0e-a966-4bac-ad47-630a3ac1db5d":{"name":"plan_id","in":"query","description":"Plan ID for estimation","required":true,"schema":{"type":"string","isRequired":true,"description":"Plan ID for estimation","uniqueKey":"","typeLabel":"string"}},"f82a3d81-7ebc-4be3-9aaf-369f4573939d":{"name":"customer_id","in":"query","description":"Customer ID for personalized pricing","required":false,"schema":{"oneOf":[{"type":"string","description":"Customer ID for personalized pricing","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","description":"Customer ID for personalized pricing","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}},"a11f6dec-f0bf-42cb-932f-7fc879ae46ab":{"name":"coupon_id","in":"query","description":"Coupon ID to apply discount","required":false,"schema":{"oneOf":[{"type":"string","description":"Coupon ID to apply discount","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","description":"Coupon ID to apply discount","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}},"a47d1ada-22cb-44e8-956a-2a477de22708":{"name":"trial_days","in":"query","description":"Number of trial days","required":false,"schema":{"oneOf":[{"type":"integer","format":"int32","minimum":0,"description":"Number of trial days","uniqueKey":"oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","minimum":0,"description":"Number of trial days","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"integer\u003cint32> | null"}}},"responses":{"96e32d6d-e325-45d8-8ee1-f1f9f8efae33":{"description":"Estimate retrieved successfully","content":{"application/json":{"schema":{"type":"object","required":["amount","currency","line_items"],"properties":{"amount":{"type":"integer","format":"int64","description":"This Unit struct represents MinorUnit in which core amount works","isRequired":true,"uniqueKey":"amount","typeLabel":"integer\u003cint64>"},"currency":{"type":"string","description":"The three-letter ISO 4217 currency code (e.g., \"USD\", \"EUR\") for the payment amount. This field is mandatory for creating a payment.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYU","UZS","VES","VND","VUV","WST","XAF","XCD","XOF","XPF","YER","ZAR","ZMW","ZWL"],"isRequired":true,"uniqueKey":"currency","typeLabel":"enum\u003cstring>"},"line_items":{"type":"array","items":{"type":"object","required":["item_id","item_type","description","amount","currency","quantity"],"properties":{"item_id":{"type":"string","description":"Unique identifier for the line item.","isRequired":true,"uniqueKey":"line_items.items.[INDEX].item_id","typeLabel":"string"},"item_type":{"type":"string","description":"Type of the line item.","isRequired":true,"uniqueKey":"line_items.items.[INDEX].item_type","typeLabel":"string"},"description":{"type":"string","description":"Description of the line item.","isRequired":true,"uniqueKey":"line_items.items.[INDEX].description","typeLabel":"string"},"amount":{"type":"integer","format":"int64","description":"This Unit struct represents MinorUnit in which core amount works","isRequired":true,"uniqueKey":"line_items.items.[INDEX].amount","typeLabel":"integer\u003cint64>"},"currency":{"type":"string","description":"The three-letter ISO 4217 currency code (e.g., \"USD\", \"EUR\") for the payment amount. This field is mandatory for creating a payment.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYU","UZS","VES","VND","VUV","WST","XAF","XCD","XOF","XPF","YER","ZAR","ZMW","ZWL"],"isRequired":true,"uniqueKey":"line_items.items.[INDEX].currency","typeLabel":"enum\u003cstring>"},"quantity":{"type":"integer","format":"int64","description":"Quantity of the line item.","isRequired":true,"uniqueKey":"line_items.items.[INDEX].quantity","typeLabel":"integer\u003cint64>"}},"uniqueKey":"line_items.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"line_items","typeLabel":"object[]"},"plan_id":{"oneOf":[{"type":"string","description":"Identifier for the associated plan_id.","uniqueKey":"plan_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Identifier for the associated plan_id.","uniqueKey":"plan_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"plan_id","typeLabel":"string | null"},"item_price_id":{"oneOf":[{"type":"string","description":"Identifier for the associated item_price_id for the subscription.","uniqueKey":"item_price_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Identifier for the associated item_price_id for the subscription.","uniqueKey":"item_price_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"item_price_id","typeLabel":"string | null"},"coupon_code":{"oneOf":[{"type":"string","description":"Identifier for the coupon code for the subscription.","uniqueKey":"coupon_code.oneOf.0","typeLabel":"string"},{"type":"null","description":"Identifier for the coupon code for the subscription.","uniqueKey":"coupon_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"coupon_code","typeLabel":"string | null"},"customer_id":{"oneOf":[{"type":"string","description":"A type for customer_id that can be used for customer ids","uniqueKey":"customer_id.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"customer_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer_id","typeLabel":"string | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"amount":123,"currency":"AED","line_items":[{"item_id":"\u003cstring>","item_type":"\u003cstring>","description":"\u003cstring>","amount":123,"currency":"AED","quantity":123}],"plan_id":"\u003cstring>","item_price_id":"\u003cstring>","coupon_code":"\u003cstring>","customer_id":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"8b2e5c44-2c18-47ab-af47-d329f439bb0f":{"description":"Invalid estimation parameters","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"80c7684f-c4e7-408a-950f-a46ed092d952":{"description":"Plan not found","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"12163795-0919-4574-ba93-08e6e595423b":{"api_key":{"type":"apiKey","in":"header","name":"api-key","description":"Use the API key created under your merchant account from the HyperSwitch dashboard. API key is used to authenticate API requests from your merchant server only. Don't expose this key on a website or embed it in a mobile application.","scopes":[]}}},"servers":{"792875b0-3b61-48a0-ab23-731c1218999a":{"url":"https://sandbox.birrpay.io","description":"Sandbox Environment"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"api-key","description":"Use the API key created under your merchant account from the HyperSwitch dashboard. API key is used to authenticate API requests from your merchant server only. Don't expose this key on a website or embed it in a mobile application.","scopes":[]},"schema":{"title":"api-key","type":"string","description":"Use the API key created under your merchant account from the HyperSwitch dashboard. API key is used to authenticate API requests from your merchant server only. Don't expose this key on a website or embed it in a mobile application.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"api_key","name":"api-key"}],"title":"api_key"}]},"originalFileLocation":"v1/openapi_spec_v1.json"},"subdomain":"birrpay","siteName":"BirrPay","title":"Subscription - Get Estimate - BirrPay","navMaps":{"firstHrefInVersion":{"1.0.0":{"href":"/v1/subscriptions/estimate","matchLevel":0},"2.0.0 [BETA]":{"href":"/introduction","matchLevel":3}},"firstHrefInLanguage":{}},"lastModified":"2026-01-24T02:55:16.515Z","originalFileLocation":"v1/subscriptions/estimate.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=\"Gets pricing estimate for a subscription.\">\u003cmeta data-mint-head name=\"application-name\" content=\"BirrPay\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/birrpay/UMKKiD5ajm4x882S/_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/birrpay/UMKKiD5ajm4x882S/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/birrpay/UMKKiD5ajm4x882S/_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/birrpay/UMKKiD5ajm4x882S/_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/birrpay/UMKKiD5ajm4x882S/_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/birrpay/UMKKiD5ajm4x882S/_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/birrpay/UMKKiD5ajm4x882S/_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/birrpay/UMKKiD5ajm4x882S/_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/birrpay/UMKKiD5ajm4x882S/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Subscription - Get Estimate - BirrPay\">\u003cmeta data-mint-head property=\"og:description\" content=\"Gets pricing estimate for a subscription.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"BirrPay\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.birrpay.io/v1/subscriptions/estimate\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://birrpay.mintlify.app/_mintlify/api/og/v2?division=Subscriptions\u0026amp;title=Subscription+-+Get+Estimate\u0026amp;description=Gets+pricing+estimate+for+a+subscription.\u0026amp;theme=838cc079bd3fa932cbeee950\u0026amp;signature=b2e937062d5603602bbf1745016fc90792e6aeffd95a922416fa90a869f7dfa8\">\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=\"Subscription - Get Estimate - BirrPay\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Gets pricing estimate for a subscription.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://birrpay.mintlify.app/_mintlify/api/og/v2?division=Subscriptions\u0026amp;title=Subscription+-+Get+Estimate\u0026amp;description=Gets+pricing+estimate+for+a+subscription.\u0026amp;theme=838cc079bd3fa932cbeee950\u0026amp;signature=b2e937062d5603602bbf1745016fc90792e6aeffd95a922416fa90a869f7dfa8\">\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/birrpay/UMKKiD5ajm4x882S/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"BirrPay\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#4F8EFF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.birrpay.io/v1/subscriptions/estimate\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/v1/subscriptions/estimate.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.birrpay.io/#organization\",\"name\":\"BirrPay\",\"url\":\"https://docs.birrpay.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/birrpay/YnpImjYt65LKI-RI/logo/light.svg?fit=max\u0026auto=format\u0026n=YnpImjYt65LKI-RI\u0026q=85\u0026s=410fca5e1e3112fa410bfe0f1bc67731\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.birrpay.io#website\",\"name\":\"BirrPay\",\"url\":\"https://docs.birrpay.io\",\"publisher\":{\"@id\":\"https://docs.birrpay.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.birrpay.io/v1/subscriptions/estimate#webpage\",\"url\":\"https://docs.birrpay.io/v1/subscriptions/estimate\",\"name\":\"Subscription - Get Estimate\",\"description\":\"Gets pricing estimate for a subscription.\",\"dateModified\":\"2026-01-24T02:55:16.515Z\",\"isPartOf\":{\"@id\":\"https://docs.birrpay.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.birrpay.io/v1/subscriptions/estimate#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.birrpay.io/v1/subscriptions/estimate#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Other APIs\",\"item\":\"https://docs.birrpay.io/v1/event/events--list\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Subscriptions\",\"item\":\"https://docs.birrpay.io/v1/subscriptions/create\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Subscription - Get Estimate\",\"item\":\"https://docs.birrpay.io/v1/subscriptions/estimate\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.birrpay.io/v1/subscriptions/estimate#apireference\",\"headline\":\"Subscription - Get Estimate\",\"name\":\"Subscription - Get Estimate\",\"description\":\"Gets pricing estimate for a subscription.\",\"url\":\"https://docs.birrpay.io/v1/subscriptions/estimate\",\"mainEntityOfPage\":{\"@id\":\"https://docs.birrpay.io/v1/subscriptions/estimate#webpage\"},\"dateModified\":\"2026-01-24T02:55:16.515Z\",\"publisher\":{\"@id\":\"https://docs.birrpay.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.birrpay.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"BirrPay\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"BirrPay","nav":{"global":null,"tabs":[{"tab":"Documentation","versions":[{"version":"1.0.0","groups":[{"group":"Get Started","pages":[{"title":"👋 Welcome to BirrPay API Reference","sidebarTitle":"Introduction","icon":"rectangle-code","iconType":"solid","href":"/introduction","hidden":false}]},{"group":"Essentials","pages":[{"title":"Authentication Types","href":"/essentials/authentication"},{"title":"Error Codes","href":"/essentials/error_codes"},{"title":"Rate Limits","href":"/essentials/rate_limit"},{"title":"Go-live Checklist","href":"/essentials/go-live"}]},{"group":"Payments Core APIs","pages":[{"sidebarTitle":"Setup Instructions","icon":"flag","iconType":"solid","title":null,"href":"/v1/payments/setup--instructions"},{"sidebarTitle":"Payment Flows","icon":"arrows-retweet","iconType":"solid","title":null,"href":"/v1/payments/payment--flows"},{"group":"Payments","pages":[{"openapi":"post /payments","title":"Payments - Create","href":"/v1/payments/payments--create"},{"openapi":"post /payments/{payment_id}","title":"Payments - Update","href":"/v1/payments/payments--update"},{"openapi":"post /payments/{payment_id}/confirm","title":"Payments - Confirm","href":"/v1/payments/payments--confirm"},{"openapi":"get /payments/{payment_id}","title":"Payments - Retrieve","href":"/v1/payments/payments--retrieve"},{"openapi":"post /payments/{payment_id}/cancel","title":"Payments - Cancel","href":"/v1/payments/payments--cancel"},{"openapi":"post /payments/{payment_id}/cancel_post_capture","title":"Payments - Cancel Post Capture","href":"/v1/payments/payments--cancel-post-capture"},{"openapi":"post /payments/{payment_id}/capture","title":"Payments - Capture","href":"/v1/payments/payments--capture"},{"openapi":"post /payments/{payment_id}/incremental_authorization","title":"Payments - Incremental Authorization","href":"/v1/payments/payments--incremental-authorization"},{"openapi":"post /payments/{payment_id}/extend_authorization","title":"Payments - Extended Authorization","href":"/v1/payments/payments--extend-authorization"},{"openapi":"post /payments/session_tokens","title":"Payments - Session token","href":"/v1/payments/payments--session-token"},{"openapi":"get /payment_link/{payment_link_id}","title":"Payments Link - Retrieve","href":"/v1/payments/payments-link--retrieve"},{"openapi":"get /payments/list","title":"Payments - List","href":"/v1/payments/payments--list"},{"openapi":"post /payments/{payment_id}/3ds/authentication","title":"Payments - External 3DS Authentication","href":"/v1/payments/payments--external-3ds-authentication"},{"openapi":"post /{payment_id}/complete_authorize","title":null,"href":"/v1/payments/payments--complete-authorize"},{"openapi":"post /payments/{payment_id}/update_metadata","title":"Payments - Update Metadata","href":"/v1/payments/payments--update-metadata"},{"openapi":"post /payments/{payment_id}/eligibility","title":"Payments - Submit Eligibility Data","href":"/v1/payments/payments--submit-eligibility-data"}]},{"group":"Payment Methods","pages":[{"openapi":"post /payment_methods","title":"PaymentMethods - Create","href":"/v1/payment-methods/paymentmethods--create"},{"openapi":"get /payment_methods/{method_id}","title":"Payment Method - Retrieve","href":"/v1/payment-methods/payment-method--retrieve"},{"openapi":"post /payment_methods/{method_id}/update","title":"Payment Method - Update","href":"/v1/payment-methods/payment-method--update"},{"openapi":"delete /payment_methods/{method_id}","title":"Payment Method - Delete","href":"/v1/payment-methods/payment-method--delete"},{"openapi":"post /{customer_id}/payment_methods/{payment_method_id}/default","title":"Payment Method - Set Default Payment Method for Customer","href":"/v1/payment-methods/payment-method--set-default-payment-method-for-customer"},{"openapi":"get /account/payment_methods","title":"List payment methods for a Merchant","href":"/v1/payment-methods/list-payment-methods-for-a-merchant"},{"openapi":"get /customers/payment_methods","title":"List customer saved payment methods for a Payment","href":"/v1/payment-methods/list-customer-saved-payment-methods-for-a-payment"},{"openapi":"get /customers/{customer_id}/payment_methods","title":"List payment methods for a Customer","href":"/v1/payment-methods/list-payment-methods-for-a-customer"},{"openapi":"post /{customer_id}/payment_methods/{payment_method_id}/default","title":"Payment Method - Set Default Payment Method for Customer","href":"/v1/customer-set-default-payment-method/customers--set-default-payment-method"}]},{"group":"Customers","pages":[{"openapi":"post /customers","title":"Customers - Create","href":"/v1/customers/customers--create"},{"openapi":"get /customers/{customer_id}","title":"Customers - Retrieve","href":"/v1/customers/customers--retrieve"},{"openapi":"post /customers/{customer_id}","title":"Customers - Update","href":"/v1/customers/customers--update"},{"openapi":"delete /customers/{customer_id}","title":"Customers - Delete","href":"/v1/customers/customers--delete"},{"openapi":"get /customers/list","title":"Customers - List","href":"/v1/customers/customers--list"}]},{"group":"Mandates","pages":[{"openapi":"post /mandates/revoke/{mandate_id}","title":"Mandates - Revoke Mandate","href":"/v1/mandates/mandates--revoke-mandate"},{"openapi":"get /mandates/{mandate_id}","title":"Mandates - Retrieve Mandate","href":"/v1/mandates/mandates--retrieve-mandate"},{"openapi":"post /customers/{customer_id}/mandates","title":null,"href":"/v1/mandates/mandates--customer-mandates-list"}]},{"group":"Refunds","pages":[{"openapi":"post /refunds","title":"Refunds - Create","href":"/v1/refunds/refunds--create"},{"openapi":"post /refunds/{refund_id}","title":"Refunds - Update","href":"/v1/refunds/refunds--update"},{"openapi":"get /refunds/{refund_id}","title":"Refunds - Retrieve","href":"/v1/refunds/refunds--retrieve"},{"openapi":"post /refunds/list","title":"Refunds - List","href":"/v1/refunds/refunds--list"}]},{"group":"Disputes","pages":[{"openapi":"get /disputes/{dispute_id}","title":"Disputes - Retrieve Dispute","href":"/v1/disputes/disputes--retrieve"},{"openapi":"get /disputes/list","title":"Disputes - List Disputes","href":"/v1/disputes/disputes--list"}]},{"group":"Authentication","pages":[{"openapi":"post /authentication","title":"Authentication - Create","href":"/v1/authentication/authentication--create"},{"openapi":"post /authentication/{authentication_id}/eligibility-check","title":"Authentication - POST Eligibility Check","href":"/v1/authentication/authentication--post-eligibility-check"},{"openapi":"get /authentication/{authentication_id}/eligibility-check","title":"Authentication - GET Eligibility Check","href":"/v1/authentication/authentication--get-eligibility-check"}]},{"group":"Payouts","pages":[{"openapi":"post /payouts/create","title":"Payouts - Create","href":"/v1/payouts/payouts--create"},{"openapi":"post /payouts/{payout_id}","title":"Payouts - Update","href":"/v1/payouts/payouts--update"},{"openapi":"post /payouts/{payout_id}/cancel","title":"Payouts - Cancel","href":"/v1/payouts/payouts--cancel"},{"openapi":"post /payouts/{payout_id}/fulfill","title":"Payouts - Fulfill","href":"/v1/payouts/payouts--fulfill"},{"openapi":"post /payouts/{payout_id}/confirm","title":"Payouts - Confirm","href":"/v1/payouts/payouts--confirm"},{"openapi":"get /payouts/{payout_id}","title":"Payouts - Retrieve","href":"/v1/payouts/payouts--retrieve"},{"openapi":"get /payouts/list","title":"Payouts - List","href":"/v1/payouts/payouts--list"},{"openapi":"post /payouts/filter","title":"Payouts - List available filters","href":"/v1/payouts/payouts--list-filters"},{"openapi":"post /payouts/list","title":"Payouts - List using filters","href":"/v1/payouts/payouts--filter"}]}]},{"group":"Account management APIs","pages":[{"group":"Organization","pages":[{"openapi":"post /organization","title":"Organization - Create","href":"/v1/organization/organization--create"},{"openapi":"get /organization/{id}","title":"Organization - Retrieve","href":"/v1/organization/organization--retrieve"},{"openapi":"put /organization/{id}","title":"Organization - Update","href":"/v1/organization/organization--update"}]},{"group":"Merchant Account","pages":[{"openapi":"post /accounts","title":"Merchant Account - Create","href":"/v1/merchant-account/merchant-account--create"},{"openapi":"get /accounts/{account_id}","title":"Merchant Account - Retrieve","href":"/v1/merchant-account/merchant-account--retrieve"},{"openapi":"post /accounts/{account_id}","title":"Merchant Account - Update","href":"/v1/merchant-account/merchant-account--update"},{"openapi":"delete /accounts/{account_id}","title":"Merchant Account - Delete","href":"/v1/merchant-account/merchant-account--delete"},{"openapi":"post /accounts/{account_id}/kv","title":"Merchant Account - KV Status","href":"/v1/merchant-account/merchant-account--kv-status"}]},{"group":"Business Profile","pages":[{"openapi":"post /account/{account_id}/business_profile","title":"Profile - Create","href":"/v1/business-profile/business-profile--create"},{"openapi":"post /account/{account_id}/business_profile/{profile_id}","title":"Profile - Update","href":"/v1/business-profile/business-profile--update"},{"openapi":"get /account/{account_id}/business_profile/{profile_id}","title":"Profile - Retrieve","href":"/v1/business-profile/business-profile--retrieve"},{"openapi":"delete /account/{account_id}/business_profile/{profile_id}","title":"Profile - Delete","href":"/v1/business-profile/business-profile--delete"},{"openapi":"get /account/{account_id}/business_profile","title":"Profile - List","href":"/v1/business-profile/business-profile--list"}]},{"group":"Platform Account","pages":[{"openapi":"post /user/create_platform","title":"Platform - Create","href":"/v1/platform/platform--create"}]},{"group":"API Key","pages":[{"openapi":"post /api_keys/{merchant_id}","title":"API Key - Create","href":"/v1/api-key/api-key--create"},{"openapi":"get /api_keys/{merchant_id}/{key_id}","title":"API Key - Retrieve","href":"/v1/api-key/api-key--retrieve"},{"openapi":"post /api_keys/{merchant_id}/{key_id}","title":"API Key - Update","href":"/v1/api-key/api-key--update"},{"openapi":"delete /api_keys/{merchant_id}/{key_id}","title":"API Key - Revoke","href":"/v1/api-key/api-key--revoke"},{"openapi":"get /api_keys/{merchant_id}/list","title":"API Key - List","href":"/v1/api-key/api-key--list"}]},{"group":"Merchant Connector Account","pages":[{"openapi":"post /account/{account_id}/connectors","title":"Merchant Connector - Create","href":"/v1/merchant-connector-account/merchant-connector--create"},{"openapi":"get /account/{account_id}/connectors/{merchant_connector_id}","title":"Merchant Connector - Retrieve","href":"/v1/merchant-connector-account/merchant-connector--retrieve"},{"openapi":"post /account/{account_id}/connectors/{merchant_connector_id}","title":"Merchant Connector - Update","href":"/v1/merchant-connector-account/merchant-connector--update"},{"openapi":"delete /account/{account_id}/connectors/{merchant_connector_id}","title":"Merchant Connector - Delete","href":"/v1/merchant-connector-account/merchant-connector--delete"},{"openapi":"get /account/{account_id}/connectors","title":"Merchant Connector - List","href":"/v1/merchant-connector-account/merchant-connector--list"}]},{"group":"GSM (Global Status Mapping)","pages":[{"openapi":"post /gsm","title":"Gsm - Create","href":"/v1/gsm/gsm--create"},{"openapi":"post /gsm/get","title":"Gsm - Get","href":"/v1/gsm/gsm--get"},{"openapi":"post /gsm/update","title":"Gsm - Update","href":"/v1/gsm/gsm--update"},{"openapi":"post /gsm/delete","title":"Gsm - Delete","href":"/v1/gsm/gsm--delete"}]}]},{"group":"Other APIs","pages":[{"group":"Event","pages":[{"openapi":"post /events/{merchant_id}","title":"Events - List","href":"/v1/event/events--list"},{"openapi":"get /events/{merchant_id}/{event_id}/attempts","title":"Events - Delivery Attempt List","href":"/v1/event/events--delivery-attempt-list"},{"openapi":"post /events/{merchant_id}/{event_id}/retry","title":"Events - Manual Retry","href":"/v1/event/events--manual-retry"}]},{"group":"Poll","pages":[{"openapi":"get /poll/status/{poll_id}","title":"Poll - Retrieve Poll Status","href":"/v1/poll/poll--retrieve-poll-status"}]},{"group":"Blocklist","pages":[{"openapi":"get /blocklist","title":null,"href":"/v1/blocklist/get-blocklist"},{"openapi":"post /blocklist","title":null,"href":"/v1/blocklist/post-blocklist"},{"openapi":"delete /blocklist","title":null,"href":"/v1/blocklist/delete-blocklist"},{"openapi":"post /blocklist/toggle","title":null,"href":"/v1/blocklist/post-blocklisttoggle"}]},{"group":"Routing","pages":[{"openapi":"get /routing","title":"Routing - List","href":"/v1/routing/routing--list"},{"openapi":"post /routing","title":"Routing - Create","href":"/v1/routing/routing--create"},{"openapi":"post /account/{account_id}/business_profile/{profile_id}/dynamic_routing/success_based/create","title":"Routing - Auth Rate Based","href":"/v1/routing/routing--success-based"},{"openapi":"post /account/{account_id}/business_profile/{profile_id}/dynamic_routing/elimination/create","title":"Routing - Elimination","href":"/v1/routing/routing--elimination"},{"openapi":"get /routing/active","title":"Routing - Retrieve Config","href":"/v1/routing/routing--retrieve-config"},{"openapi":"post /routing/deactivate","title":"Routing - Deactivate","href":"/v1/routing/routing--deactivate"},{"openapi":"get /routing/default","title":"Routing - Retrieve Default Config","href":"/v1/routing/routing--retrieve-default-config"},{"openapi":"post /routing/default","title":"Routing - Update Default Config","href":"/v1/routing/routing--update-default-config"},{"openapi":"get /routing/default/profile","title":"Routing - Retrieve Default For Profile","href":"/v1/routing/routing--retrieve-default-for-profile"},{"openapi":"post /routing/default/profile/{profile_id}","title":"Routing - Update Default For Profile","href":"/v1/routing/routing--update-default-for-profile"},{"openapi":"get /routing/{routing_algorithm_id}","title":"Routing - Retrieve","href":"/v1/routing/routing--retrieve"},{"openapi":"post /routing/{routing_algorithm_id}/activate","title":"Routing - Activate config","href":"/v1/routing/routing--activate-config"},{"openapi":"post /routing/evaluate","title":"Routing - Evaluate","href":"/v1/routing/routing--evaluate"},{"openapi":"post /routing/feedback","title":"Routing - Feedback","href":"/v1/routing/routing--feedback"},{"openapi":"post /routing/rule/evaluate","title":"Routing - Rule Evaluate","href":"/v1/routing/routing--rule-evaluate"}]},{"group":"Relay","pages":[{"openapi":"post /relay","title":"Relay - Create","href":"/v1/relay/relay"},{"openapi":"get /relay/{relay_id}","title":"Relay - Retrieve","href":"/v1/relay/relay--retrieve"}]},{"group":"Schemas","pages":[{"title":null,"href":"/v1/schemas/outgoing--webhook"}]},{"group":"Subscriptions","pages":[{"openapi":"post /subscriptions/create","title":"Subscription - Create","href":"/v1/subscriptions/create"},{"openapi":"post /subscriptions/{subscription_id}/confirm","title":"Subscription - Confirm","href":"/v1/subscriptions/confirm"},{"openapi":"post /subscriptions","title":"Subscription - Create and Confirm","href":"/v1/subscriptions/create-and-confirm"},{"openapi":"put /subscriptions/{subscription_id}/update","title":"Subscription - Update","href":"/v1/subscriptions/update"},{"openapi":"get /subscriptions/{subscription_id}","title":"Subscription - Retrieve","href":"/v1/subscriptions/get"},{"title":"Get plans","href":"/v1/subscriptions/get-plans"},{"openapi":"get /subscriptions/estimate","title":"Subscription - Get Estimate","href":"/v1/subscriptions/estimate"},{"openapi":"post /subscriptions/{subscription_id}/pause","title":"Subscription - Pause Subscription","description":"Pause the subscription","href":"/v1/subscriptions/pause"},{"openapi":"post /subscriptions/{subscription_id}/resume","title":"Subscription - Resume Subscription","href":"/v1/subscriptions/resume"},{"openapi":"post /subscriptions/{subscription_id}/cancel","title":"Subscription - Cancel Subscription","href":"/v1/subscriptions/cancel"}]}]}]},{"version":"2.0.0 [BETA]","pages":[{"title":"2.0.0 [BETA]","href":"/introduction"}]}]},{"tab":"Locker API Reference","pages":[{"title":"Locker API Reference","href":"/locker-api-reference/overview"}]},{"tab":"Intelligent Router API Reference","pages":[{"title":"Intelligent Router API Reference","href":"/intelligent-router-api-reference/overview"}]}]},"title":"Subscription - Get Estimate - BirrPay","buildId":"dpl_849ArpqvBiCczQiT1Y1stNGpbqHT","deploymentId":"dpl_849ArpqvBiCczQiT1Y1stNGpbqHT","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-Bbp7I60D.js","utils-C3RIvJha.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DqD-vLt8.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B31Loprg.js","snippetPresets-DKpk-b8t.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-Cj65AhOR.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BXtn5gcC.js","shallow-RY2b03Cp.js","getApiPlaygroundDisplay-B0jeiPk3.js","CodeSnippet-CYgBjjwn.js","CodeSnippets-DOngDrYB.js","Page-n7I5XbKb.js","getPastedJson-DRQbJx-T.js","icon-CQiQCicY.js","MethodPill-BKTLdNtu.js","DuplicateIcon-B9jpAdat.js","createIcon-DCddRrXv.js","DynamicMarkdown-a8hUKrw6.js","SectionHeading-eECVV2eH.js","axios-vUo_bRtp.js","Markdown--GF7ZIpf.js","clsx-DZLdJUrt.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-2LoAhjKH.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Zwc0ZncM.js"]}