Sign in

v7

latestOpenAPI 3.1.02026-08-051856761.1 MB
customer_portal
benefit-grants
public

List Benefit Grants

List benefits grants of the authenticated customer.

Scopes: customer_portal:read customer_portal:write

get/v1/customer-portal/benefit-grants/

Query parameters

querystring nullable

Filter by benefit description.

Filter by benefit description.

'custom' | 'discord' | 'github_repository' | 'downloadables' | 'license_keys' | 'meter_credit' | 'feature_flag' | 'slack_shared_channel'
OR
BenefitType[]

Filter by benefit type.

string uuid4
OR
string[]

Filter by benefit ID.

string uuid4
OR
string[]

Filter by checkout ID.

string uuid4

The order ID.

OR
string[]

Filter by order ID.

string uuid4

The subscription ID.

OR
string[]

Filter by subscription ID.

string uuid4
OR
string[]

Filter by member ID.

pageinteger

Page number, defaults to 1.

Page number, defaults to 1.

limitinteger

Size of a page, defaults to 10. Maximum is 100.

Size of a page, defaults to 10. Maximum is 100.

sortingCustomerBenefitGrantSortProperty[] nullable

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.

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.

Response

Successful Response