entitlements

List plan entitlements

Changed on
get/plan-entitlements

Request

  • Base URL
    https://api.schematichq.com
  • URL
    https://api.schematichq.com/plan-entitlements
  • Auth
    API key in header X-Schematic-Api-Key

Query parameters

feature_idstring

Filter plan entitlements by a single feature ID (starting with feat_)

feature_idsstring[]

Filter plan entitlements by multiple feature IDs (starting with feat_)

idsstring[]

Filter plan entitlements by multiple plan entitlement IDs (starting with pltl_)

plan_idstring

Filter plan entitlements by a single plan ID (starting with plan_)

plan_idsstring[]

Filter plan entitlements by multiple plan IDs (starting with plan_)

plan_version_idstring

Filter plan entitlements by a single plan version ID (starting with plvr_)

plan_version_idsstring[]

Filter plan entitlements by multiple plan version IDs (starting with plvr_)

qstring

Search for plan entitlements by feature or company name

with_metered_productsboolean

Filter plan entitlements only with metered products

limitinteger

Page limit (default 100)

offsetinteger

Page offset (default 0)

Response

OK

Changes

  • 8eb4adb2badeRevision changes
    • info

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

    • info

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

  • d2fb8bb90eafRevision changes
    • info

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