{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Spacebring Docs","colors":{"primary":"#00928F","light":"#7BEEB3","dark":"#00928F"},"logo":{"light":"https://mintcdn.com/spacebring/ElSlMekJ2CB5Dog7/logo/light.svg?fit=max\u0026auto=format\u0026n=ElSlMekJ2CB5Dog7\u0026q=85\u0026s=29b9c3bc15b6d346f2c13cccf246e486","dark":"https://mintcdn.com/spacebring/ElSlMekJ2CB5Dog7/logo/dark.svg?fit=max\u0026auto=format\u0026n=ElSlMekJ2CB5Dog7\u0026q=85\u0026s=fa94390626c2e4ed5dc7bcf5cbb80355"},"favicon":"https://mintcdn.com/spacebring/ElSlMekJ2CB5Dog7/favicon.svg?fit=max\u0026auto=format\u0026n=ElSlMekJ2CB5Dog7\u0026q=85\u0026s=3fbdcdb2b3743fb24f3b7b4e8824d364","footer":{"socials":{"github":"https://github.com/spacebring"}},"fonts":{"heading":{"family":"OktaNeue-SemiBold","weight":600,"source":"https://www.spacebring.com/OktaNeue-SemiBold.woff2","format":"woff2"},"body":{"family":"Inter"}},"integrations":{"cookies":{"key":"sb_analytics_consent","value":"granted"}},"interaction":{"drilldown":false},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"spacebring","hasAudioNarration":false,"actualSubdomain":"spacebring","customDomains":["www.spacebring.com"],"gitSource":{"type":"github","owner":"spacebring","repo":"spacebring-mono","deployBranch":"main","contentDirectory":"apps/docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6aecd09ab75211e6a46d60fa","collectionId":"51c5a7ff-a30a-4139-933f-46885475550c","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6aecd09ab75211e6a46d60fa"},"feedback":{"thumbs":true},"entitlements":{},"buildId":"6aee07232e4164cdd9d1ee33","clientVersion":"0.0.4076","searchFilterCounts":[{"language":"default","tag":"Developer resources","count":230},{"language":"default","tag":"APIs","count":225},{"language":"default","tag":"Docs","count":210},{"language":"default","tag":"Admin experience","count":193},{"language":"default","tag":"Billing","count":83},{"language":"default","tag":"Integrations","count":46},{"language":"default","tag":"Invoices","count":28},{"language":"default","tag":"Guides","count":28},{"language":"default","tag":"Resources","count":28},{"language":"default","tag":"Payments","count":27}]},"assistantConfig":{},"basePath":"/docs","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"[data-component-part=\"tab-content\"].hidden{display:block!important;visibility:hidden!important;height:0!important;overflow:hidden!important;pointer-events:none!important}"}],"page":{"pagePath":"developer/api/plans/retrieve-a-plan","slug":"/developer/api/plans/retrieve-a-plan","pageMetadata":{"title":"Retrieve a plan","description":"Retrieve a certain plan. \u003ch3>OAuth\u003c/h3>Required scopes: \u003ccode>plans.readonly\u003c/code> or \u003ccode>plans\u003c/code>","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /plans/v1/{planId}","href":"/developer/api/plans/retrieve-a-plan","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Retrieve a certain plan. \", _jsx(\"h3\", {\n children: \"OAuth\"\n }), \"Required scopes: \", _jsx(\"code\", {\n children: \"plans.readonly\"\n }), \" or \", _jsx(\"code\", {\n children: \"plans\"\n })]\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":"Retrieve a certain plan. \u003ch3>OAuth\u003c/h3>Required scopes: \u003ccode>plans.readonly\u003c/code> or \u003ccode>plans\u003c/code>","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /plans/v1/{planId}","href":"/developer/api/plans/retrieve-a-plan","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Plans"],"summary":"Retrieve a plan","description":"Retrieve a certain plan. \u003ch3>OAuth\u003c/h3>Required scopes: \u003ccode>plans.readonly\u003c/code> or \u003ccode>plans\u003c/code>","operationId":"getPlan","parameters":["8e51b051-4531-4a00-b39f-8b52eb5ef21b","7789cc94-a766-4a5b-9b0b-11a3edb53c55"],"security":["a878238f-fbbf-4b0e-8c54-bc698fad69a2","0342c0db-df18-499b-8661-e64431dffc3d"],"responses":{"200":"0ad98e8d-9760-44e3-b963-f27024414cc2","400":"b90ac376-de19-4d3e-8df0-e8eff2e611c4"},"method":"get","type":"path","servers":["3818a9a5-6331-4dfe-9434-c7a3057e158d"],"path":"/plans/v1/{planId}","baseUrlOptions":["https://api.spacebring.com"],"title":"Retrieve a plan","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"8e51b051-4531-4a00-b39f-8b52eb5ef21b":{"in":"path","name":"planId","required":true,"description":"The id of the plan.","schema":{"type":"string","format":"uuid","isRequired":true,"description":"The id of the plan.","uniqueKey":"","typeLabel":"string\u003cuuid>"}},"7789cc94-a766-4a5b-9b0b-11a3edb53c55":{"in":"header","name":"spacebring-network-id","schema":{"type":"string","format":"uuid","isRequired":false,"description":"The id of the network. Required when using bearer token authentication","uniqueKey":"","typeLabel":"string\u003cuuid>"},"required":false,"description":"The id of the network. Required when using bearer token authentication"}},"responses":{"0ad98e8d-9760-44e3-b963-f27024414cc2":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"plan":{"type":"object","properties":{"addons":{"default":[],"description":"Addons included in the plan.","type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the addon.","isRequired":true,"uniqueKey":"plan.addons.items.[INDEX].id","typeLabel":"string\u003cuuid>"}},"required":["id"],"additionalProperties":false,"uniqueKey":"plan.addons.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"plan.addons","typeLabel":"object[]"},"commitmentCycles":{"type":"number","description":"Number of billing cycles the member is committed to.","isRequired":true,"uniqueKey":"plan.commitmentCycles","typeLabel":"number"},"createDate":{"type":"string","format":"date-time","description":"ISO timestamp of when the plan was created.","isRequired":true,"uniqueKey":"plan.createDate","typeLabel":"string\u003cdate-time>"},"credits":{"type":"number","description":"Credits included in the plan.","isRequired":true,"uniqueKey":"plan.credits","typeLabel":"number"},"customTax":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether custom tax is enabled for the plan.","isRequired":true,"uniqueKey":"plan.customTax.enabled","typeLabel":"boolean"},"rate":{"type":"number","description":"Custom tax rate percentage.","isRequired":true,"uniqueKey":"plan.customTax.rate","typeLabel":"number"}},"required":["enabled","rate"],"additionalProperties":false,"description":"Custom tax settings.","isRequired":true,"uniqueKey":"plan.customTax","typeLabel":"object"},"dayPasses":{"type":"number","description":"Number of day passes included in the plan.","isRequired":true,"uniqueKey":"plan.dayPasses","typeLabel":"number"},"description":{"type":"string","description":"Description of the plan.","isRequired":true,"uniqueKey":"plan.description","typeLabel":"string"},"discounts":{"type":"object","properties":{"creditPackages":{"type":"number","description":"Discount percentage for credit packages.","isRequired":true,"uniqueKey":"plan.discounts.creditPackages","typeLabel":"number"},"desks":{"type":"number","description":"Discount percentage for desk bookings.","isRequired":true,"uniqueKey":"plan.discounts.desks","typeLabel":"number"},"equipment":{"type":"number","description":"Discount percentage for equipment bookings.","isRequired":true,"uniqueKey":"plan.discounts.equipment","typeLabel":"number"},"events":{"type":"number","description":"Discount percentage for events.","isRequired":true,"uniqueKey":"plan.discounts.events","typeLabel":"number"},"rooms":{"type":"number","description":"Discount percentage for room bookings.","isRequired":true,"uniqueKey":"plan.discounts.rooms","typeLabel":"number"},"shop":{"type":"number","description":"Discount percentage for shop products.","isRequired":true,"uniqueKey":"plan.discounts.shop","typeLabel":"number"}},"required":["creditPackages","desks","equipment","events","rooms","shop"],"additionalProperties":false,"description":"Percentage discounts applied to different product types.","deprecated":true,"isRequired":true,"uniqueKey":"plan.discounts","typeLabel":"object"},"exclusiveAccess":{"type":"object","properties":{"benefitRefs":{"type":"array","items":{"type":"string","format":"uuid","uniqueKey":"plan.exclusiveAccess.benefitRefs.items.[INDEX]","typeLabel":"string\u003cuuid>"},"description":"Benefit IDs with exclusive access for this plan.","isRequired":true,"uniqueKey":"plan.exclusiveAccess.benefitRefs","typeLabel":"string\u003cuuid>[]"},"resourceRefs":{"type":"array","items":{"type":"string","format":"uuid","uniqueKey":"plan.exclusiveAccess.resourceRefs.items.[INDEX]","typeLabel":"string\u003cuuid>"},"description":"Resource IDs with exclusive access for this plan.","isRequired":true,"uniqueKey":"plan.exclusiveAccess.resourceRefs","typeLabel":"string\u003cuuid>[]"}},"required":["benefitRefs","resourceRefs"],"additionalProperties":false,"description":"Resources and benefits exclusively available to members on this plan.","isRequired":true,"uniqueKey":"plan.exclusiveAccess","typeLabel":"object"},"grantedDiscounts":{"type":"array","items":{"type":"object","properties":{"coupon":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the coupon.","isRequired":true,"uniqueKey":"plan.grantedDiscounts.items.[INDEX].coupon.id","typeLabel":"string\u003cuuid>"},"amountOff":{"description":"Fixed discount amount.","type":"number","uniqueKey":"plan.grantedDiscounts.items.[INDEX].coupon.amountOff","typeLabel":"number"},"currencyCode":{"description":"Currency code for amountOff.","type":"string","uniqueKey":"plan.grantedDiscounts.items.[INDEX].coupon.currencyCode","typeLabel":"string"},"enabledForCredits":{"description":"Whether the coupon applies to credit purchases.","type":"boolean","uniqueKey":"plan.grantedDiscounts.items.[INDEX].coupon.enabledForCredits","typeLabel":"boolean"},"limitedItems":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether item-level limits are enabled.","isRequired":true,"uniqueKey":"plan.grantedDiscounts.items.[INDEX].coupon.limitedItems.enabled","typeLabel":"boolean"},"values":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the limited item.","isRequired":true,"uniqueKey":"plan.grantedDiscounts.items.[INDEX].coupon.limitedItems.values.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","enum":["roomBookings","eventSpaceBookings","conferenceRoomBookings","meetingRoomBookings","phoneBoothBookings","stationBookings","studioBookings","hotDeskBookings","dedicatedDeskBookings","officeBookings","parkingBookings","equipmentBookings","eventTickets","shopProducts","packages","subscriptionItems"],"description":"Product type of the limited item.","isRequired":true,"uniqueKey":"plan.grantedDiscounts.items.[INDEX].coupon.limitedItems.values.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"title":{"description":"Display name of the limited item.","type":"string","uniqueKey":"plan.grantedDiscounts.items.[INDEX].coupon.limitedItems.values.items.[INDEX].title","typeLabel":"string"}},"required":["id","type"],"additionalProperties":false,"description":"Product or package the coupon is limited to.","uniqueKey":"plan.grantedDiscounts.items.[INDEX].coupon.limitedItems.values.items.[INDEX]","typeLabel":"object"},"description":"Items the coupon applies to when limits are enabled.","isRequired":true,"uniqueKey":"plan.grantedDiscounts.items.[INDEX].coupon.limitedItems.values","typeLabel":"object[]"}},"required":["enabled","values"],"additionalProperties":false,"description":"Item-level redemption limits.","uniqueKey":"plan.grantedDiscounts.items.[INDEX].coupon.limitedItems","typeLabel":"object"},"limitedRedemption":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether redemption limits are enabled.","isRequired":true,"uniqueKey":"plan.grantedDiscounts.items.[INDEX].coupon.limitedRedemption.enabled","typeLabel":"boolean"},"usage":{"type":"number","description":"Current redemption count.","isRequired":true,"uniqueKey":"plan.grantedDiscounts.items.[INDEX].coupon.limitedRedemption.usage","typeLabel":"number"},"value":{"type":"number","description":"Maximum redemption count.","isRequired":true,"uniqueKey":"plan.grantedDiscounts.items.[INDEX].coupon.limitedRedemption.value","typeLabel":"number"}},"required":["enabled","usage","value"],"additionalProperties":false,"description":"Redemption limits for the coupon.","uniqueKey":"plan.grantedDiscounts.items.[INDEX].coupon.limitedRedemption","typeLabel":"object"},"percentOff":{"description":"Percentage discount.","type":"number","uniqueKey":"plan.grantedDiscounts.items.[INDEX].coupon.percentOff","typeLabel":"number"},"productTypes":{"type":"array","items":{"type":"string","enum":["roomBookings","eventSpaceBookings","conferenceRoomBookings","meetingRoomBookings","phoneBoothBookings","stationBookings","studioBookings","hotDeskBookings","dedicatedDeskBookings","officeBookings","parkingBookings","equipmentBookings","eventTickets","shopProducts","packages","subscriptionItems"],"uniqueKey":"plan.grantedDiscounts.items.[INDEX].coupon.productTypes.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"Product types the coupon applies to.","uniqueKey":"plan.grantedDiscounts.items.[INDEX].coupon.productTypes","typeLabel":"enum\u003cstring>[]"}},"required":["id"],"additionalProperties":false,"description":"Granted coupon details.","isRequired":true,"uniqueKey":"plan.grantedDiscounts.items.[INDEX].coupon","typeLabel":"object"}},"required":["coupon"],"additionalProperties":false,"uniqueKey":"plan.grantedDiscounts.items.[INDEX]","typeLabel":"object"},"description":"Coupons granted to members on this plan.","isRequired":true,"uniqueKey":"plan.grantedDiscounts","typeLabel":"object[]"},"id":{"type":"string","format":"uuid","description":"Unique identifier of the plan.","isRequired":true,"uniqueKey":"plan.id","typeLabel":"string\u003cuuid>"},"locale":{"type":"string","description":"Auto-detected language of the description.","isRequired":true,"uniqueKey":"plan.locale","typeLabel":"string"},"locationRef":{"type":"string","format":"uuid","description":"ID of the location this plan belongs to.","isRequired":true,"uniqueKey":"plan.locationRef","typeLabel":"string\u003cuuid>"},"media":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":"Storage key of the media file.","isRequired":true,"uniqueKey":"plan.media.items.[INDEX].key","typeLabel":"string"},"url":{"type":"string","description":"Public URL of the media file.","isRequired":true,"uniqueKey":"plan.media.items.[INDEX].url","typeLabel":"string"}},"required":["key","url"],"additionalProperties":false,"uniqueKey":"plan.media.items.[INDEX]","typeLabel":"object"},"description":"Media files attached to this plan. The first is its cover image.","isRequired":true,"uniqueKey":"plan.media","typeLabel":"object[]"},"period":{"type":"string","enum":["day","week","month","threeMonths","sixMonths","year"],"description":"Billing period of the plan.","isRequired":true,"uniqueKey":"plan.period","typeLabel":"enum\u003cstring>"},"price":{"type":"number","description":"Price of the plan.","isRequired":true,"uniqueKey":"plan.price","typeLabel":"number"},"selfSignup":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether members can self-sign up to this plan.","isRequired":true,"uniqueKey":"plan.selfSignup.enabled","typeLabel":"boolean"},"type":{"type":"string","enum":["immediate","request"],"description":"Self sign-up flow type.","isRequired":true,"uniqueKey":"plan.selfSignup.type","typeLabel":"enum\u003cstring>"}},"required":["enabled","type"],"additionalProperties":false,"description":"Self sign-up settings.","isRequired":true,"uniqueKey":"plan.selfSignup","typeLabel":"object"},"setupFee":{"type":"number","description":"One-time setup fee charged when subscribing.","isRequired":true,"uniqueKey":"plan.setupFee","typeLabel":"number"},"title":{"type":"string","description":"Display name of the plan.","isRequired":true,"uniqueKey":"plan.title","typeLabel":"string"},"access":{"description":"Third-party access integrations configured for the plan.","type":"object","properties":{"avigilonAltaGroupRef":{"type":"number","description":"Avigilon Alta access group reference.","uniqueKey":"plan.access.avigilonAltaGroupRef","typeLabel":"number"},"brivoGroupRef":{"type":"number","description":"Brivo access group reference.","uniqueKey":"plan.access.brivoGroupRef","typeLabel":"number"},"kisiGroupRef":{"type":"number","description":"Kisi access group reference.","uniqueKey":"plan.access.kisiGroupRef","typeLabel":"number"},"saltoksAccessGroupRef":{"type":"string","format":"uuid","description":"Salto KS access group reference.","uniqueKey":"plan.access.saltoksAccessGroupRef","typeLabel":"string\u003cuuid>"},"tapkeyGroupRef":{"type":"string","format":"uuid","description":"Tapkey access group reference.","uniqueKey":"plan.access.tapkeyGroupRef","typeLabel":"string\u003cuuid>"},"unifiAccessGroupRef":{"type":"string","description":"UniFi Access policy reference.","uniqueKey":"plan.access.unifiAccessGroupRef","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"plan.access","typeLabel":"object"},"printing":{"description":"Printing integration settings.","type":"object","properties":{"ezeepBlueGroupRef":{"type":"string","format":"uuid","description":"Ezeep Blue printing group reference.","isRequired":true,"uniqueKey":"plan.printing.ezeepBlueGroupRef","typeLabel":"string\u003cuuid>"}},"required":["ezeepBlueGroupRef"],"additionalProperties":false,"uniqueKey":"plan.printing","typeLabel":"object"}},"required":["addons","commitmentCycles","createDate","credits","customTax","dayPasses","description","discounts","exclusiveAccess","grantedDiscounts","id","locale","locationRef","media","period","price","selfSignup","setupFee","title"],"additionalProperties":false,"description":"The plan.","isRequired":true,"uniqueKey":"plan","typeLabel":"object"}},"required":["plan"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"plan":{"addons":[],"commitmentCycles":123,"createDate":"2023-11-07T05:31:56Z","credits":123,"customTax":{"enabled":true,"rate":123},"dayPasses":123,"description":"\u003cstring>","discounts":{"creditPackages":123,"desks":123,"equipment":123,"events":123,"rooms":123,"shop":123},"exclusiveAccess":{"benefitRefs":["3c90c3cc-0d44-4b50-8888-8dd25736052a"],"resourceRefs":["3c90c3cc-0d44-4b50-8888-8dd25736052a"]},"grantedDiscounts":[{"coupon":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","amountOff":123,"currencyCode":"\u003cstring>","enabledForCredits":true,"limitedItems":{"enabled":true,"values":[{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","type":"roomBookings","title":"\u003cstring>"}]},"limitedRedemption":{"enabled":true,"usage":123,"value":123},"percentOff":123,"productTypes":["roomBookings"]}}],"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","locale":"\u003cstring>","locationRef":"3c90c3cc-0d44-4b50-8888-8dd25736052a","media":[{"key":"\u003cstring>","url":"\u003cstring>"}],"period":"day","price":123,"selfSignup":{"enabled":true,"type":"immediate"},"setupFee":123,"title":"\u003cstring>","access":{"avigilonAltaGroupRef":123,"brivoGroupRef":123,"kisiGroupRef":123,"saltoksAccessGroupRef":"3c90c3cc-0d44-4b50-8888-8dd25736052a","tapkeyGroupRef":"3c90c3cc-0d44-4b50-8888-8dd25736052a","unifiAccessGroupRef":"\u003cstring>"},"printing":{"ezeepBlueGroupRef":"3c90c3cc-0d44-4b50-8888-8dd25736052a"}}}}},"exampleType":"generated"}},"exampleType":"generated"},"b90ac376-de19-4d3e-8df0-e8eff2e611c4":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","uniqueKey":"message","typeLabel":"string"},"type":{"type":"string","uniqueKey":"type","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","type":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"a878238f-fbbf-4b0e-8c54-bc698fad69a2":{"BasicAuth":{"type":"http","description":"See our [authentication documentation](https://www.spacebring.com/docs/developer/api/authentication#basic-authentication) for how to authorize your requests","scheme":"basic","scopes":[],"schemeName":"BasicAuth"}},"0342c0db-df18-499b-8661-e64431dffc3d":{"OAuth2":{"type":"oauth2","description":"See our [authentication documentation](https://www.spacebring.com/docs/developer/api/authentication#oauth2) for how to authorize your requests","flows":{"authorizationCode":{"authorizationUrl":"https://oauth2.spacebring.com/api/oauth2/authorize","tokenUrl":"https://oauth2.spacebring.com/api/oauth2/token","refreshUrl":"https://oauth2.spacebring.com/api/oauth2/token","scopes":{"benefits.readonly":"Read benefits and applications","benefits":"Read and write benefits and applications","checkIns.readonly":"Read check-ins","checkIns":"Read and write check-ins","community.readonly":"Read community companies and memberships","community":"Read and write community companies and memberships","events.readonly":"Read events and tickets","events":"Read and write events and tickets","feed.readonly":"Read feed posts","feed":"Read and write feed posts","invoices.readonly":"Read contracts, credit notes, discounts and invoices","invoices":"Read and write contract, credit notes, discounts and invoices","locations.readonly":"Read locations","locations":"Read and write locations","plans.readonly":"Read plans","plans":"Read and write plans","resources.readonly":"Read resources and bookings","resources":"Read and write resources and bookings","subscriptions.readonly":"Read subscriptions","subscriptions":"Read and write subscriptions","shop.readonly":"Read products and orders","shop":"Read and write products and orders","support.readonly":"Read support tickets","support":"Read and write support tickets","transactions.readonly":"Read transactions","transactions":"Read and write transactions","visitors.readonly":"Read visitors","visitors":"Read and write visitors"}}},"scopes":["plans.readonly","plans"],"schemeName":"OAuth2"}}},"servers":{"3818a9a5-6331-4dfe-9434-c7a3057e158d":{"url":"https://api.spacebring.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","description":"See our [authentication documentation](https://www.spacebring.com/docs/developer/api/authentication#basic-authentication) for how to authorize your requests","scheme":"basic","scopes":[],"schemeName":"BasicAuth"},"schema":{"title":"Basic Auth","type":"object","description":"See our [authentication documentation](https://www.spacebring.com/docs/developer/api/authentication#basic-authentication) for how to authorize your requests","isRequired":true,"properties":{"username":{"type":"string","uniqueKey":"username","isRequired":true,"typeLabel":"string","deprecated":false},"password":{"type":"string","uniqueKey":"password","isRequired":true,"typeLabel":"string","deprecated":false}},"additionalProperties":false,"deprecated":false},"schemeName":"BasicAuth","name":"Authorization"}],"title":"BasicAuth"},{"schemes":[{"scheme":{"type":"oauth2","description":"See our [authentication documentation](https://www.spacebring.com/docs/developer/api/authentication#oauth2) for how to authorize your requests","flows":{"authorizationCode":{"authorizationUrl":"https://oauth2.spacebring.com/api/oauth2/authorize","tokenUrl":"https://oauth2.spacebring.com/api/oauth2/token","refreshUrl":"https://oauth2.spacebring.com/api/oauth2/token","scopes":{"benefits.readonly":"Read benefits and applications","benefits":"Read and write benefits and applications","checkIns.readonly":"Read check-ins","checkIns":"Read and write check-ins","community.readonly":"Read community companies and memberships","community":"Read and write community companies and memberships","events.readonly":"Read events and tickets","events":"Read and write events and tickets","feed.readonly":"Read feed posts","feed":"Read and write feed posts","invoices.readonly":"Read contracts, credit notes, discounts and invoices","invoices":"Read and write contract, credit notes, discounts and invoices","locations.readonly":"Read locations","locations":"Read and write locations","plans.readonly":"Read plans","plans":"Read and write plans","resources.readonly":"Read resources and bookings","resources":"Read and write resources and bookings","subscriptions.readonly":"Read subscriptions","subscriptions":"Read and write subscriptions","shop.readonly":"Read products and orders","shop":"Read and write products and orders","support.readonly":"Read support tickets","support":"Read and write support tickets","transactions.readonly":"Read transactions","transactions":"Read and write transactions","visitors.readonly":"Read visitors","visitors":"Read and write visitors"}}},"scopes":["plans.readonly","plans"],"schemeName":"OAuth2"},"schema":{"title":"OAuth2 Auth","type":"string","isRequired":true,"description":"See our [authentication documentation](https://www.spacebring.com/docs/developer/api/authentication#oauth2) for how to authorize your requests","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"OAuth2","name":"Authorization"}],"title":"OAuth2"}]},"originalFileLocation":"assets/openapi.json"},"subdomain":"spacebring","siteName":"Spacebring Docs","title":"Retrieve a plan - Spacebring Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-06T14:15:05.848Z","originalFileLocation":"developer/api/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=\"Retrieve a certain plan. OAuthRequired scopes: plans.readonly or plans\">\u003cmeta data-mint-head name=\"application-name\" content=\"Spacebring Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/spacebring/YJ_pXMVKGxwLzz_x/_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=\"/docs/mintlify-assets/_mintlify/favicons/spacebring/YJ_pXMVKGxwLzz_x/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/spacebring/YJ_pXMVKGxwLzz_x/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/spacebring/YJ_pXMVKGxwLzz_x/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/spacebring/YJ_pXMVKGxwLzz_x/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/spacebring/YJ_pXMVKGxwLzz_x/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/spacebring/YJ_pXMVKGxwLzz_x/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/spacebring/YJ_pXMVKGxwLzz_x/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/spacebring/YJ_pXMVKGxwLzz_x/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Retrieve a plan - Spacebring Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieve a certain plan. OAuthRequired scopes: plans.readonly or plans\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Spacebring Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://www.spacebring.com/docs/developer/api/plans/retrieve-a-plan\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://spacebring.mintlify.site/docs/_mintlify/api/og/v2?division=Plans\u0026amp;title=Retrieve+a+plan\u0026amp;description=Retrieve+a+certain+plan.+%3Ch3%3EOAuth%3C%2Fh3%3ERequired+scopes%3A+%3Ccode%3Eplans.readonly%3C%2Fcode%3E+or+%3Ccode%3Eplans%3C%2Fcode%3E\u0026amp;theme=d0b0508e0910b4cedd4270e7\u0026amp;signature=8dc6dc9d648053dec871d965ec7a0abae0a6f776722b3e94d29d2cb54f37e2f1\">\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 - Spacebring Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieve a certain plan. OAuthRequired scopes: plans.readonly or plans\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://spacebring.mintlify.site/docs/_mintlify/api/og/v2?division=Plans\u0026amp;title=Retrieve+a+plan\u0026amp;description=Retrieve+a+certain+plan.+%3Ch3%3EOAuth%3C%2Fh3%3ERequired+scopes%3A+%3Ccode%3Eplans.readonly%3C%2Fcode%3E+or+%3Ccode%3Eplans%3C%2Fcode%3E\u0026amp;theme=d0b0508e0910b4cedd4270e7\u0026amp;signature=8dc6dc9d648053dec871d965ec7a0abae0a6f776722b3e94d29d2cb54f37e2f1\">\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=\"/docs/mintlify-assets/_mintlify/favicons/spacebring/YJ_pXMVKGxwLzz_x/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Spacebring Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#00928F\">\u003clink data-mint-head rel=\"canonical\" href=\"https://www.spacebring.com/docs/developer/api/plans/retrieve-a-plan\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/developer/api/plans/retrieve-a-plan.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://www.spacebring.com/#organization\",\"name\":\"Spacebring Docs\",\"url\":\"https://www.spacebring.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/spacebring/ElSlMekJ2CB5Dog7/logo/light.svg?fit=max\u0026auto=format\u0026n=ElSlMekJ2CB5Dog7\u0026q=85\u0026s=29b9c3bc15b6d346f2c13cccf246e486\"}},{\"@type\":\"WebSite\",\"@id\":\"https://www.spacebring.com/docs#website\",\"name\":\"Spacebring Docs\",\"url\":\"https://www.spacebring.com/docs\",\"publisher\":{\"@id\":\"https://www.spacebring.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://www.spacebring.com/docs/developer/api/plans/retrieve-a-plan#webpage\",\"url\":\"https://www.spacebring.com/docs/developer/api/plans/retrieve-a-plan\",\"name\":\"Retrieve a plan\",\"description\":\"Retrieve a certain plan. OAuthRequired scopes: plans.readonly or plans\",\"dateModified\":\"2026-11-06T14:15:05.848Z\",\"isPartOf\":{\"@id\":\"https://www.spacebring.com/docs#website\"},\"breadcrumb\":{\"@id\":\"https://www.spacebring.com/docs/developer/api/plans/retrieve-a-plan#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://www.spacebring.com/docs/developer/api/plans/retrieve-a-plan#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"APIs\",\"item\":\"https://www.spacebring.com/docs/developer/api/authentication\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Plans\",\"item\":\"https://www.spacebring.com/docs/developer/api/plans/retrieve-plans\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Retrieve a plan\",\"item\":\"https://www.spacebring.com/docs/developer/api/plans/retrieve-a-plan\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://www.spacebring.com/docs/developer/api/plans/retrieve-a-plan#apireference\",\"headline\":\"Retrieve a plan\",\"name\":\"Retrieve a plan\",\"description\":\"Retrieve a certain plan. OAuthRequired scopes: plans.readonly or plans\",\"url\":\"https://www.spacebring.com/docs/developer/api/plans/retrieve-a-plan\",\"mainEntityOfPage\":{\"@id\":\"https://www.spacebring.com/docs/developer/api/plans/retrieve-a-plan#webpage\"},\"dateModified\":\"2026-11-06T14:15:05.848Z\",\"publisher\":{\"@id\":\"https://www.spacebring.com/#organization\"},\"isPartOf\":{\"@id\":\"https://www.spacebring.com/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Spacebring Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Spacebring Docs","nav":{"global":null,"tabs":[{"tab":"Docs","pages":[{"title":"Docs","href":""}]},{"tab":"Guides","pages":[{"title":"Guides","href":"/guides/automate-onboarding-and-follow-ups"}]},{"tab":"Developer resources","groups":[{"group":"Overview","boost":0.1,"pages":[{"title":"Introduction","icon":"code","href":"/developer"},{"title":"Guides","icon":"map","href":"/developer/guides"},{"title":"Changelog","icon":"clock-rotate-left","href":"/developer/changelog"}]},{"group":"APIs","boost":0.1,"pages":[{"title":"Authentication","href":"/developer/api/authentication"},{"title":"Pagination","href":"/developer/api/pagination"},{"title":"Rate limiting","href":"/developer/api/rate-limiting"},{"title":"File uploads","href":"/developer/api/file-uploads"},{"title":"OpenAPI spec","href":"/developer/api/openapi-spec"},{"group":"Alternative currencies","pages":[{"title":"Retrieve alternative currencies","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /alt_currencies/v1","href":"/developer/api/alternative-currencies/retrieve-alternative-currencies"},{"title":"Create an alternative currency","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /alt_currencies/v1","href":"/developer/api/alternative-currencies/create-an-alternative-currency"},{"title":"Retrieve an alternative currency","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /alt_currencies/v1/{id}","href":"/developer/api/alternative-currencies/retrieve-an-alternative-currency"},{"title":"Delete an alternative currency","deprecated":null,"version":null,"openapi":"/assets/openapi.json delete /alt_currencies/v1/{id}","href":"/developer/api/alternative-currencies/delete-an-alternative-currency"},{"title":"Update an alternative currency","deprecated":null,"version":null,"openapi":"/assets/openapi.json patch /alt_currencies/v1/{id}","href":"/developer/api/alternative-currencies/update-an-alternative-currency"}]},{"group":"Benefits","pages":[{"title":"Retrieve categories","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /benefits/categories/v1","href":"/developer/api/benefits/retrieve-categories"},{"title":"Create a category","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /benefits/categories/v1","href":"/developer/api/benefits/create-a-category"},{"title":"Get a category","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /benefits/categories/v1/{categoryId}","href":"/developer/api/benefits/get-a-category"},{"title":"Update a category","deprecated":null,"version":null,"openapi":"/assets/openapi.json put /benefits/categories/v1/{categoryId}","href":"/developer/api/benefits/update-a-category"},{"title":"Delete a category","deprecated":null,"version":null,"openapi":"/assets/openapi.json delete /benefits/categories/v1/{categoryId}","href":"/developer/api/benefits/delete-a-category"},{"title":"Retrieve benefits","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /benefits/v1","href":"/developer/api/benefits/retrieve-benefits"},{"title":"Create a benefit","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /benefits/v1","href":"/developer/api/benefits/create-a-benefit"},{"title":"Retrieve a benefit","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /benefits/v1/{benefitId}","href":"/developer/api/benefits/retrieve-a-benefit"},{"title":"Update a benefit","deprecated":null,"version":null,"openapi":"/assets/openapi.json put /benefits/v1/{benefitId}","href":"/developer/api/benefits/update-a-benefit"},{"title":"Delete a benefit","deprecated":null,"version":null,"openapi":"/assets/openapi.json delete /benefits/v1/{benefitId}","href":"/developer/api/benefits/delete-a-benefit"},{"title":"Partially update a benefit","deprecated":null,"version":null,"openapi":"/assets/openapi.json patch /benefits/v1/{benefitId}","href":"/developer/api/benefits/partially-update-a-benefit"},{"title":"Create a media upload","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /benefits/v1/media","href":"/developer/api/benefits/create-a-media-upload"},{"title":"Retrieve applications","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /benefits/applications/v1","href":"/developer/api/benefits/retrieve-applications"},{"title":"Apply for a benefit","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /benefits/applications/v1","href":"/developer/api/benefits/apply-for-a-benefit"},{"title":"Retrieve an application","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /benefits/applications/v1/{benefitApplicationId}","href":"/developer/api/benefits/retrieve-an-application"}]},{"group":"Billing","pages":[{"title":"Retrieve invoices","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /billing/invoices/v1","href":"/developer/api/billing/retrieve-invoices"},{"title":"Create an invoice","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /billing/invoices/v1","href":"/developer/api/billing/create-an-invoice"},{"title":"Retrieve an invoice","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /billing/invoices/v1/{invoiceId}","href":"/developer/api/billing/retrieve-an-invoice"},{"title":"Delete an invoice","deprecated":null,"version":null,"openapi":"/assets/openapi.json delete /billing/invoices/v1/{invoiceId}","href":"/developer/api/billing/delete-an-invoice"},{"title":"Update an invoice","deprecated":null,"version":null,"openapi":"/assets/openapi.json patch /billing/invoices/v1/{invoiceId}","href":"/developer/api/billing/update-an-invoice"},{"title":"Cancel a payment","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /billing/invoices/v1/{invoiceId}/cancel_payment","href":"/developer/api/billing/cancel-a-payment"},{"title":"Duplicate an invoice","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /billing/invoices/v1/{invoiceId}/duplicate","href":"/developer/api/billing/duplicate-an-invoice"},{"title":"Issue an invoice","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /billing/invoices/v1/{invoiceId}/issue","href":"/developer/api/billing/issue-an-invoice"},{"title":"Pay an invoice","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /billing/invoices/v1/{invoiceId}/pay","href":"/developer/api/billing/pay-an-invoice"},{"title":"Resend an invoice","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /billing/invoices/v1/{invoiceId}/resend","href":"/developer/api/billing/resend-an-invoice"},{"title":"Void an invoice","deprecated":null,"version":null,"openapi":"/assets/openapi.json patch /billing/invoices/v1/{invoiceId}/void","href":"/developer/api/billing/void-an-invoice"},{"title":"List invoice items","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /billing/invoices/v1/items","href":"/developer/api/billing/list-invoice-items"},{"title":"Create an invoice item","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /billing/invoices/v1/items","href":"/developer/api/billing/create-an-invoice-item"},{"title":"Retrieve an invoice item","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /billing/invoices/v1/items/{id}","href":"/developer/api/billing/retrieve-an-invoice-item"},{"title":"Delete an invoice item","deprecated":null,"version":null,"openapi":"/assets/openapi.json delete /billing/invoices/v1/items/{id}","href":"/developer/api/billing/delete-an-invoice-item"},{"title":"Update an invoice item","deprecated":null,"version":null,"openapi":"/assets/openapi.json patch /billing/invoices/v1/items/{id}","href":"/developer/api/billing/update-an-invoice-item"},{"title":"List upcoming invoice items","deprecated":true,"version":null,"openapi":"/assets/openapi.json get /billing/invoices/v1/items/upcoming","href":"/developer/api/billing/list-upcoming-invoice-items"},{"title":"Retrieve the upcoming invoice","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /billing/invoices/v1/upcoming","href":"/developer/api/billing/retrieve-the-upcoming-invoice"},{"title":"Retrieve credit notes","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /billing/credit_notes/v1","href":"/developer/api/billing/retrieve-credit-notes"},{"title":"Create a credit note","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /billing/credit_notes/v1","href":"/developer/api/billing/create-a-credit-note"},{"title":"Retrieve a credit note","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /billing/credit_notes/v1/{id}","href":"/developer/api/billing/retrieve-a-credit-note"},{"title":"Update a credit note","deprecated":null,"version":null,"openapi":"/assets/openapi.json patch /billing/credit_notes/v1/{id}","href":"/developer/api/billing/update-a-credit-note"},{"title":"Void a credit note","deprecated":null,"version":null,"openapi":"/assets/openapi.json put /billing/credit_notes/v1/{id}/void","href":"/developer/api/billing/void-a-credit-note"},{"title":"Preview a credit note","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /billing/credit_notes/v1/preview","href":"/developer/api/billing/preview-a-credit-note"}]},{"group":"Check-ins","pages":[{"title":"Retrieve check-ins","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /check_ins/v1","href":"/developer/api/check-ins/retrieve-check-ins"},{"title":"Get a check-in","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /check_ins/v1/{checkInId}","href":"/developer/api/check-ins/get-a-check-in"},{"title":"Update a check-in","deprecated":null,"version":null,"openapi":"/assets/openapi.json patch /check_ins/v1/{checkInId}","href":"/developer/api/check-ins/update-a-check-in"},{"title":"Check in","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /check_ins/v1/checkin","href":"/developer/api/check-ins/check-in"},{"title":"Check out","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /check_ins/v1/checkout","href":"/developer/api/check-ins/check-out"}]},{"group":"Community","pages":[{"title":"Retrieve companies","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /community/companies/v1","href":"/developer/api/community/retrieve-companies"},{"title":"Create a company","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /community/companies/v1","href":"/developer/api/community/create-a-company"},{"title":"Retrieve a company","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /community/companies/v1/{id}","href":"/developer/api/community/retrieve-a-company"},{"title":"Update a company","deprecated":null,"version":null,"openapi":"/assets/openapi.json put /community/companies/v1/{id}","href":"/developer/api/community/update-a-company"},{"title":"Create a logo upload","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /community/companies/v1/media","href":"/developer/api/community/create-a-logo-upload"},{"title":"Retrieve memberships","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /community/memberships/v1","href":"/developer/api/community/retrieve-memberships"},{"title":"Create a membership","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /community/memberships/v1","href":"/developer/api/community/create-a-membership"},{"title":"Retrieve a membership","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /community/memberships/v1/{id}","href":"/developer/api/community/retrieve-a-membership"},{"title":"Update a membership","deprecated":null,"version":null,"openapi":"/assets/openapi.json put /community/memberships/v1/{id}","href":"/developer/api/community/update-a-membership"},{"title":"Delete a membership","deprecated":null,"version":null,"openapi":"/assets/openapi.json delete /community/memberships/v1/{id}","href":"/developer/api/community/delete-a-membership"},{"title":"Retrieve deleted memberships","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /community/memberships/v1/deleted","href":"/developer/api/community/retrieve-deleted-memberships"}]},{"group":"Contracts","pages":[{"title":"Retrieve contracts","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /contracts/v1","href":"/developer/api/contracts/retrieve-contracts"},{"title":"Create a contract","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /contracts/v1","href":"/developer/api/contracts/create-a-contract"},{"title":"Get a contract","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /contracts/v1/{contractId}","href":"/developer/api/contracts/get-a-contract"},{"title":"Delete a contract","deprecated":null,"version":null,"openapi":"/assets/openapi.json delete /contracts/v1/{contractId}","href":"/developer/api/contracts/delete-a-contract"},{"title":"Update a contract","deprecated":null,"version":null,"openapi":"/assets/openapi.json patch /contracts/v1/{contractId}","href":"/developer/api/contracts/update-a-contract"},{"title":"Issue a contract","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /contracts/v1/{contractId}/issue","href":"/developer/api/contracts/issue-a-contract"},{"title":"Resend a contract","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /contracts/v1/{contractId}/resend","href":"/developer/api/contracts/resend-a-contract"},{"title":"Decline a contract","deprecated":null,"version":null,"openapi":"/assets/openapi.json put /contracts/v1/{contractId}/signers/{signerId}/decline","href":"/developer/api/contracts/decline-a-contract"},{"title":"Sign a contract","deprecated":null,"version":null,"openapi":"/assets/openapi.json put /contracts/v1/{contractId}/signers/{signerId}/sign","href":"/developer/api/contracts/sign-a-contract"},{"title":"Terminate a contract","deprecated":null,"version":null,"openapi":"/assets/openapi.json patch /contracts/v1/{contractId}/terminate","href":"/developer/api/contracts/terminate-a-contract"},{"title":"Retrieve templates","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /contracts/templates/v1","href":"/developer/api/contracts/retrieve-templates"},{"title":"Create a template","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /contracts/templates/v1","href":"/developer/api/contracts/create-a-template"},{"title":"Create a template upload","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /contracts/templates/v1/media","href":"/developer/api/contracts/create-a-template-upload"},{"title":"Retrieve a template","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /contracts/templates/v1/{templateId}","href":"/developer/api/contracts/retrieve-a-template"},{"title":"Delete a template","deprecated":null,"version":null,"openapi":"/assets/openapi.json delete /contracts/templates/v1/{templateId}","href":"/developer/api/contracts/delete-a-template"},{"title":"Update a template","deprecated":null,"version":null,"openapi":"/assets/openapi.json patch /contracts/templates/v1/{templateId}","href":"/developer/api/contracts/update-a-template"},{"title":"Duplicate a template","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /contracts/templates/v1/{templateId}/duplicate","href":"/developer/api/contracts/duplicate-a-template"}]},{"group":"Discounts","pages":[{"title":"Retrieve coupons","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /discounts/v1/coupons","href":"/developer/api/discounts/retrieve-coupons"},{"title":"Create a coupon","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /discounts/v1/coupons","href":"/developer/api/discounts/create-a-coupon"},{"title":"Get a coupon","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /discounts/v1/coupons/{id}","href":"/developer/api/discounts/get-a-coupon"},{"title":"Delete a coupon","deprecated":null,"version":null,"openapi":"/assets/openapi.json delete /discounts/v1/coupons/{id}","href":"/developer/api/discounts/delete-a-coupon"},{"title":"Update a coupon","deprecated":null,"version":null,"openapi":"/assets/openapi.json patch /discounts/v1/coupons/{id}","href":"/developer/api/discounts/update-a-coupon"},{"title":"Retrieve promocodes","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /discounts/v1/promocodes","href":"/developer/api/discounts/retrieve-promocodes"},{"title":"Create a promocode","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /discounts/v1/promocodes","href":"/developer/api/discounts/create-a-promocode"},{"title":"Get a promocode","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /discounts/v1/promocodes/{id}","href":"/developer/api/discounts/get-a-promocode"},{"title":"Archive a promocode","deprecated":null,"version":null,"openapi":"/assets/openapi.json put /discounts/v1/promocodes/{id}/archive","href":"/developer/api/discounts/archive-a-promocode"},{"title":"Retrieve redemptions","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /discounts/v1/redemptions","href":"/developer/api/discounts/retrieve-redemptions"}]},{"group":"Events","pages":[{"title":"Retrieve events","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /events/v1","href":"/developer/api/events/retrieve-events"},{"title":"Create an event","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /events/v1","href":"/developer/api/events/create-an-event"},{"title":"Retrieve an event","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /events/v1/{id}","href":"/developer/api/events/retrieve-an-event"},{"title":"Update an event","deprecated":null,"version":null,"openapi":"/assets/openapi.json put /events/v1/{id}","href":"/developer/api/events/update-an-event"},{"title":"Delete an event","deprecated":null,"version":null,"openapi":"/assets/openapi.json delete /events/v1/{id}","href":"/developer/api/events/delete-an-event"},{"title":"Partially update an event","deprecated":null,"version":null,"openapi":"/assets/openapi.json patch /events/v1/{id}","href":"/developer/api/events/partially-update-an-event"},{"title":"Cancel an event","deprecated":null,"version":null,"openapi":"/assets/openapi.json put /events/v1/{id}/cancel","href":"/developer/api/events/cancel-an-event"},{"title":"Copy an event","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /events/v1/{id}/copy","href":"/developer/api/events/copy-an-event"},{"title":"Add event hosts","deprecated":null,"version":null,"openapi":"/assets/openapi.json put /events/v1/{id}/hosts","href":"/developer/api/events/add-event-hosts"},{"title":"Create a media upload","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /events/v1/media","href":"/developer/api/events/create-a-media-upload"},{"title":"Retrieve tickets","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /events/tickets/v1","href":"/developer/api/events/retrieve-tickets"},{"title":"Retrieve a ticket","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /events/tickets/v1/{id}","href":"/developer/api/events/retrieve-a-ticket"},{"title":"Update a ticket","deprecated":null,"version":null,"openapi":"/assets/openapi.json put /events/tickets/v1/{id}","href":"/developer/api/events/update-a-ticket"},{"title":"Delete a ticket","deprecated":null,"version":null,"openapi":"/assets/openapi.json delete /events/tickets/v1/{id}","href":"/developer/api/events/delete-a-ticket"},{"title":"Check in a ticket","deprecated":true,"version":null,"openapi":"/assets/openapi.json post /events/tickets/v1/{id}/checkin","href":"/developer/api/events/check-in-a-ticket"}]},{"group":"Feed","pages":[{"title":"Get posts","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /feed/posts/v1","href":"/developer/api/feed/get-posts"},{"title":"Create a post","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /feed/posts/v1","href":"/developer/api/feed/create-a-post"},{"title":"Get a post","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /feed/posts/v1/{id}","href":"/developer/api/feed/get-a-post"},{"title":"Update a post","deprecated":null,"version":null,"openapi":"/assets/openapi.json put /feed/posts/v1/{id}","href":"/developer/api/feed/update-a-post"},{"title":"Delete a post","deprecated":null,"version":null,"openapi":"/assets/openapi.json delete /feed/posts/v1/{id}","href":"/developer/api/feed/delete-a-post"},{"title":"Partially update a post","deprecated":null,"version":null,"openapi":"/assets/openapi.json patch /feed/posts/v1/{id}","href":"/developer/api/feed/partially-update-a-post"},{"title":"Get comments for a post","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /feed/posts/v1/{id}/comments","href":"/developer/api/feed/get-comments-for-a-post"},{"title":"Get likes for a post","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /feed/posts/v1/{id}/likes","href":"/developer/api/feed/get-likes-for-a-post"},{"title":"Create a like for a post","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /feed/posts/v1/{id}/likes","href":"/developer/api/feed/create-a-like-for-a-post"},{"title":"Delete a like for a post","deprecated":null,"version":null,"openapi":"/assets/openapi.json delete /feed/posts/v1/{id}/likes","href":"/developer/api/feed/delete-a-like-for-a-post"},{"title":"Create a post comment","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /feed/comments/v1","href":"/developer/api/feed/create-a-post-comment"},{"title":"Delete a post comment","deprecated":null,"version":null,"openapi":"/assets/openapi.json delete /feed/comments/v1/{id}","href":"/developer/api/feed/delete-a-post-comment"},{"title":"Create a like for a post comment","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /feed/comments/v1/{id}/likes","href":"/developer/api/feed/create-a-like-for-a-post-comment"},{"title":"Delete a like for a post comment","deprecated":null,"version":null,"openapi":"/assets/openapi.json delete /feed/comments/v1/{id}/likes","href":"/developer/api/feed/delete-a-like-for-a-post-comment"},{"title":"Create a media upload","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /feed/v1/media","href":"/developer/api/feed/create-a-media-upload"}]},{"group":"Floors","pages":[{"title":"Get floors","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /floors/v1","href":"/developer/api/floors/get-floors"},{"title":"Delete a floor","deprecated":null,"version":null,"openapi":"/assets/openapi.json delete /floors/v1/{id}","href":"/developer/api/floors/delete-a-floor"}]},{"group":"Guides","pages":[{"title":"Retrieve guides","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /guides/v1","href":"/developer/api/guides/retrieve-guides"},{"title":"Create a guide","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /guides/v1","href":"/developer/api/guides/create-a-guide"},{"title":"Retrieve a guide","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /guides/v1/{guideId}","href":"/developer/api/guides/retrieve-a-guide"},{"title":"Delete a guide","deprecated":null,"version":null,"openapi":"/assets/openapi.json delete /guides/v1/{guideId}","href":"/developer/api/guides/delete-a-guide"},{"title":"Update a guide","deprecated":null,"version":null,"openapi":"/assets/openapi.json patch /guides/v1/{guideId}","href":"/developer/api/guides/update-a-guide"},{"title":"Create an attachment upload","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /guides/v1/attachments","href":"/developer/api/guides/create-an-attachment-upload"},{"title":"Create a media upload","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /guides/v1/media","href":"/developer/api/guides/create-a-media-upload"}]},{"group":"Locations","pages":[{"title":"Retrieve all locations","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /locations/v1","href":"/developer/api/locations/retrieve-all-locations"},{"title":"Get a location","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /locations/v1/{locationId}","href":"/developer/api/locations/get-a-location"}]},{"group":"Networks","pages":[{"title":"Retrieve networks","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /networks/v1","href":"/developer/api/networks/retrieve-networks"}]},{"group":"Packages","pages":[{"title":"Retrieve packages","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /packages/v1","href":"/developer/api/packages/retrieve-packages"},{"title":"Create a package","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /packages/v1","href":"/developer/api/packages/create-a-package"},{"title":"Retrieve a package","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /packages/v1/{packageId}","href":"/developer/api/packages/retrieve-a-package"},{"title":"Delete a package","deprecated":null,"version":null,"openapi":"/assets/openapi.json delete /packages/v1/{packageId}","href":"/developer/api/packages/delete-a-package"},{"title":"Update a package","deprecated":null,"version":null,"openapi":"/assets/openapi.json patch /packages/v1/{packageId}","href":"/developer/api/packages/update-a-package"}]},{"group":"Plans","pages":[{"title":"Retrieve plans","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /plans/v1","href":"/developer/api/plans/retrieve-plans"},{"title":"Create a plan","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /plans/v1","href":"/developer/api/plans/create-a-plan"},{"title":"Create a media upload","description":"Create a media upload for a plan cover image. The response carries a presigned URL: send the raw file bytes with a PUT request within a minute, using exactly the headers returned. Once the file is stored, pass the returned key as \u003ccode>media[0].key\u003c/code> when creating or updating a plan within an hour; an image that is not attached by then is discarded. \u003ch3>OAuth\u003c/h3>Required scopes: \u003ccode>plans\u003c/code>","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /plans/v1/media","href":"/developer/api/plans/create-a-media-upload"},{"title":"Retrieve a plan","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /plans/v1/{planId}","href":"/developer/api/plans/retrieve-a-plan"},{"title":"Delete a plan","description":"Delete a certain plan. \u003ch3>OAuth\u003c/h3>Required scopes: \u003ccode>plans\u003c/code>","deprecated":null,"version":null,"openapi":"/assets/openapi.json delete /plans/v1/{planId}","href":"/developer/api/plans/delete-a-plan"},{"title":"Update a plan","deprecated":null,"version":null,"openapi":"/assets/openapi.json patch /plans/v1/{planId}","href":"/developer/api/plans/update-a-plan"}]},{"group":"Registrations","pages":[{"title":"Retrieve registrations","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /registrations/v1","href":"/developer/api/registrations/retrieve-registrations"}]},{"group":"Resources","pages":[{"title":"Retrieve resources","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /resources/v1","href":"/developer/api/resources/retrieve-resources"},{"title":"Create a resource","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /resources/v1","href":"/developer/api/resources/create-a-resource"},{"title":"Retrieve resource assignments","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /resources/v1/assignments","href":"/developer/api/resources/retrieve-resource-assignments"},{"title":"Create a resource assignment","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /resources/v1/assignments","href":"/developer/api/resources/create-a-resource-assignment"},{"title":"Get a resource assignment","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /resources/v1/assignments/{assignmentId}","href":"/developer/api/resources/get-a-resource-assignment"},{"title":"Delete a resource assignment","deprecated":null,"version":null,"openapi":"/assets/openapi.json delete /resources/v1/assignments/{assignmentId}","href":"/developer/api/resources/delete-a-resource-assignment"},{"title":"Update a resource assignment","deprecated":null,"version":null,"openapi":"/assets/openapi.json patch /resources/v1/assignments/{assignmentId}","href":"/developer/api/resources/update-a-resource-assignment"},{"title":"Create a media upload","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /resources/v1/media","href":"/developer/api/resources/create-a-media-upload"},{"title":"Get a resource","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /resources/v1/{resourceId}","href":"/developer/api/resources/get-a-resource"},{"title":"Delete a resource","deprecated":null,"version":null,"openapi":"/assets/openapi.json delete /resources/v1/{resourceId}","href":"/developer/api/resources/delete-a-resource"},{"title":"Patch a resource","deprecated":null,"version":null,"openapi":"/assets/openapi.json patch /resources/v1/{resourceId}","href":"/developer/api/resources/patch-a-resource"},{"title":"Check resource availability","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /resources/v1/{resourceId}/availability","href":"/developer/api/resources/check-resource-availability"},{"title":"Retrieve bookings","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /resources/bookings/v1","href":"/developer/api/resources/retrieve-bookings"},{"title":"Create a booking","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /resources/bookings/v1","href":"/developer/api/resources/create-a-booking"},{"title":"Get a booking","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /resources/bookings/v1/{bookingId}","href":"/developer/api/resources/get-a-booking"},{"title":"Delete a booking","deprecated":null,"version":null,"openapi":"/assets/openapi.json delete /resources/bookings/v1/{bookingId}","href":"/developer/api/resources/delete-a-booking"},{"title":"Update a booking","deprecated":null,"version":null,"openapi":"/assets/openapi.json patch /resources/bookings/v1/{bookingId}","href":"/developer/api/resources/update-a-booking"}]},{"group":"Shop","pages":[{"title":"Retrieve categories","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /shop/categories/v1","href":"/developer/api/shop/retrieve-categories"},{"title":"Create a category","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /shop/categories/v1","href":"/developer/api/shop/create-a-category"},{"title":"Get a category","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /shop/categories/v1/{categoryId}","href":"/developer/api/shop/get-a-category"},{"title":"Update a category","deprecated":null,"version":null,"openapi":"/assets/openapi.json put /shop/categories/v1/{categoryId}","href":"/developer/api/shop/update-a-category"},{"title":"Delete a category","deprecated":null,"version":null,"openapi":"/assets/openapi.json delete /shop/categories/v1/{categoryId}","href":"/developer/api/shop/delete-a-category"},{"title":"Retrieve products","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /shop/products/v1","href":"/developer/api/shop/retrieve-products"},{"title":"Create a product","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /shop/products/v1","href":"/developer/api/shop/create-a-product"},{"title":"Get a product","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /shop/products/v1/{productId}","href":"/developer/api/shop/get-a-product"},{"title":"Update a product","deprecated":null,"version":null,"openapi":"/assets/openapi.json put /shop/products/v1/{productId}","href":"/developer/api/shop/update-a-product"},{"title":"Delete a product","deprecated":null,"version":null,"openapi":"/assets/openapi.json delete /shop/products/v1/{productId}","href":"/developer/api/shop/delete-a-product"},{"title":"Partially update a product","deprecated":null,"version":null,"openapi":"/assets/openapi.json patch /shop/products/v1/{productId}","href":"/developer/api/shop/partially-update-a-product"},{"title":"Create a media upload","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /shop/products/v1/media","href":"/developer/api/shop/create-a-media-upload"},{"title":"Retrieve orders","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /shop/orders/v1","href":"/developer/api/shop/retrieve-orders"},{"title":"Get an order","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /shop/orders/v1/{orderId}","href":"/developer/api/shop/get-an-order"}]},{"group":"Subscriptions","pages":[{"title":"Retrieve subscriptions","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /subscriptions/v1","href":"/developer/api/subscriptions/retrieve-subscriptions"},{"title":"Create a subscription","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /subscriptions/v1","href":"/developer/api/subscriptions/create-a-subscription"},{"title":"Retrieve a subscription","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /subscriptions/v1/{subscriptionId}","href":"/developer/api/subscriptions/retrieve-a-subscription"},{"title":"Delete a subscription","deprecated":null,"version":null,"openapi":"/assets/openapi.json delete /subscriptions/v1/{subscriptionId}","href":"/developer/api/subscriptions/delete-a-subscription"},{"title":"Update a subscription","deprecated":null,"version":null,"openapi":"/assets/openapi.json patch /subscriptions/v1/{subscriptionId}","href":"/developer/api/subscriptions/update-a-subscription"},{"title":"Create a subscription item","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /subscriptions/v1/{subscriptionId}/items","href":"/developer/api/subscriptions/create-a-subscription-item"},{"title":"Delete a subscription item","deprecated":null,"version":null,"openapi":"/assets/openapi.json delete /subscriptions/v1/{subscriptionId}/items/{itemId}","href":"/developer/api/subscriptions/delete-a-subscription-item"},{"title":"Update a subscription item","deprecated":null,"version":null,"openapi":"/assets/openapi.json patch /subscriptions/v1/{subscriptionId}/items/{itemId}","href":"/developer/api/subscriptions/update-a-subscription-item"}]},{"group":"Support","pages":[{"title":"Retrieve tickets","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /support/tickets/v1","href":"/developer/api/support/retrieve-tickets"},{"title":"Create a ticket","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /support/tickets/v1","href":"/developer/api/support/create-a-ticket"},{"title":"Retrieve a ticket","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /support/tickets/v1/{id}","href":"/developer/api/support/retrieve-a-ticket"},{"title":"Update a ticket's assignee","deprecated":null,"version":null,"openapi":"/assets/openapi.json put /support/tickets/v1/{id}/assignee","href":"/developer/api/support/update-a-tickets-assignee"},{"title":"Update a ticket's status","deprecated":null,"version":null,"openapi":"/assets/openapi.json put /support/tickets/v1/{id}/status","href":"/developer/api/support/update-a-tickets-status"},{"title":"Update a ticket's type","deprecated":null,"version":null,"openapi":"/assets/openapi.json patch /support/tickets/v1/{id}/type","href":"/developer/api/support/update-a-tickets-type"},{"title":"Create a ticket comment","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /support/tickets/v1/comment","href":"/developer/api/support/create-a-ticket-comment"},{"title":"Delete a ticket comment","deprecated":null,"version":null,"openapi":"/assets/openapi.json delete /support/tickets/v1/comment/{id}","href":"/developer/api/support/delete-a-ticket-comment"},{"title":"Update a ticket comment","deprecated":null,"version":null,"openapi":"/assets/openapi.json patch /support/tickets/v1/comment/{id}","href":"/developer/api/support/update-a-ticket-comment"},{"title":"Create a ticket media upload","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /support/tickets/v1/media","href":"/developer/api/support/create-a-ticket-media-upload"}]},{"group":"Transactions","pages":[{"title":"Retrieve scheduled credits transactions","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /transactions/credits/scheduled/v1","href":"/developer/api/transactions/retrieve-scheduled-credits-transactions"},{"title":"Retrieve credit transactions","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /transactions/credits/v1","href":"/developer/api/transactions/retrieve-credit-transactions"},{"title":"Create a credit transaction","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /transactions/credits/v1","href":"/developer/api/transactions/create-a-credit-transaction"},{"title":"Retrieve a credit transaction","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /transactions/credits/v1/{id}","href":"/developer/api/transactions/retrieve-a-credit-transaction"},{"title":"Retrieve scheduled day pass transactions","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /transactions/day_passes/scheduled/v1","href":"/developer/api/transactions/retrieve-scheduled-day-pass-transactions"},{"title":"Retrieve day pass transactions","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /transactions/day_passes/v1","href":"/developer/api/transactions/retrieve-day-pass-transactions"},{"title":"Create a day pass transaction","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /transactions/day_passes/v1","href":"/developer/api/transactions/create-a-day-pass-transaction"},{"title":"Retrieve a day pass transaction","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /transactions/day_passes/v1/{id}","href":"/developer/api/transactions/retrieve-a-day-pass-transaction"},{"title":"Retrieve money transactions","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /transactions/money/v1","href":"/developer/api/transactions/retrieve-money-transactions"},{"title":"Create a money transaction","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /transactions/money/v1","href":"/developer/api/transactions/create-a-money-transaction"},{"title":"Retrieve a money transaction","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /transactions/money/v1/{transactionId}","href":"/developer/api/transactions/retrieve-a-money-transaction"},{"title":"Update a money transaction","deprecated":null,"version":null,"openapi":"/assets/openapi.json patch /transactions/money/v1/{transactionId}","href":"/developer/api/transactions/update-a-money-transaction"},{"title":"Refund a money transaction","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /transactions/money/v1/{transactionId}/refund","href":"/developer/api/transactions/refund-a-money-transaction"},{"title":"Retrieve credit balance","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /transactions/v1/balances/{id}/credits","href":"/developer/api/transactions/retrieve-credit-balance"},{"title":"Retrieve day passes balance","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /transactions/v1/balances/{id}/day_passes","href":"/developer/api/transactions/retrieve-day-passes-balance"}]},{"group":"Visitors","pages":[{"title":"Get contacts","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /visitors/contacts/v1","href":"/developer/api/visitors/get-contacts"},{"title":"Create a contact","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /visitors/contacts/v1","href":"/developer/api/visitors/create-a-contact"},{"title":"Get a contact","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /visitors/contacts/v1/{contactId}","href":"/developer/api/visitors/get-a-contact"},{"title":"Get requests","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /visitors/requests/v1","href":"/developer/api/visitors/get-requests"},{"title":"Create a request","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /visitors/requests/v1","href":"/developer/api/visitors/create-a-request"},{"title":"Retrieve a request","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /visitors/requests/v1/{id}","href":"/developer/api/visitors/retrieve-a-request"},{"title":"Approve a request","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /visitors/requests/v1/{id}/approve","href":"/developer/api/visitors/approve-a-request"},{"title":"Reject a request","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /visitors/requests/v1/{id}/reject","href":"/developer/api/visitors/reject-a-request"},{"title":"Retrieve visits","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /visitors/visits/v1","href":"/developer/api/visitors/retrieve-visits"},{"title":"Create a visit","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /visitors/visits/v1","href":"/developer/api/visitors/create-a-visit"},{"title":"Retrieve a visit","deprecated":null,"version":null,"openapi":"/assets/openapi.json get /visitors/visits/v1/{id}","href":"/developer/api/visitors/retrieve-a-visit"},{"title":"Update a visit","deprecated":null,"version":null,"openapi":"/assets/openapi.json put /visitors/visits/v1/{id}","href":"/developer/api/visitors/update-a-visit"},{"title":"Delete a visit","deprecated":null,"version":null,"openapi":"/assets/openapi.json delete /visitors/visits/v1/{id}","href":"/developer/api/visitors/delete-a-visit"},{"title":"Check in a visit","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /visitors/visits/v1/checkin","href":"/developer/api/visitors/check-in-a-visit"},{"title":"Check out a visit","deprecated":null,"version":null,"openapi":"/assets/openapi.json post /visitors/visits/v1/checkout","href":"/developer/api/visitors/check-out-a-visit"}]}]},{"group":"Webhooks","boost":0.1,"pages":[{"title":"Overview","href":"/developer/webhooks/index"},{"title":"Verifying webhooks requests","href":"/developer/webhooks/verifying"}]}]},{"tab":"Contact us","href":"mailto:support@spacebring.com"}]},"basePath":"","title":"Retrieve a plan - Spacebring Docs","buildId":"dpl_ATnXPMW25DMPUr9VBw6kL6MfBt6T","deploymentId":"dpl_ATnXPMW25DMPUr9VBw6kL6MfBt6T","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CNqlzjVB.js","utils-BqFiXZ79.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-CnR4QBe6.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BY2ZM1OO.js","snippetPresets-x-8ACO8V.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-Ch-SJE05.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CqqG_0NE.js","shallow-BXrZ2b0C.js","getApiPlaygroundDisplay-n7J_wkjq.js","CodeSnippet-CQsp4vyQ.js","CodeSnippets-BfuHqvZx.js","Page-CTxrMSpo.js","getPastedJson-BjrGIK1i.js","icon-7iLZnVOC.js","MethodPill-TBS1m84e.js","DuplicateIcon-BNMrV4Vs.js","createIcon-C5kCqeU2.js","DynamicMarkdown-Bq09mRwR.js","SectionHeading-G4Bflf5Q.js","axios-vUo_bRtp.js","Markdown-BTUds0aX.js","clsx-6wHzaN2_.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BPypQKlo.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-o6bee4ro.js"]}