---
title: "List packages"
method: GET
path: "/package/lists"
tags: ["Package"]
---

# List packages

`GET /package/lists`

## Request

- Base URL: `https://demo.onlinebillingform.com/api/v2`
- URL: `https://demo.onlinebillingform.com/api/v2/package/lists`
- Auth: HTTP bearer

Use this BillingServ API endpoint to list packages. Review the response for the operation result or validation errors.

## Query parameters

- `featured` string
- `per_page` integer

## Response `200`

OK

- PackageListResponse
  - `success` true, required
  - `packages` object, required
    - `data` object[], required
      - `options` PackageOption[], required
        - `id` integer, required
        - `user_id` integer
        - `internal_name` string
        - `display_name` string, required
        - `api_type` string, nullable
        - `required` integer, required: 1 when the option must be supplied, otherwise 0.
        - `type` integer, required: Control type: 0 select, 1 text, 2 number, 3 radio, 4 checkbox, 5 switch.
        - `values` PackageOptionValue[], required
          - `id` integer, required
          - `option_id` integer, required
          - `display_name` string, required
          - `cycle_type` integer, required: Billing cycle identifier for this predefined option value.
          - `price` number, double, required
          - `fee` number, double, required
          - `created_at` string, date-time, nullable
          - `updated_at` string, date-time, nullable
          - `deleted_at` string, date-time, nullable
        - `created_at` string, date-time, nullable
        - `updated_at` string, date-time, nullable
        - `deleted_at` string, date-time, nullable

## Other responses

- `401`: Missing or invalid API key
- `403`: Authenticated key does not have permission for this endpoint
- `422`: Validation error

## Changes

- **2026-08-22** `76cfbed5eb40`: 3 info
  - the response property `success` became required for the status `200`
  - the `success` response property const value `true` was added for the status `200`
  - added the required property `packages` to the response with the `200` status
- **2026-08-22** `6b9208b64456`: 6 info
  - added the optional property `code` to the response with the `401` status
  - added the optional property `code` to the response with the `403` status
  - added the optional property `code` to the response with the `422` status
  - added the optional property `request_id` to the response with the `401` status
  - …2 more

[Operation history](https://skmtc.dev/billingserv/apis/billingserv-api-v2/changes/package/lists/get.md)

---

[API](https://skmtc.dev/billingserv/apis/billingserv-api-v2.md) - [All operations](https://skmtc.dev/billingserv/apis/billingserv-api-v2/llms.txt) - [OpenAPI document](https://skmtc.dev/billingserv/apis/billingserv-api-v2/revisions/232ab5ca8413?raw)