Community Member Subscriptions List
list_subscriptionsRetrieve and filter Circle community member subscriptions by status, member, paywall, platform, and dates, with sorting and pagination. Bounded all_pages consumes API quota per page.
Instructions
Community Member Subscriptions List. Reads community data. Supports bounded all_pages; every page counts against the API quota.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number | |
| sort | No | Sort field (one of: charges_quantity, subscription_term, renews_on, community_member_name, paywall_name, platform, status, created_at). Defaults to created_at | |
| query | No | Free-text search | |
| status | No | Comma-separated list of statuses (e.g. active,trial,canceled) | |
| account | No | Named private Circle account; selects credentials, not a remote community ID. | |
| currency | No | Comma-separated list of currency codes | |
| per_page | No | Records per page (max 100) | |
| platform | No | Comma-separated list of platforms (web, app_store, play_store) | |
| all_pages | No | Read bounded page/per_page pages; each request consumes API quota. Not a snapshot or guaranteed complete backup. | |
| direction | No | Sort direction (asc or desc). Defaults to desc | |
| max_items | No | Maximum returned records with all_pages=true, default 1000. At most 100 requests; output includes continuation state. | |
| paywall_ids | No | Comma-separated list of paywall IDs | |
| member_email | No | Filter by community member email (partial match) | |
| start_date_gte | No | Only include subscriptions started on/after this date (ISO8601) | |
| start_date_lte | No | Only include subscriptions started on/before this date (ISO8601) | |
| billing_interval | No | Filter by paywall price billing interval (e.g. month, year) | |
| paywall_price_type | No | Comma-separated list of paywall price types (e.g. subscription,onetime,installments) | |
| community_member_id | No | Filter by community member ID | |
| scheduled_to_cancel | No | Filter by whether the subscription is scheduled to cancel | |
| total_amount_paid_gte | No | Minimum total amount paid (in currency subunits) | |
| total_amount_paid_lte | No | Maximum total amount paid (in currency subunits) | |
| subscription_processor_id | No | Filter by exact subscription processor ID | |
| billing_info_business_name | No | Filter by billing info business name (partial match) | |
| community_member_public_uid | No | Filter by community member public UID |