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

# Get payment plan

`GET /payment-plans/{paymentPlanId}`

Query a payment plan by id

## Path parameters

- `paymentPlanId` integer, required

## Query parameters

- `includeSubObjects` boolean

## Headers

- `api-token` string, required

## Response `200`

Successful payment plan query. The response body contains the data representation of the queried  payment plan and (if requested) any sub-objects linked to it.

- PaymentPlanWithSubObjectsRes
  - `id` integer
  - `dateCreated` string
  - `dateUpdated` string
  - `name` string
  - `description` string
  - `type` string
  - `status` string
  - `currency` string
  - `cardTerminalId` integer
  - `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[]
  - `addOns` BaseAddOn[]
    - `id` integer
    - `dateCreated` string, date-time
    - `dateUpdated` string, date-time
    - `name` string
    - `description` string
    - `amount` number, float
    - `frequency` string
    - `isQuantityEditable` string
  - `isProrated` string

## Other responses

- `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.
- `404` — No resource(s) found for the given request. If you have not used query parameters with your request your business currently has no resource(s) matching the specified values.
- `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/versions/345052ca6578/schema)