plans

List custom plan billings

Changed on
get/custom-plan-billings

Request

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

Query parameters

company_idstring

Filter by company ID

plan_idstring

Filter by plan ID

plan_version_idstring

Filter by the plan version the billing record was created for

plan_billing_source'amendment' | 'custom_plan' | 'manage_plan'

Filter by the flow that created the billing record: custom_plan for a first publish, amendment for a republish, manage_plan for a standard plan assigned by invoice. Defaults to custom_plan unless plan_billing_sources is set.

plan_billing_sourcesPlanBillingSource[]

Filter by multiple billing sources. Takes precedence over plan_billing_source.

status'active' | 'expired' | 'paid' | 'pending'

Filter by billing status

statusesCustomPlanBillingStatus[]

Filter by multiple billing statuses

limitinteger

Page limit (default 100)

offsetinteger

Page offset (default 0)

Response

OK

Changes

  • 6d4b96940aadRevision changes
    • info

      added the optional property // to the response with the status

  • ce7c5cc627adRevision changes
    • warning

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

    • warning

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

    • warning

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