Search documentation of polar_express

# PolarExpress.Params.BenefitsListBenefitGrantsParams (polar_express v0.1.5)

Copy Markdown View Source

Parameters for benefits list benefit grants.

## Summary

### Types

t()

## Types

# t()

    @type t() :: %PolarExpress.Params.BenefitsListBenefitGrantsParams{
      customer_id: map() | nil,
      is_granted: boolean() | nil,
      limit: integer() | nil,
      member_id: map() | nil,
      page: integer() | nil
    }

- `customer_id` - Filter by customer.
- `is_granted` - Filter by granted status. If `true`, only granted benefits will be returned. If `false`, only revoked benefits will be returned.
- `limit` - Size of a page, defaults to 10. Maximum is 100.
- `member_id` - Filter by member.
- `page` - Page number, defaults to 1.