billing

List billing prices

Changed on
get/billing/price

Request

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

Query parameters

currency'aed' | 'afn' | 'all' | 'amd' | 'ang' | 'aoa' | 'ars' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bif' | 'bmd' | 'bnd' | 'bob' | 'brl' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'cad' | 'cdf' | 'chf' | 'clp' | 'cny' | 'cop' | 'crc' | 'cve' | 'czk' | 'djf' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'fkp' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gnf' | 'gtq' | 'gyd' | 'hkd' | 'hnl' | 'htg' | 'huf' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lak' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mur' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nio' | 'nok' | 'npr' | 'nzd' | 'pab' | 'pen' | 'pgk' | 'php' | 'pkr' | 'pln' | 'pyg' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'shp' | 'sle' | 'sos' | 'srd' | 'std' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'twd' | 'tzs' | 'uah' | 'ugx' | 'usd' | 'uyu' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'xcg' | 'xof' | 'xpf' | 'yer' | 'zar' | 'zmw'

Filter for prices in a specific currency (e.g. usd, eur)

for_initial_planboolean

Filter for prices valid for initial plans (free prices only)

for_trial_expiry_planboolean

Filter for prices valid for trial expiry plans (free prices only)

idsstring[]
intervalstring
interval_countinteger

Filter for prices billed every N intervals; combine with interval (e.g. interval=month, interval_count=3 for quarterly)

is_activeboolean

Filter for active prices on active products (defaults to true if not specified)

plan_version_idstring

Filter for prices belonging to a specific plan version (e.g. the latest published version)

priceinteger
product_idstring
product_idsstring[]
provider_type'metronome' | 'orb' | 'schematic' | 'stripe'
qstring
tiers_mode'graduated' | 'volume'
usage_type'licensed' | 'metered'
with_meterboolean

Filter for prices with a meter

limitinteger

Page limit (default 100)

offsetinteger

Page offset (default 0)

Response

OK

Changes

  • a126a6ee4accRevision changes
    • info

      added the new optional query request parameter interval_count

    • info

      added the optional property / to the response with the status

  • 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