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

# Subscription: List

`GET /subscriptions`

List existing subscriptions.

## Query parameters

- `start_time` string, date-time
- `end_time` string, date-time
- `per_page` integer
- `page` integer

## Response `200`

200 response

- SubscriptionList
  - `resource` string, required — Resource type name, always "subscription_list".
  - `data` Subscription[], required — Array of subscription objects for this page.
    - `id` string, required — A unique 25-character alphanumeric resource identifier.
    - `resource` 'subscription', required — Resource type name, always "subscription".
    - `status` string, required — Current status of the subscription (e.g. "active", "cancelled").
    - `amount` integer, required — Amount greater than or equal to 0, in the lowest denomination of the currency (e.g. cents for USD).
    - `currency` 'JPY' | 'USD' | 'EUR' | 'TWD' | 'KRW' | 'PLN' | 'GBP' | 'HKD' | 'SGD' | 'NZD' | 'AUD' | 'IDR' | 'MYR' | 'PHP' | 'THB' | 'CNY' | 'BRL' | 'CHF' | 'CAD' | 'VND', required — 3-letter ISO currency code.
    - `customer` object, required
      - `id` integer, required — Internal numeric ID of the customer.
      - `uuid` string, required — A unique 25-character alphanumeric resource identifier.
      - `merchant_id` integer, required — Internal numeric ID of the merchant.
      - `created_at` string, date-time, required — Timestamp when the customer was created.
      - `updated_at` string, date-time, required — Timestamp when the customer was last updated.
      - `email` string, nullable, required — Customer's email address, or null if not provided.
      - `currency` 'JPY' | 'USD' | 'EUR' | 'TWD' | 'KRW' | 'PLN' | 'GBP' | 'HKD' | 'SGD' | 'NZD' | 'AUD' | 'IDR' | 'MYR' | 'PHP' | 'THB' | 'CNY' | 'BRL' | 'CHF' | 'CAD' | 'VND', required — 3-letter ISO currency code.
      - `locale` 'ja' | 'en' | 'ko', required — For supported payment methods, sets the language of the instruction page.
      - `name` string, nullable, required — Customer-defined display name, or null if not set.
      - `phone` string, nullable, required — Customer's phone number, or null if not set.
      - `archived_at` string, date-time, nullable, required — Timestamp when the customer was archived, or null if still active.
    - `period` 'weekly' | 'monthly' | 'yearly', required — Interval for subscription payments
    - `day` integer, required — Day of the period on which the subscription is charged.
    - `payment_details` object, required
      - `type` string, required — Payment method type for this subscription.
      - `month` string, required — Card expiry month.
      - `year` string, required — Card expiry year.
      - `email` string, required — Customer's email address.
    - `retry_count` integer, required — Number of times payment has been retried after failure.
    - `retry_at` string, date-time, nullable, required — Timestamp of the next scheduled payment retry, or null.
    - `next_capture_at` string, date-time, required — Timestamp of the next scheduled subscription charge.
    - `created_at` string, date-time, required — Timestamp when the subscription was created.
    - `ended_at` string, date-time, nullable, required — Timestamp when the subscription ended, or null if still active.
    - `metadata` object, required — Arbitrary key-value metadata attached to the subscription.
    - `payments` UUID[], required — Array of payment UUIDs associated with this subscription.
  - `start_time` string, date-time, required — Start of the time range for records in this response.
  - `end_time` string, date-time, required — End of the time range for records in this response.
  - `total` integer, required — Total number of records matching the query.
  - `page` integer, required — Current page number.
  - `per_page` integer, required — Number of results per page.
  - `last_page` integer, required — Last available page number.

---

[API](https://skmtc.net/komoju/apis/komoju-api.md) · [All operations](https://skmtc.net/komoju/apis/komoju-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/komoju/komoju-api/versions/65483c40ba32/schema)