List My Plans

Returns all active plans (contracts) for the authenticated customer.

GET /api/public/plans/my

List My Plans

cURL

curl --request GET \
  --url https://spaces.nexudus.com/api/public/plans/my \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/public/plans/my"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/public/plans/my', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

List My Plans

Returns the list of plans (contracts/tariffs) that the authenticated customer currently holds. Used to display the customer’s active subscriptions on the dashboard.

A plan (also called a tariff) is a recurring membership package. Each plan creates a contract that tracks billing, start/end dates, and cancellation status.

Authentication

Requires a valid customer bearer token.

Query Parameters

_shape · string

Comma-separated list of field paths to include in the response. When provided, only the specified fields are returned — useful for reducing payload size. Supports nested paths using dot notation. Example: _shape=Records.Tariff.Name,Records.Price,Records.Active,Records.StartDate.

Response

Returns an array of contract/plan objects for the authenticated customer.

Contract Fields

Identity

Field	Type	Description
Id	number	Unique numeric identifier for the contract
UniqueId	string	Globally unique identifier

Dates

Field	Type	Description
StartDate	string | null	Contract start date (business-local)
ContractTerm	string | null	Contract end/term date (business-local)
RenewalDate	string | null	Next renewal date (business-local)
RenewalDateUtc	string | null	Next renewal date (UTC)
CancellationDate	string | null	Scheduled cancellation date
CancellationDateUtc	string | null	Scheduled cancellation date (UTC)
EarliestCancellationDate	string | null	Earliest allowed cancellation date
NextAutoInvoice	string | null	Next automatic invoice date

Pricing

Field	Type	Description
Price	number | null	Current contract price
PriceWithMinimum	number | null	Price including minimum charge
PriceFormatted	string	Price formatted with currency symbol
NextPrice	number | null	Price after next renewal
NextPriceFormatted	string	Next price formatted with currency symbol
Value	number | null	Contract value
DepositsAmount	number	Total deposit amount
DepositsAmountFormatted	string	Deposits formatted with currency symbol

Status

Field	Type	Description
Active	boolean	Whether the contract is currently active
Cancelled	boolean	Whether the contract has been cancelled
MainContract	boolean	Whether this is the primary contract
PricePlanTermsAccepted	boolean	Whether T&C have been accepted
PricePlanTermsAcceptedOn	string | null	When T&C were accepted
IsPaused	boolean	Whether the contract has a pause configured
IsPausedNow	boolean	Whether currently in a paused period
CanBePausedNow	boolean	Whether the contract can be paused now
InPausedPeriod	boolean	Whether currently within a pause period
InPausedPeriodFrom	string | null	Pause start date (business-local)
InPausedPeriodUntil	string | null	Pause end date (business-local)

Billing

Field	Type	Description
BillingDay	number	Day of month billing occurs
Quantity	number	Number of units on this contract
Notes	string	Contract notes
Desks	string	Comma-separated assigned desk names

Nested Objects

Field	Type	Description
IssuedBy	object	Location that issued the contract
Coworker	object	Customer the contract belongs to
Tariff	object	Plan/tariff object (see plan-details for fields)
NextTariff	object | null	Next tariff after renewal (if changing)
Schedules	object[]	Contract schedule entries

Timestamps (from base)

Field	Type	Description
CreatedOn	string	Date created (business-local time)
UpdatedOn	string | null	Date last updated (business-local time)
CreatedOnUtc	string	Date created (UTC)
UpdatedOnUtc	string | null	Date last updated (UTC)

Examples

Fetch my plans

GET /api/public/plans/my
Authorization: Bearer {token}

TypeScript Integration

import endpoints from '@/api/endpoints'

const response = await httpClient.get(endpoints.plans.my)