Search documentation of polar_express

# PolarExpress.Params.CustomerPortal.BenefitGrantsListBenefitGrantsParams (polar_express v0.1.5)

Copy Markdown View Source

Parameters for benefit grants list benefit grants.

## Summary

### Types

t()

## Types

# t()

    @type t() :: %PolarExpress.Params.CustomerPortal.BenefitGrantsListBenefitGrantsParams{
      benefit_id: map() | nil,
      checkout_id: map() | nil,
      limit: integer() | nil,
      member_id: map() | nil,
      order_id: map() | nil,
      page: integer() | nil,
      query: String.t() | nil,
      sorting: [map()] | nil,
      subscription_id: map() | nil,
      type: map() | nil
    }

- `benefit_id` - Filter by benefit ID.
- `checkout_id` - Filter by checkout ID.
- `limit` - Size of a page, defaults to 10. Maximum is 100.
- `member_id` - Filter by member ID.
- `order_id` - Filter by order ID.
- `page` - Page number, defaults to 1.
- `query` - Filter by benefit description.
- `sorting` - Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign `-` before the criteria name to sort by descending order.
- `subscription_id` - Filter by subscription ID.
- `type` - Filter by benefit type.