Plans

Get plans

Retrieve a list of plans based on provided filters

Required scopes: flex.billing.plans.read

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

Request

Base URL
https://app.officernd.com
URL
https://app.officernd.com/api/v2/organizations/{orgSlug}/plans
Auth
OAuth 2
Authorization code: https://identity.officernd.com/auth/authorize
Client credentials
Token URL: https://identity.officernd.com/auth/token scopes: flex.billing.plans.read

Path parameters

orgSlugstring required

organization slug

Query parameters

_idstring

Filter by plan id. Supports single id (e.g. _id=xxx) or multiple (e.g. _id[$in]=id1,id2).

namestring

Example:Plan Name

Filter by the exact name of the plan.

codestring

Example:EXMPL

Filter by the code of the plan.

locationstring

Example:6780f1ba4d5e6f7a8b9c0d1e

Filter by location

modifiedAtstring

Example:modifiedAt[$gte]=YYYY-MM-DDTHH:mm:ssZ

Filter by the modified date. Supports date comparison filters: $gt, $gte, $lt, $lte

createdAtstring

Example:createdAt[$gte]=YYYY-MM-DDTHH:mm:ssZ

Support date comparison filters: $gt, $gte, $lt, $lte

$selectstring

Select fields to return

$cursorNextstring

$cursorPrevstring

$limitnumber

Response

rangeStartnumber

rangeEndnumber

cursorNextstring

cursorPrevstring

Example response

{
  "results": [
    {
      "properties": {
        "customProperty1": "value1",
        "customProperty2": "value2"
      },
      "_id": "6ae8841cc1df3a9836907977",
      "name": "Plan Name",
      "description": "Example Description",
      "code": "EXMPL",
      "type": "Desk",
      "price": 100,
      "deposit": 50,
      "depositPercent": 20,
      "useDepositPercent": true,
      "locations": [
        "6ae8841cc1df3a9836907978",
        "6ae8841cc1df3a9836907979"
      ],
      "image": "exampleImageLink.com",
      "link": "exampleExternalLink.com",
      "intervalCount": 6,
      "revenueAccount": "6ae8841cc1df3a983690797a",
      "setupFees": [
        "6ae8841cc1df3a983690797b",
        "6ae8841cc1df3a983690797c"
      ],
      "discounts": [
        "6ae8841cc1df3a983690797d",
        "6ae8841cc1df3a983690797e"
      ],
      "legalDocuments": [
        "6ae8841cc1df3a983690797f",
        "6ae8841cc1df3a9836907980"
      ],
      "shouldProrate": true,
      "credits": [],
      "useCoins": true,
      "extras": [],
      "requiresApproval": true,
      "allowsCancellation": true,
      "forMembers": true,
      "forTeamMembers": true,
      "forNonMembers": true,
      "shouldPassesGrantActiveStatus": true,
      "amenities": [
        "6ae8841cc1df3a9836907981",
        "6ae8841cc1df3a9836907982"
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.