POpolar
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/

Request

  • Base URL
    https://api.polar.sh
  • URL
    https://api.polar.sh/v1/customer-portal/benefit-grants/
  • Auth
    • HTTP bearer
    • or HTTP bearer

Query parameters

querystring nullable

Filter by benefit description.

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

The order ID.

OR
string[]
string uuid4

The subscription ID.

OR
string[]
string uuid4
OR
string[]
pageinteger

Page number, defaults to 1.

limitinteger

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.

Response

Successful Response

Changes

No recorded changes to this operation across all 11 revisions of this API.