entitlements

Count feature usage

Changed on
get/feature-usage/count

Request

  • Base URL
    https://api.schematichq.com
  • URL
    https://api.schematichq.com/feature-usage/count
  • 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

  • 3baa54bf8b3fRevision changes
    • warning

      for the query request parameter limit, the max was set to 250.00

    • warning

      for the query request parameter limit, the min was set to 0.00

  • c0d7b479cd11Revision changes
    • warning

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

    • info

      added the enum value metronome to the property allOf[BillingProviderType]/ of the query request parameter managed_by