> ## 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 subscription
> Retrieve a certain subscription. OAuth
Required scopes: subscriptions.readonly or subscriptions
## OpenAPI
````yaml /assets/openapi.json get /subscriptions/v1/{subscriptionId}
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:
/subscriptions/v1/{subscriptionId}:
get:
tags:
- Subscriptions
summary: Retrieve a subscription
description: >-
Retrieve a certain subscription. OAuth
Required scopes:
subscriptions.readonly or subscriptions
operationId: getSubscription
parameters:
- in: path
name: subscriptionId
required: true
description: The id of the subscription.
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/getSubscription'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/responseError'
security:
- BasicAuth: []
- OAuth2:
- subscriptions.readonly
- subscriptions
components:
schemas:
getSubscription:
type: object
properties:
subscription:
type: object
properties:
addPendingItemsToInvoice:
type: boolean
description: Whether pending items are added to the next invoice.
advanceInvoicing:
type: object
properties:
days:
type: number
description: Number of days before renewal to issue an invoice.
type:
type: string
enum:
- days
- default
description: Advance invoicing mode.
required:
- days
- type
additionalProperties: false
description: Advance invoicing settings.
assignments:
type: array
items:
type: object
properties:
entire:
type: boolean
description: >-
Whether the assignment grants access to the entire
resource.
id:
type: string
format: uuid
description: Unique identifier of the assignment.
quantity:
description: Assigned quantity.
type: number
resource:
type: object
properties:
coverUrl:
description: Cover image URL of the assigned resource.
type: string
id:
type: string
description: Unique identifier of the assigned resource.
title:
type: string
description: Display name of the assigned resource.
type:
type: string
description: Resource type.
required:
- id
- title
- type
additionalProperties: false
description: Assigned resource details.
title:
type: string
description: Display title of the assignment.
required:
- id
- resource
- title
additionalProperties: false
description: Resource assignments for this subscription.
billingCycleAnchor:
type: string
enum:
- any
- day
description: Billing cycle anchor mode.
company:
description: Company associated with this subscription.
type: object
properties:
createDate:
type: string
format: date-time
description: ISO timestamp of when the company was created.
id:
type: string
format: uuid
description: Unique identifier of the company.
locationRef:
type: string
format: uuid
description: ID of the location this company belongs to.
logo:
description: Company logo.
type: object
properties:
key:
type: string
description: Storage key of the company logo.
url:
type: string
description: Public URL of the company logo.
required:
- key
- url
additionalProperties: false
metadata:
description: Custom metadata for the company.
type: object
additionalProperties: {}
notes:
description: Internal notes about the company.
nullable: true
type: string
publicLogoUrl:
description: Logo URL resolved from the company website.
type: string
title:
type: string
description: Display name of the company.
required:
- createDate
- id
- locationRef
- title
additionalProperties: false
companyRef:
description: ID of the company this subscription belongs to.
type: string
format: uuid
contract:
description: Contract associated with this subscription.
type: object
properties:
id:
type: string
format: uuid
description: Unique identifier of the contract.
url:
type: string
description: URL of the contract document.
required:
- id
- url
additionalProperties: false
createDate:
type: string
format: date-time
description: ISO timestamp of when the subscription was created.
credits:
type: number
description: Total credits included in the subscription.
currentInterval:
description: Current billing interval.
type: object
properties:
endDate:
type: string
format: date-time
description: ISO timestamp when the interval ends.
futureIntervalItemsCreated:
description: Whether future interval items have been created.
type: boolean
startDate:
type: string
format: date-time
description: ISO timestamp when the interval starts.
required:
- endDate
- startDate
additionalProperties: false
customerRef:
type: string
format: uuid
description: ID of the customer billed for this subscription.
dayPasses:
type: number
description: Total day passes included in the subscription.
deleteDate:
description: ISO timestamp of when the subscription was deleted.
type: string
format: date-time
discounts:
deprecated: true
description: Maximum synthetic discount percentages across items.
type: object
properties:
creditPackages:
type: number
description: >-
Maximum discount percentage for credit packages across
items.
desks:
type: number
description: Maximum discount percentage for desk bookings across items.
equipment:
type: number
description: >-
Maximum discount percentage for equipment bookings across
items.
events:
type: number
description: Maximum discount percentage for event tickets across items.
rooms:
type: number
description: Maximum discount percentage for room bookings across items.
shop:
type: number
description: Maximum discount percentage for shop products across items.
required:
- creditPackages
- desks
- equipment
- events
- rooms
- shop
additionalProperties: false
endDate:
description: ISO timestamp when the subscription ends.
type: string
format: date-time
id:
type: string
format: uuid
description: Unique identifier of the subscription.
items:
type: array
items:
type: object
properties:
autoUpdateFromProduct:
type: boolean
description: Whether the item syncs from its linked product.
avigilonAltaGroupRef:
description: Avigilon Alta access group reference.
nullable: true
type: number
brivoGroupRef:
description: Brivo access group reference.
nullable: true
type: number
commitmentCycles:
description: Number of billing cycles in the commitment period.
type: number
commitmentEndDate:
description: ISO timestamp when the commitment period ends.
type: string
format: date-time
couponRef:
description: ID of the coupon applied to this item.
type: string
createDate:
type: string
format: date-time
description: ISO timestamp of when the item was created.
credits:
type: number
description: Credits included per billing cycle.
customEnd:
type: boolean
description: Whether the item has a custom end date.
customStart:
type: boolean
description: Whether the item has a custom start date.
customTax:
type: object
properties:
enabled:
type: boolean
description: Whether custom tax is enabled for this item.
rate:
type: number
description: Custom tax rate as a decimal.
required:
- enabled
- rate
additionalProperties: false
description: Custom tax settings for this item.
dayPasses:
type: number
description: Day passes included per billing cycle.
discounts:
description: Synthetic discount percentages by product type.
deprecated: true
type: object
properties:
creditPackages:
type: number
description: Discount percentage applied to credit packages.
desks:
type: number
description: Discount percentage applied to desk bookings.
equipment:
type: number
description: Discount percentage applied to equipment bookings.
events:
type: number
description: Discount percentage applied to event tickets.
rooms:
type: number
description: Discount percentage applied to room bookings.
shop:
type: number
description: Discount percentage applied to shop products.
required:
- creditPackages
- desks
- equipment
- events
- rooms
- shop
additionalProperties: false
endDate:
description: ISO timestamp when the item ends.
type: string
format: date-time
endFixed:
type: boolean
description: >-
Whether the end date is fixed and cannot shift with
billing cycles.
entire:
description: Whether the item grants access to the entire resource.
type: boolean
exclusiveAccess:
description: Resources with exclusive access.
type: object
properties:
resourceRefs:
type: array
items:
type: string
format: uuid
description: Resource IDs with exclusive access.
required:
- resourceRefs
additionalProperties: false
ezeepBlueGroupRef:
description: Ezeep Blue group reference.
nullable: true
type: string
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 this item.
id:
type: string
format: uuid
description: Unique identifier of the subscription item.
kisiGroupRef:
description: Kisi access group reference.
nullable: true
type: number
optionRef:
description: ID of the product option linked to this item.
type: string
format: uuid
plan:
description: Linked plan details.
type: object
properties:
id:
type: string
format: uuid
description: Unique identifier of the plan.
resourceRef:
description: Resource reference associated with the plan.
type: string
title:
type: string
description: Display name of the plan.
required:
- id
- title
additionalProperties: false
planRef:
description: ID of the linked plan.
type: string
format: uuid
price:
type: number
description: Price per billing cycle.
productRef:
description: ID of the linked product.
type: string
format: uuid
quantity:
type: number
description: Quantity of this item.
resource:
description: Linked resource details.
type: object
properties:
id:
type: string
format: uuid
description: Unique identifier of the resource.
imageUrl:
description: Cover image URL of the resource.
type: string
title:
type: string
description: Display name of the resource.
type:
type: string
description: Resource type.
required:
- id
- title
- type
additionalProperties: false
resourceRef:
description: Reference to the linked resource.
nullable: true
type: string
saltoksAccessGroupRef:
description: Salto KS access group reference.
nullable: true
type: string
setupFee:
type: number
description: One-time setup fee for this item.
startDate:
description: ISO timestamp when the item starts.
type: string
format: date-time
startFixed:
type: boolean
description: Whether the start date is fixed.
tapkeyGroupRef:
description: Tapkey access group reference.
nullable: true
type: string
tier:
description: Linked tier details.
type: object
properties:
id:
type: string
format: uuid
description: Unique identifier of the tier.
title:
type: string
description: Display name of the tier.
required:
- id
- title
additionalProperties: false
tierRef:
description: ID of the linked tier.
type: string
format: uuid
title:
description: Display title of the item.
nullable: true
type: string
type:
type: string
enum:
- oneOff
- recurring
description: Billing type of the item.
required:
- autoUpdateFromProduct
- createDate
- credits
- customEnd
- customStart
- customTax
- dayPasses
- endFixed
- grantedDiscounts
- id
- price
- quantity
- setupFee
- startFixed
- type
additionalProperties: false
description: Subscription line items.
locationRef:
type: string
format: uuid
description: ID of the location this subscription belongs to.
membershipRef:
description: ID of the membership this subscription belongs to.
type: string
format: uuid
networkRef:
type: string
format: uuid
description: ID of the network this subscription belongs to.
nextInterval:
description: Next billing interval.
type: object
properties:
endDate:
description: ISO timestamp when the next interval ends.
type: string
format: date-time
startDate:
type: string
format: date-time
description: ISO timestamp when the next interval starts.
required:
- startDate
additionalProperties: false
pausePaymentCollection:
description: Payment collection pause settings.
type: object
properties:
behavior:
type: string
enum:
- draft
- void
description: Behavior while payment collection is paused.
createDate:
type: string
format: date-time
description: ISO timestamp when payment collection was paused.
resumesAt:
description: ISO timestamp when payment collection resumes.
type: string
format: date-time
required:
- behavior
- createDate
additionalProperties: false
payment:
description: Payment status for subscriptions created by the current user.
type: object
properties:
request:
description: Pending payment request details.
type: object
properties:
id:
type: string
format: uuid
description: Unique identifier of the payment request.
url:
type: string
description: URL to complete the payment.
required:
- id
- url
additionalProperties: false
status:
type: string
description: Payment status.
required:
- status
additionalProperties: false
payWithInvoice:
type: object
properties:
creditPackages:
type: boolean
description: Whether credit packages are invoiced.
desks:
type: boolean
description: Whether desk bookings are invoiced.
equipment:
description: Whether equipment bookings are invoiced.
type: boolean
events:
type: boolean
description: Whether events are invoiced.
parking:
description: Whether parking bookings are invoiced.
type: boolean
rooms:
type: boolean
description: Whether room bookings are invoiced.
shop:
type: boolean
description: Whether shop purchases are invoiced.
required:
- creditPackages
- desks
- events
- rooms
- shop
additionalProperties: false
description: Invoice payment settings by product type.
period:
type: string
enum:
- day
- week
- month
- threeMonths
- sixMonths
- year
description: Billing period.
price:
type: number
description: Total recurring price of the subscription.
purchaseDate:
description: ISO timestamp of when the subscription was purchased.
type: string
format: date-time
startDate:
type: string
format: date-time
description: ISO timestamp when the subscription starts.
startFixed:
type: boolean
description: Whether the start date is fixed.
status:
type: string
enum:
- active
- scheduled
- incomplete
- incompleteExpired
- canceled
description: Subscription status.
subscriptionType:
type: string
enum:
- company
- user
description: Whether the subscription belongs to a company or user.
timezoneId:
type: string
description: Timezone identifier for billing dates.
user:
description: User associated with this subscription.
type: object
properties:
about:
description: User bio.
nullable: true
type: string
email:
description: User email address.
nullable: true
type: string
id:
type: string
format: uuid
description: Unique identifier of the user.
name:
description: User first name.
nullable: true
type: string
phoneNumber:
description: User phone number.
nullable: true
type: string
photoUrl:
description: User profile photo URL.
nullable: true
type: string
surname:
description: User last name.
nullable: true
type: string
required:
- id
additionalProperties: false
userCreator:
description: User who created this subscription.
type: object
properties:
about:
description: User bio.
nullable: true
type: string
email:
description: User email address.
nullable: true
type: string
id:
type: string
format: uuid
description: Unique identifier of the user.
name:
description: User first name.
nullable: true
type: string
phoneNumber:
description: User phone number.
nullable: true
type: string
photoUrl:
description: User profile photo URL.
nullable: true
type: string
surname:
description: User last name.
nullable: true
type: string
required:
- id
additionalProperties: false
userRef:
description: ID of the user associated with this subscription.
type: string
format: uuid
required:
- addPendingItemsToInvoice
- advanceInvoicing
- assignments
- billingCycleAnchor
- createDate
- credits
- customerRef
- dayPasses
- id
- items
- locationRef
- networkRef
- payWithInvoice
- period
- price
- startDate
- startFixed
- status
- subscriptionType
- timezoneId
additionalProperties: false
description: The subscription.
required:
- subscription
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
````