---
title: "List billing subscriptions"
method: GET
path: "/api/external/v2/billing_subscriptions"
tags: ["Billing Subscriptions"]
---

# List billing subscriptions

`GET /api/external/v2/billing_subscriptions`

This endpoint returns a list of subscriptions.

> ℹ️
> This endpoint requires one of the following scopes: `billing_subscriptions:all`, `billing_subscriptions:readonly`

## Query parameters

- `cursor` string
- `limit` integer
- `filter` string
- `sort` string

## Response `200`

Returns a list of billing subscriptions

- object
  - `has_more` boolean, required — Indicates whether additional results are available beyond this set. Use this flag to determine if another request is needed.
  - `next_cursor` string, nullable, required — Cursor to retrieve the next set of results. Include this value in the cursor parameter of your next request to fetch subsequent items. A `null` `next_cursor` in the response indicates no further results.
  - `items` object[], required
    - `id` integer, required — Billing subscription identifier
    - `next_occurrence` string, date, nullable, required — The date for the next subscription renewal
    - `prev_occurrence` string, date, nullable, required — The date of the previous subscription renewal
    - `stopped_at` string, date-time, nullable, required — The exact timestamp when the subscription was terminated
    - `start` string, date, nullable, required — The subscription start date
    - `finish` string, date, nullable, required — The date of the last occurrence of the subscription
    - `status` 'draft' | 'stopped' | 'finished' | 'pending' | 'not_started' | 'in_progress', required
    - `mode` 'awaiting_validation' | 'finalized' | 'email', required — - `awaiting_validation`: generated invoices will be in draft - `finalized`: generated invoices will be finalized - `email`: generated invoices will be finalized and sent by email to the recipients configured on the subscription
    - `activated_at` string, date-time, nullable, required — The exact timestamp for when the subscription was activated
    - `payment_conditions` union, required
      - 'upon_receipt' | '7_days' | '15_days' | '30_days' | '30_days_end_of_month' | '45_days' | '45_days_end_of_month' | '60_days'
      - unknown
    - `payment_method` 'offline' | 'gocardless_direct_debit' | 'pro_account_sepa_core', required — Payment method offline means the subscription is not linked to a payment method gocardless_direct-debit means at each new occurrence the client will be automatically debited thanks to GoCardless. To do so, you need a GoCardless account properly configured.
    - `label` string, nullable, required
    - `email_settings` object, nullable, required
      - `recipients` string[], required — Primary email recipients for invoice delivery
      - `billing_email_template` object, nullable, required
        - `id` integer, required
        - `label` string, required
    - `recurring_rule` object, required
      - `day_of_month` number[], nullable, required
      - `month_of_year` number[], nullable, required
      - `week_start` number, nullable, required
      - `day` number[], nullable, required
      - `rule_type` 'weekly' | 'monthly' | 'yearly', required
      - `interval` integer, nullable, required
      - `count` integer, nullable, required — Number of occurrences of the recurring rule
      - `until` string, nullable, required
    - `customer` object, nullable, required
      - `id` integer, required
      - `url` string, required — URL to get the customer.
    - `customer_invoice_data` object, required
      - `label` string, nullable, required — Invoice label
      - `currency` 'EUR' | 'USD' | 'GBP' | 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BYR' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'FJD' | 'FKP' | 'GEL' | 'GGP' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'IMP' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JEP' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LTL' | 'LVL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SLE' | 'SOS' | 'SRD' | 'STD' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'UYU' | 'UZS' | 'VEF' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XDR' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMK' | 'ZMW' | 'ZWL', required
      - `amount` string, required — Invoice amount (total value of the invoice in euros. If the currency is euro, `currency_amount` and `amount` are identical)
      - `currency_amount` string, required — Invoice currency amount (total value of the invoice in the currency of the invoice)
      - `currency_amount_before_tax` string, required — Invoice currency amount before tax (total value before tax of the invoice in the currency of the invoice)
      - `exchange_rate` string, required — Invoice exchange rate (used to convert the invoice to euros. If the invoice currency is euro it will be 1.0)
      - `currency_tax` string, required — Invoice taxable amount (in euros. If the currency is euro, `currency_amount` and `amount` are identical)
      - `language` 'fr_FR' | 'en_GB' | 'de_DE', required — The local default is based on the thirdparty (customer / supplier ) billing_language . In case the customer is not present, we will default to the company locale.
      - `customer_invoice_template` object, nullable, required
        - `id` integer, required
      - `discount` object, required
        - `type` 'absolute' | 'relative', required — Discount type. - absolute if it is an amount - relative if it is a percentage
        - `value` string, nullable, required — Discount value on the total amount before tax
      - `pdf_invoice_free_text` string, required
      - `pdf_invoice_subject` string, required
      - `pdf_description` string, nullable, required
      - `special_mention` string, nullable, required — Additional details
      - `invoice_line_sections` object, required
        - `url` string, required — URL to get the invoice line sections of the invoice.
      - `invoice_lines` object, required
        - `url` string, required — URL to get the invoice lines of the invoice.
    - `created_at` string, date-time, required — The time the subscription has been created
    - `updated_at` string, date-time, required — The last time the subscription has been updated

## Other responses

- `400` — Bad request
- `401` — Access token is missing or invalid
- `403` — Access to this resource forbidden
- `404` — The resource was not found

---

[API](https://skmtc.net/pennylane/apis/company-v2.md) · [All operations](https://skmtc.net/pennylane/apis/company-v2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/pennylane/company-v2/versions/a5b7236473c6/schema)