Schematic Plangroups API is one of 20 APIs that Schematic publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 4 JSON Schema definitions.
Tagged areas include plangroups. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, a getting-started guide, a GitHub repository, and 4 JSON Schemas.
This API exposes
3 operations
across 2 paths,
and defines 71 schemas.
It is described by OpenAPI 3.2.0, at version 0.1.
Requests are made against a single base URL, https://api.schematichq.com.
3 operations2 paths71 schemas1 GET1 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Specification
OpenAPI 3.2.0
API Version
0.1
Server
https://api.schematichq.com
Authentication
API Key
Resource Areas
1
Authentication & Security 1
Schematic Plangroups API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as X-Schematic-Api-Key (ApiKeyAuth).
By default, every request must be authenticated.
Paths & Operations 3
Across 2 paths, the API surfaces 3 operations — 1 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
plangroups 3
GET
/plan-groups
Get plan group
getPlanGroup1 param→ 200401403404500
POST
/plan-groups
Create plan group
createPlanGroupbody→ 201400401403404500
PUT
/plan-groups/{plan_group_id}
Update plan group
updatePlanGroup1 parambody→ 200400401403404500
Schemas 71
The contract defines 71 schemas that model the data the API accepts and returns. The most detailed are PlanGroupDetailResponseData (37 properties), PlanGroupPlanDetailResponseData (33 properties), CreatePlanGroupRequestBody (32 properties), UpdatePlanGroupRequestBody (32 properties). Each schema is shown below with its type and property counts.
PlanGroupResponseData
object
28 properties16 required
EventSummaryResponseData
object
6 properties5 required
CreditCurrencyPriceResponseData
object
2 properties1 required
UpdatePlanGroupRequestBody
object
32 properties18 required
BillingCreditBurnStrategy
string
EntitlementValueType
string
FeatureResponseData
object
13 properties7 required
RuleType
string
ConditionType
string
BillingPlanCreditGrantResetStart
string
CustomPlanConfig
object
3 properties3 required
PlanGroupDetailResponseData
object
37 properties17 required
BillingProductPriceInterval
string
PreviewObject
object
4 properties2 required
ProrationBehavior
string
BillingProductResponseData
object
13 properties11 required
PlanEntitlementResponseData
object
27 properties9 required
FlagType
string
EntityType
string
EntitlementCurrencyPricesResponseData
object
3 properties1 required
MetricPeriod
string
PreviewObjectResponseData
object
4 properties2 required
BillingCreditRolloverPolicy
string
CustomPlanViewConfigResponseData
object
3 properties3 required
ChargeType
string
BillingProductDetailResponseData
object
15 properties13 required
BillingCreditExpiryType
string
CheckoutSettingsResponseData
object
3 properties3 required
CreatePlanGroupRequestBody
object
32 properties18 required
TraitType
string
ComponentSettingsResponseData
object
6 properties6 required
BillingTiersMode
string
PlanVersionResponseData
object
11 properties10 required
BillingPriceView
object
23 properties17 required
BillingPriceUsageType
string
BillingCreditResponseData
object
16 properties10 required
PlanVersionStatus
string
OrderedPlansInGroup
object
2 properties1 required
CompatiblePlansResponseData
object
2 properties2 required
PlanEntitlementsOrder
object
2 properties1 required
BillingPriceResponseData
object
9 properties7 required
RuleConditionGroupDetailResponseData
object
7 properties6 required
CompatiblePlans
object
2 properties2 required
RuleDetailResponseData
object
11 properties10 required
ComparableOperator
string
BillingProviderType
string
EntitlementPriceBehavior
string
BillingPriceScheme
string
FeatureLifecyclePhase
string
PlanGroupBundleOrder
object
1 property1 required
EntityTraitDefinitionResponseData
object
7 properties7 required
PlanType
string
BillingProductPriceTierResponseData
object
4 properties
PlanIcon
string
FlagInPlanResponseData
object
13 properties9 required
RuleConditionDetailResponseData
object
21 properties10 required
PlanGroupPlanEntitlementsOrder
object
2 properties1 required
PlanResponseData
object
10 properties7 required
FeatureType
string
BillingLinkedResourceResponseData
object
3 properties3 required
BillingPlanCreditGrantResponseData
object
27 properties9 required
MetricPeriodMonthReset
string
PlanCurrencyPricesResponseData
object
4 properties1 required
PlanGroupPlanDetailResponseData
object
33 properties19 required
FeatureInPlanResponseData
object
18 properties9 required
BillingPlanCreditGrantResetCadence
string
ApiError
object
1 property1 required
BillingCreditExpiryUnit
string
EntitlementsInPlan
object
2 properties1 required
BillingPlanCreditGrantResetType
string
ScheduledDowngradeConfigBehavior
string
Specification
The full machine-readable OpenAPI contract behind this narrative.
Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.
Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.
MCP tools for apis
4 tools reach this content
search_api_evangelistSearch every content type across the network at once.
find_relatedThe shared-tag relevance graph — what else covers this.
get_tagEverything one tag labels, across all content types.
guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
A second provider on the same verified email joins the account you already have.
Your account
ⓘWhere this information came from
This is an independent, third-party profile of Schematic Plangroups API, published by
API Evangelist. We do not operate, host, resell, or
support these APIs, and we are not affiliated with or endorsed by the company unless stated above.
Everything here is built from publicly available information — the company's own site,
developer portal, documentation, public repositories, and the specifications it publishes for public use.
Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's
public API artifacts, scored against a published rubric. They are not certifications,
endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and
you do not need to justify the request. A removed company is recorded as unrated, never scored
zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy → On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.