Get a catalog view by ID

GET

https://api.schematichq.com/catalogs/:catalog_id/view

GET

/catalogs/:catalog_id/view

const url = 'https://api.schematichq.com/catalogs/catalog_id/view';
const options = {method: 'GET', headers: {'X-Schematic-Api-Key': '<apiKey>'}};
try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

{
  "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": {}
}

The same view for the catalog catalog_id names rather than the environment’s default catalog.

Authentication

X-Schematic-Api-Keystring

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.

Path parameters

catalog_idstringRequired

catalog_id

Response

dataobject

paramsobject

Input parameters

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error