| Field | Type | Required | Description |
|---|---|---|---|
typeFilter |
Components\BenefitType|array|null | ➖ | Filter by benefit type. |
benefitId |
string|array|null | ➖ | Filter by benefit ID. |
organizationId |
string|array|null | ➖ | Filter by organization ID. |
checkoutId |
string|array|null | ➖ | Filter by checkout ID. |
orderId |
string|array|null | ➖ | Filter by order ID. |
subscriptionId |
string|array|null | ➖ | Filter by subscription ID. |
page |
?int | ➖ | Page number, defaults to 1. |
limit |
?int | ➖ | Size of a page, defaults to 10. Maximum is 100. |
sorting |
array<Components\CustomerBenefitGrantSortProperty> | ➖ | 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. |