Subscriptions
Create a subscription
Getting Started
Endpoints
- Benefit Applications
- Benefits
- Bookings
- Companies
- Event Tickets
- Feed Posts
- Invoices
- Invoice Items
- Locations
- Memberships
- Networks
- Orders
- Plans
- Products
- Resources
- Subscriptions
- Support Tickets
- Transactions
- Visitors
Subscriptions
Create a subscription
Create a subscription for a membership or company.
OAuth
Required scopes:subscriptions
POST
/
subscriptions
/
v1
curl --request POST \
--url https://api.spacebring.com/subscriptions/v1 \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '{
"subscription": {
"companyRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"membershipRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"period": "day",
"startDate": "2023-12-25",
"endDate": "2023-12-25",
"items": [
{
"credits": 123,
"day_passes": 123,
"price": 123,
"quantity": 123,
"customTax": {
"enabled": true,
"rate": 123
},
"title": "<string>",
"plan": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}
],
"payWithInvoice": {
"desks": true,
"events": true,
"rooms": true,
"shop": true,
"creditPackages": true
}
},
"issueFirstInvoice": true
}'
{
"subscription": {
"company": {
"createDate": "<string>",
"id": "<string>",
"locationRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"metadata": {},
"notes": "<string>",
"subscriptionRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>"
},
"companyRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createDate": "2023-11-07T05:31:56Z",
"credits": 123,
"currentInterval": {
"endDate": "2023-11-07T05:31:56Z",
"startDate": "2023-11-07T05:31:56Z"
},
"dayPasses": 123,
"deleteDate": "2023-11-07T05:31:56Z",
"endDate": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"items": [
{
"credits": 123,
"customTax": {
"enabled": true,
"rate": 123
},
"dayPasses": 123,
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"plan": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"price": 123,
"quantity": 123,
"title": "<string>"
}
],
"locationRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"membershipRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"nextInterval": {
"startDate": "2023-11-07T05:31:56Z"
},
"payWithInvoice": {
"creditPackages": true,
"desks": true,
"events": true,
"rooms": true,
"shop": true
},
"period": "day",
"price": 123,
"startDate": "2023-11-07T05:31:56Z",
"timezoneId": "<string>",
"user": {
"about": "<string>",
"email": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"phoneNumber": "<string>",
"photoUrl": "<string>",
"surname": "<string>"
},
"userCreator": {
"about": "<string>",
"email": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"phoneNumber": "<string>",
"photoUrl": "<string>",
"surname": "<string>"
}
}
}
Authorizations
See our authentication documentation for how to authorize your requests
Headers
The id of the network. Required when using bearer token authentication
Body
application/json
Available options:
day
, week
, month
, threeMonths
, sixMonths
, year
If true, the first invoice will be issued.
Response
200
application/json
OK
Use to attach key-value data to the object. Available only for admins.
Available options:
day
, week
, month
, threeMonths
, sixMonths
, year
curl --request POST \
--url https://api.spacebring.com/subscriptions/v1 \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '{
"subscription": {
"companyRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"membershipRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"period": "day",
"startDate": "2023-12-25",
"endDate": "2023-12-25",
"items": [
{
"credits": 123,
"day_passes": 123,
"price": 123,
"quantity": 123,
"customTax": {
"enabled": true,
"rate": 123
},
"title": "<string>",
"plan": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}
],
"payWithInvoice": {
"desks": true,
"events": true,
"rooms": true,
"shop": true,
"creditPackages": true
}
},
"issueFirstInvoice": true
}'
{
"subscription": {
"company": {
"createDate": "<string>",
"id": "<string>",
"locationRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"metadata": {},
"notes": "<string>",
"subscriptionRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>"
},
"companyRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createDate": "2023-11-07T05:31:56Z",
"credits": 123,
"currentInterval": {
"endDate": "2023-11-07T05:31:56Z",
"startDate": "2023-11-07T05:31:56Z"
},
"dayPasses": 123,
"deleteDate": "2023-11-07T05:31:56Z",
"endDate": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"items": [
{
"credits": 123,
"customTax": {
"enabled": true,
"rate": 123
},
"dayPasses": 123,
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"plan": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"price": 123,
"quantity": 123,
"title": "<string>"
}
],
"locationRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"membershipRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"nextInterval": {
"startDate": "2023-11-07T05:31:56Z"
},
"payWithInvoice": {
"creditPackages": true,
"desks": true,
"events": true,
"rooms": true,
"shop": true
},
"period": "day",
"price": 123,
"startDate": "2023-11-07T05:31:56Z",
"timezoneId": "<string>",
"user": {
"about": "<string>",
"email": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"phoneNumber": "<string>",
"photoUrl": "<string>",
"surname": "<string>"
},
"userCreator": {
"about": "<string>",
"email": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"phoneNumber": "<string>",
"photoUrl": "<string>",
"surname": "<string>"
}
}
}