plans

Count plans

Changed on
get/plans/count

Request

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

Query parameters

company_idstring
company_scoped_onlyboolean

Only return plans that are scoped to a company (custom plans assigned to a company)

exclude_company_scopedboolean

Exclude plans that are scoped to a company (custom plans assigned to a company)

exclude_unusedboolean

Exclude plans that nothing is using: no company is on the plan and it has no draft version

for_fallback_planboolean

Filter for plans valid as fallback plans (not linked to billing)

for_initial_planboolean

Filter for plans valid as initial plans (not linked to billing, free, or auto-cancelling trial)

for_trial_expiry_planboolean

Filter for plans valid as trial expiry plans (not linked to billing or free)

has_product_idboolean

Filter out plans that do not have a billing product ID

idsstring[]
include_draft_versionsboolean

Include billing settings from draft versions for plans which have draft version

plan_type'plan' | 'add_on'

Filter by plan type

qstring
scoped_to_company_idstring

Filter plans scoped to a specific company (custom plans)

with_entitlementsboolean

Include each plan's entitlements in the response

with_published_versionboolean

Only return plans that have a published version

without_entitlement_for_include_draftsboolean

With without_entitlement_for, also treat an entitlement on a plan's draft version as existing

without_entitlement_forstring

Filter out plans that already have a plan entitlement for the specified feature ID

without_paid_product_idboolean

Filter out plans that have a paid billing product ID

limitinteger

Page limit (default 100)

offsetinteger

Page offset (default 0)

Response

OK

Changes

  • 5a677fa71c74Revision changes
    • info

      added the new optional query request parameter with_published_version

    • info

      added the new optional query request parameter without_entitlement_for_include_drafts

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

  • 75c44665b715Revision changes
    • info

      added the new optional query request parameter exclude_unused

    • info

      added the optional property / to the response with the status