2.5 KiB
2.5 KiB
ListCustomersParams
Fields
| Field | Type | Required | Description |
|---|---|---|---|
offset |
Optional[int] | ➖ | Number of items to skip |
limit |
Optional[int] | ➖ | Number of items to return. Default 10, max 1000. |
plans |
List[models.ListCustomersPlan] | ➖ | Filter by plan ID and version. Returns customers with active subscriptions to this plan. |
subscription_status |
Optional[models.SubscriptionStatus] | ➖ | Filter by customer product status. Defaults to active and scheduled |
search |
Optional[str] | ➖ | Search customers by id, name, or email |