Sign in

v1

latestOpenAPI 3.0.02026-07-24161215397.4 KB
Plans

Get plan

Get plan by id

Required scopes: flex.billing.plans.read

get/api/v2/organizations/{orgSlug}/plans/{planId}

Path parameters

planIdstring required

plan id

orgSlugstring required

organization slug

Response

propertiesobject

An object that contains all custom properties that can be applied to the item.

_idstring

The _id of the plan.

namestring

The name of the plan.

descriptionstring

Text describing the plan. It will appear when users need to choose among different plans.

codestring

External identified for the plan. Usually used for accounting purposes.

typestring

The type of the plan. It could be office, desk, hotdesk or service or any custom type.

pricenumber

The default unit price for the plan, depending if it is recurring plan or a one-off plan.

depositnumber

The deposit of the plan. This is a fixed price.

depositPercentnumber

The deposit of the plan. This is a percent of the price.

useDepositPercentboolean

This shows if the deposit is fixed or is a percent of the price.

locationsstring[]

An array with the ids of the locations associated with the plan. If the plan is applicable to all locations the array is empty.

imagestring

A link to the image of the plan.

linkstring

Link to the product page. It is used on the signup and checkout pages, and the booking dialog.

intervalLength'once' | 'month'

The plan interval. It could be month or once.

intervalCountnumber

The length of the interval.

revenueAccountstring

The _id of the revenue account associated with the plan.

setupFeesstring[]

An array with the ids of the setup fees associated with the plan.

discountsstring[]

An array with the ids of the discounts applied to the plan.

legalDocumentsstring[]

An array with the ids of the legal documents that members should be prompted to accept when purchasing this plan.

shouldProrateboolean

Shows if the plan has proration

creditsobject[]

An array of the credits in the plan.

useCoinsboolean

Shows if coins can be used in the plan.

passesForLocationsnumber[]

An array with the count of passes in the plan by location.

extrasobject[]

An array with all the extras in the plan.

requiresApprovalboolean

Shows if admins must approve purchases of this plan.

allowsCancellationboolean

Shows if members can request cancellation of this plan.

forMembersboolean

Shows if the plan is available for purchase by members marked as contact person.

forTeamMembersboolean

Shows if the plan is available for purchase by all active company members.

forNonMembersboolean

Shows if the plan is available for purchase on the Signup page and accessible to everyone on the Member Portal.

markupPercentnumber

The markup percent of the plan.

shouldPassesGrantActiveStatusboolean

Shows if passes give active status to the members without active memberships.

amenitiesstring[]

An array with the ids of all the amenities in the plan.

Example response

{
  "properties": {
    "customProperty1": "value1",
    "customProperty2": "value2"
  },
  "_id": "6a59d07d856fad4ee41952be",
  "name": "Plan Name",
  "description": "Example Description",
  "code": "EXMPL",
  "type": "Desk",
  "price": 100,
  "deposit": 50,
  "depositPercent": 20,
  "useDepositPercent": true,
  "locations": [
    "6a59d07d856fad4ee41952bf",
    "6a59d07d856fad4ee41952c0"
  ],
  "image": "exampleImageLink.com",
  "link": "exampleExternalLink.com",
  "intervalCount": 6,
  "revenueAccount": "6a59d07d856fad4ee41952c1",
  "setupFees": [
    "6a59d07d856fad4ee41952c2",
    "6a59d07d856fad4ee41952c3"
  ],
  "discounts": [
    "6a59d07d856fad4ee41952c4",
    "6a59d07d856fad4ee41952c5"
  ],
  "legalDocuments": [
    "6a59d07d856fad4ee41952c6",
    "6a59d07d856fad4ee41952c7"
  ],
  "shouldProrate": true,
  "credits": [],
  "useCoins": true,
  "extras": [],
  "requiresApproval": true,
  "allowsCancellation": true,
  "forMembers": true,
  "forTeamMembers": true,
  "forNonMembers": true,
  "shouldPassesGrantActiveStatus": true,
  "amenities": [
    "6a59d07d856fad4ee41952c8",
    "6a59d07d856fad4ee41952c9"
  ]
}