---
title: "Retrieves the collection of Plan resources."
method: GET
path: "/plans"
tags: ["Plan"]
---

# Retrieves the collection of Plan resources.

`GET /plans`

Retrieves the collection of Plan resources.

## Query parameters

- `page` integer
- `itemsPerPage` integer

## Response `200`

Plan collection

- Plan[]
  - `id` string
  - `integration` string — The key of the integration source e.g. "quickbooks", or "xero"
  - `srcId` string, nullable
  - `isActive` boolean, nullable
  - `aggregateUsage` string, nullable — A usage aggregation strategy for metered usage plans e.g. "sum" e.g. "last_during_period" e.g. "max"
  - `amount` integer, nullable — price of the plan
  - `billingScheme` string, nullable — Describes how to compute the price per period e.g. "per_unit" e.g. "tiered"
  - `created` string, date-time — The date and time the plan is first created
  - `currency` string, nullable
  - `description` string, nullable — plan description
  - `productId` string, nullable — id for the plan
  - `tiersMode` string, nullable — Defines if the tier pricing should be graduated or volume e.g. "graduated" e.g. "volume"
  - `transformUsage` integer, nullable — Division transformation applied to the reported usage
  - `usageType` string, nullable — Configures how the quantity per period should be determined e.g. "metered" e.g. "licensed"
  - `intervalCount` integer, nullable
  - `trialPeriodDays` integer, nullable

---

[API](https://skmtc.net/bossinsights/apis/boss-insights.md) · [All operations](https://skmtc.net/bossinsights/apis/boss-insights/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bossinsights/boss-insights/revisions/d08a107895ad/schema)