How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Schematic plans API

The plans API from Schematic — 14 operation(s) for plans.

Schematic plans 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 Plans. 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 17 operations across 14 paths, and defines 91 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.

17 operations 14 paths 91 schemas 2 DELETE7 GET3 POST5 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 plans 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 17

Across 14 paths, the API surfaces 17 operations — 2 DELETE, 7 GET, 3 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.

plans 17
PUT
/company-plans/{company_plan_id}
Update company plans
updateCompanyPlans 1 param body → 200400401403404500
GET
/custom-plan-billings
List custom plan billings
listCustomPlanBillings 6 params → 200400401403404500
PUT
/custom-plan-billings/{custom_plan_billing_id}/retry
Retry custom plan billing
retryCustomPlanBilling 1 param body → 200400401403404500
POST
/custom-plans
Create custom plan
createCustomPlan body → 201400401403404500
GET
/plans
List plans
listPlans 15 params → 200400401403404500
POST
/plans
Create plan
createPlan body → 201400401403404500
GET
/plans/{plan_id}
Get plan
getPlan 2 params → 200401403404500
PUT
/plans/{plan_id}
Update plan
updatePlan 1 param body → 200400401403404500
DELETE
/plans/{plan_id}
Delete plan
deletePlan 1 param → 200400401403404500
PUT
/plans/{plan_id}/billing_products
Upsert billing product plan
upsertBillingProductPlan 1 param body → 200400401403404500
POST
/plans/billing-linked
Upsert plan for billing product
upsertPlanForBillingProduct body → 201400401403404500
GET
/plans/billing-product-match-companies
List billing product match companies
listBillingProductMatchCompanies 4 params → 200400401403404500
GET
/plans/billing-product-match-companies/count
Count billing product match companies
countBillingProductMatchCompanies 4 params → 200400401403404500
GET
/plans/count
Count plans
countPlans 15 params → 200400401403404500
GET
/plans/issues
List plan issues
listPlanIssues 2 params → 200400401403404500
DELETE
/plans/version/{plan_id}
Delete plan version
deletePlanVersion 2 params → 200400401403404500
PUT
/plans/version/{plan_id}/publish
Publish plan version
publishPlanVersion 1 param body → 200400401403404500

Schemas 91

The contract defines 91 schemas that model the data the API accepts and returns. The most detailed are PlanDetailResponseData (29 properties), PlanCreditGrantView (28 properties), BillingPlanCreditGrantResponseData (27 properties), CompanyDetailResponseData (24 properties). Each schema is shown below with its type and property counts.

Rule
object
10 properties 9 required
CompanyDetailResponseData
object
24 properties 16 required
CustomPlanBillingResponseData
object
11 properties 8 required
FeatureResponseData
object
13 properties 7 required
DeleteResponse
object
1 property
CreditCurrencyPrice
object
2 properties 1 required
PreviewObject
object
4 properties 2 required
PlanCurrencyPriceRequestBody
object
4 properties 1 required
MetricPeriodMonthReset
string
CustomPlanActivationStrategy
string
BillingPriceView
object
23 properties 17 required
FeatureType
string
BillingCreditRolloverPolicy
string
BillingSubscriptionView
object
24 properties 14 required
CustomPlanBillingStatus
string
EntityTraitDefinitionResponseData
object
7 properties 7 required
ComparableOperator
string
PlanCreditGrantView
object
28 properties 10 required
UpdatePayInAdvanceRequestBody
object
2 properties 2 required
CreditCurrencyPriceResponseData
object
2 properties 1 required
BillingPlanCreditGrantResetStart
string
FeatureLifecyclePhase
string
PlanVersionMigrationStrategy
string
UpsertBillingProductRequestBody
object
12 properties 2 required
UpdatePlanRequestBody
object
3 properties 1 required
CreateBillingLinkedPlanRequestBody
object
7 properties 5 required
EntityKeyDetailResponseData
object
10 properties 9 required
FlagInPlanResponseData
object
13 properties 9 required
PlanIssueResponseData
object
4 properties 2 required
ScheduledDowngradeResponseData
object
11 properties 9 required
TraitType
string
EntityType
string
RuleConditionDetailResponseData
object
21 properties 10 required
RuleConditionGroupDetailResponseData
object
7 properties 6 required
PlanVersionResponseData
object
11 properties 10 required
BillingPlanCreditGrantResponseData
object
27 properties 9 required
CountResponse
object
1 property
PlanCurrencyPricesResponseData
object
4 properties 1 required
BillingPlanCreditGrantResetCadence
string
BillingProductPriceTierResponseData
object
4 properties
ApiError
object
1 property 1 required
EntitlementValueType
string
PaymentMethodResponseData
object
18 properties 8 required
BillingPriceScheme
string
PlanIcon
string
RuleType
string
ConditionGroup
object
1 property 1 required
FeatureInPlanResponseData
object
18 properties 9 required
UpdateCompanyPlansRequestBody
object
2 properties 1 required
BillingProductResponseData
object
13 properties 11 required
CompanyEventPeriodMetricsResponseData
object
11 properties 10 required
BillingPriceUsageType
string
InvoiceResponseData
object
19 properties 12 required
EventSummaryResponseData
object
6 properties 5 required
EntityKeyDefinitionResponseData
object
5 properties 5 required
RuleDetailResponseData
object
11 properties 10 required
BillingProductForSubscriptionResponseData
object
22 properties 18 required
BillingPlanCreditGrantResetType
string
BillingPriceResponseData
object
9 properties 7 required
BillingProviderType
string
BillingTiersMode
string
PlanDetailResponseData
object
29 properties 16 required
BillingCreditBurnStrategy
string
CreateCustomPlanRequestBody
object
5 properties 3 required
GenericPreviewObject
object
4 properties 2 required
BillingCreditExpiryUnit
string
BillingCreditView
object
20 properties 12 required
Condition
object
15 properties 7 required
CreatePlanRequestBody
object
4 properties 3 required
BillingCreditResponseData
object
16 properties 10 required
BillingSubscriptionTrialEndSetting
string
BillingProductDetailResponseData
object
15 properties 13 required
TraitDefinition
object
3 properties 3 required
CompanyPlanWithBillingSubView
object
11 properties 3 required
PublishPlanVersionRequestBody
object
6 properties 3 required
FlagType
string
ConditionType
string
ChargeType
string
PlanVersionStatus
string
PlanType
string
BillingSubscriptionDiscountView
object
14 properties 7 required
BillingProductPlanResponseData
object
11 properties 7 required
RetryCustomPlanBillingRequestBody
object
4 properties 2 required
BillingLinkedResourceResponseData
object
3 properties 3 required
MetricPeriod
string
InvoiceStatus
string
FeatureEntitlement
object
14 properties 3 required
BillingProductPriceInterval
string
EntityTraitDetailResponseData
object
7 properties 6 required
BillingCreditExpiryType
string
PreviewObjectResponseData
object
4 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

schematic-plans-api-openapi.yml Raw ↑

Other APIs Schematic publishes across the network.

Schematic accesstokens API
Schematic accounts API
Schematic billing API
Schematic checkout API
Schematic companies API
Schematic components API
Schematic componentspublic API
Schematic credits API
Schematic dataexports API
Schematic entitlements API
Schematic events API
Schematic features API
Where this information came from

This is an independent, third-party profile of Schematic plans 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.