---
title: "List Subscriptions"
method: GET
path: "/v1/subscriptions"
tags: ["Subscriptions"]
---

# List Subscriptions

`GET /v1/subscriptions`

The **List Subscriptions** endpoint allows you to retrieve a list of all active subscriptions within your organization. Use this endpoint to track and manage your organization's ongoing subscriptions with its customers.

> 📘 Note
> 
> A subscription is created automatically when a customer makes a payment on a recurring plan. Use this endpoint to track all active subscriptions.

## Query parameters

- `customer_id` string
- `status` 'Pending' | 'Active' | 'Canceled' | 'InTrial'
- `after` string
- `before` string
- `limit` integer
- `page` integer
- `since` string
- `sort` 'asc' | 'desc'
- `until` string

## Response `200`

OK

- InternalPaginatedResponseSubscriptionsSubscriptionResponse
  - `data` InternalPaginatedItemsSubscriptionsSubscriptionResponse
    - `items` SubscriptionsSubscriptionResponse[]
      - `cancel_at_period_end` boolean — Indicates whether the subscription will be canceled at the end of the current period.
      - `created_at` string — The timestamp indicating when the subscription was created.
      - `currency` string — The currency of the subscription.
      - `customer` CustomersCustomerResponse
        - `created_at` string — The timestamp indicating when the customer was created.
        - `deleted_at` string — The timestamp indicating when the customer was deleted, if applicable.
        - `email` string — The email address of the customer.
        - `id` string — The unique identifier of the customer.
        - `metadata` object
        - `name` string — The name of the customer.
        - `org_id` string — The identifier representing the organization associated with the customer.
        - `phone` string — The phone number of the customer.
        - `properties` object — Additional properties associated with the customer.
        - `reference` string — The reference associated with the customer.
        - `updated_at` string — The timestamp indicating when the customer was last updated.
        - `v1` unknown
        - `wallet_address` string — The wallet address associated with the customer.
      - `customer_id` string — The unique identifier of the customer associated with the subscription.
      - `id` string — The unique identifier of the subscription.
      - `items` SubscriptionsSubscriptionItem[] — List of subscription items included in the subscription.
        - `created_at` string — The timestamp indicating when the subscription item was created.
        - `id` string — The unique identifier of the subscription item.
        - `plan_id` string — The unique identifier of the plan associated with the subscription item.
        - `properties` object
        - `subscription_id` string — The unique identifier of the subscription associated with the subscription item.
        - `updated_at` string — The timestamp indicating when the subscription item was last updated.
      - `metadata` integer[] — Additional metadata associated with the subscription.
      - `org_id` string — The identifier representing the organization associated with the subscription.
      - `payment_method` 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 — The payment method: - 1 = Unknown - 2 = Merchantcontract - 3 = Proxywallet - 4 = Unblock - 5 = Card - 6 = Googlepay - 7 = Applepay - 8 = Paypal - 9 = Directdebit - 10 = Ramp - 11 = Rampcryptosettlement
      - `properties` object
      - `reference` string — The reference associated with the subscription.
      - `source` 1 | 2 | 3 | 4 — The source of this billing information. Can be one of the following: - 1 = Lago - 2 = Boomfi - 3 = Stripe - 4 = Chargebee
      - `start_at` string — The timestamp indicating when the subscription starts.
      - `status` 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 — The current status of the subscription. - 1 = Unknown - 2 = Pending - 3 = Future - 4 = Intrial - 5 = Active - 6 = Paused - 7 = Expired - 8 = Canceled
      - `updated_at` string — The timestamp indicating when the subscription was last updated.
      - `v1` integer[] — v1
    - `last_update` string — Timestamp of the last update in the subscription list.
    - `next` integer — Index of the next page of subscriptions.
    - `total` integer — Total number of subscriptions in the system.
  - `error` boolean

## Other responses

- `400` — Bad Request
- `500` — Internal Server Error

---

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