Skip to main content
Version: Next

RESTGetAPIEntitlementsQuery

Index

Properties

optionalafter

after?: string

Retrieve entitlements after this date

optionalbefore

before?: string

Retrieve entitlements before this date

optionallimit

limit?: number

Entitlements to return (minimum 1, maximum 100)

@default

100

optionalsku_ids

sku_ids?: string

Comma-delimited set of SKU ids (snowflakes) to check entitlements for

optionaluser_id

user_id?: string

The user id to look up entitlements for

optionalwith_payments

with_payments?: boolean

Whether to include the payment data in the entitlement