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

The credits API from Schematic — 20 operation(s) for credits.

Schematic credits 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 Credits. 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 29 operations across 20 paths, and defines 48 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.

29 operations 20 paths 48 schemas 3 DELETE18 GET4 POST4 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 credits 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 29

Across 20 paths, the API surfaces 29 operations — 3 DELETE, 18 GET, 4 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

credits 29
GET
/billing/credits
List billing credits
listBillingCredits 4 params → 200400401403404500
POST
/billing/credits
Create billing credit
createBillingCredit body → 201400401403404500
GET
/billing/credits/{credit_id}
Get single billing credit
getSingleBillingCredit 1 param → 200401403404500
PUT
/billing/credits/{credit_id}
Update billing credit
updateBillingCredit 1 param body → 200400401403404500
DELETE
/billing/credits/{credit_id}
Soft delete billing credit
softDeleteBillingCredit 1 param → 200400401403404500
GET
/billing/credits/balance
List company credit balances
listCompanyCreditBalances 1 param → 200400401403404500
GET
/billing/credits/bundles
List credit bundles
listCreditBundles 6 params → 200400401403404500
POST
/billing/credits/bundles
Create credit bundle
createCreditBundle body → 201400401403404500
GET
/billing/credits/bundles/{bundle_id}
Get credit bundle
getCreditBundle 1 param → 200401403404500
PUT
/billing/credits/bundles/{bundle_id}
Update credit bundle details
updateCreditBundleDetails 1 param body → 200400401403404500
DELETE
/billing/credits/bundles/{bundle_id}
Delete credit bundle
deleteCreditBundle 1 param → 200400401403404500
GET
/billing/credits/bundles/count
Count credit bundles
countCreditBundles 6 params → 200400401403404500
GET
/billing/credits/count
Count billing credits
countBillingCredits 4 params → 200400401403404500
PUT
/billing/credits/grants/{grant_id}/zero-out
Zero out grant
zeroOutGrant 1 param body → 200400401403404500
POST
/billing/credits/grants/company
Grant billing credits to company
grantBillingCreditsToCompany body → 201400401403404500
GET
/billing/credits/grants/company/count
Count company grants
countCompanyGrants 5 params → 200400401403404500
GET
/billing/credits/grants/company/list
List company grants
listCompanyGrants 5 params → 200400401403404500
GET
/billing/credits/grants/count
Count billing credits grants
countBillingCreditsGrants 4 params → 200400401403404500
GET
/billing/credits/grants/list
List grants for credit
listGrantsForCredit 4 params → 200400401403404500
GET
/billing/credits/ledger
Get enriched credit ledger
getEnrichedCreditLedger 8 params → 200400401403404500
GET
/billing/credits/ledger/count
Count credit ledger
countCreditLedger 8 params → 200400401403404500
GET
/billing/credits/plan-grants
List billing plan credit grants
listBillingPlanCreditGrants 7 params → 200400401403404500
POST
/billing/credits/plan-grants
Create billing plan credit grant
createBillingPlanCreditGrant body → 201400401403404500
GET
/billing/credits/plan-grants/{plan_grant_id}
Get single billing plan credit grant
getSingleBillingPlanCreditGrant 1 param → 200401403404500
PUT
/billing/credits/plan-grants/{plan_grant_id}
Update billing plan credit grant
updateBillingPlanCreditGrant 1 param body → 200400401403404500
DELETE
/billing/credits/plan-grants/{plan_grant_id}
Delete billing plan credit grant
deleteBillingPlanCreditGrant 2 params → 200400401403404500
GET
/billing/credits/plan-grants/count
Count billing plan credit grants
countBillingPlanCreditGrants 7 params → 200400401403404500
GET
/v2/billing/credits/ledger
List credit event ledger
listCreditEventLedger 8 params → 200400401403404500
GET
/v2/billing/credits/ledger/count
Count credit event ledger
countCreditEventLedger 8 params → 200400401403404500

Schemas 48

The contract defines 48 schemas that model the data the API accepts and returns. The most detailed are CreditEventLedgerResponseData (31 properties), BillingPlanCreditGrantResponseData (27 properties), BillingCreditGrantResponseData (24 properties), CreditLedgerEnrichedEntryResponseData (22 properties). Each schema is shown below with its type and property counts.

ApiError
object
1 property 1 required
BillingCreditResponseData
object
16 properties 10 required
BillingPriceScheme
string
CreditLedgerPeriod
string
CreditAutoTopupAmountType
string
UpdateBillingPlanCreditGrantRequestBody
object
16 properties 2 required
CreateCompanyCreditGrant
object
12 properties 4 required
BillingCreditBundleStatus
string
CreateCreditBundleRequestBody
object
12 properties 4 required
DeleteResponse
object
1 property
CreditEventType
string
CreditBundleCurrencyPriceResponseData
object
2 properties 1 required
BillingCreditGrantReason
string
BillingProductResponseData
object
13 properties 11 required
CreditTransferResponseData
object
6 properties 6 required
CreditLedgerEnrichedEntryResponseData
object
22 properties 18 required
BillingCreditLedgerResponseData
object
6 properties 2 required
SortDirection
string
BillingPlanCreditGrantResetStart
string
CreditCurrencyPriceRequestBody
object
3 properties 1 required
BillingPlanCreditGrantResetType
string
CreditBundleCurrencyPriceRequestBody
object
3 properties 1 required
BillingCreditRolloverPolicy
string
PreviewObjectResponseData
object
4 properties 2 required
BillingPriceResponseData
object
9 properties 7 required
BillingProviderType
string
CreditGrantSortOrder
string
CompanyCreditBalanceResponseData
object
4 properties 3 required
UpdateCreditBundleDetailsRequestBody
object
9 properties 2 required
BillingCreditBurnStrategy
string
ZeroOutGrantRequestBody
object
1 property
CreateBillingPlanCreditGrantRequestBody
object
19 properties 5 required
BillingPlanCreditGrantResponseData
object
27 properties 9 required
CompanyLedgerResponseData
object
3 properties 2 required
BillingCreditExpiryUnit
string
CreditCurrencyPriceResponseData
object
2 properties 1 required
CountResponse
object
1 property
UpdateBillingCreditRequestBody
object
12 properties 2 required
BillingCreditGrantZeroedOutReason
string
FeatureLedgerResponseData
object
4 properties 2 required
BillingProductPriceInterval
string
BillingCreditGrantResponseData
object
24 properties 13 required
BillingPlanCreditGrantResetCadence
string
CreateBillingCreditRequestBody
object
13 properties 3 required
BillingCreditBundleResponseData
object
21 properties 12 required
BillingCreditBundleType
string
BillingCreditExpiryType
string
CreditEventLedgerResponseData
object
31 properties 9 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

schematic-credits-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 dataexports API
Schematic entitlements API
Schematic events API
Schematic features API
Schematic insights API
Where this information came from

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