> ## Documentation Index
> Fetch the complete documentation index at: https://docs.withorb.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Summary list endpoints

Two list endpoints have a summary version that returns lighter objects:

| Full list | Summary list | Each summary carries | Left out |
| - | - | - | - |
| [List subscriptions](https://docs.withorb.com/api-reference/subscription/list-subscriptions.md) | [List subscription summaries](https://docs.withorb.com/api-reference/subscription/list-subscription-summaries.md) (`GET /v1/subscriptions/summary`) | A `SubscriptionSummary`: `id`, `name`, `status`, `start_date`, `end_date`, `created_at`, `metadata`, and the plan and customer as references | Price intervals, billing periods and the billing cycle anchor, plan phases, adjustment, discount, minimum and maximum intervals, the fixed fee quantity schedule, trial info, pending changes, redeemed coupons, invoicing threshold, net terms and auto-collection settings |
| [List invoices](https://docs.withorb.com/api-reference/invoice/list-invoices.md) | [List invoices summary](https://docs.withorb.com/api-reference/invoice/list-invoices-summary.md) (`GET /v1/invoices/summary`) | An `InvoiceSummary`: every invoice field except those left out | Line items, `subtotal`, discounts, minimums and maximums |

A summary list takes the same filters as its full list, and pages and orders its results the same way. Its summaries are the same objects that [standard webhook payloads](https://docs.withorb.com/integrations-and-exports/webhooks/payload-styles.md) carry.

## When to use a summary list

The full lists compute what they return for each object on the page: a subscription's price intervals and billing periods, or an invoice's line items. That work grows with each subscription's history and each invoice's size, so pages of large subscriptions or invoices can take seconds to return. A summary list reads only each object's own fields, so its pages stay quick however large the objects are.

Use a summary list when you only need to know which subscriptions or invoices exist and their state, for example to sync them into another system, to check statuses, or to find the objects that need more work. Use the full list when you need what the summary leaves out for most of the page.

When you need the full object for only some of the results, page through the summary list and fetch those objects with [Fetch subscription](https://docs.withorb.com/api-reference/subscription/fetch-subscription.md) or [Fetch invoice](https://docs.withorb.com/api-reference/invoice/fetch-invoice.md):

```python theme={null}
from orb import Orb

client = Orb()  # reads ORB_API_KEY

for summary in client.subscriptions.list_summary(customer_id="cus_123", status="active"):
    if summary.metadata.get("needs_review") == "true":
        subscription = client.subscriptions.fetch(summary.id)
        ...
```

## Using the summary lists from the SDKs

| SDK | Subscriptions | Invoices |
| - | - | - |
| Python | `client.subscriptions.list_summary()` | `client.invoices.list_summary()` |
| TypeScript | `client.subscriptions.listSummary()` | `client.invoices.listSummary()` |
| Java and Kotlin | `client.subscriptions().listSummary()` | `client.invoices().listSummary()` |
| Go | `client.Subscriptions.ListSummary(ctx, params)` | `client.Invoices.ListSummary(ctx, params)` |
| Ruby | `client.subscriptions.list_summary` | `client.invoices.list_summary` |
| C# | `await client.Subscriptions.ListSummary()` | `await client.Invoices.ListSummary()` |

Each method returns a page you can iterate through, like the SDK's other list methods.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.