---
title: "Get plans"
method: GET
path: "/api/v2/organizations/{orgSlug}/plans"
tags: ["Plans"]
---

# Get plans

`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`

Retrieve a list of plans based on provided filters 

 Required scopes: `flex.billing.plans.read`

## Path parameters

- `orgSlug` string, required

## Query parameters

- `_id` string
- `name` string
- `code` string
- `location` string
- `modifiedAt` string
- `createdAt` string
- `$select` string
- `$cursorNext` string
- `$cursorPrev` string
- `$limit` number

## Response `200`

- object
  - `rangeStart` number
  - `rangeEnd` number
  - `cursorNext` string
  - `cursorPrev` string
  - `results` PlanResultDto[]
    - `properties` object: An object that contains all custom properties that can be applied to the item.
    - `_id` string: The _id of the plan.
    - `name` string: The name of the plan.
    - `description` string: Text describing the plan. It will appear when users need to choose among different plans.
    - `code` string: External identified for the plan. Usually used for accounting purposes.
    - `type` string: The type of the plan. It could be office, desk, hotdesk or service or any custom type.
    - `price` number: The default unit price for the plan, depending if it is recurring plan or a one-off plan.
    - `deposit` number: The deposit of the plan. This is a fixed price.
    - `depositPercent` number: The deposit of the plan. This is a percent of the price.
    - `useDepositPercent` boolean: This shows if the deposit is fixed or is a percent of the price.
    - `locations` string[]: An array with the ids of the locations associated with the plan. If the plan is applicable to all locations the array is empty.
    - `image` string: A link to the image of the plan.
    - `link` string: 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.
    - `intervalCount` number: The length of the interval.
    - `revenueAccount` string: The _id of the revenue account associated with the plan.
    - `setupFees` string[]: An array with the ids of the setup fees associated with the plan.
    - `discounts` string[]: An array with the ids of the discounts applied to the plan.
    - `legalDocuments` string[]: An array with the ids of the legal documents that members should be prompted to accept when purchasing this plan.
    - `shouldProrate` boolean: Shows if the plan has proration
    - `credits` object[]: An array of the credits in the plan.
    - `useCoins` boolean: Shows if coins can be used in the plan.
    - `passesForLocations` number[]: An array with the count of passes in the plan by location.
    - `extras` object[]: An array with all the extras in the plan.
    - `requiresApproval` boolean: Shows if admins must approve purchases of this plan.
    - `allowsCancellation` boolean: Shows if members can request cancellation of this plan.
    - `forMembers` boolean: Shows if the plan is available for purchase by members marked as contact person.
    - `forTeamMembers` boolean: Shows if the plan is available for purchase by all active company members.
    - `forNonMembers` boolean: Shows if the plan is available for purchase on the Signup page and accessible to everyone on the Member Portal.
    - `markupPercent` number: The markup percent of the plan.
    - `shouldPassesGrantActiveStatus` boolean: Shows if passes give active status to the members without active memberships.
    - `amenities` string[]: An array with the ids of all the amenities in the plan.

---

[API](https://skmtc.dev/officernd/apis/billing-product-api.md) - [All operations](https://skmtc.dev/officernd/apis/billing-product-api/llms.txt) - [OpenAPI document](https://skmtc.dev/officernd/apis/billing-product-api/revisions/78f9c9851fb0?raw)