---
title: "Get Plan Subscription List"
method: GET
path: "/v3.0/plan-subscriptions/"
tags: ["plan-subscriptions"]
---

# Get Plan Subscription List

`GET /v3.0/plan-subscriptions/`

## Request

- Base URL: `https://api.formaloo.me`
- URL: `https://api.formaloo.me/v3.0/plan-subscriptions/`
- Auth: none declared. Required headers: `x-api-key`

## Query parameters

- `active_business` string, required
- `page` integer
- `search` string

## Headers

- `x-api-key` string, required

## Response `200`

- PaginatedPlanSubscriptionShortList
  - `count` integer
  - `next` string, uri, nullable
  - `previous` string, uri, nullable
  - `page_size` integer
  - `page_count` integer
  - `current_page` integer
  - `plan_subscriptions` PlanSubscriptionShort[]
    - `plan_deal` ShortPlanDeal
      - `plan` ShortPlan
        - `title` string, nullable: the title of plan.
        - `plan_type` 'free' | 'plus' | 'pro' | 'advance' | 'enterprise' | 'team' | 'on_premise': * `free` - Free * `plus` - Plus * `pro` - Pro * `advance` - Advanced * `enterprise` - Enterprise * `team` - Team * `on_premise` - On Premise
        - `description` string, nullable
        - `slug` string, nullable
      - `slug` string, nullable
      - `title` string, nullable: the title of the item as shown for the admin.
      - `display_title` string, nullable: the title of the item to show in dashboards.
      - `is_subscription` boolean: is this a subscription or one time purchase?
      - `subscription_period` union: the period of the subscription * `None` - --- * `monthly` - Monthly * `annual` - Annual
        - 'monthly' | 'annual': * `None` - --- * `monthly` - Monthly * `annual` - Annual
        - ''
        - unknown
      - `description` string, nullable
    - `status` 'pending' | 'active' | 'canceling' | 'cancelled': * `pending` - Pending * `active` - Active * `canceling` - canceling * `cancelled` - Cancelled
    - `subscription_method` PaymentMethodShort
      - `title` string, required: payment method's display name.
      - `logo` string, uri: payment method's logo.
      - `description` string, nullable: any extra description to show with payment method.
    - `created_at` string, date-time
    - `slug` string, nullable

---

[API](https://skmtc.dev/formaloo/apis/formaloo-api-documentation.md) · [All operations](https://skmtc.dev/formaloo/apis/formaloo-api-documentation/llms.txt) · [OpenAPI document](https://skmtc.dev/formaloo/apis/formaloo-api-documentation/revisions/47b268aeb656?raw)