billing

List billing products

Changed on
get/billing/products

Request

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

Query parameters

idsstring[]
is_activeboolean

Filter products that are active. Defaults to true if not specified

namestring
price_usage_type'licensed' | 'metered'
provider_type'metronome' | 'orb' | 'schematic' | 'stripe'
qstring
recurring_charges_onlyboolean

Filter to products that have at least one recurring price

with_one_time_chargesboolean

Filter products that are one time charges

with_prices_onlyboolean

Filter products that have prices

with_zero_priceboolean

Filter products that have zero price for free subscription type

without_linked_to_planboolean

Filter products that are not linked to any plan

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

    • warning

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

    • warning

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

    • info

      added the new enum value metronome to the query request parameter provider_type