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

# List subscriptions

`GET /subscriptions/`

## Query parameters

- `page` integer
- `page_size` integer
- `ordering` string
- `customer` string
- `status` 'active' | 'paused' | 'cancelled' | 'finalized' | 'needs_attention'
- `next_billing` string, date
- `date_start` string, date
- `document` integer
- `lines` string
- `addons` integer
- `coupon` string
- `cancelled` string, date-time
- `cancel_reason` string
- `paused` string, date-time
- `paused_reason` string
- `needs_attention` string, date-time
- `needs_attention_reason` string
- `instant` boolean

## Headers

- `x-simple-workspace` string, required
- `x-piriod-test-mode` boolean

## Response `200`

Paginated subscription list.

- object
  - `count` integer, required — Total number of items matching the filter.
  - `next` string, uri, nullable — URL of the next page, or `null` if last page.
  - `previous` string, uri, nullable — URL of the previous page, or `null` if first page.
  - `results` Subscription[], required — The items in the current page.
    - `id` string
    - `customer` string, required — Customer ID.
    - `document` integer, required — Document type ID used to issue invoices.
    - `date_start` string, date, required
    - `next_billing` string, date, required
    - `previous_billing` string, date, nullable
    - `billing_cycles` integer, nullable — Total cycles or null for indefinite.
    - `next_billing_cycle` integer
    - `expiration_days` integer — Days until invoices generated by this subscription expire.
    - `collection_scheme` 'send_invoice' | 'charge_payment'
    - `default_source` string, nullable — Default payment source ID. Required when `collection_scheme=charge_payment`.
    - `custom_change` number, nullable — Custom currency conversion factor for issued invoices.
    - `coupon` string, nullable — Coupon ID applied at the subscription (invoice-level) scope.
    - `coupon_redemptions` integer
    - `require_reference` boolean
    - `note` string, nullable
    - `orgunit` integer, nullable
    - `status` 'active' | 'paused' | 'cancelled' | 'finalized' | 'needs_attention'
    - `status_description` string, nullable
    - `needs_attention` string, date-time, nullable
    - `needs_attention_reason` 'biller_issue' | 'gateway_issue' | 'reference_expired' | 'without_usage_records' | 'processing_issue' | 'without_reference', nullable
    - `cancel_reason` 'custom' | 'fraud_review_failed' | 'insolvency' | 'no_card' | 'non_compliant_customer' | 'not_paid' | 'not_specified' | 'shutdown_ops', nullable
    - `cancelled` string, date-time, nullable
    - `paused` string, date-time, nullable
    - `paused_reason` 'not_specified' | 'non_compliant_customer' | 'custom', nullable
    - `pause_until` string, date, nullable
    - `lines` SubscriptionLine[], required
      - `id` string
      - `plan` string, required — Plan ID. Read responses include the full plan inline.
      - `quantity` integer, required
      - `coupon` string, nullable — Coupon ID applied to this line.
      - `coupon_redemptions` integer
      - `created` string, date-time
      - `updated` string, date-time
    - `addons` SubscriptionAddon[]
      - `addon` string — Addon ID.
      - `quantity` integer
      - `addon_redemptions` integer
      - `rates` SubscriptionAddonRate[]
        - `billing_cycle` integer — Billing cycle this rate applies to.
        - `percentage` number — Discount/markup percentage applied to the addon for the cycle.
        - `description` string, nullable
    - `references` SubscriptionReference[]
      - `date` string, date, required
      - `date_end` string, date, nullable
      - `document` string, required — Document reference type.
      - `description` string, nullable
      - `serial` string, required
    - `test_mode` boolean
    - `created` string, date-time
    - `updated` string, date-time

---

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