Entitlements

Query entitlements

Changed on

Use when listing or searching entitlements (e.g. plan editor or audit). Returns a paginated list; supports filtering by plan, addon, feature.

post/entitlements/search

Request

  • Base URL
    https://us.api.flexprice.io/v1
  • URL
    https://us.api.flexprice.io/v1/entitlements/search
  • Auth
    API key in header x-api-key

Request body

end_timestring date-time
entity_idsstring[]
entity_type'PLAN' | 'SUBSCRIPTION' | 'ADDON'
expandstring
feature_idsstring[]
feature_type'metered' | 'boolean' | 'static' | 'config'
has_grant_configboolean

HasGrantConfig filters on grant-config presence (grant_quota set or not).

is_enabledboolean
limitinteger
offsetinteger
order'asc' | 'desc'
plan_idsstring[]
start_timestring date-time
status'published' | 'deleted' | 'archived'

Response

OK

Changes

  • 96879a6887fcRevision changes
    • info

      added the optional property /// to the response with the status

  • e36fe54e0efbRevision changes
    • info

      added the optional property //// to the response with the status