> ## 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.
# Create a subscription
> Create a subscription for a membership or company. OAuth
Required scopes: subscriptions
## OpenAPI
````yaml /assets/openapi.json post /subscriptions/v1
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:
post:
tags:
- Subscriptions
summary: Create a subscription
description: >-
Create a subscription for a membership or company.
OAuth
Required scopes: subscriptions
operationId: createSubscription
parameters:
- 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
requestBody:
$ref: '#/components/requestBodies/assignSubscription'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
subscription:
$ref: '#/components/schemas/subscription'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/responseError'
security:
- BasicAuth: []
- OAuth2:
- subscriptions
components:
requestBodies:
assignSubscription:
content:
application/json:
schema:
type: object
properties:
issueFirstInvoice:
description: >-
If "manual", the first invoice will not be issued. If "auto",
the first invoice will be issued automatically.
default: auto
type: string
enum:
- manual
- auto
subscription:
description: >-
Subscription to create. Must include exactly one of companyRef
or membershipRef, not both.
allOf:
- type: object
properties:
addPendingItemsToInvoice:
description: Whether pending items are added to the next invoice.
default: true
type: boolean
advanceInvoicing:
description: Advance invoicing settings.
type: object
properties:
days:
description: Number of days before renewal to issue an invoice.
type: number
minimum: 0
type:
description: Advance invoicing mode.
type: string
enum:
- days
- default
required:
- type
billingCycleAnchor:
description: Billing cycle anchor mode.
type: string
enum:
- any
- day
endDate:
description: ISO timestamp when the subscription ends.
nullable: true
type: string
format: date-time
items:
description: Initial subscription line items.
type: array
items:
type: object
properties:
autoUpdateFromProduct:
description: Whether the item syncs from its linked product.
type: boolean
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
couponRef:
description: ID of the coupon applied to this item.
nullable: true
type: string
createDate:
description: ISO timestamp of when the item was created.
type: string
format: date-time
credits:
description: Credits included per billing cycle.
type: number
customEnd:
description: Whether the item has a custom end date.
type: boolean
customStart:
description: Whether the item has a custom start date.
type: boolean
customTax:
description: Custom tax settings for this item.
type: object
properties:
enabled:
description: Whether custom tax is enabled for this item.
type: boolean
rate:
description: Custom tax rate as a decimal.
type: number
dayPasses:
description: Day passes included per billing cycle.
type: number
discounts:
type: object
description: Synthetic discount percentages by product type.
deprecated: true
properties:
creditPackages:
description: >-
Discount percentage applied to credit
packages.
type: number
desks:
description: >-
Discount percentage applied to desk
bookings.
type: number
equipment:
description: >-
Discount percentage applied to equipment
bookings.
type: number
events:
description: >-
Discount percentage applied to event
tickets.
type: number
rooms:
description: >-
Discount percentage applied to room
bookings.
type: number
shop:
description: >-
Discount percentage applied to shop
products.
type: number
endDate:
description: ISO timestamp when the item ends.
type: string
format: date-time
entire:
description: >-
Whether the item grants access to the entire
resource.
type: boolean
exclusiveAccess:
description: Resources with exclusive access.
type: object
properties:
resourceRefs:
description: Resource IDs with exclusive access.
type: array
items:
type: string
format: uuid
ezeepBlueGroupRef:
description: Ezeep Blue group reference.
nullable: true
type: string
grantedDiscounts:
description: Coupons granted to this item.
type: array
items:
type: object
properties:
coupon:
type: object
properties:
amountOff:
description: Fixed discount amount.
type: number
currencyCode:
description: >-
Currency code for fixed discount
amounts.
type: string
id:
description: Unique identifier of the coupon.
type: string
format: uuid
percentOff:
description: Percentage discount amount.
type: number
productTypes:
description: Product types the coupon applies to.
type: array
items:
type: string
required:
- id
required:
- coupon
kisiGroupRef:
description: Kisi access group reference.
nullable: true
type: number
plan:
description: Linked plan details.
type: object
properties:
id:
description: Unique identifier of the plan.
type: string
title:
description: Display name of the plan.
type: string
required:
- id
planRef:
description: ID of the linked plan.
type: string
format: uuid
price:
description: Price per billing cycle.
type: number
productRef:
description: ID of the linked product.
type: string
format: uuid
quantity:
description: Quantity of this item.
type: number
resourceRef:
description: Reference to the linked resource.
nullable: true
type: string
format: uuid
saltoksAccessGroupRef:
description: Salto KS access group reference.
nullable: true
type: string
setupFee:
description: One-time setup fee for this item.
type: number
startDate:
description: ISO timestamp when the item starts.
type: string
format: date-time
tapkeyGroupRef:
description: Tapkey access group reference.
nullable: true
type: string
tier:
description: Linked tier details.
type: object
properties:
id:
description: Unique identifier of the tier.
type: string
title:
description: Display name of the tier.
type: string
required:
- id
tierRef:
description: ID of the linked tier.
type: string
format: uuid
title:
description: Display title of the item.
type: string
type:
description: Billing type of the item.
type: string
enum:
- oneOff
- recurring
period:
description: Billing period.
type: string
enum:
- day
- week
- month
- threeMonths
- sixMonths
- year
startDate:
description: ISO timestamp when the subscription starts.
type: string
format: date-time
required:
- period
- startDate
- oneOf:
- type: object
properties:
companyRef:
description: ID of the company to assign the subscription to.
type: string
format: uuid
required:
- companyRef
- type: object
properties:
membershipRef:
description: >-
ID of the membership to assign the subscription
to.
type: string
format: uuid
required:
- membershipRef
required:
- subscription
required: true
schemas:
subscription:
type: object
properties:
addPendingItemsToInvoice:
description: Whether pending items are added to the next invoice.
type: boolean
advanceInvoicing:
description: Advance invoicing settings.
type: object
properties:
days:
description: Number of days before renewal to issue an invoice.
type: number
type:
description: Advance invoicing mode.
type: string
enum:
- days
- default
required:
- days
- type
additionalProperties: false
assignments:
description: Resource assignments for this subscription.
type: array
items:
type: object
properties:
entire:
description: Whether the assignment grants access to the entire resource.
type: boolean
id:
description: Unique identifier of the assignment.
type: string
format: uuid
quantity:
description: Assigned quantity.
type: number
resource:
description: Assigned resource details.
type: object
properties:
coverUrl:
description: Cover image URL of the assigned resource.
type: string
id:
description: Unique identifier of the assigned resource.
type: string
title:
description: Display name of the assigned resource.
type: string
type:
description: Resource type.
type: string
required:
- id
- title
- type
additionalProperties: false
title:
description: Display title of the assignment.
type: string
required:
- id
- resource
- title
additionalProperties: false
billingCycleAnchor:
description: Billing cycle anchor mode.
type: string
enum:
- any
- day
company:
description: Company associated with this subscription.
type: object
properties:
createDate:
description: ISO timestamp of when the company was created.
type: string
format: date-time
id:
description: Unique identifier of the company.
type: string
format: uuid
locationRef:
description: ID of the location this company belongs to.
type: string
format: uuid
logo:
description: Company logo.
type: object
properties:
key:
description: Storage key of the company logo.
type: string
url:
description: Public URL of the company logo.
type: string
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:
description: Display name of the company.
type: string
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:
description: Unique identifier of the contract.
type: string
format: uuid
url:
description: URL of the contract document.
type: string
required:
- id
- url
additionalProperties: false
createDate:
description: ISO timestamp of when the subscription was created.
type: string
format: date-time
credits:
description: Total credits included in the subscription.
type: number
currentInterval:
description: Current billing interval.
type: object
properties:
endDate:
description: ISO timestamp when the interval ends.
type: string
format: date-time
futureIntervalItemsCreated:
description: Whether future interval items have been created.
type: boolean
startDate:
description: ISO timestamp when the interval starts.
type: string
format: date-time
required:
- endDate
- startDate
additionalProperties: false
customerRef:
description: ID of the customer billed for this subscription.
type: string
format: uuid
dayPasses:
description: Total day passes included in the subscription.
type: number
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:
description: Maximum discount percentage for credit packages across items.
type: number
desks:
description: Maximum discount percentage for desk bookings across items.
type: number
equipment:
description: Maximum discount percentage for equipment bookings across items.
type: number
events:
description: Maximum discount percentage for event tickets across items.
type: number
rooms:
description: Maximum discount percentage for room bookings across items.
type: number
shop:
description: Maximum discount percentage for shop products across items.
type: number
required:
- creditPackages
- desks
- equipment
- events
- rooms
- shop
additionalProperties: false
endDate:
description: ISO timestamp when the subscription ends.
type: string
format: date-time
id:
description: Unique identifier of the subscription.
type: string
format: uuid
items:
description: Subscription line items.
type: array
items:
type: object
properties:
autoUpdateFromProduct:
description: Whether the item syncs from its linked product.
type: boolean
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:
description: ISO timestamp of when the item was created.
type: string
format: date-time
credits:
description: Credits included per billing cycle.
type: number
customEnd:
description: Whether the item has a custom end date.
type: boolean
customStart:
description: Whether the item has a custom start date.
type: boolean
customTax:
description: Custom tax settings for this item.
type: object
properties:
enabled:
description: Whether custom tax is enabled for this item.
type: boolean
rate:
description: Custom tax rate as a decimal.
type: number
required:
- enabled
- rate
additionalProperties: false
dayPasses:
description: Day passes included per billing cycle.
type: number
discounts:
description: Synthetic discount percentages by product type.
deprecated: true
type: object
properties:
creditPackages:
description: Discount percentage applied to credit packages.
type: number
desks:
description: Discount percentage applied to desk bookings.
type: number
equipment:
description: Discount percentage applied to equipment bookings.
type: number
events:
description: Discount percentage applied to event tickets.
type: number
rooms:
description: Discount percentage applied to room bookings.
type: number
shop:
description: Discount percentage applied to shop products.
type: number
required:
- creditPackages
- desks
- equipment
- events
- rooms
- shop
additionalProperties: false
endDate:
description: ISO timestamp when the item ends.
type: string
format: date-time
endFixed:
description: >-
Whether the end date is fixed and cannot shift with billing
cycles.
type: boolean
entire:
description: Whether the item grants access to the entire resource.
type: boolean
exclusiveAccess:
description: Resources with exclusive access.
type: object
properties:
resourceRefs:
description: Resource IDs with exclusive access.
type: array
items:
type: string
format: uuid
required:
- resourceRefs
additionalProperties: false
ezeepBlueGroupRef:
description: Ezeep Blue group reference.
nullable: true
type: string
grantedDiscounts:
description: Coupons granted to this item.
type: array
items:
type: object
properties:
coupon:
type: object
properties:
amountOff:
description: Fixed discount amount.
type: number
currencyCode:
description: Currency code for fixed discount amounts.
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 coupon limits are enabled.
type: boolean
values:
description: >-
Allowed item identifiers when limits are
enabled.
anyOf:
- type: array
items: {}
- type: object
additionalProperties: {}
required:
- enabled
- values
additionalProperties: false
limitedRedemption:
description: Global redemption limits.
type: object
properties:
enabled:
description: Whether redemption limits are enabled.
type: boolean
usage:
description: Number of times the coupon has been redeemed.
type: number
value:
description: Maximum number of redemptions allowed.
type: number
required:
- enabled
- usage
- value
additionalProperties: false
percentOff:
description: Percentage discount amount.
type: number
productTypes:
description: Product types the coupon applies to.
type: array
items:
type: string
required:
- id
- limitedItems
- limitedRedemption
- productTypes
additionalProperties: false
required:
- coupon
additionalProperties: false
id:
description: Unique identifier of the subscription item.
type: string
format: uuid
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:
description: Unique identifier of the plan.
type: string
format: uuid
resourceRef:
description: Resource reference associated with the plan.
type: string
title:
description: Display name of the plan.
type: string
required:
- id
- title
additionalProperties: false
planRef:
description: ID of the linked plan.
type: string
format: uuid
price:
description: Price per billing cycle.
type: number
productRef:
description: ID of the linked product.
type: string
format: uuid
quantity:
description: Quantity of this item.
type: number
resource:
description: Linked resource details.
type: object
properties:
id:
description: Unique identifier of the resource.
type: string
format: uuid
imageUrl:
description: Cover image URL of the resource.
type: string
title:
description: Display name of the resource.
type: string
type:
description: Resource type.
type: string
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:
description: One-time setup fee for this item.
type: number
startDate:
description: ISO timestamp when the item starts.
type: string
format: date-time
startFixed:
description: Whether the start date is fixed.
type: boolean
tapkeyGroupRef:
description: Tapkey access group reference.
nullable: true
type: string
tier:
description: Linked tier details.
type: object
properties:
id:
description: Unique identifier of the tier.
type: string
format: uuid
title:
description: Display name of the tier.
type: string
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:
description: Billing type of the item.
type: string
enum:
- oneOff
- recurring
required:
- autoUpdateFromProduct
- createDate
- credits
- customEnd
- customStart
- customTax
- dayPasses
- endFixed
- grantedDiscounts
- id
- price
- quantity
- setupFee
- startFixed
- type
additionalProperties: false
locationRef:
description: ID of the location this subscription belongs to.
type: string
format: uuid
membershipRef:
description: ID of the membership this subscription belongs to.
type: string
format: uuid
networkRef:
description: ID of the network this subscription belongs to.
type: string
format: uuid
nextInterval:
description: Next billing interval.
type: object
properties:
endDate:
description: ISO timestamp when the next interval ends.
type: string
format: date-time
startDate:
description: ISO timestamp when the next interval starts.
type: string
format: date-time
required:
- startDate
additionalProperties: false
pausePaymentCollection:
description: Payment collection pause settings.
type: object
properties:
behavior:
description: Behavior while payment collection is paused.
type: string
enum:
- draft
- void
createDate:
description: ISO timestamp when payment collection was paused.
type: string
format: date-time
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:
description: Unique identifier of the payment request.
type: string
format: uuid
url:
description: URL to complete the payment.
type: string
required:
- id
- url
additionalProperties: false
status:
description: Payment status.
type: string
required:
- status
additionalProperties: false
payWithInvoice:
description: Invoice payment settings by product type.
type: object
properties:
creditPackages:
description: Whether credit packages are invoiced.
type: boolean
desks:
description: Whether desk bookings are invoiced.
type: boolean
equipment:
description: Whether equipment bookings are invoiced.
type: boolean
events:
description: Whether events are invoiced.
type: boolean
parking:
description: Whether parking bookings are invoiced.
type: boolean
rooms:
description: Whether room bookings are invoiced.
type: boolean
shop:
description: Whether shop purchases are invoiced.
type: boolean
required:
- creditPackages
- desks
- events
- rooms
- shop
additionalProperties: false
period:
description: Billing period.
type: string
enum:
- day
- week
- month
- threeMonths
- sixMonths
- year
price:
description: Total recurring price of the subscription.
type: number
purchaseDate:
description: ISO timestamp of when the subscription was purchased.
type: string
format: date-time
startDate:
description: ISO timestamp when the subscription starts.
type: string
format: date-time
startFixed:
description: Whether the start date is fixed.
type: boolean
status:
description: Subscription status.
type: string
enum:
- active
- scheduled
- incomplete
- incompleteExpired
- canceled
subscriptionType:
description: Whether the subscription belongs to a company or membership.
type: string
enum:
- company
- membership
timezoneId:
description: Timezone identifier for billing dates.
type: string
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:
description: Unique identifier of the user.
type: string
format: uuid
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:
description: Unique identifier of the user.
type: string
format: uuid
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
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
````