list-subscriptions
List all subscriptions with pagination and sorting to monitor customer subscription states and upcoming renewals. Filter by billing period start dates.
Instructions
List all subscriptions with pagination and sorting. Use this to monitor customer subscription states (Active/Cancelled) and upcoming renewals. Note: Billforward has no native filter on subscription creation date — period_start_after/period_start_before filter by the current billing period start instead.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Number of records to return (Hard Max: 200) | |
| offset | No | Number of records to skip for pagination | |
| orderBy | No | Field to order by (e.g., 'created', 'id', 'state') | created |
| orderDirection | No | Direction of sorting | DESC |
| period_start_after | No | Filter subscriptions whose current billing period started after this ISO date | |
| period_start_before | No | Filter subscriptions whose current billing period started before this ISO date |