/
SC
schematichq
/
Schematic API
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Checked 50m ago · Updated 1h ago
View markdown
schematichq
Schematic API
post
Preview checkout internal
419cb5147b52
OpenAPI 3.0.0
raw.githubusercontent.com
2026-08-10
262
493
962.8 KB
accesstokens
1
accounts
19
billing
24
catalogs
14
checkout
9
post
Checkout internal
post
Get checkout data
post
Preview checkout internal
get
Get company billing details
put
Update company billing details
post
Manage plan
post
Preview manage plan
post
Cancel subscription
put
Update customer subscription trial end
companies
40
components
8
componentspublic
1
credits
30
dataexports
4
entitlements
24
events
6
features
17
insights
6
integrationsapi
9
licenses
3
planbundle
3
plangroups
3
planmigrations
9
plans
18
scheduledcheckout
4
webhooks
10
checkout
Preview checkout internal
post
/checkout-internal/preview
Request body
ChangeSubscriptionInternalRequestBody
required
add_on_ids
UpdateAddOnRequestBody[]
required
auto_topup_overrides
UpdateAutoTopupOverrideRequestBody[]
required
billing_entity_id
string
nullable
company_id
string
required
coupon_external_id
string
nullable
credit_bundles
UpdateCreditBundleRequestBody[]
required
custom_field_values
CheckoutFieldValue[]
required
new_plan_id
string
required
new_price_id
string
required
opt_in_accepted
boolean
nullable
pay_in_advance
UpdatePayInAdvanceRequestBody[]
required
payment_method_id
string
nullable
promo_code
string
nullable
skip_trial
boolean
required
Response
OK
object
required
data
PreviewSubscriptionChangeResponseData
required
params
object
required
Input parameters