list_subscription_rate_plans
Retrieve and filter rate plans for a specific subscription to view pricing details, charges, and billing terms. Supports pagination and filtering by status or type.
Instructions
List rate plans on a subscription. GET /subscriptions/{subscriptionId}/rateplans. Returns paginated rate plans (product rate plan ref, name, type, effectiveStartDate, charges when included). Optional: include, pageNo, itemPerPage, orderBy, sortBy, status (active|pause|cancel|archived), type (ongoing|prepaid|contract). status/type filters are case-insensitive.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| subscriptionId | Yes | Subscription ID (required) | |
| include | No | Attributes to include (e.g. rateplanCharge) | |
| pageNo | No | Page number | |
| itemPerPage | No | Items per page | |
| orderBy | No | Sort column | |
| sortBy | No | Sort direction | |
| status | No | Filter by rate plan status (case-insensitive) | |
| type | No | Filter by rate plan type (case-insensitive) |