Retrieve subscriptions

GET

subscriptions

curl --request GET \
  --url https://api.spacebring.com/subscriptions/v1 \
  --header 'Authorization: Basic <encoded-value>'

{
  "subscriptions": [
    {
      "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

Authorization

string

header

required

See our authentication documentation for how to authorize your requests

Headers

spacebring-network-id

string

The id of the network. Required when using bearer token authentication

Query Parameters

locationRef

string

required

The id of the location.

limit

integer

default:

The number of items to return

Required range: 1 < x < 100

nextPageToken

string

nextPageToken retrieved from a previous request

Response

200

application/json

subscriptions

object[]

subscriptions.company

object

subscriptions.companyRef

string

subscriptions.createDate

string

subscriptions.credits

number

subscriptions.currentInterval

object

subscriptions.dayPasses

integer

subscriptions.deleteDate

string

subscriptions.endDate

string

subscriptions.id

string

subscriptions.items

object[]

subscriptions.locationRef

string

subscriptions.membershipRef

string

subscriptions.nextInterval

object

subscriptions.payWithInvoice

object

subscriptions.period

enum<string>

Available options:

day,

week,

month,

threeMonths,

sixMonths,

year

subscriptions.price

number

subscriptions.startDate

string

subscriptions.timezoneId

string

subscriptions.user

object

subscriptions.userCreator

object

Retrieve resources Create a subscription

curl --request GET \
  --url https://api.spacebring.com/subscriptions/v1 \
  --header 'Authorization: Basic <encoded-value>'

{
  "subscriptions": [
    {
      "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>"
      }
    }
  ]
}

Getting Started

Endpoints

Retrieve subscriptions

OAuth

Authorizations

Headers

Query Parameters

Response