Create a plan
curl --request POST \
--url https://api.spacebring.com/plans/v1 \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"plan": {
"locationRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"price": 1,
"title": "<string>",
"access": {
"avigilonAltaGroupRef": 123,
"brivoGroupRef": 123,
"kisiGroupRef": 123,
"saltoksAccessGroupRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tapkeyGroupRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"addons": [],
"commitmentCycles": 0,
"credits": 0,
"customTax": {
"enabled": false,
"rate": 0
},
"dayPasses": 0,
"description": "",
"discounts": {
"creditPackages": 0,
"desks": 0,
"equipment": 0,
"events": 0,
"rooms": 0,
"shop": 0
},
"exclusiveAccess": {
"resourceRefs": []
},
"grantedDiscounts": [
{
"coupon": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amountOff": 123,
"currencyCode": "<string>",
"percentOff": 123,
"productTypes": []
}
}
],
"printing": {
"ezeepBlueGroupRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"selfSignup": {
"enabled": false,
"type": "immediate"
},
"setupFee": 0
}
}
'{
"plan": {
"addons": [],
"commitmentCycles": 123,
"createDate": "2023-11-07T05:31:56Z",
"credits": 123,
"customTax": {
"enabled": true,
"rate": 123
},
"dayPasses": 123,
"description": "<string>",
"discounts": {
"creditPackages": 123,
"desks": 123,
"equipment": 123,
"events": 123,
"rooms": 123,
"shop": 123
},
"exclusiveAccess": {
"resourceRefs": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
},
"grantedDiscounts": [
{
"coupon": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amountOff": 123,
"currencyCode": "<string>",
"enabledForCredits": true,
"limitedItems": {
"enabled": true,
"values": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>"
}
]
},
"limitedRedemption": {
"enabled": true,
"usage": 123,
"value": 123
},
"percentOff": 123,
"productTypes": []
}
}
],
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"locale": "<string>",
"locationRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"price": 123,
"selfSignup": {
"enabled": true
},
"setupFee": 123,
"title": "<string>",
"access": {
"avigilonAltaGroupRef": 123,
"brivoGroupRef": 123,
"kisiGroupRef": 123,
"saltoksAccessGroupRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tapkeyGroupRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"printing": {
"ezeepBlueGroupRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}
}Plans
Create a plan
Create a plan.
OAuth
Required scopes:plansPOST
/
plans
/
v1
Create a plan
curl --request POST \
--url https://api.spacebring.com/plans/v1 \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"plan": {
"locationRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"price": 1,
"title": "<string>",
"access": {
"avigilonAltaGroupRef": 123,
"brivoGroupRef": 123,
"kisiGroupRef": 123,
"saltoksAccessGroupRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tapkeyGroupRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"addons": [],
"commitmentCycles": 0,
"credits": 0,
"customTax": {
"enabled": false,
"rate": 0
},
"dayPasses": 0,
"description": "",
"discounts": {
"creditPackages": 0,
"desks": 0,
"equipment": 0,
"events": 0,
"rooms": 0,
"shop": 0
},
"exclusiveAccess": {
"resourceRefs": []
},
"grantedDiscounts": [
{
"coupon": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amountOff": 123,
"currencyCode": "<string>",
"percentOff": 123,
"productTypes": []
}
}
],
"printing": {
"ezeepBlueGroupRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"selfSignup": {
"enabled": false,
"type": "immediate"
},
"setupFee": 0
}
}
'{
"plan": {
"addons": [],
"commitmentCycles": 123,
"createDate": "2023-11-07T05:31:56Z",
"credits": 123,
"customTax": {
"enabled": true,
"rate": 123
},
"dayPasses": 123,
"description": "<string>",
"discounts": {
"creditPackages": 123,
"desks": 123,
"equipment": 123,
"events": 123,
"rooms": 123,
"shop": 123
},
"exclusiveAccess": {
"resourceRefs": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
},
"grantedDiscounts": [
{
"coupon": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amountOff": 123,
"currencyCode": "<string>",
"enabledForCredits": true,
"limitedItems": {
"enabled": true,
"values": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>"
}
]
},
"limitedRedemption": {
"enabled": true,
"usage": 123,
"value": 123
},
"percentOff": 123,
"productTypes": []
}
}
],
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"locale": "<string>",
"locationRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"price": 123,
"selfSignup": {
"enabled": true
},
"setupFee": 123,
"title": "<string>",
"access": {
"avigilonAltaGroupRef": 123,
"brivoGroupRef": 123,
"kisiGroupRef": 123,
"saltoksAccessGroupRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tapkeyGroupRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"printing": {
"ezeepBlueGroupRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}
}Authorizations
BasicAuthOAuth2
See our authentication documentation for how to authorize your requests
Body
application/json
Plan to create.
Show child attributes
Show child attributes
Response
Created
Show child attributes
Show child attributes
Was this page helpful?
⌘I