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 planbundle API

The planbundle API from Schematic — 2 operation(s) for planbundle.

Schematic planbundle 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 planbundle. 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 2 operations across 2 paths, and defines 58 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.

2 operations 2 paths 58 schemas 1 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 planbundle 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 2

Across 2 paths, the API surfaces 2 operations — 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

planbundle 2
POST
/plan-bundles
Create plan bundle
createPlanBundle body → 201400401403404500
PUT
/plan-bundles/{plan_bundle_id}
Update plan bundle
updatePlanBundle 1 param body → 200400401403404500

Schemas 58

The contract defines 58 schemas that model the data the API accepts and returns. The most detailed are CreateEntitlementInBundleRequestBody (28 properties), BillingPlanCreditGrantResponseData (27 properties), PlanEntitlementResponseData (27 properties), BillingPriceView (23 properties). Each schema is shown below with its type and property counts.

BillingCreditResponseData
object
16 properties 10 required
CreatePriceTierRequestBody
object
4 properties
ApiError
object
1 property 1 required
EntitlementValueType
string
BillingPriceScheme
string
CreditAutoTopupAmountType
string
UpdateBillingPlanCreditGrantRequestBody
object
16 properties 2 required
PlanIcon
string
FeatureResponseData
object
13 properties 7 required
BillingProductResponseData
object
13 properties 11 required
PlanCurrencyPriceRequestBody
object
4 properties 1 required
UpsertBillingProductRequestBody
object
12 properties 2 required
BillingProductPriceTierResponseData
object
4 properties
ChargeType
string
BillingPriceUsageType
string
PlanBundleCreditGrantRequestBody
object
5 properties 1 required
PlanBundleResponseData
object
5 properties
MetricPeriodMonthReset
string
PlanBundleEntitlementRequestBody
object
3 properties 1 required
CreateEntitlementInBundleRequestBody
object
28 properties 3 required
UpdatePlanRequestBody
object
3 properties 1 required
PlanResponseData
object
10 properties 7 required
EntitlementPriceBehavior
string
BillingPriceView
object
23 properties 17 required
BillingPlanCreditGrantResetType
string
FeatureType
string
CurrencyPriceRequestBody
object
7 properties 1 required
PlanType
string
PlanEntitlementResponseData
object
27 properties 9 required
UpdatePlanTraitTraitRequestBody
object
2 properties 2 required
PlanTraitResponseData
object
9 properties 9 required
BillingProductPlanResponseData
object
11 properties 7 required
TraitType
string
BillingPriceResponseData
object
9 properties 7 required
BillingCreditRolloverPolicy
string
BillingProviderType
string
BillingTiersMode
string
EntityType
string
BillingLinkedResourceResponseData
object
3 properties 3 required
EntityTraitDefinitionResponseData
object
7 properties 7 required
CreatePlanBundleRequestBody
object
5 properties 1 required
MetricPeriod
string
BillingCreditBurnStrategy
string
UpdatePlanBundleRequestBody
object
6 properties 1 required
CreateBillingPlanCreditGrantRequestBody
object
19 properties 5 required
PlanBundleAction
string
BillingPlanCreditGrantResponseData
object
27 properties 9 required
BillingCreditExpiryUnit
string
CreditCurrencyPriceResponseData
object
2 properties 1 required
CreatePlanRequestBody
object
4 properties 3 required
BillingPlanCreditGrantResetCadence
string
DeleteBillingPlanCreditGrantRequestBody
object
1 property
BillingProductPriceInterval
string
BillingPlanCreditGrantResetStart
string
EntitlementCurrencyPricesResponseData
object
3 properties 1 required
FeatureLifecyclePhase
string
BillingCreditExpiryType
string
PreviewObjectResponseData
object
4 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

schematic-planbundle-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 planbundle 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.