> ## 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/{id}
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/{id}:
get:
tags:
- Plans
summary: Retrieve a plan
description: >-
Retrieve a certain plan. OAuth
Required scopes:
plans.readonly or plans
operationId: getPlan
parameters:
- name: id
in: path
description: The id of the plan.
schema:
type: string
format: uuid
required: true
- 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:
type: object
properties:
plan:
$ref: '#/components/schemas/plan'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/responseError'
security:
- BasicAuth: []
- OAuth2:
- plans.readonly
- plans
components:
schemas:
plan:
type: object
properties:
access:
description: Third-party access integrations configured for the plan.
type: object
properties:
avigilonAltaGroupRef:
description: Avigilon Alta access group reference.
type: number
brivoGroupRef:
description: Brivo access group reference.
type: number
kisiGroupRef:
description: Kisi access group reference.
type: number
saltoksAccessGroupRef:
description: Salto KS access group reference.
type: string
format: uuid
tapkeyGroupRef:
description: Tapkey access group reference.
type: string
format: uuid
additionalProperties: false
addons:
description: Addons included in the plan.
default: []
type: array
items:
type: object
properties:
id:
description: Unique identifier of the addon.
type: string
format: uuid
required:
- id
additionalProperties: false
commitmentCycles:
description: Number of billing cycles the member is committed to.
type: number
createDate:
description: ISO timestamp of when the plan was created.
type: string
format: date-time
credits:
description: Credits included in the plan.
type: number
customTax:
description: Custom tax settings.
type: object
properties:
enabled:
description: Whether custom tax is enabled for the plan.
type: boolean
rate:
description: Custom tax rate percentage.
type: number
required:
- enabled
- rate
additionalProperties: false
dayPasses:
description: Number of day passes included in the plan.
type: number
description:
description: Description of the plan.
type: string
discounts:
description: Percentage discounts applied to different product types.
deprecated: true
type: object
properties:
creditPackages:
description: Discount percentage for credit packages.
type: number
desks:
description: Discount percentage for desk bookings.
type: number
equipment:
description: Discount percentage for equipment bookings.
type: number
events:
description: Discount percentage for events.
type: number
rooms:
description: Discount percentage for room bookings.
type: number
shop:
description: Discount percentage for shop products.
type: number
required:
- creditPackages
- desks
- equipment
- events
- rooms
- shop
additionalProperties: false
exclusiveAccess:
description: Resources exclusively available to members on this plan.
type: object
properties:
resourceRefs:
description: Resource IDs with exclusive access for this plan.
type: array
items:
type: string
format: uuid
required:
- resourceRefs
additionalProperties: false
grantedDiscounts:
description: Coupons granted to members on this plan.
type: array
items:
type: object
properties:
coupon:
description: Coupon attached to the plan.
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:
description: Unique identifier of the coupon.
type: string
format: uuid
limitedItems:
description: Item-level redemption limits.
type: object
properties:
enabled:
description: Whether item-level limits are enabled.
type: boolean
values:
description: Limited item values.
type: array
items: {}
required:
- enabled
- values
additionalProperties: false
limitedRedemption:
description: Redemption limits.
type: object
properties:
enabled:
description: Whether redemption limits are enabled.
type: boolean
usage:
description: Current redemption count.
type: number
value:
description: Maximum redemption count.
type: number
required:
- enabled
additionalProperties: false
percentOff:
description: Percentage discount.
type: number
productTypes:
description: Product types the coupon applies to.
type: array
items:
type: string
enum:
- roomBookings
- eventSpaceBookings
- conferenceRoomBookings
- meetingRoomBookings
- phoneBoothBookings
- stationBookings
- studioBookings
- hotDeskBookings
- dedicatedDeskBookings
- parkingBookings
- equipmentBookings
- eventTickets
- shopProducts
- packages
- subscriptionItems
required:
- id
additionalProperties: false
required:
- coupon
additionalProperties: false
id:
description: Unique identifier of the plan.
type: string
format: uuid
locale:
description: Auto-detected language of the description.
type: string
locationRef:
description: ID of the location this plan belongs to.
type: string
format: uuid
period:
description: Billing period of the plan.
type: string
enum:
- day
- week
- month
- threeMonths
- sixMonths
- year
price:
description: Price of the plan.
type: number
printing:
description: Printing integration settings.
type: object
properties:
ezeepBlueGroupRef:
description: Ezeep Blue printing group reference.
type: string
format: uuid
required:
- ezeepBlueGroupRef
additionalProperties: false
selfSignup:
description: Self sign-up settings.
type: object
properties:
enabled:
description: Whether members can self-sign up to this plan.
type: boolean
type:
description: Self sign-up flow type.
type: string
enum:
- immediate
- request
required:
- enabled
- type
additionalProperties: false
setupFee:
description: One-time setup fee charged when subscribing.
type: number
title:
description: Display name of the plan.
type: string
required:
- addons
- commitmentCycles
- createDate
- credits
- customTax
- dayPasses
- description
- discounts
- exclusiveAccess
- grantedDiscounts
- id
- locale
- locationRef
- period
- price
- selfSignup
- setupFee
- title
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 invoices
invoices: Read and write 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
````