> ## Documentation Index
> Fetch the complete documentation index at: https://www.spacebring.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Retrieve a plan
> Retrieve a certain plan. OAuth
Required scopes: plans.readonly or plans
## OpenAPI
````yaml /assets/openapi.json get /plans/v1/{planId}
openapi: 3.0.2
info:
title: Spacebring
version: 1.0.0
termsOfService: https://www.spacebring.com/terms
servers:
- url: https://api.spacebring.com
security: []
paths:
/plans/v1/{planId}:
get:
tags:
- Plans
summary: Retrieve a plan
description: >-
Retrieve a certain plan. OAuth
Required scopes:
plans.readonly or plans
operationId: getPlan
parameters:
- in: path
name: planId
required: true
description: The id of the plan.
schema:
type: string
format: uuid
- in: header
name: spacebring-network-id
schema:
type: string
format: uuid
required: false
description: >-
The id of the network. Required when using bearer token
authentication
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/getPlan'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/responseError'
security:
- BasicAuth: []
- OAuth2:
- plans.readonly
- plans
components:
schemas:
getPlan:
type: object
properties:
plan:
type: object
properties:
access:
description: Third-party access integrations configured for the plan.
type: object
properties:
avigilonAltaGroupRef:
type: number
description: Avigilon Alta access group reference.
brivoGroupRef:
type: number
description: Brivo access group reference.
kisiGroupRef:
type: number
description: Kisi access group reference.
saltoksAccessGroupRef:
type: string
format: uuid
description: Salto KS access group reference.
tapkeyGroupRef:
type: string
format: uuid
description: Tapkey access group reference.
additionalProperties: false
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.
required:
- id
additionalProperties: false
commitmentCycles:
type: number
description: Number of billing cycles the member is committed to.
createDate:
type: string
format: date-time
description: ISO timestamp of when the plan was created.
credits:
type: number
description: Credits included in the plan.
customTax:
type: object
properties:
enabled:
type: boolean
description: Whether custom tax is enabled for the plan.
rate:
type: number
description: Custom tax rate percentage.
required:
- enabled
- rate
additionalProperties: false
description: Custom tax settings.
dayPasses:
type: number
description: Number of day passes included in the plan.
description:
type: string
description: Description of the plan.
discounts:
type: object
properties:
creditPackages:
type: number
description: Discount percentage for credit packages.
desks:
type: number
description: Discount percentage for desk bookings.
equipment:
type: number
description: Discount percentage for equipment bookings.
events:
type: number
description: Discount percentage for events.
rooms:
type: number
description: Discount percentage for room bookings.
shop:
type: number
description: Discount percentage for shop products.
required:
- creditPackages
- desks
- equipment
- events
- rooms
- shop
additionalProperties: false
description: Percentage discounts applied to different product types.
deprecated: true
exclusiveAccess:
type: object
properties:
resourceRefs:
type: array
items:
type: string
format: uuid
description: Resource IDs with exclusive access for this plan.
required:
- resourceRefs
additionalProperties: false
description: Resources exclusively available to members on this plan.
grantedDiscounts:
type: array
items:
type: object
properties:
coupon:
type: object
properties:
amountOff:
description: Fixed discount amount.
type: number
currencyCode:
description: Currency code for amountOff.
type: string
enabledForCredits:
description: Whether the coupon applies to credit purchases.
type: boolean
id:
type: string
format: uuid
description: Unique identifier of the coupon.
limitedItems:
type: object
properties:
enabled:
type: boolean
description: Whether item-level limits are enabled.
values:
type: array
items:
type: object
properties:
id:
type: string
format: uuid
description: Unique identifier of the limited item.
title:
description: Display name of the limited item.
type: string
type:
type: string
enum:
- roomBookings
- eventSpaceBookings
- conferenceRoomBookings
- meetingRoomBookings
- phoneBoothBookings
- stationBookings
- studioBookings
- hotDeskBookings
- dedicatedDeskBookings
- parkingBookings
- equipmentBookings
- eventTickets
- shopProducts
- packages
- subscriptionItems
description: Product type of the limited item.
required:
- id
- type
additionalProperties: false
description: Product or package the coupon is limited to.
description: >-
Items the coupon applies to when limits are
enabled.
required:
- enabled
- values
additionalProperties: false
description: Item-level redemption limits.
limitedRedemption:
type: object
properties:
enabled:
type: boolean
description: Whether redemption limits are enabled.
usage:
type: number
description: Current redemption count.
value:
type: number
description: Maximum redemption count.
required:
- enabled
- usage
- value
additionalProperties: false
description: Redemption limits for the coupon.
percentOff:
description: Percentage discount.
type: number
productTypes:
type: array
items:
type: string
enum:
- roomBookings
- eventSpaceBookings
- conferenceRoomBookings
- meetingRoomBookings
- phoneBoothBookings
- stationBookings
- studioBookings
- hotDeskBookings
- dedicatedDeskBookings
- parkingBookings
- equipmentBookings
- eventTickets
- shopProducts
- packages
- subscriptionItems
description: Product types the coupon applies to.
required:
- id
additionalProperties: false
description: Granted coupon details.
required:
- coupon
additionalProperties: false
description: Coupons granted to members on this plan.
id:
type: string
format: uuid
description: Unique identifier of the plan.
locale:
type: string
description: Auto-detected language of the description.
locationRef:
type: string
format: uuid
description: ID of the location this plan belongs to.
period:
type: string
enum:
- day
- week
- month
- threeMonths
- sixMonths
- year
description: Billing period of the plan.
price:
type: number
description: Price of the plan.
printing:
description: Printing integration settings.
type: object
properties:
ezeepBlueGroupRef:
type: string
format: uuid
description: Ezeep Blue printing group reference.
required:
- ezeepBlueGroupRef
additionalProperties: false
selfSignup:
type: object
properties:
enabled:
type: boolean
description: Whether members can self-sign up to this plan.
type:
type: string
enum:
- immediate
- request
description: Self sign-up flow type.
required:
- enabled
- type
additionalProperties: false
description: Self sign-up settings.
setupFee:
type: number
description: One-time setup fee charged when subscribing.
title:
type: string
description: Display name of the plan.
required:
- addons
- commitmentCycles
- createDate
- credits
- customTax
- dayPasses
- description
- discounts
- exclusiveAccess
- grantedDiscounts
- id
- locale
- locationRef
- period
- price
- selfSignup
- setupFee
- title
additionalProperties: false
description: The plan.
required:
- plan
additionalProperties: false
responseError:
type: object
properties:
message:
type: string
type:
type: string
securitySchemes:
BasicAuth:
type: http
description: >-
See our [authentication
documentation](https://www.spacebring.com/docs/api-reference/authentication#basic-authentication)
for how to authorize your requests
scheme: basic
OAuth2:
type: oauth2
description: >-
See our [authentication
documentation](https://www.spacebring.com/docs/api-reference/authentication#oauth2)
for how to authorize your requests
flows:
authorizationCode:
authorizationUrl: https://api.spacebring.com/oauth2/authorize
tokenUrl: https://api.spacebring.com/oauth2/token
refreshUrl: https://api.spacebring.com/oauth2/token
scopes:
benefits.readonly: Read benefits and applications
benefits: Read and write benefits and applications
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
````