{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Salesbricks","colors":{"primary":"#197F78","light":"#26BFB4","dark":"#197F78"},"logo":{"light":"https://mintcdn.com/salesbricks/3GVA0K12Q7dXW89y/logo/light.svg?fit=max\u0026auto=format\u0026n=3GVA0K12Q7dXW89y\u0026q=85\u0026s=ead3e65ff72970d53a9cd22de50bd8fc","dark":"https://mintcdn.com/salesbricks/3GVA0K12Q7dXW89y/logo/dark.svg?fit=max\u0026auto=format\u0026n=3GVA0K12Q7dXW89y\u0026q=85\u0026s=786876a66955115a9896bb4ce9e0f779","href":"https://www.salesbricks.com"},"favicon":"https://mintcdn.com/salesbricks/3GVA0K12Q7dXW89y/favicon.svg?fit=max\u0026auto=format\u0026n=3GVA0K12Q7dXW89y\u0026q=85\u0026s=149c42d5e530bbd556361118b756ccb8","api":{"playground":{"display":"interactive"},"mdx":{"auth":{"method":"key"},"server":["https://api.salesbricks.com"]}},"background":{"color":{"light":"#FFFFFF","dark":"#0A0A0A"}},"navbar":{"primary":{"type":"button","label":"Log in","href":"https://app.salesbricks.com/login"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/salesbricks","x":"https://twitter.com/getsalesbricks","instagram":"https://www.instagram.com/salesbricks"}},"search":{"prompt":"Search Salesbricks docs..."},"seo":{"indexing":"navigable"},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"salesbricks","hasAudioNarration":false,"actualSubdomain":"salesbricks","customDomains":["docs.salesbricks.com"],"gitSource":{"type":"github","owner":"goderecho","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae4d297f0f0e506e23495aa","collectionId":"e22ee52d-f716-4e2e-b522-09bd305a1646","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae4d297f0f0e506e23495aa"},"feedback":{"thumbs":false},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6aed16ea8eec1bf8be06828a","clientVersion":"0.0.4076","searchFilterCounts":[{"language":"default","tag":"APIs \u0026 Webhooks","count":127},{"language":"default","tag":"REST API Endpoints","count":83},{"language":"default","tag":"Documentation","count":40},{"language":"default","tag":"Webhooks","count":34},{"language":"default","tag":"Integrations","count":19},{"language":"default","tag":"Invoices","count":13},{"language":"default","tag":"Subscriptions","count":12},{"language":"default","tag":"Usage","count":11},{"language":"default","tag":"Payment Methods","count":11},{"language":"default","tag":"Order Webhooks","count":10}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"table.two-column td,table.two-column th{width:50%}"}],"page":{"pagePath":"api-reference/plans/retrieve-a-plan","slug":"/api-reference/plans/retrieve-a-plan","pageMetadata":{"title":"Retrieve a plan","description":"Returns the details of a plan, including its name and bricks.","deprecated":null,"version":null,"openapi":"https://api.salesbricks.com/api/v2/openapi.yaml get /plans/{plan_id}","href":"/api-reference/plans/retrieve-a-plan","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Returns the details of a plan, including its name and bricks.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Retrieve a plan","description":"Returns the details of a plan, including its name and bricks.","deprecated":null,"version":null,"openapi":"https://api.salesbricks.com/api/v2/openapi.yaml get /plans/{plan_id}","href":"/api-reference/plans/retrieve-a-plan","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"retrievePlan","description":"Returns the details of a plan, including its name and bricks.","summary":"Retrieve a plan","parameters":["0edc46cf-bc78-4d0a-a8fb-75764d33239b","8b791b64-2238-4038-9d8b-dfe60a50a53a"],"tags":["Plans"],"responses":{"200":"d22fc524-3040-4ac2-9e4d-96968c9d82c0","404":"54669ae9-a31e-456d-9b39-fb94d9a55254"},"method":"get","type":"path","servers":["473a595f-0b07-4538-b033-faf5582d0b46"],"security":["96e2b814-4b2f-4ec1-a062-fb177ecfca77"],"path":"/plans/{plan_id}","baseUrlOptions":["https://api.salesbricks.com/api/v2"],"title":"Retrieve a plan","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"0edc46cf-bc78-4d0a-a8fb-75764d33239b":{"in":"query","name":"currency","schema":{"type":"string","enum":["AUD","CAD","EUR","GBP","INR","USD"],"description":"Currency for pricing tiers (default: USD)","uniqueKey":"","typeLabel":"enum\u003cstring>"},"description":"Currency for pricing tiers (default: USD)"},"8b791b64-2238-4038-9d8b-dfe60a50a53a":{"in":"path","name":"plan_id","schema":{"type":"string","pattern":"^([a-zA-Z\\d\\-]+)$","isRequired":true,"uniqueKey":"","typeLabel":"string"},"required":true}},"responses":{"d22fc524-3040-4ac2-9e4d-96968c9d82c0":{"content":{"application/json":{"schema":{"type":"object","properties":{"plan_id":{"type":"string","format":"uuid","description":"Unique identifier for the plan","isRequired":true,"uniqueKey":"plan_id","typeLabel":"string\u003cuuid>"},"plan_name":{"type":"string","description":"Name of the plan","isRequired":true,"uniqueKey":"plan_name","typeLabel":"string"},"description":{"oneOf":[{"type":"string","description":"Description of the plan","isRequired":true,"uniqueKey":"description.oneOf.0","typeLabel":"string"},{"type":"null","description":"Description of the plan","isRequired":true,"uniqueKey":"description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"description","typeLabel":"string | null"},"code":{"oneOf":[{"type":"string","description":"Code for the plan","isRequired":true,"uniqueKey":"code.oneOf.0","typeLabel":"string"},{"type":"null","description":"Code for the plan","isRequired":true,"uniqueKey":"code.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"code","typeLabel":"string | null"},"product_id":{"type":"string","format":"uuid","description":"Unique identifier for the product the plan belongs to","isRequired":true,"uniqueKey":"product_id","typeLabel":"string\u003cuuid>"},"product_name":{"type":"string","description":"Name of the product the plan belongs to","isRequired":true,"uniqueKey":"product_name","typeLabel":"string"},"is_product_active":{"type":"boolean","description":"Whether the product is active. Plans on an inactive product are still listed here but cannot be used to build new orders.","isRequired":true,"uniqueKey":"is_product_active","typeLabel":"boolean"},"is_private":{"type":"boolean","description":"Private plans are not selectable by a buyer during self-serve, though your team can still build orders on them.","isRequired":true,"uniqueKey":"is_private","typeLabel":"boolean"},"bricks":{"type":"array","items":{"type":"object","properties":{"brick_id":{"type":"string","format":"uuid","description":"Unique identifier for the brick","isRequired":true,"uniqueKey":"bricks.items.[INDEX].brick_id","typeLabel":"string\u003cuuid>"},"brick_name":{"type":"string","description":"Name of the brick","isRequired":true,"uniqueKey":"bricks.items.[INDEX].brick_name","typeLabel":"string"},"brick_code":{"oneOf":[{"type":"string","description":"The internal SKU code you set on the brick. Unlike `brick_id` it stays the same across environments and when a brick is recreated, so use it to map bricks to your own features. Null when the brick has no code.","isRequired":true,"uniqueKey":"bricks.items.[INDEX].brick_code.oneOf.0","typeLabel":"string"},{"type":"null","description":"The internal SKU code you set on the brick. Unlike `brick_id` it stays the same across environments and when a brick is recreated, so use it to map bricks to your own features. Null when the brick has no code.","isRequired":true,"uniqueKey":"bricks.items.[INDEX].brick_code.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"bricks.items.[INDEX].brick_code","typeLabel":"string | null"},"brick_type":{"enum":["SUBSCRIPTION","ONE_TIME","MILESTONE","USAGE"],"type":"string","x-spec-enum-id":"c660eeda64fa22f1","description":"Type of the brick\n\n* `SUBSCRIPTION` - Subscription\n* `ONE_TIME` - One-timePurchase\n* `MILESTONE` - Milestone\n* `USAGE` - Usage","isRequired":true,"uniqueKey":"bricks.items.[INDEX].brick_type","typeLabel":"enum\u003cstring>"},"included_units":{"type":"integer","description":"Number of included units in pricing","uniqueKey":"bricks.items.[INDEX].included_units","typeLabel":"integer"},"min_units":{"type":"integer","description":"Minimum units required","uniqueKey":"bricks.items.[INDEX].min_units","typeLabel":"integer"},"tiers":{"type":"array","items":{"type":"object","properties":{"from":{"type":"integer","description":"Start of the tier range","isRequired":true,"uniqueKey":"bricks.items.[INDEX].tiers.items.[INDEX].from","typeLabel":"integer"}},"required":["from"],"uniqueKey":"bricks.items.[INDEX].tiers.items.[INDEX]","typeLabel":"object"},"description":"Tier breakpoints for tiered/volume discount pricing","uniqueKey":"bricks.items.[INDEX].tiers","typeLabel":"object[]"},"blocks":{"type":"array","items":{"type":"object","properties":{"from":{"type":"integer","description":"Start of the block range","isRequired":true,"uniqueKey":"bricks.items.[INDEX].blocks.items.[INDEX].from","typeLabel":"integer"},"to":{"type":"integer","description":"End of the block range","isRequired":true,"uniqueKey":"bricks.items.[INDEX].blocks.items.[INDEX].to","typeLabel":"integer"}},"required":["from","to"],"uniqueKey":"bricks.items.[INDEX].blocks.items.[INDEX]","typeLabel":"object"},"description":"Block ranges for block pricing","uniqueKey":"bricks.items.[INDEX].blocks","typeLabel":"object[]"},"pool":{"type":"object","description":"Pool configuration. Only present on a usage pool brick, whose units are drawn down by the bricks in `pooled_bricks`.","required":["billing_mode","default_pre_commitment","default_pre_commitment_schedule","pooled_bricks","rate_model","tiers"],"properties":{"billing_mode":{"enum":["PRE_COMMITMENT","PAY_AS_YOU_GO"],"type":"string","description":"PRE_COMMITMENT: pool units are bought up front at the pool rate. PAY_AS_YOU_GO: pool units are billed at the pool rate as they are used.","x-spec-enum-id":"63eb0617a6aeb15e","readOnly":true,"isRequired":true,"uniqueKey":"bricks.items.[INDEX].pool.billing_mode","typeLabel":"enum\u003cstring>"},"rate_model":{"enum":["FLAT_RATE","TIERED","VOLUME_DISCOUNT","BLOCK"],"type":"string","x-spec-enum-id":"e005ba660b8dcddf","description":"How the tiers apply. FLAT_RATE has a single tier. TIERED charges each unit at the rate of the tier it falls in. VOLUME_DISCOUNT charges every unit at the rate of the tier the total quantity reaches.\n\n* `FLAT_RATE` - Flat-rate\n* `TIERED` - Tiered\n* `VOLUME_DISCOUNT` - Volume Discount\n* `BLOCK` - Block","isRequired":true,"uniqueKey":"bricks.items.[INDEX].pool.rate_model","typeLabel":"enum\u003cstring>"},"tiers":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"up_to":{"oneOf":[{"type":"integer","description":"Last unit (inclusive) this tier covers. The next tier starts at the unit after it. Null for the top tier, which has no upper limit.","isRequired":true,"uniqueKey":"bricks.items.[INDEX].pool.tiers.oneOf.0.items.[INDEX].up_to.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Last unit (inclusive) this tier covers. The next tier starts at the unit after it. Null for the top tier, which has no upper limit.","isRequired":true,"uniqueKey":"bricks.items.[INDEX].pool.tiers.oneOf.0.items.[INDEX].up_to.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"bricks.items.[INDEX].pool.tiers.oneOf.0.items.[INDEX].up_to","typeLabel":"integer | null"},"rate":{"type":"string","format":"decimal","pattern":"^-?\\d{0,14}(?:\\.\\d{0,6})?$","description":"Price of one pool unit, in cents of the requested currency (e.g. \"150.000000\" = $1.50). Fractions of a cent are allowed.","isRequired":true,"uniqueKey":"bricks.items.[INDEX].pool.tiers.oneOf.0.items.[INDEX].rate","typeLabel":"string\u003cdecimal>"}},"required":["rate","up_to"],"uniqueKey":"bricks.items.[INDEX].pool.tiers.oneOf.0.items.[INDEX]","typeLabel":"object"},"readOnly":true,"description":"The pool rate in the requested currency. Empty when the pool has no price in that currency. Null when the pool's pricing can't be expressed as tiers, such as BLOCK pricing or included units.","isRequired":true,"uniqueKey":"bricks.items.[INDEX].pool.tiers.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"up_to":{"oneOf":[{"type":"integer","description":"Last unit (inclusive) this tier covers. The next tier starts at the unit after it. Null for the top tier, which has no upper limit."},{"type":"null","description":"Last unit (inclusive) this tier covers. The next tier starts at the unit after it. Null for the top tier, which has no upper limit."}]},"rate":{"type":"string","format":"decimal","pattern":"^-?\\d{0,14}(?:\\.\\d{0,6})?$","description":"Price of one pool unit, in cents of the requested currency (e.g. \"150.000000\" = $1.50). Fractions of a cent are allowed."}},"required":["rate","up_to"]},"readOnly":true,"description":"The pool rate in the requested currency. Empty when the pool has no price in that currency. Null when the pool's pricing can't be expressed as tiers, such as BLOCK pricing or included units.","isRequired":true,"uniqueKey":"bricks.items.[INDEX].pool.tiers.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"bricks.items.[INDEX].pool.tiers","typeLabel":"object[] | null"},"default_pre_commitment":{"oneOf":[{"type":"integer","description":"Pool units committed by default on a new order. Null if unset.","isRequired":true,"uniqueKey":"bricks.items.[INDEX].pool.default_pre_commitment.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Pool units committed by default on a new order. Null if unset.","isRequired":true,"uniqueKey":"bricks.items.[INDEX].pool.default_pre_commitment.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"bricks.items.[INDEX].pool.default_pre_commitment","typeLabel":"integer | null"},"default_pre_commitment_schedule":{"oneOf":[{"enum":["ALL_UPFRONT","MONTHLY","QUARTERLY","SEMI_ANNUALLY","ANNUALLY"],"type":"string","x-spec-enum-id":"3291f1569df314cc","description":"How often the default commitment is billed and resets. Null if unset.\n\n* `ALL_UPFRONT` - All upfront\n* `MONTHLY` - Monthly\n* `QUARTERLY` - Quarterly\n* `SEMI_ANNUALLY` - Semi-annually\n* `ANNUALLY` - Annually","isRequired":true,"uniqueKey":"bricks.items.[INDEX].pool.default_pre_commitment_schedule.oneOf.0","typeLabel":"enum\u003cstring>"},{"enum":["ALL_UPFRONT","MONTHLY","QUARTERLY","SEMI_ANNUALLY","ANNUALLY"],"type":"null","x-spec-enum-id":"3291f1569df314cc","description":"How often the default commitment is billed and resets. Null if unset.\n\n* `ALL_UPFRONT` - All upfront\n* `MONTHLY` - Monthly\n* `QUARTERLY` - Quarterly\n* `SEMI_ANNUALLY` - Semi-annually\n* `ANNUALLY` - Annually","isRequired":true,"uniqueKey":"bricks.items.[INDEX].pool.default_pre_commitment_schedule.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"bricks.items.[INDEX].pool.default_pre_commitment_schedule","typeLabel":"enum\u003cstring> | null"},"pooled_bricks":{"type":"array","items":{"type":"object","properties":{"brick_id":{"type":"string","format":"uuid","description":"Unique identifier for the brick","isRequired":true,"uniqueKey":"bricks.items.[INDEX].pool.pooled_bricks.items.[INDEX].brick_id","typeLabel":"string\u003cuuid>"},"brick_name":{"type":"string","description":"Name of the brick","isRequired":true,"uniqueKey":"bricks.items.[INDEX].pool.pooled_bricks.items.[INDEX].brick_name","typeLabel":"string"},"brick_code":{"oneOf":[{"type":"string","description":"The internal SKU code you set on the brick. Unlike `brick_id` it stays the same across environments and when a brick is recreated, so use it to map bricks to your own features. Null when the brick has no code.","isRequired":true,"uniqueKey":"bricks.items.[INDEX].pool.pooled_bricks.items.[INDEX].brick_code.oneOf.0","typeLabel":"string"},{"type":"null","description":"The internal SKU code you set on the brick. Unlike `brick_id` it stays the same across environments and when a brick is recreated, so use it to map bricks to your own features. Null when the brick has no code.","isRequired":true,"uniqueKey":"bricks.items.[INDEX].pool.pooled_bricks.items.[INDEX].brick_code.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"bricks.items.[INDEX].pool.pooled_bricks.items.[INDEX].brick_code","typeLabel":"string | null"},"rate_model":{"enum":["FLAT_RATE","TIERED","VOLUME_DISCOUNT","BLOCK"],"type":"string","x-spec-enum-id":"e005ba660b8dcddf","description":"How the tiers apply. FLAT_RATE has a single tier. TIERED charges each unit at the rate of the tier it falls in. VOLUME_DISCOUNT charges every unit at the rate of the tier the total quantity reaches.\n\n* `FLAT_RATE` - Flat-rate\n* `TIERED` - Tiered\n* `VOLUME_DISCOUNT` - Volume Discount\n* `BLOCK` - Block","isRequired":true,"uniqueKey":"bricks.items.[INDEX].pool.pooled_bricks.items.[INDEX].rate_model","typeLabel":"enum\u003cstring>"},"tiers":{"type":"array","items":{"type":"object","properties":{"up_to":{"oneOf":[{"type":"integer","description":"Last unit (inclusive) this tier covers. The next tier starts at the unit after it. Null for the top tier, which has no upper limit.","isRequired":true,"uniqueKey":"bricks.items.[INDEX].pool.pooled_bricks.items.[INDEX].tiers.items.[INDEX].up_to.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Last unit (inclusive) this tier covers. The next tier starts at the unit after it. Null for the top tier, which has no upper limit.","isRequired":true,"uniqueKey":"bricks.items.[INDEX].pool.pooled_bricks.items.[INDEX].tiers.items.[INDEX].up_to.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"bricks.items.[INDEX].pool.pooled_bricks.items.[INDEX].tiers.items.[INDEX].up_to","typeLabel":"integer | null"},"pool_unit_rate":{"type":"string","format":"decimal","pattern":"^-?\\d{0,14}(?:\\.\\d{0,6})?$","description":"Pool units drawn for each unit of usage on this brick. A rate of \"2.5\" means 10 units of usage draw 25 pool units.","isRequired":true,"uniqueKey":"bricks.items.[INDEX].pool.pooled_bricks.items.[INDEX].tiers.items.[INDEX].pool_unit_rate","typeLabel":"string\u003cdecimal>"},"overage_unit_rate":{"type":"string","format":"decimal","pattern":"^-?\\d{0,14}(?:\\.\\d{0,6})?$","description":"Multiplier on the pool's rate for each unit of usage on this brick once the pool's commitment is used up. Overage price per unit = overage_unit_rate x pool rate. Not used by PAY_AS_YOU_GO pools, which bill all usage at pool_unit_rate x pool rate.","isRequired":true,"uniqueKey":"bricks.items.[INDEX].pool.pooled_bricks.items.[INDEX].tiers.items.[INDEX].overage_unit_rate","typeLabel":"string\u003cdecimal>"}},"required":["overage_unit_rate","pool_unit_rate","up_to"],"uniqueKey":"bricks.items.[INDEX].pool.pooled_bricks.items.[INDEX].tiers.items.[INDEX]","typeLabel":"object"},"description":"This brick's pool rates. Currently always a single tier.","isRequired":true,"uniqueKey":"bricks.items.[INDEX].pool.pooled_bricks.items.[INDEX].tiers","typeLabel":"object[]"}},"required":["brick_code","brick_id","brick_name","rate_model","tiers"],"uniqueKey":"bricks.items.[INDEX].pool.pooled_bricks.items.[INDEX]","typeLabel":"object"},"readOnly":true,"description":"The bricks whose usage draws down this pool.","isRequired":true,"uniqueKey":"bricks.items.[INDEX].pool.pooled_bricks","typeLabel":"object[]"}},"uniqueKey":"bricks.items.[INDEX].pool","typeLabel":"object"}},"required":["brick_code","brick_id","brick_name","brick_type"],"uniqueKey":"bricks.items.[INDEX]","typeLabel":"object"},"readOnly":true,"description":"Bricks for the plan","isRequired":true,"uniqueKey":"bricks","typeLabel":"object[]"}},"required":["bricks","code","description","is_private","is_product_active","plan_id","plan_name","product_id","product_name"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"plan_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","plan_name":"\u003cstring>","description":"\u003cstring>","code":"\u003cstring>","product_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","product_name":"\u003cstring>","is_product_active":true,"is_private":true,"bricks":[{"brick_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","brick_name":"\u003cstring>","brick_code":"\u003cstring>","brick_type":"SUBSCRIPTION","included_units":123,"min_units":123,"tiers":[{"from":123}],"blocks":[{"from":123,"to":123}],"pool":{"billing_mode":"PRE_COMMITMENT","rate_model":"FLAT_RATE","tiers":[{"up_to":123,"rate":"\u003cstring>"}],"default_pre_commitment":123,"default_pre_commitment_schedule":"ALL_UPFRONT","pooled_bricks":[{"brick_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","brick_name":"\u003cstring>","brick_code":"\u003cstring>","rate_model":"FLAT_RATE","tiers":[{"up_to":123,"pool_unit_rate":"\u003cstring>","overage_unit_rate":"\u003cstring>"}]}]}}]}}},"exampleType":"generated"}},"description":"","exampleType":"generated"},"54669ae9-a31e-456d-9b39-fb94d9a55254":{"content":{"application/json":{"schema":{"type":"object","description":"Standardizes API error responses with a consistent structure containing error code and message.","properties":{"error":{"type":"object","description":"The error that caused the request to fail","required":["code","message"],"properties":{"code":{"enum":["ERR_NOT_FOUND","ERR_BAD_REQUEST","ERR_SERVER_ERROR"],"type":"string","x-spec-enum-id":"dc5a5d6feae1b697","description":"Error code indicating the type of error: NOT_FOUND for missing resources, BAD_REQUEST for invalid input, SERVER_ERROR for internal server issues\n\n* `ERR_NOT_FOUND` - ERR_NOT_FOUND\n* `ERR_BAD_REQUEST` - ERR_BAD_REQUEST\n* `ERR_SERVER_ERROR` - ERR_SERVER_ERROR","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable explanation of the error","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"error_id":{"type":"string","format":"uuid","description":"Correlation handle for SERVER_ERROR responses — quote this when contacting support; it joins to the structured server log line for the failure. Not present on 4xx responses.","uniqueKey":"error.error_id","typeLabel":"string\u003cuuid>"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"NotFoundResponse":{"title":"NotFoundResponse","value":{"error":{"code":"ERR_NOT_FOUND","message":"Not found — the resource you are looking for does not exist."}}}},"exampleType":"examples"}},"description":"","exampleType":"examples"}},"security":{"96e2b814-4b2f-4ec1-a062-fb177ecfca77":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"X-SALESBRICKS-KEY","description":"API key for authentication","scopes":[],"schemeName":"ApiKeyAuth"}}},"servers":{"473a595f-0b07-4538-b033-faf5582d0b46":{"url":"https://api.salesbricks.com/api/v2","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"X-SALESBRICKS-KEY","description":"API key for authentication","scopes":[],"schemeName":"ApiKeyAuth"},"schema":{"title":"X-SALESBRICKS-KEY","type":"string","description":"API key for authentication","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"X-SALESBRICKS-KEY"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"https://api.salesbricks.com/api/v2/openapi.yaml"},"subdomain":"salesbricks","siteName":"Salesbricks","title":"Retrieve a plan - Salesbricks","relatedPagesConfig":{"enabled":true,"limit":3,"mode":"automatic"},"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-05T23:31:30.480Z","originalFileLocation":"api-reference/plans/retrieve-a-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=\"Returns the details of a plan, including its name and bricks.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Salesbricks\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/salesbricks/Q_HZP6fZfruEcDCT/_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/salesbricks/Q_HZP6fZfruEcDCT/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/salesbricks/Q_HZP6fZfruEcDCT/_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/salesbricks/Q_HZP6fZfruEcDCT/_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/salesbricks/Q_HZP6fZfruEcDCT/_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/salesbricks/Q_HZP6fZfruEcDCT/_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/salesbricks/Q_HZP6fZfruEcDCT/_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/salesbricks/Q_HZP6fZfruEcDCT/_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/salesbricks/Q_HZP6fZfruEcDCT/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Retrieve a plan - Salesbricks\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns the details of a plan, including its name and bricks.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Salesbricks\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.salesbricks.com/api-reference/plans/retrieve-a-plan\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://salesbricks.mintlify.site/_mintlify/api/og/v2?division=Plans\u0026amp;title=Retrieve+a+plan\u0026amp;description=Returns+the+details+of+a+plan%2C+including+its+name+and+bricks.\u0026amp;theme=c38cf69ba54d28d8add3f8a9\u0026amp;signature=8cd827d7d1f0ade4f4559bbe6bcfa0430d0664ea175c12daeca192e9304b7938\">\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=\"Retrieve a plan - Salesbricks\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns the details of a plan, including its name and bricks.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://salesbricks.mintlify.site/_mintlify/api/og/v2?division=Plans\u0026amp;title=Retrieve+a+plan\u0026amp;description=Returns+the+details+of+a+plan%2C+including+its+name+and+bricks.\u0026amp;theme=c38cf69ba54d28d8add3f8a9\u0026amp;signature=8cd827d7d1f0ade4f4559bbe6bcfa0430d0664ea175c12daeca192e9304b7938\">\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/salesbricks/Q_HZP6fZfruEcDCT/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Salesbricks\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#197F78\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.salesbricks.com/api-reference/plans/retrieve-a-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/plans/retrieve-a-plan.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.salesbricks.com/#organization\",\"name\":\"Salesbricks\",\"url\":\"https://docs.salesbricks.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/salesbricks/3GVA0K12Q7dXW89y/logo/light.svg?fit=max\u0026auto=format\u0026n=3GVA0K12Q7dXW89y\u0026q=85\u0026s=ead3e65ff72970d53a9cd22de50bd8fc\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.salesbricks.com#website\",\"name\":\"Salesbricks\",\"url\":\"https://docs.salesbricks.com\",\"publisher\":{\"@id\":\"https://docs.salesbricks.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.salesbricks.com/api-reference/plans/retrieve-a-plan#webpage\",\"url\":\"https://docs.salesbricks.com/api-reference/plans/retrieve-a-plan\",\"name\":\"Retrieve a plan\",\"description\":\"Returns the details of a plan, including its name and bricks.\",\"dateModified\":\"2026-11-05T23:31:30.480Z\",\"isPartOf\":{\"@id\":\"https://docs.salesbricks.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.salesbricks.com/api-reference/plans/retrieve-a-plan#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.salesbricks.com/api-reference/plans/retrieve-a-plan#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"REST API Endpoints\",\"item\":\"https://docs.salesbricks.com/api-reference/customers/list-all-customers\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Plans\",\"item\":\"https://docs.salesbricks.com/api-reference/plans/list-all-plans\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Retrieve a plan\",\"item\":\"https://docs.salesbricks.com/api-reference/plans/retrieve-a-plan\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.salesbricks.com/api-reference/plans/retrieve-a-plan#apireference\",\"headline\":\"Retrieve a plan\",\"name\":\"Retrieve a plan\",\"description\":\"Returns the details of a plan, including its name and bricks.\",\"url\":\"https://docs.salesbricks.com/api-reference/plans/retrieve-a-plan\",\"mainEntityOfPage\":{\"@id\":\"https://docs.salesbricks.com/api-reference/plans/retrieve-a-plan#webpage\"},\"dateModified\":\"2026-11-05T23:31:30.480Z\",\"publisher\":{\"@id\":\"https://docs.salesbricks.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.salesbricks.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Salesbricks\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Salesbricks","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/quickstart-guide/introduction"}]},{"tab":"Integrations","pages":[{"title":"Integrations","href":"/integrations/salesforce/overview"}]},{"tab":"APIs \u0026 Webhooks","groups":[{"group":"APIs","icon":"code","pages":[{"title":"REST API Overview","href":"/api-reference/getting-started/overview"},{"title":"Authentication","href":"/api-reference/getting-started/authentication"},{"title":"Starting a Subscription","href":"/api-reference/getting-started/starting-a-subscription"},{"title":"Idempotent Requests","href":"/api-reference/getting-started/idempotent-requests"},{"title":"GraphQL API (Legacy)","href":"/api-reference/getting-started/graphql"},{"title":"Manage My Subscription","href":"/api-reference/manage-my-subscription"}]},{"group":"REST API Endpoints","icon":"server","pages":[{"group":"Customers","pages":[{"title":"List all customers","deprecated":null,"version":null,"openapi":"https://api.salesbricks.com/api/v2/openapi.yaml get /customers","href":"/api-reference/customers/list-all-customers"},{"title":"Create a customer","deprecated":null,"version":null,"openapi":"https://api.salesbricks.com/api/v2/openapi.yaml post /customers","href":"/api-reference/customers/create-a-customer"},{"title":"Retrieve a customer","deprecated":null,"version":null,"openapi":"https://api.salesbricks.com/api/v2/openapi.yaml get /customers/{customer_id}","href":"/api-reference/customers/retrieve-a-customer"},{"title":"Update a customer","deprecated":null,"version":null,"openapi":"https://api.salesbricks.com/api/v2/openapi.yaml patch /customers/{customer_id}","href":"/api-reference/customers/update-a-customer"},{"title":"Search customers","deprecated":null,"version":null,"openapi":"https://api.salesbricks.com/api/v2/openapi.yaml post /customers/search","href":"/api-reference/customers/search-customers"}]},{"group":"Invoices","pages":[{"title":"List all customer invoices","deprecated":null,"version":null,"openapi":"https://api.salesbricks.com/api/v2/openapi.yaml get /customers/{customer_id}/invoices","href":"/api-reference/invoices/list-all-customer-invoices"},{"title":"Create standalone invoice","deprecated":null,"version":null,"openapi":"https://api.salesbricks.com/api/v2/openapi.yaml post /invoices","href":"/api-reference/invoices/create-standalone-invoice"},{"title":"Retrieve an invoice","deprecated":null,"version":null,"openapi":"https://api.salesbricks.com/api/v2/openapi.yaml get /invoices/{invoice_id}","href":"/api-reference/invoices/retrieve-an-invoice"},{"title":"Update an invoice","deprecated":null,"version":null,"openapi":"https://api.salesbricks.com/api/v2/openapi.yaml patch /invoices/{invoice_id}","href":"/api-reference/invoices/update-an-invoice"},{"title":"Finalize an invoice","deprecated":null,"version":null,"openapi":"https://api.salesbricks.com/api/v2/openapi.yaml post /invoices/{invoice_id}/finalize","href":"/api-reference/invoices/finalize-an-invoice"},{"title":"Pay an invoice","deprecated":null,"version":null,"openapi":"https://api.salesbricks.com/api/v2/openapi.yaml post /invoices/{invoice_id}/pay","href":"/api-reference/invoices/pay-an-invoice"},{"title":"Create a payment","deprecated":null,"version":null,"openapi":"https://api.salesbricks.com/api/v2/openapi.yaml post /invoices/{invoice_id}/payments","href":"/api-reference/invoices/create-a-payment"},{"title":"Retrieve an invoice PDF","deprecated":null,"version":null,"openapi":"https://api.salesbricks.com/api/v2/openapi.yaml get /invoices/{invoice_id}/pdf","href":"/api-reference/invoices/retrieve-an-invoice-pdf"},{"title":"Regenerate an invoice","deprecated":null,"version":null,"openapi":"https://api.salesbricks.com/api/v2/openapi.yaml post /invoices/{invoice_id}/regenerate","href":"/api-reference/invoices/regenerate-an-invoice"},{"title":"Void an invoice","deprecated":null,"version":null,"openapi":"https://api.salesbricks.com/api/v2/openapi.yaml post /invoices/{invoice_id}/void","href":"/api-reference/invoices/void-an-invoice"},{"title":"Search invoices","deprecated":null,"version":null,"openapi":"https://api.salesbricks.com/api/v2/openapi.yaml post /invoices/search","href":"/api-reference/invoices/search-invoices"},{"title":"List all subscription invoices","deprecated":null,"version":null,"openapi":"https://api.salesbricks.com/api/v2/openapi.yaml get /subscriptions/{subscription_id}/invoices","href":"/api-reference/invoices/list-all-subscription-invoices"},{"title":"Retrieve next subscription invoice","deprecated":null,"version":null,"openapi":"https://api.salesbricks.com/api/v2/openapi.yaml get /subscriptions/{subscription_id}/invoices/next","href":"/api-reference/invoices/retrieve-next-subscription-invoice"}]},{"group":"Payment Methods","pages":[{"title":"List all payment methods","deprecated":null,"version":null,"openapi":"https://api.salesbricks.com/api/v2/openapi.yaml get /customers/{customer_id}/payment-methods","href":"/api-reference/payment-methods/list-all-payment-methods"},{"title":"Setup a payment method","deprecated":null,"version":null,"openapi":"https://api.salesbricks.com/api/v2/openapi.yaml post /customers/{customer_id}/payment-methods","href":"/api-reference/payment-methods/setup-a-payment-method"},{"title":"Retrieve default payment method","deprecated":null,"version":null,"openapi":"https://api.salesbricks.com/api/v2/openapi.yaml get /customers/{customer_id}/payment-methods/default","href":"/api-reference/payment-methods/retrieve-default-payment-method"},{"title":"Set default payment method","deprecated":null,"version":null,"openapi":"https://api.salesbricks.com/api/v2/openapi.yaml put /customers/{customer_id}/payment-methods/default","href":"/api-reference/payment-methods/set-default-payment-method"},{"title":"Delete a payment method","deprecated":null,"version":null,"openapi":"https://api.salesbricks.com/api/v2/openapi.yaml delete /customers/{customer_id}/payment-methods/detail","href":"/api-reference/payment-methods/delete-a-payment-method"},{"title":"List the payment methods for an invoice","deprecated":null,"version":null,"openapi":"https://api.salesbricks.com/api/v2/openapi.yaml get /invoices/{invoice_id}/payment-methods","href":"/api-reference/payment-methods/list-the-payment-methods-for-an-invoice"},{"title":"List all payment methods","deprecated":null,"version":null,"openapi":"https://api.salesbricks.com/api/v2/openapi.yaml get /subscriptions/{subscription_id}/payment-methods","href":"/api-reference/payment-methods/list-all-payment-methods-1"},{"title":"Setup a payment method","deprecated":null,"version":null,"openapi":"https://api.salesbricks.com/api/v2/openapi.yaml post /subscriptions/{subscription_id}/payment-methods","href":"/api-reference/payment-methods/setup-a-payment-method-1"},{"title":"Retrieve default payment method","deprecated":null,"version":null,"openapi":"https://api.salesbricks.com/api/v2/openapi.yaml get /subscriptions/{subscription_id}/payment-methods/default","href":"/api-reference/payment-methods/retrieve-default-payment-method-1"},{"title":"Set default payment method","deprecated":null,"version":null,"openapi":"https://api.salesbricks.com/api/v2/openapi.yaml put /subscriptions/{subscription_id}/payment-methods/default","href":"/api-reference/payment-methods/set-default-payment-method-1"},{"title":"Delete a payment method","deprecated":null,"version":null,"openapi":"https://api.salesbricks.com/api/v2/openapi.yaml delete /subscriptions/{subscription_id}/payment-methods/detail","href":"/api-reference/payment-methods/delete-a-payment-method-1"}]},{"group":"Customer Contacts","pages":[{"title":"Create a customer contact","deprecated":null,"version":null,"openapi":"https://api.salesbricks.com/api/v2/openapi.yaml post /customers/{customer_id}/persons","href":"/api-reference/customer-contacts/create-a-customer-contact"},{"title":"Update a customer contact","deprecated":null,"version":null,"openapi":"https://api.salesbricks.com/api/v2/openapi.yaml patch /customers/{customer_id}/persons/{person_id}","href":"/api-reference/customer-contacts/update-a-customer-contact"},{"title":"Search customer contacts","deprecated":null,"version":null,"openapi":"https://api.salesbricks.com/api/v2/openapi.yaml post /persons/search","href":"/api-reference/customer-contacts/search-customer-contacts"}]},{"group":"Discount Coupons","pages":[{"title":"List all discount coupons","deprecated":null,"version":null,"openapi":"https://api.salesbricks.com/api/v2/openapi.yaml get /discount-coupons","href":"/api-reference/discount-coupons/list-all-discount-coupons"},{"title":"Retrieve a discount coupon","deprecated":null,"version":null,"openapi":"https://api.salesbricks.com/api/v2/openapi.yaml get /discount-coupons/{code}","href":"/api-reference/discount-coupons/retrieve-a-discount-coupon"}]},{"group":"Invoice Versions","pages":[{"title":"List all invoice versions","deprecated":null,"version":null,"openapi":"https://api.salesbricks.com/api/v2/openapi.yaml get /invoices/{invoice_id}/versions","href":"/api-reference/invoice-versions/list-all-invoice-versions"}]},{"group":"Legal Entities","pages":[{"title":"List all legal entities","deprecated":null,"version":null,"openapi":"https://api.salesbricks.com/api/v2/openapi.yaml get /legal-entities","href":"/api-reference/legal-entities/list-all-legal-entities"}]},{"group":"Plans","pages":[{"title":"List all plans","description":"Returns a paginated list of published plans. This will fetch the plan and the associated bricks for that plan.","deprecated":null,"version":null,"openapi":"https://api.salesbricks.com/api/v2/openapi.yaml get /plans","href":"/api-reference/plans/list-all-plans"},{"title":"Retrieve a plan","deprecated":null,"version":null,"openapi":"https://api.salesbricks.com/api/v2/openapi.yaml get /plans/{plan_id}","href":"/api-reference/plans/retrieve-a-plan"}]},{"group":"Revenue","pages":[{"title":"Get per-subscription revenue by month","description":"Returns one row per (subscription, currency) with a sparse `entries` list of {month, revenue_type, amount} records. Revenue types are: recurring, overage, pay_as_you_go, one_time, and milestone. Continuation logic is applied server-side for recurring revenue — active subscriptions are forward-filled using their renewable MRR. Paginated at the (subscription, currency) grain via limit/offset.","deprecated":null,"version":null,"openapi":"https://api.salesbricks.com/api/v2/openapi.yaml get /revenue/subscriptions","href":"/api-reference/revenue/get-per-subscription-revenue-by-month"}]},{"group":"Subscriptions","pages":[{"title":"Create a subscription","deprecated":null,"version":null,"openapi":"https://api.salesbricks.com/api/v2/openapi.yaml post /subscriptions","href":"/api-reference/subscriptions/create-a-subscription"},{"title":"Retrieve a subscription","deprecated":null,"version":null,"openapi":"https://api.salesbricks.com/api/v2/openapi.yaml get /subscriptions/{subscription_id}","href":"/api-reference/subscriptions/retrieve-a-subscription"},{"title":"Update a subscription","deprecated":null,"version":null,"openapi":"https://api.salesbricks.com/api/v2/openapi.yaml patch /subscriptions/{subscription_id}","href":"/api-reference/subscriptions/update-a-subscription"},{"title":"Retrieve subscription checkout URL","deprecated":null,"version":null,"openapi":"https://api.salesbricks.com/api/v2/openapi.yaml get /subscriptions/{subscription_id}/checkout","href":"/api-reference/subscriptions/retrieve-subscription-checkout-url"},{"title":"Update a subscription pause","deprecated":null,"version":null,"openapi":"https://api.salesbricks.com/api/v2/openapi.yaml put /subscriptions/{subscription_id}/pause","href":"/api-reference/subscriptions/update-a-subscription-pause"},{"title":"Pause a subscription","deprecated":null,"version":null,"openapi":"https://api.salesbricks.com/api/v2/openapi.yaml post /subscriptions/{subscription_id}/pause","href":"/api-reference/subscriptions/pause-a-subscription"},{"title":"Cancel an upcoming subscription pause","deprecated":null,"version":null,"openapi":"https://api.salesbricks.com/api/v2/openapi.yaml delete /subscriptions/{subscription_id}/pause","href":"/api-reference/subscriptions/cancel-an-upcoming-subscription-pause"},{"title":"Resume a paused subscription","deprecated":null,"version":null,"openapi":"https://api.salesbricks.com/api/v2/openapi.yaml post /subscriptions/{subscription_id}/resume","href":"/api-reference/subscriptions/resume-a-paused-subscription"},{"title":"Retrieve subscription sign URL","deprecated":null,"version":null,"openapi":"https://api.salesbricks.com/api/v2/openapi.yaml post /subscriptions/{subscription_id}/sign","href":"/api-reference/subscriptions/retrieve-subscription-sign-url"},{"title":"Start a subscription","deprecated":null,"version":null,"openapi":"https://api.salesbricks.com/api/v2/openapi.yaml post /subscriptions/{subscription_id}/start","href":"/api-reference/subscriptions/start-a-subscription"},{"title":"Terminate a subscription","deprecated":null,"version":null,"openapi":"https://api.salesbricks.com/api/v2/openapi.yaml post /subscriptions/{subscription_id}/terminate","href":"/api-reference/subscriptions/terminate-a-subscription"},{"title":"Estimate a subscription","deprecated":null,"version":null,"openapi":"https://api.salesbricks.com/api/v2/openapi.yaml post /subscriptions/estimate","href":"/api-reference/subscriptions/estimate-a-subscription"}]},{"group":"Subscription Management","pages":[{"title":"Retrieve subscription management URL","deprecated":null,"version":null,"openapi":"https://api.salesbricks.com/api/v2/openapi.yaml get /subscriptions/{subscription_id}/billing-portal","href":"/api-reference/subscription-management/retrieve-subscription-management-url"}]},{"group":"Subscription State","pages":[{"title":"List all subscription bricks","deprecated":null,"version":null,"openapi":"https://api.salesbricks.com/api/v2/openapi.yaml get /subscriptions/{subscription_id}/bricks","href":"/api-reference/subscription-state/list-all-subscription-bricks"},{"title":"Retrieve current subscription state","deprecated":null,"version":null,"openapi":"https://api.salesbricks.com/api/v2/openapi.yaml get /subscriptions/{subscription_id}/current","href":"/api-reference/subscription-state/retrieve-current-subscription-state"},{"title":"Update details for a closed subscription","deprecated":null,"version":null,"openapi":"https://api.salesbricks.com/api/v2/openapi.yaml patch /subscriptions/{subscription_id}/current","href":"/api-reference/subscription-state/update-details-for-a-closed-subscription"},{"title":"Retrieve current subscription order form PDF","deprecated":null,"version":null,"openapi":"https://api.salesbricks.com/api/v2/openapi.yaml get /subscriptions/{subscription_id}/current/pdf","href":"/api-reference/subscription-state/retrieve-current-subscription-order-form-pdf"},{"title":"Retrieve a subscription order form PDF","deprecated":null,"version":null,"openapi":"https://api.salesbricks.com/api/v2/openapi.yaml get /subscriptions/{subscription_id}/pdf","href":"/api-reference/subscription-state/retrieve-a-subscription-order-form-pdf"}]},{"group":"Usage","pages":[{"title":"Retrieve brick usage","deprecated":null,"version":null,"openapi":"https://api.salesbricks.com/api/v2/openapi.yaml get /subscriptions/{subscription_id}/bricks/{brick_id}/usage","href":"/api-reference/usage/retrieve-brick-usage"},{"title":"List individual usage entries","deprecated":null,"version":null,"openapi":"https://api.salesbricks.com/api/v2/openapi.yaml get /subscriptions/{subscription_id}/bricks/{brick_id}/usage/entries","href":"/api-reference/usage/list-individual-usage-entries"},{"title":"Retrieve brick usage time series","deprecated":null,"version":null,"openapi":"https://api.salesbricks.com/api/v2/openapi.yaml get /subscriptions/{subscription_id}/bricks/{brick_id}/usage/series","href":"/api-reference/usage/retrieve-brick-usage-time-series"},{"title":"Create a usage entry","deprecated":null,"version":null,"openapi":"https://api.salesbricks.com/api/v2/openapi.yaml post /usage/","href":"/api-reference/usage/create-a-usage-entry"},{"title":"Delete a usage entry","deprecated":null,"version":null,"openapi":"https://api.salesbricks.com/api/v2/openapi.yaml delete /usage/","href":"/api-reference/usage/delete-a-usage-entry"},{"title":"Update a usage entry","deprecated":null,"version":null,"openapi":"https://api.salesbricks.com/api/v2/openapi.yaml patch /usage/","href":"/api-reference/usage/update-a-usage-entry"},{"title":"Get usage transaction details","deprecated":null,"version":null,"openapi":"https://api.salesbricks.com/api/v2/openapi.yaml get /usage/transactions/{transaction_id}/","href":"/api-reference/usage/get-usage-transaction-details"}]},{"group":"Subscription Milestones","pages":[{"title":"List all subscription milestones","deprecated":null,"version":null,"openapi":"https://api.salesbricks.com/api/v2/openapi.yaml get /subscriptions/{subscription_id}/milestones","href":"/api-reference/subscription-milestones/list-all-subscription-milestones"},{"title":"Complete a subscription milestone","deprecated":null,"version":null,"openapi":"https://api.salesbricks.com/api/v2/openapi.yaml post /subscriptions/{subscription_id}/milestones/{milestone_id}/complete","href":"/api-reference/subscription-milestones/complete-a-subscription-milestone"}]},{"group":"Subscription History","pages":[{"title":"List all subscription orders","deprecated":null,"version":null,"openapi":"https://api.salesbricks.com/api/v2/openapi.yaml get /subscriptions/{subscription_id}/orders","href":"/api-reference/subscription-history/list-all-subscription-orders"}]},{"group":"Subscription Recasts","pages":[{"title":"List all subscription recast open orders","deprecated":null,"version":null,"openapi":"https://api.salesbricks.com/api/v2/openapi.yaml get /subscriptions/{subscription_id}/recast","href":"/api-reference/subscription-recasts/list-all-subscription-recast-open-orders"},{"title":"Create a subscription recast","deprecated":null,"version":null,"openapi":"https://api.salesbricks.com/api/v2/openapi.yaml post /subscriptions/{subscription_id}/recast","href":"/api-reference/subscription-recasts/create-a-subscription-recast"},{"title":"Delete a subscription recast","deprecated":null,"version":null,"openapi":"https://api.salesbricks.com/api/v2/openapi.yaml delete /subscriptions/{subscription_id}/recast/{order_id}","href":"/api-reference/subscription-recasts/delete-a-subscription-recast"},{"title":"Update a subscription recast","deprecated":null,"version":null,"openapi":"https://api.salesbricks.com/api/v2/openapi.yaml patch /subscriptions/{subscription_id}/recast/{order_id}","href":"/api-reference/subscription-recasts/update-a-subscription-recast"},{"title":"Retrieve subscription recast checkout URL","deprecated":null,"version":null,"openapi":"https://api.salesbricks.com/api/v2/openapi.yaml get /subscriptions/{subscription_id}/recast/{order_id}/checkout","href":"/api-reference/subscription-recasts/retrieve-subscription-recast-checkout-url"},{"title":"Retrieve subscription recast sign URL","deprecated":null,"version":null,"openapi":"https://api.salesbricks.com/api/v2/openapi.yaml post /subscriptions/{subscription_id}/recast/{order_id}/sign","href":"/api-reference/subscription-recasts/retrieve-subscription-recast-sign-url"},{"title":"Start a subscription recast","deprecated":null,"version":null,"openapi":"https://api.salesbricks.com/api/v2/openapi.yaml post /subscriptions/{subscription_id}/recast/{order_id}/start","href":"/api-reference/subscription-recasts/start-a-subscription-recast"},{"title":"Estimate a subscription recast","deprecated":null,"version":null,"openapi":"https://api.salesbricks.com/api/v2/openapi.yaml post /subscriptions/{subscription_id}/recast/estimate","href":"/api-reference/subscription-recasts/estimate-a-subscription-recast"}]},{"group":"Subscription Upgrades","pages":[{"title":"List all subscription upgrade open orders","deprecated":null,"version":null,"openapi":"https://api.salesbricks.com/api/v2/openapi.yaml get /subscriptions/{subscription_id}/upgrade","href":"/api-reference/subscription-upgrades/list-all-subscription-upgrade-open-orders"},{"title":"Create a subscription upgrade","deprecated":null,"version":null,"openapi":"https://api.salesbricks.com/api/v2/openapi.yaml post /subscriptions/{subscription_id}/upgrade","href":"/api-reference/subscription-upgrades/create-a-subscription-upgrade"},{"title":"Delete a subscription upgrade","deprecated":null,"version":null,"openapi":"https://api.salesbricks.com/api/v2/openapi.yaml delete /subscriptions/{subscription_id}/upgrade/{order_id}","href":"/api-reference/subscription-upgrades/delete-a-subscription-upgrade"},{"title":"Update a subscription upgrade","deprecated":null,"version":null,"openapi":"https://api.salesbricks.com/api/v2/openapi.yaml patch /subscriptions/{subscription_id}/upgrade/{order_id}","href":"/api-reference/subscription-upgrades/update-a-subscription-upgrade"},{"title":"Retrieve subscription upgrade checkout URL","deprecated":null,"version":null,"openapi":"https://api.salesbricks.com/api/v2/openapi.yaml get /subscriptions/{subscription_id}/upgrade/{order_id}/checkout","href":"/api-reference/subscription-upgrades/retrieve-subscription-upgrade-checkout-url"},{"title":"Retrieve subscription upgrade sign URL","deprecated":null,"version":null,"openapi":"https://api.salesbricks.com/api/v2/openapi.yaml post /subscriptions/{subscription_id}/upgrade/{order_id}/sign","href":"/api-reference/subscription-upgrades/retrieve-subscription-upgrade-sign-url"},{"title":"Start a subscription upgrade","deprecated":null,"version":null,"openapi":"https://api.salesbricks.com/api/v2/openapi.yaml post /subscriptions/{subscription_id}/upgrade/{order_id}/start","href":"/api-reference/subscription-upgrades/start-a-subscription-upgrade"},{"title":"Estimate a subscription upgrade","deprecated":null,"version":null,"openapi":"https://api.salesbricks.com/api/v2/openapi.yaml post /subscriptions/{subscription_id}/upgrade/estimate","href":"/api-reference/subscription-upgrades/estimate-a-subscription-upgrade"}]}]},{"group":"Usage","icon":"gauge-high","pages":[{"title":"Overview","href":"/api-reference/usage/overview"},{"title":"Submit a usage entry","openapi":"POST /usage","href":"/api-reference/usage/post"},{"title":"Update a usage entry","openapi":"PATCH /usage","href":"/api-reference/usage/patch"},{"title":"Delete a usage entry","openapi":"DELETE /usage","href":"/api-reference/usage/delete"}]},{"group":"Webhooks","icon":"webhook","pages":[{"title":"Overview","href":"/api-reference/webhooks/overview"},{"title":"Schemas","href":"/api-reference/webhooks/schemas"},{"group":"Order Webhooks","pages":[{"title":"Order Webhook Payload","mode":"wide","href":"/api-reference/webhooks/order/payload"},{"title":"order.stage.change","href":"/api-reference/webhooks/order/stage-change"},{"title":"order.approval.status.changed","href":"/api-reference/webhooks/order/approval-status-changed"},{"title":"order.complete","href":"/api-reference/webhooks/order/complete"},{"title":"order.closed.lost","href":"/api-reference/webhooks/order/closed-lost"},{"title":"order.closed.delete","href":"/api-reference/webhooks/order/closed-delete"},{"title":"order.end","href":"/api-reference/webhooks/order/end"},{"title":"order.new-ramping-period","href":"/api-reference/webhooks/order/new-ramping-period"},{"title":"order.terminated","href":"/api-reference/webhooks/order/terminated"},{"title":"order.reinstated","href":"/api-reference/webhooks/order/reinstated"}]},{"group":"Subscription Webhooks","pages":[{"title":"Subscription Inactive Payload","mode":"wide","href":"/api-reference/webhooks/subscription/payload"},{"title":"subscription.inactive","href":"/api-reference/webhooks/subscription/inactive"}]},{"group":"Invoice Webhooks","pages":[{"title":"Invoice Webhook Payload","mode":"wide","href":"/api-reference/webhooks/invoice/payload"},{"title":"invoice.start","href":"/api-reference/webhooks/invoice/start"},{"title":"invoice.upcoming.due","href":"/api-reference/webhooks/invoice/upcoming-due"},{"title":"invoice.past.due","href":"/api-reference/webhooks/invoice/past-due"},{"title":"invoice.payment.succeeded","href":"/api-reference/webhooks/invoice/payment/succeeded"},{"title":"invoice.payment.failed","href":"/api-reference/webhooks/invoice/payment/failed"},{"title":"invoice.refunded","href":"/api-reference/webhooks/invoice/refunded"},{"title":"invoice.voided","href":"/api-reference/webhooks/invoice/voided"}]},{"group":"Payment Webhooks","pages":[{"title":"Payment Webhook Payload","mode":"wide","href":"/api-reference/webhooks/payment/payload"}]},{"group":"Usage Webhooks","pages":[{"title":"Usage Threshold Payload","mode":"wide","href":"/api-reference/webhooks/usage/payload"},{"title":"usage.threshold.exceeded.precommitment","href":"/api-reference/webhooks/usage/threshold-exceeded-precommitment"},{"title":"usage.threshold.exceeded.units","href":"/api-reference/webhooks/usage/threshold-exceeded-units"},{"title":"usage.threshold.exceeded.money","href":"/api-reference/webhooks/usage/threshold-exceeded-money"}]},{"group":"Plan Webhooks","pages":[{"title":"plan.published","href":"/api-reference/webhooks/plan/published"}]},{"group":"Company Webhooks","pages":[{"title":"Company Webhook Payload","mode":"wide","href":"/api-reference/webhooks/company/payload"},{"title":"company.created","href":"/api-reference/webhooks/company/created"},{"title":"company.updated","href":"/api-reference/webhooks/company/updated"}]},{"group":"Person Webhooks","pages":[{"title":"Person Webhook Payload","mode":"wide","href":"/api-reference/webhooks/person/payload"},{"title":"person.created","href":"/api-reference/webhooks/person/created"},{"title":"person.updated","href":"/api-reference/webhooks/person/updated"}]}]}]},{"tab":"What's new","pages":[{"title":"What's new","href":"/whats-new"}]},{"tab":"Knowledge Base","href":"https://support.salesbricks.com"}]},"basePath":"","title":"Retrieve a plan - Salesbricks","buildId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","deploymentId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-i2a3QZ8E.js","utils-ChLwp8m0.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DRktVTDc.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CA2pEs4T.js","snippetPresets-ClQ6XrKD.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-Ct_Lv36y.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-Cn2PYw9e.js","shallow-rkyymjXQ.js","getApiPlaygroundDisplay-BB9vkXtE.js","CodeSnippet-Bm5RU7m1.js","CodeSnippets-BgU9Deuz.js","Page-BUDYNlhG.js","getPastedJson-BD-6NNum.js","icon-8Z6tud2e.js","MethodPill-Tuzr4g3V.js","DuplicateIcon-0ceWFYhN.js","createIcon-FBXow_ST.js","DynamicMarkdown-CD8713Yy.js","SectionHeading-7zgzQbH-.js","axios-vUo_bRtp.js","Markdown-D7Ofw1oz.js","clsx-eKJ4rcii.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CwjSCXIK.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-9EK5IAXV.js"]}