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

The checkout API from Schematic — 7 operation(s) for checkout.

Schematic Checkout 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 Checkout. 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 7 operations across 7 paths, and defines 111 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.

7 operations 7 paths 111 schemas 6 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 Checkout 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 7

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

Checkout 7
POST
/checkout-internal
Checkout internal
checkoutInternal body → 201400401403404500
POST
/checkout-internal/data
Get checkout data
getCheckoutData body → 200400401403404500
POST
/checkout-internal/preview
Preview checkout internal
previewCheckoutInternal body → 200400401403404500
POST
/manage-plan
Manage plan
managePlan body → 200400401403404500
POST
/manage-plan/preview
Preview manage plan
previewManagePlan body → 200400401403404500
POST
/manage-plan/subscription/cancel
Cancel subscription
cancelSubscription body → 200400401403404500
PUT
/subscription/{subscription_id}/edit-trial-end
Update customer subscription trial end
updateCustomerSubscriptionTrialEnd 1 param body → 200400401403404500

Schemas 111

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

InvoiceResponseData
object
19 properties 12 required
CustomPlanActivationStrategy
string
FeatureResponseData
object
13 properties 7 required
ConditionType
string
CompanySubscriptionResponseData
object
15 properties 10 required
BillingProductResponseData
object
13 properties 11 required
CreditBundlePurchaseResponseData
object
3 properties 2 required
ManagePlanRequest
object
13 properties 4 required
PreviewObjectResponseData
object
4 properties 2 required
BillingProductDetailResponseData
object
15 properties 13 required
BillingSubscriptionDiscountView
object
14 properties 7 required
UpdatePayInAdvanceRequestBody
object
2 properties 2 required
TraitType
string
TraitDefinition
object
3 properties 3 required
BillingPriceView
object
23 properties 17 required
BillingCreditResponseData
object
16 properties 10 required
FeatureUsageDetailResponseData
object
1 property 1 required
RuleDetailResponseData
object
11 properties 10 required
CompanyPlanWithBillingSubView
object
11 properties 3 required
InvoiceStatus
string
CheckoutDataRequestBody
object
2 properties 1 required
FeatureLifecyclePhase
string
FlagInPlanResponseData
object
13 properties 9 required
UsageBasedEntitlementResponseData
object
12 properties 2 required
FeatureUsageResponseData
object
34 properties 4 required
BillingProductPriceTierResponseData
object
4 properties
PlanType
string
EntityTraitDetailResponseData
object
7 properties 6 required
CheckoutDataResponseData
object
10 properties 5 required
Rule
object
10 properties 9 required
PreviewSubscriptionChangeResponseData
object
13 properties 10 required
FeatureType
string
BillingPlanCreditGrantResponseData
object
27 properties 9 required
UpdateAddOnRequestBody
object
2 properties 2 required
BillingPlanCreditGrantResetCadence
string
EntitlementValueType
string
CompanyEventPeriodMetricsResponseData
object
11 properties 10 required
RuleType
string
BillingProductPriceInterval
string
PaymentMethodResponseData
object
18 properties 8 required
PreviewSubscriptionUpcomingInvoiceLineItems
object
5 properties 5 required
PlanEntitlementResponseData
object
27 properties 9 required
BillingCreditGrantReason
string
EntityType
string
CreditCurrencyPrice
object
2 properties 1 required
MetricPeriod
string
PlanCreditGrantView
object
28 properties 10 required
BillingCreditRolloverPolicy
string
CompanyOverrideResponseData
object
20 properties 8 required
EntitlementType
string
PreviewSubscriptionFinanceResponseData
object
13 properties 10 required
EntityKeyDefinitionResponseData
object
5 properties 5 required
ScheduledDowngradeResponseData
object
11 properties 9 required
PlanVersionStatus
string
RuleConditionGroupDetailResponseData
object
7 properties 6 required
UpdateTrialEndRequestBody
object
1 property
ChangeSubscriptionInternalRequestBody
object
10 properties 7 required
BillingProviderType
string
EntitlementPriceBehavior
string
CustomPlanBillingStatus
string
EntityTraitDefinitionResponseData
object
7 properties 7 required
CreditBundleCurrencyPriceResponseData
object
2 properties 1 required
PlanResponseData
object
10 properties 7 required
EntityKeyDetailResponseData
object
10 properties 9 required
GenericPreviewObject
object
4 properties 2 required
FeatureInPlanResponseData
object
18 properties 9 required
PlanCurrencyPricesResponseData
object
4 properties 1 required
ApiError
object
1 property 1 required
BillingPlanCreditGrantResetType
string
CreditCurrencyPriceResponseData
object
2 properties 1 required
BillingSubscriptionView
object
24 properties 14 required
PreviewObject
object
4 properties 2 required
FlagType
string
PlanDetailResponseData
object
29 properties 16 required
EntitlementCurrencyPricesResponseData
object
3 properties 1 required
ChargeType
string
BillingCreditExpiryType
string
ManagePlanPreviewResponseResponseData
object
1 property
BillingCreditView
object
20 properties 12 required
PlanVersionResponseData
object
11 properties 10 required
FeatureEntitlement
object
14 properties 3 required
BillingPriceUsageType
string
ManagePlanResponseResponseData
object
2 properties 1 required
BillingPriceResponseData
object
9 properties 7 required
PlanSelection
object
3 properties 1 required
ComparableOperator
string
BillingCreditBundleStatus
string
BillingPriceScheme
string
CompanyDetailResponseData
object
24 properties 16 required
BillingProductForSubscriptionResponseData
object
22 properties 18 required
RuleConditionDetailResponseData
object
21 properties 10 required
Condition
object
15 properties 7 required
MetricPeriodMonthReset
string
CreditUsageAggregation
object
4 properties
EventSummaryResponseData
object
6 properties 5 required
BillingCreditBurnStrategy
string
BillingPlanCreditGrantResetStart
string
BillingCreditBundleType
string
CancelSubscriptionRequest
object
3 properties 1 required
BillingSubscriptionTrialEndSetting
string
BillingTiersMode
string
CustomPlanBillingResponseData
object
11 properties 8 required
CompanyOverrideNoteResponseData
object
6 properties 6 required
ConditionGroup
object
1 property 1 required
BillingCreditBundleResponseData
object
21 properties 12 required
PlanIcon
string
CreditGrantDetail
object
4 properties 2 required
BillingLinkedResourceResponseData
object
3 properties 3 required
UpdateCreditBundleRequestBody
object
2 properties 2 required
CheckoutSubscription
object
23 properties 12 required
BillingCreditExpiryUnit
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

schematic-checkout-api-openapi.yml Raw ↑

Other APIs Schematic publishes across the network.

Schematic Accounts API
Schematic Billing API
Schematic Companies API
Schematic Components API
Schematic Componentspublic API
Schematic Credits API
Schematic Entitlements API
Schematic Events API
Schematic Features API
Schematic Insights API
Schematic Planbundle API
Schematic Plangroups API
Where this information came from

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