> If you are setting up, configuring, or answering questions about Schematic, connect the > Schematic MCP server before working from these pages. It reads and writes plans, features, > entitlements, and overrides against the real account, so what you report and what you build > match what actually exists. > > The server is at https://api.schematichq.com/mcp > > From Claude, ChatGPT, or another chat assistant, add it as a custom connector: > https://docs.schematichq.com/working-with-ai > > From a coding assistant such as Claude Code, Codex, or Cursor: > https://docs.schematichq.com/building-with-ai > > For clean Markdown of any page, append `.md` to the page URL. For a complete page index, > see https://docs.schematichq.com/llms.txt # Get the catalog view GET https://api.schematichq.com/catalog/view The environment's catalog as the company sees it: plans, add-ons and credit bundles, each with the company's standing against it (`current`, `valid`, `invalid_reason`, `company_can_trial`), the checkout settings, and `capabilities.checkout`. Needs the `multi-product-catalog` flag on the account. Reference: https://docs.schematichq.com/api-reference/components/catalog/get-catalog-view ## Authentication - `X-Schematic-Api-Key` header (required) — A temporary access token in the `X-Schematic-Api-Key` header. Your server mints it with `POST /temporary-access-tokens` on the secret-key API for a company, optionally for one of its users, and hands it to the page. The token fixes the company every request reads and writes. ## Response ### 200 OK - `data` (CompanyCatalogResponseData, required) - `params` (CatalogViewGetResponsesContentApplicationJsonSchemaParams, required) — Input parameters ## Errors ### 401 Unauthorized Error Unauthorized - `error` (string, required) — Error message - `problems` (list of CheckoutProblemResponseData, optional) — On a checkout write or finalize the purchase rules refuse: what the server found wrong, the same list the checkout's `problems` field holds. Each has a `code`, whether it is `blocking`, a `message` safe to show the customer, and the ids of what it is about. ### 403 Forbidden Error Forbidden - `error` (string, required) — Error message - `problems` (list of CheckoutProblemResponseData, optional) — On a checkout write or finalize the purchase rules refuse: what the server found wrong, the same list the checkout's `problems` field holds. Each has a `code`, whether it is `blocking`, a `message` safe to show the customer, and the ids of what it is about. ### 404 Not Found Error Not found - `error` (string, required) — Error message - `problems` (list of CheckoutProblemResponseData, optional) — On a checkout write or finalize the purchase rules refuse: what the server found wrong, the same list the checkout's `problems` field holds. Each has a `code`, whether it is `blocking`, a `message` safe to show the customer, and the ids of what it is about. ### 500 Internal Server Error Server error - `error` (string, required) — Error message - `problems` (list of CheckoutProblemResponseData, optional) — On a checkout write or finalize the purchase rules refuse: what the server found wrong, the same list the checkout's `problems` field holds. Each has a `code`, whether it is `blocking`, a `message` safe to show the customer, and the ids of what it is about. ## Types ### CompanyCatalogResponseData - `add_ons` (list of CatalogCompanyPlanResponseData, required) - `capabilities` (CatalogCapabilitiesResponseData, required) - `checkout_settings` (CatalogCheckoutSettingsResponseData, required) - `credit_bundles` (list of CatalogCreditBundleResponseData, required) - `default_currency` (enum, required) — ISO 4217 currency of every top-level price slot; currency_prices carries the others. - Allowed values: `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` - `id` (string, required) - `name` (string, required) - `plans` (list of CatalogCompanyPlanResponseData, required) - `prevent_self_service_downgrade` (boolean, required) - `custom_plan_cta` (CatalogCustomPlanCTAResponseData, optional) — Present when the catalog offers a custom plan; absent when custom plans are hidden. - `description` (string, optional, nullable) - `prevent_self_service_downgrade_button_text` (string, optional, nullable) - `prevent_self_service_downgrade_url` (string, optional, nullable) - `pricing_model` (string, optional, nullable) - `pricing_url` (string, optional, nullable) - `trial_expiry_plan` (CatalogPlanRefResponseData, optional) — The plan a trialing company lands on when its trial ends, when configured and offered by this catalog. Catalog configuration, surfaced here so the trial notice can render before any plan change. - `trial_payment_method_required` (boolean, optional, nullable) — Whether starting a trial requires a payment method; a null value means required. ### CatalogViewGetResponsesContentApplicationJsonSchemaParams Input parameters ### CheckoutProblemResponseData - `blocking` (boolean, required) — Whether completing the checkout would be refused while this stands. - `code` (enum, required) - Allowed values: `add_on_conflicts_with_plan`, `add_on_interval_mismatch`, `add_on_requires_billed_plan`, `add_on_unavailable`, `billing_cycle_anchor_conflicts_with_trial`, `billing_cycle_anchor_must_be_future`, `billing_cycle_anchor_needs_new_subscription`, `billing_cycle_anchor_without_plan`, `billing_start_date_must_be_past`, `billing_start_date_needs_new_subscription`, `billing_start_date_needs_renewal_date`, `billing_start_date_not_before_renewal_date`, `billing_start_date_too_far_in_past`, `checkout_superseded`, `credit_bundle_incompatible`, `credit_bundle_unavailable`, `credit_bundles_activate_on_payment`, `currency_mismatch`, `custom_field_required`, `discount_ineligible`, `downgrade_not_permitted`, `end_date_must_be_future`, `end_date_needs_new_subscription`, `end_date_not_after_renewal_date`, `free_first_period_activates_on_payment`, `invoice_email_required`, `invoiced_subscription_conflicts_with_trial`, `invoiced_subscription_needs_new_subscription`, `invoiced_subscription_requires_plan`, `opt_in_required`, `pay_in_advance_price_invalid`, `pay_in_advance_required`, `payment_method_required`, `plan_not_trialable`, `plan_unavailable`, `price_unavailable`, `prorate_first_period_without_anchor`, `provider_rejected`, `scheduled_change_blocks_purchase`, `scheduled_change_pending`, `selection_invalid`, `subscription_currency_change`, `trial_end_must_be_future`, `trial_end_too_far`, `trial_excludes_add_ons`, `trial_excludes_usage_based`, `usage_price_missing_for_interval`, `usage_over_limit` - `message` (string, required) — What is wrong, in words safe for anyone allowed to read the checkout. - `source` (enum, required) - Allowed values: `provider`, `requirement`, `validation` - `bundle_id` (string, optional, nullable) - `currency` (enum, optional) — The currency this problem is about, when it is about one. - Allowed values: `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` - `detail` (string, optional) — Diagnostic detail for operators, including what the billing provider said. Never shown to a customer. - `feature_id` (string, optional, nullable) - `field_id` (string, optional, nullable) - `payment_method_id` (string, optional, nullable) - `plan_id` (string, optional, nullable) - `price_id` (string, optional, nullable) ### CatalogCompanyPlanResponseData - `auto_topups` (list of CatalogAutoTopupResponseData, required) — The plan's included credits that top up automatically or let the company choose to. Empty for add-ons. - `available_periods` (list of enum, required) - Allowed values: `monthly`, `quarterly`, `yearly` - `billing_strategy` (enum, required) - Allowed values: `schematic_managed`, `provider_managed`, `no_billing` - `charge_type` (enum, required) - Allowed values: `free`, `none`, `one_time`, `recurring` - `company_can_trial` (boolean, required) - `currency_prices` (list of CatalogCurrencyPricesResponseData, required) - `current` (boolean, required) - `description` (string, required) - `entitlements` (list of CatalogPlanEntitlementResponseData, required) - `icon` (string, required) - `id` (string, required) - `included_credit_grants` (list of CatalogCreditGrantResponseData, required) - `is_trialable` (boolean, required) - `name` (string, required) - `usage_violations` (list of CatalogUsageViolationResponseData, required) - `valid` (boolean, required) - `compatible_plan_ids` (list of string, optional, nullable) — For add-ons, the plans this add-on may be purchased with. Null means compatible with every plan. - `invalid_reason` (enum, optional, nullable) - Allowed values: `downgrade_not_permitted`, `feature_usage_exceeded` - `monthly_price` (CatalogPriceResponseData, optional) - `one_time_price` (CatalogPriceResponseData, optional) - `quarterly_price` (CatalogPriceResponseData, optional) - `trial_days` (long, optional, nullable) - `yearly_price` (CatalogPriceResponseData, optional) ### CatalogCapabilitiesResponseData - `badge_visibility` (boolean, required) — Whether the consumer may hide the 'powered by Schematic' badge (the account's badge-hideable entitlement); false means the badge must be shown. - `checkout` (boolean, required) ### CatalogCheckoutSettingsResponseData - `bundle_purchase_behavior` (enum, required) - Allowed values: `individual`, `quantity` - `collect_address` (boolean, required) - `collect_email` (boolean, required) - `collect_phone` (boolean, required) - `collect_tax_id` (boolean, required) - `custom_fields` (list of CatalogCheckoutFieldResponseData, required) — The custom fields checkout collects; a checkout sends their values as custom_field_values by id. - `proration_behavior` (enum, required) - Allowed values: `create_prorations`, `invoice_immediately` - `tax_collection_enabled` (boolean, required) ### CatalogCreditBundleResponseData - `bundle_type` (enum, required) - Allowed values: `fixed` - `credit_id` (string, required) - `credit_name` (string, required) - `currency_prices` (list of CatalogBundleCurrencyPriceResponseData, required) - `expiry_type` (enum, required) - Allowed values: `duration`, `end_of_billing_period`, `end_of_next_billing_period`, `end_of_trial`, `no_expiry` - `expiry_unit` (enum, required) - Allowed values: `billing_periods`, `days` - `id` (string, required) - `name` (string, required) - `compatible_plan_ids` (list of string, optional, nullable) — The plans whose companies may purchase this bundle. Null means compatible with every plan. - `credit_icon` (string, optional, nullable) - `credit_plural_name` (string, optional, nullable) - `credit_singular_name` (string, optional, nullable) - `expiry_unit_count` (long, optional, nullable) - `price` (CatalogPriceResponseData, optional) - `quantity` (long, optional, nullable) — Credits granted per purchase; null means the buyer chooses a custom quantity priced via unit_price. - `unit_price` (CatalogPriceResponseData, optional) ### CatalogCustomPlanCTAResponseData - `cta_text` (string, optional, nullable) - `cta_url` (string, optional, nullable) - `price_text` (string, optional, nullable) ### CatalogPlanRefResponseData - `id` (string, required) - `name` (string, required) ### CatalogAutoTopupResponseData - `availability` (enum, required) — automatic tops up on the plan's settings; user_controlled lets the company choose its own. - Allowed values: `off`, `automatic`, `user_controlled` - `credit_id` (string, required) - `currency_prices` (list of CatalogBundleCurrencyPriceResponseData, required) — The credit's unit price in each other currency it is sold in. - `enabled` (boolean, required) — Whether the plan tops up by default. - `plan_credit_grant_id` (string, required) - `amount` (long, optional, nullable) — Credits bought per top-up, as the plan sets it. - `company_amount` (long, optional, nullable) — The company's own amount, when it has chosen one. - `company_enabled` (boolean, optional, nullable) — Whether the company has turned top-ups on, when it has chosen. - `company_threshold_credits` (long, optional, nullable) — The company's own threshold, when it has chosen one. - `threshold_credits` (long, optional, nullable) — The balance below which a top-up runs, as the plan sets it. - `unit_price` (CatalogPriceResponseData, optional) — The credit's price per unit, which a top-up is charged at. ### CatalogCurrencyPricesResponseData - `currency` (enum, required) - Allowed values: `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` - `monthly_price` (CatalogPriceResponseData, optional) - `one_time_price` (CatalogPriceResponseData, optional) - `quarterly_price` (CatalogPriceResponseData, optional) - `yearly_price` (CatalogPriceResponseData, optional) ### CatalogPlanEntitlementResponseData - `currency_prices` (list of CatalogCurrencyPricesResponseData, required) - `feature_description` (string, required) - `feature_icon` (string, required) - `feature_id` (string, required) - `feature_name` (string, required) - `feature_type` (enum, required) - Allowed values: `boolean`, `event`, `license`, `trait` - `id` (string, required) - `value_type` (enum, required) - Allowed values: `boolean`, `credit`, `numeric`, `trait`, `unknown`, `unlimited` - `consumption_rate` (double, optional, nullable) — Credits consumed per unit of usage, for credit-burndown entitlements. - `credit_equivalent_limit` (long, optional, nullable) — How many units of usage the plan's fixed included credit grants cover (⌊granted credits ÷ consumption rate⌋). Null when there is no fixed grant or the grant scales per license. - `credit_icon` (string, optional, nullable) - `credit_id` (string, optional, nullable) - `credit_name` (string, optional, nullable) - `credit_plural_name` (string, optional, nullable) - `credit_singular_name` (string, optional, nullable) - `feature_plural_name` (string, optional, nullable) - `feature_singular_name` (string, optional, nullable) - `license_id` (string, optional, nullable) - `metered_monthly_price` (CatalogPriceResponseData, optional) - `metered_quarterly_price` (CatalogPriceResponseData, optional) - `metered_yearly_price` (CatalogPriceResponseData, optional) - `metric_period` (enum, optional, nullable) - Allowed values: `all_time`, `current_day`, `current_month`, `current_week` - `metric_period_month_reset` (enum, optional, nullable) - Allowed values: `billing_cycle`, `first_of_month` - `price_behavior` (enum, optional, nullable) - Allowed values: `credit_burndown`, `overage`, `pay_as_you_go`, `pay_in_advance`, `tier` - `soft_limit` (long, optional, nullable) - `value_bool` (boolean, optional, nullable) - `value_numeric` (long, optional, nullable) - `warning_threshold` (long, optional, nullable) — The default warning-tier value, when configured. ### CatalogCreditGrantResponseData - `company_credit_amount` (long, required) — Flat credit amount granted to the company regardless of scaling. - `credit_amount` (long, required) — Credits granted; for per_license scaling this is the amount per license unit. - `credit_id` (string, required) - `credit_name` (string, required) - `id` (string, required) - `scaling` (enum, required) - Allowed values: `fixed`, `per_license` - `visible` (boolean, required) — Whether the catalog shows this credit on the plan. Display-only: a hidden grant is still granted and priced at checkout. - `credit_icon` (string, optional, nullable) - `credit_plural_name` (string, optional, nullable) - `credit_singular_name` (string, optional, nullable) - `license_id` (string, optional, nullable) - `reset_cadence` (enum, optional, nullable) - Allowed values: `daily`, `every_6_months`, `monthly`, `quarterly`, `weekly`, `yearly` ### CatalogUsageViolationResponseData - `feature_id` (string, required) - `feature_name` (string, required) - `usage` (long, required) - `limit` (long, optional, nullable) — The limit the target plan would impose; null means unlimited. ### CatalogPriceResponseData - `currency` (enum, required) - Allowed values: `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` - `id` (string, required) - `interval` (enum, required) - Allowed values: `day`, `month`, `one-time`, `year` - `interval_count` (long, required) - `package_size` (long, required) — Units covered per priced package; a price of $10 with package_size 1000 charges $10 per 1000 units. - `price` (long, required) - `price_tiers` (list of CatalogPriceTierResponseData, required) - `scheme` (enum, required) - Allowed values: `per_unit`, `tiered` - `overage_unit_price_decimal` (string, optional, nullable) — Per-unit price of the final tier, precomputed for overage display. - `price_decimal` (string, optional, nullable) - `tiers_mode` (enum, optional, nullable) - Allowed values: `graduated`, `volume` ### CatalogCheckoutFieldResponseData - `id` (string, required) - `name` (string, required) - `required` (boolean, required) — A checkout with this field empty is refused with custom_field_required. - `helper_text` (string, optional, nullable) - `value` (string, optional, nullable) — The company's saved value, when it has one. ### CatalogBundleCurrencyPriceResponseData - `currency` (enum, required) - Allowed values: `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` - `price` (CatalogPriceResponseData, optional) - `unit_price` (CatalogPriceResponseData, optional) ### CatalogPriceTierResponseData - `from` (long, required) — Lower bound of the tier (inclusive). - `flat_price` (long, optional, nullable) - `per_unit_price` (long, optional, nullable) - `per_unit_price_decimal` (string, optional, nullable) - `to` (long, optional, nullable) — Upper bound of the tier (inclusive); null means unbounded. ## Examples **Response** ```json { "data": { "add_ons": [ { "auto_topups": [ { "availability": "off", "credit_id": "string", "currency_prices": [ { "currency": "aed", "price": { "currency": "aed", "id": "string", "interval": "day", "interval_count": 1, "package_size": 1, "price": 1, "price_tiers": [ { "from": 1, "flat_price": 1, "per_unit_price": 1, "per_unit_price_decimal": "string", "to": 1 } ], "scheme": "per_unit", "overage_unit_price_decimal": "string", "price_decimal": "string", "tiers_mode": "graduated" }, "unit_price": { "currency": "aed", "id": "string", "interval": "day", "interval_count": 1, "package_size": 1, "price": 1, "price_tiers": [ { "from": 1, "flat_price": 1, "per_unit_price": 1, "per_unit_price_decimal": "string", "to": 1 } ], "scheme": "per_unit", "overage_unit_price_decimal": "string", "price_decimal": "string", "tiers_mode": "graduated" } } ], "enabled": true, "plan_credit_grant_id": "string", "amount": 1, "company_amount": 1, "company_enabled": true, "company_threshold_credits": 1, "threshold_credits": 1, "unit_price": { "currency": "aed", "id": "string", "interval": "day", "interval_count": 1, "package_size": 1, "price": 1, "price_tiers": [ { "from": 1, "flat_price": 1, "per_unit_price": 1, "per_unit_price_decimal": "string", "to": 1 } ], "scheme": "per_unit", "overage_unit_price_decimal": "string", "price_decimal": "string", "tiers_mode": "graduated" } } ], "available_periods": [ "monthly" ], "billing_strategy": "schematic_managed", "charge_type": "free", "company_can_trial": true, "currency_prices": [ { "currency": "aed", "monthly_price": { "currency": "aed", "id": "string", "interval": "day", "interval_count": 1, "package_size": 1, "price": 1, "price_tiers": [ { "from": 1, "flat_price": 1, "per_unit_price": 1, "per_unit_price_decimal": "string", "to": 1 } ], "scheme": "per_unit", "overage_unit_price_decimal": "string", "price_decimal": "string", "tiers_mode": "graduated" }, "one_time_price": { "currency": "aed", "id": "string", "interval": "day", "interval_count": 1, "package_size": 1, "price": 1, "price_tiers": [ { "from": 1, "flat_price": 1, "per_unit_price": 1, "per_unit_price_decimal": "string", "to": 1 } ], "scheme": "per_unit", "overage_unit_price_decimal": "string", "price_decimal": "string", "tiers_mode": "graduated" }, "quarterly_price": { "currency": "aed", "id": "string", "interval": "day", "interval_count": 1, "package_size": 1, "price": 1, "price_tiers": [ { "from": 1, "flat_price": 1, "per_unit_price": 1, "per_unit_price_decimal": "string", "to": 1 } ], "scheme": "per_unit", "overage_unit_price_decimal": "string", "price_decimal": "string", "tiers_mode": "graduated" }, "yearly_price": { "currency": "aed", "id": "string", "interval": "day", "interval_count": 1, "package_size": 1, "price": 1, "price_tiers": [ { "from": 1, "flat_price": 1, "per_unit_price": 1, "per_unit_price_decimal": "string", "to": 1 } ], "scheme": "per_unit", "overage_unit_price_decimal": "string", "price_decimal": "string", "tiers_mode": "graduated" } } ], "current": true, "description": "string", "entitlements": [ { "currency_prices": [ { "currency": "aed", "monthly_price": { "currency": "aed", "id": "string", "interval": "day", "interval_count": 1, "package_size": 1, "price": 1, "price_tiers": [ { "from": 1, "flat_price": 1, "per_unit_price": 1, "per_unit_price_decimal": "string", "to": 1 } ], "scheme": "per_unit", "overage_unit_price_decimal": "string", "price_decimal": "string", "tiers_mode": "graduated" }, "one_time_price": { "currency": "aed", "id": "string", "interval": "day", "interval_count": 1, "package_size": 1, "price": 1, "price_tiers": [ { "from": 1, "flat_price": 1, "per_unit_price": 1, "per_unit_price_decimal": "string", "to": 1 } ], "scheme": "per_unit", "overage_unit_price_decimal": "string", "price_decimal": "string", "tiers_mode": "graduated" }, "quarterly_price": { "currency": "aed", "id": "string", "interval": "day", "interval_count": 1, "package_size": 1, "price": 1, "price_tiers": [ { "from": 1, "flat_price": 1, "per_unit_price": 1, "per_unit_price_decimal": "string", "to": 1 } ], "scheme": "per_unit", "overage_unit_price_decimal": "string", "price_decimal": "string", "tiers_mode": "graduated" }, "yearly_price": { "currency": "aed", "id": "string", "interval": "day", "interval_count": 1, "package_size": 1, "price": 1, "price_tiers": [ { "from": 1, "flat_price": 1, "per_unit_price": 1, "per_unit_price_decimal": "string", "to": 1 } ], "scheme": "per_unit", "overage_unit_price_decimal": "string", "price_decimal": "string", "tiers_mode": "graduated" } } ], "feature_description": "string", "feature_icon": "string", "feature_id": "string", "feature_name": "string", "feature_type": "boolean", "id": "string", "value_type": "boolean", "consumption_rate": 1.1, "credit_equivalent_limit": 1, "credit_icon": "string", "credit_id": "string", "credit_name": "string", "credit_plural_name": "string", "credit_singular_name": "string", "feature_plural_name": "string", "feature_singular_name": "string", "license_id": "string", "metered_monthly_price": { "currency": "aed", "id": "string", "interval": "day", "interval_count": 1, "package_size": 1, "price": 1, "price_tiers": [ { "from": 1, "flat_price": 1, "per_unit_price": 1, "per_unit_price_decimal": "string", "to": 1 } ], "scheme": "per_unit", "overage_unit_price_decimal": "string", "price_decimal": "string", "tiers_mode": "graduated" }, "metered_quarterly_price": { "currency": "aed", "id": "string", "interval": "day", "interval_count": 1, "package_size": 1, "price": 1, "price_tiers": [ { "from": 1, "flat_price": 1, "per_unit_price": 1, "per_unit_price_decimal": "string", "to": 1 } ], "scheme": "per_unit", "overage_unit_price_decimal": "string", "price_decimal": "string", "tiers_mode": "graduated" }, "metered_yearly_price": { "currency": "aed", "id": "string", "interval": "day", "interval_count": 1, "package_size": 1, "price": 1, "price_tiers": [ { "from": 1, "flat_price": 1, "per_unit_price": 1, "per_unit_price_decimal": "string", "to": 1 } ], "scheme": "per_unit", "overage_unit_price_decimal": "string", "price_decimal": "string", "tiers_mode": "graduated" }, "metric_period": "all_time", "metric_period_month_reset": "billing_cycle", "price_behavior": "credit_burndown", "soft_limit": 1, "value_bool": true, "value_numeric": 1, "warning_threshold": 1 } ], "icon": "string", "id": "string", "included_credit_grants": [ { "company_credit_amount": 1, "credit_amount": 1, "credit_id": "string", "credit_name": "string", "id": "string", "scaling": "fixed", "visible": true, "credit_icon": "string", "credit_plural_name": "string", "credit_singular_name": "string", "license_id": "string", "reset_cadence": "daily" } ], "is_trialable": true, "name": "string", "usage_violations": [ { "feature_id": "string", "feature_name": "string", "usage": 1, "limit": 1 } ], "valid": true, "compatible_plan_ids": [ "string" ], "invalid_reason": "downgrade_not_permitted", "monthly_price": { "currency": "aed", "id": "string", "interval": "day", "interval_count": 1, "package_size": 1, "price": 1, "price_tiers": [ { "from": 1, "flat_price": 1, "per_unit_price": 1, "per_unit_price_decimal": "string", "to": 1 } ], "scheme": "per_unit", "overage_unit_price_decimal": "string", "price_decimal": "string", "tiers_mode": "graduated" }, "one_time_price": { "currency": "aed", "id": "string", "interval": "day", "interval_count": 1, "package_size": 1, "price": 1, "price_tiers": [ { "from": 1, "flat_price": 1, "per_unit_price": 1, "per_unit_price_decimal": "string", "to": 1 } ], "scheme": "per_unit", "overage_unit_price_decimal": "string", "price_decimal": "string", "tiers_mode": "graduated" }, "quarterly_price": { "currency": "aed", "id": "string", "interval": "day", "interval_count": 1, "package_size": 1, "price": 1, "price_tiers": [ { "from": 1, "flat_price": 1, "per_unit_price": 1, "per_unit_price_decimal": "string", "to": 1 } ], "scheme": "per_unit", "overage_unit_price_decimal": "string", "price_decimal": "string", "tiers_mode": "graduated" }, "trial_days": 1, "yearly_price": { "currency": "aed", "id": "string", "interval": "day", "interval_count": 1, "package_size": 1, "price": 1, "price_tiers": [ { "from": 1, "flat_price": 1, "per_unit_price": 1, "per_unit_price_decimal": "string", "to": 1 } ], "scheme": "per_unit", "overage_unit_price_decimal": "string", "price_decimal": "string", "tiers_mode": "graduated" } } ], "capabilities": { "badge_visibility": true, "checkout": true }, "checkout_settings": { "bundle_purchase_behavior": "individual", "collect_address": true, "collect_email": true, "collect_phone": true, "collect_tax_id": true, "custom_fields": [ { "id": "string", "name": "string", "required": true, "helper_text": "string", "value": "string" } ], "proration_behavior": "create_prorations", "tax_collection_enabled": true }, "credit_bundles": [ { "bundle_type": "fixed", "credit_id": "string", "credit_name": "string", "currency_prices": [ { "currency": "aed", "price": { "currency": "aed", "id": "string", "interval": "day", "interval_count": 1, "package_size": 1, "price": 1, "price_tiers": [ { "from": 1, "flat_price": 1, "per_unit_price": 1, "per_unit_price_decimal": "string", "to": 1 } ], "scheme": "per_unit", "overage_unit_price_decimal": "string", "price_decimal": "string", "tiers_mode": "graduated" }, "unit_price": { "currency": "aed", "id": "string", "interval": "day", "interval_count": 1, "package_size": 1, "price": 1, "price_tiers": [ { "from": 1, "flat_price": 1, "per_unit_price": 1, "per_unit_price_decimal": "string", "to": 1 } ], "scheme": "per_unit", "overage_unit_price_decimal": "string", "price_decimal": "string", "tiers_mode": "graduated" } } ], "expiry_type": "duration", "expiry_unit": "billing_periods", "id": "string", "name": "string", "compatible_plan_ids": [ "string" ], "credit_icon": "string", "credit_plural_name": "string", "credit_singular_name": "string", "expiry_unit_count": 1, "price": { "currency": "aed", "id": "string", "interval": "day", "interval_count": 1, "package_size": 1, "price": 1, "price_tiers": [ { "from": 1, "flat_price": 1, "per_unit_price": 1, "per_unit_price_decimal": "string", "to": 1 } ], "scheme": "per_unit", "overage_unit_price_decimal": "string", "price_decimal": "string", "tiers_mode": "graduated" }, "quantity": 1, "unit_price": { "currency": "aed", "id": "string", "interval": "day", "interval_count": 1, "package_size": 1, "price": 1, "price_tiers": [ { "from": 1, "flat_price": 1, "per_unit_price": 1, "per_unit_price_decimal": "string", "to": 1 } ], "scheme": "per_unit", "overage_unit_price_decimal": "string", "price_decimal": "string", "tiers_mode": "graduated" } } ], "default_currency": "aed", "id": "string", "name": "string", "plans": [ { "auto_topups": [ { "availability": "off", "credit_id": "string", "currency_prices": [ { "currency": "aed", "price": { "currency": "aed", "id": "string", "interval": "day", "interval_count": 1, "package_size": 1, "price": 1, "price_tiers": [ { "from": 1, "flat_price": 1, "per_unit_price": 1, "per_unit_price_decimal": "string", "to": 1 } ], "scheme": "per_unit", "overage_unit_price_decimal": "string", "price_decimal": "string", "tiers_mode": "graduated" }, "unit_price": { "currency": "aed", "id": "string", "interval": "day", "interval_count": 1, "package_size": 1, "price": 1, "price_tiers": [ { "from": 1, "flat_price": 1, "per_unit_price": 1, "per_unit_price_decimal": "string", "to": 1 } ], "scheme": "per_unit", "overage_unit_price_decimal": "string", "price_decimal": "string", "tiers_mode": "graduated" } } ], "enabled": true, "plan_credit_grant_id": "string", "amount": 1, "company_amount": 1, "company_enabled": true, "company_threshold_credits": 1, "threshold_credits": 1, "unit_price": { "currency": "aed", "id": "string", "interval": "day", "interval_count": 1, "package_size": 1, "price": 1, "price_tiers": [ { "from": 1, "flat_price": 1, "per_unit_price": 1, "per_unit_price_decimal": "string", "to": 1 } ], "scheme": "per_unit", "overage_unit_price_decimal": "string", "price_decimal": "string", "tiers_mode": "graduated" } } ], "available_periods": [ "monthly" ], "billing_strategy": "schematic_managed", "charge_type": "free", "company_can_trial": true, "currency_prices": [ { "currency": "aed", "monthly_price": { "currency": "aed", "id": "string", "interval": "day", "interval_count": 1, "package_size": 1, "price": 1, "price_tiers": [ { "from": 1, "flat_price": 1, "per_unit_price": 1, "per_unit_price_decimal": "string", "to": 1 } ], "scheme": "per_unit", "overage_unit_price_decimal": "string", "price_decimal": "string", "tiers_mode": "graduated" }, "one_time_price": { "currency": "aed", "id": "string", "interval": "day", "interval_count": 1, "package_size": 1, "price": 1, "price_tiers": [ { "from": 1, "flat_price": 1, "per_unit_price": 1, "per_unit_price_decimal": "string", "to": 1 } ], "scheme": "per_unit", "overage_unit_price_decimal": "string", "price_decimal": "string", "tiers_mode": "graduated" }, "quarterly_price": { "currency": "aed", "id": "string", "interval": "day", "interval_count": 1, "package_size": 1, "price": 1, "price_tiers": [ { "from": 1, "flat_price": 1, "per_unit_price": 1, "per_unit_price_decimal": "string", "to": 1 } ], "scheme": "per_unit", "overage_unit_price_decimal": "string", "price_decimal": "string", "tiers_mode": "graduated" }, "yearly_price": { "currency": "aed", "id": "string", "interval": "day", "interval_count": 1, "package_size": 1, "price": 1, "price_tiers": [ { "from": 1, "flat_price": 1, "per_unit_price": 1, "per_unit_price_decimal": "string", "to": 1 } ], "scheme": "per_unit", "overage_unit_price_decimal": "string", "price_decimal": "string", "tiers_mode": "graduated" } } ], "current": true, "description": "string", "entitlements": [ { "currency_prices": [ { "currency": "aed", "monthly_price": { "currency": "aed", "id": "string", "interval": "day", "interval_count": 1, "package_size": 1, "price": 1, "price_tiers": [ { "from": 1, "flat_price": 1, "per_unit_price": 1, "per_unit_price_decimal": "string", "to": 1 } ], "scheme": "per_unit", "overage_unit_price_decimal": "string", "price_decimal": "string", "tiers_mode": "graduated" }, "one_time_price": { "currency": "aed", "id": "string", "interval": "day", "interval_count": 1, "package_size": 1, "price": 1, "price_tiers": [ { "from": 1, "flat_price": 1, "per_unit_price": 1, "per_unit_price_decimal": "string", "to": 1 } ], "scheme": "per_unit", "overage_unit_price_decimal": "string", "price_decimal": "string", "tiers_mode": "graduated" }, "quarterly_price": { "currency": "aed", "id": "string", "interval": "day", "interval_count": 1, "package_size": 1, "price": 1, "price_tiers": [ { "from": 1, "flat_price": 1, "per_unit_price": 1, "per_unit_price_decimal": "string", "to": 1 } ], "scheme": "per_unit", "overage_unit_price_decimal": "string", "price_decimal": "string", "tiers_mode": "graduated" }, "yearly_price": { "currency": "aed", "id": "string", "interval": "day", "interval_count": 1, "package_size": 1, "price": 1, "price_tiers": [ { "from": 1, "flat_price": 1, "per_unit_price": 1, "per_unit_price_decimal": "string", "to": 1 } ], "scheme": "per_unit", "overage_unit_price_decimal": "string", "price_decimal": "string", "tiers_mode": "graduated" } } ], "feature_description": "string", "feature_icon": "string", "feature_id": "string", "feature_name": "string", "feature_type": "boolean", "id": "string", "value_type": "boolean", "consumption_rate": 1.1, "credit_equivalent_limit": 1, "credit_icon": "string", "credit_id": "string", "credit_name": "string", "credit_plural_name": "string", "credit_singular_name": "string", "feature_plural_name": "string", "feature_singular_name": "string", "license_id": "string", "metered_monthly_price": { "currency": "aed", "id": "string", "interval": "day", "interval_count": 1, "package_size": 1, "price": 1, "price_tiers": [ { "from": 1, "flat_price": 1, "per_unit_price": 1, "per_unit_price_decimal": "string", "to": 1 } ], "scheme": "per_unit", "overage_unit_price_decimal": "string", "price_decimal": "string", "tiers_mode": "graduated" }, "metered_quarterly_price": { "currency": "aed", "id": "string", "interval": "day", "interval_count": 1, "package_size": 1, "price": 1, "price_tiers": [ { "from": 1, "flat_price": 1, "per_unit_price": 1, "per_unit_price_decimal": "string", "to": 1 } ], "scheme": "per_unit", "overage_unit_price_decimal": "string", "price_decimal": "string", "tiers_mode": "graduated" }, "metered_yearly_price": { "currency": "aed", "id": "string", "interval": "day", "interval_count": 1, "package_size": 1, "price": 1, "price_tiers": [ { "from": 1, "flat_price": 1, "per_unit_price": 1, "per_unit_price_decimal": "string", "to": 1 } ], "scheme": "per_unit", "overage_unit_price_decimal": "string", "price_decimal": "string", "tiers_mode": "graduated" }, "metric_period": "all_time", "metric_period_month_reset": "billing_cycle", "price_behavior": "credit_burndown", "soft_limit": 1, "value_bool": true, "value_numeric": 1, "warning_threshold": 1 } ], "icon": "string", "id": "string", "included_credit_grants": [ { "company_credit_amount": 1, "credit_amount": 1, "credit_id": "string", "credit_name": "string", "id": "string", "scaling": "fixed", "visible": true, "credit_icon": "string", "credit_plural_name": "string", "credit_singular_name": "string", "license_id": "string", "reset_cadence": "daily" } ], "is_trialable": true, "name": "string", "usage_violations": [ { "feature_id": "string", "feature_name": "string", "usage": 1, "limit": 1 } ], "valid": true, "compatible_plan_ids": [ "string" ], "invalid_reason": "downgrade_not_permitted", "monthly_price": { "currency": "aed", "id": "string", "interval": "day", "interval_count": 1, "package_size": 1, "price": 1, "price_tiers": [ { "from": 1, "flat_price": 1, "per_unit_price": 1, "per_unit_price_decimal": "string", "to": 1 } ], "scheme": "per_unit", "overage_unit_price_decimal": "string", "price_decimal": "string", "tiers_mode": "graduated" }, "one_time_price": { "currency": "aed", "id": "string", "interval": "day", "interval_count": 1, "package_size": 1, "price": 1, "price_tiers": [ { "from": 1, "flat_price": 1, "per_unit_price": 1, "per_unit_price_decimal": "string", "to": 1 } ], "scheme": "per_unit", "overage_unit_price_decimal": "string", "price_decimal": "string", "tiers_mode": "graduated" }, "quarterly_price": { "currency": "aed", "id": "string", "interval": "day", "interval_count": 1, "package_size": 1, "price": 1, "price_tiers": [ { "from": 1, "flat_price": 1, "per_unit_price": 1, "per_unit_price_decimal": "string", "to": 1 } ], "scheme": "per_unit", "overage_unit_price_decimal": "string", "price_decimal": "string", "tiers_mode": "graduated" }, "trial_days": 1, "yearly_price": { "currency": "aed", "id": "string", "interval": "day", "interval_count": 1, "package_size": 1, "price": 1, "price_tiers": [ { "from": 1, "flat_price": 1, "per_unit_price": 1, "per_unit_price_decimal": "string", "to": 1 } ], "scheme": "per_unit", "overage_unit_price_decimal": "string", "price_decimal": "string", "tiers_mode": "graduated" } } ], "prevent_self_service_downgrade": true, "custom_plan_cta": { "cta_text": "string", "cta_url": "string", "price_text": "string" }, "description": "string", "prevent_self_service_downgrade_button_text": "string", "prevent_self_service_downgrade_url": "string", "pricing_model": "string", "pricing_url": "string", "trial_expiry_plan": { "id": "string", "name": "string" }, "trial_payment_method_required": true }, "params": {} } ``` **SDK Code** ```python import requests url = "https://api.schematichq.com/catalog/view" headers = {"X-Schematic-Api-Key": ""} response = requests.get(url, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.schematichq.com/catalog/view'; const options = {method: 'GET', headers: {'X-Schematic-Api-Key': ''}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.schematichq.com/catalog/view" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("X-Schematic-Api-Key", "") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.schematichq.com/catalog/view") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["X-Schematic-Api-Key"] = '' response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.schematichq.com/catalog/view") .header("X-Schematic-Api-Key", "") .asString(); ``` ```php request('GET', 'https://api.schematichq.com/catalog/view', [ 'headers' => [ 'X-Schematic-Api-Key' => '', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.schematichq.com/catalog/view"); var request = new RestRequest(Method.GET); request.AddHeader("X-Schematic-Api-Key", ""); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = ["X-Schematic-Api-Key": ""] let request = NSMutableURLRequest(url: NSURL(string: "https://api.schematichq.com/catalog/view")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```