entitlements

List feature usage

Changed on
get/feature-usage

Request

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

Query parameters

company_idstring
company_keysobject
feature_idsstring[]
include_usage_aggregationboolean

Include time-bucketed usage aggregation (today, this week, this month, billing period) for credit-based entitlements. Defaults to false for performance.

managed_by'metronome' | 'orb' | 'schematic' | 'stripe'

Filter for features managed by a billing provider, or by Schematic (no billing provider)

qstring
without_negative_entitlementsboolean
limitinteger

Page limit (default 100)

offsetinteger

Page offset (default 0)

Response

OK

Changes

  • 6d4b96940aadRevision changes
    • info

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

  • ce7c5cc627adRevision changes
    • warning

      added the new end_date_must_be_future enum value to the //////// response property for the response status

    • warning

      added the new end_date_needs_new_subscription enum value to the //////// response property for the response status

    • warning

      added the new end_date_not_after_renewal_date enum value to the //////// response property for the response status