---
title: "Get payment plan collection"
method: GET
path: "/payment-plans"
tags: ["Payment Plans"]
---

# Get payment plan collection

`GET /payment-plans`

Query all payment plans filtered by the provided parameters

## Query parameters

- `id` integer
- `name` string
- `type` 'subscription' | 'cycle'
- `status` 'active' | 'inactive'
- `currency` 'CAD' | 'USD'
- `setupAmount` number, float
- `recurringAmount` number, float
- `billingPeriod` 'daily' | 'weekly' | 'monthly' | 'yearly'
- `billingPeriodIncrements` integer
- `dateBilling` string
- `termType` 'forever' | 'expires'
- `freeTrialPeriod` integer
- `taxType` 'no_tax' | 'customer' | 'merchant'
- `taxCalculation` 'country_only' | 'country_province' | 'province_only'
- `paymentMethod` 'card' | 'bank' | 'card_bank'
- `addOnId` integer
- `sortBy` 'asc' | 'desc'
- `limit` integer
- `offset` integer

## Headers

- `api-token` string, required

## Response `200`

Successful payment plan collection query. The response body contains the data representation of all queried  payment plans matching the provided parameters.

- PaymentPlanCollectionRes
  - `data` BasePaymentPlan[]
    - `id` integer
    - `dateCreated` string
    - `dateUpdated` string
    - `name` string
    - `description` string
    - `type` string
    - `status` string
    - `currency` string
    - `cardTerminalId` number, float
    - `setupAmount` number, float
    - `recurringAmount` number, float
    - `billSetupImmediately` string
    - `billingPeriod` string
    - `billingPeriodIncrements` integer
    - `dateBilling` string
    - `termType` string
    - `freeTrialPeriod` integer
    - `taxType` string
    - `taxCalculation` string
    - `termLength` integer
    - `paymentMethod` string
    - `businessEmail` string
    - `addOnIds` integer[]

## Other responses

- `204` — No payment plans found matching the provided parameters.
- `400` — You are initiating a request with invalid parameter and/or body values.
- `401` — You are not authorized to access this resource. Please ensure that you are authenticated, and that you are using the `api-token` header
- `403` — You do not have permission to access this resource. Please ensure you are both authenticated and that you have the required roles/permissions active.
- `500` — Helcim internal server error encountered.

---

[API](https://skmtc.net/helcim/apis/the-helcim-api.md) · [All operations](https://skmtc.net/helcim/apis/the-helcim-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/helcim/the-helcim-api/revisions/345052ca6578/schema)