---
title: "Returns number of rate plans"
method: GET
path: "/rateplan/v1/rate-plans/$count"
tags: ["RatePlan"]
---

# Returns number of rate plans

`GET /rateplan/v1/rate-plans/$count`

## Request

- Base URL: `https://api.apaleo.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.apaleo.com/rateplan/v1/rate-plans/$count`
- Auth: OAuth 2
  - Implicit: `https://identity.apaleo.com/connect/authorize`
  - Scopes: `rateplans.read`, `setup.read`, `setup.manage`, `admin`

Returns number of rate plans matching the filter criteria, and depending on client scopes


            
If a client has no additional scopes, only public rate plans are counted.

The 'rateplans.read-corporate' scope adds corporate rate plans to the result number.<br>You must have at least one of these scopes: 'rateplans.read, setup.read, setup.manage'.<br>For fine-grained clients, you must have this permission: 'core.rate_plans.read'.

## Query parameters

- `propertyId` string
- `ratePlanCodes` string[]
- `includedServiceIds` string[]
- `channelCodes` string[]
- `promoCodes` string[]
- `companyIds` string[]
- `baseRatePlanIds` string[]
- `unitGroupIds` string[]
- `timeSliceDefinitionIds` string[]
- `unitGroupTypes` string[]
- `timeSliceTemplate` 'DayUse' | 'OverNight'
- `minGuaranteeTypes` string[]
- `cancellationPolicyIds` string[]
- `noShowPolicyIds` string[]
- `isDerived` boolean
- `derivationLevelFilter` string[]
- `includeArchived` boolean

## Response `200`

Success

- CountModel
  - `count` integer, required

## Other responses

- `400`: Bad request.
- `401`: You are unauthorized.
- `403`: Forbidden.
- `404`: The Request-URI could not be found.
- `422`: Validation errors in the request body or query params.
- `499`: Client closed request.
- `500`: An unexpected error occurred.
- `503`: The server is currently unavailable. Please try later.

---

[API](https://skmtc.dev/apaleo/apis/apaleo-rate-plan-api.md) - [All operations](https://skmtc.dev/apaleo/apis/apaleo-rate-plan-api/llms.txt) - [OpenAPI document](https://skmtc.dev/apaleo/apis/apaleo-rate-plan-api/revisions/9c4f5fec8ed5?raw)