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

The entitlements API from Schematic — 16 operation(s) for entitlements.

Schematic Entitlements 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 Entitlements. 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 22 operations across 16 paths, and defines 107 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.

22 operations 16 paths 107 schemas 2 DELETE14 GET4 POST2 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 Entitlements 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 22

Across 16 paths, the API surfaces 22 operations — 2 DELETE, 14 GET, 4 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Entitlements 22
GET
/company-overrides
List company overrides
listCompanyOverrides 9 params → 200400401403404500
POST
/company-overrides
Create company override
createCompanyOverride body → 201400401403404500
GET
/company-overrides/{company_override_id}
Get company override
getCompanyOverride 1 param → 200401403404500
PUT
/company-overrides/{company_override_id}
Update company override
updateCompanyOverride 1 param body → 200400401403404500
DELETE
/company-overrides/{company_override_id}
Delete company override
deleteCompanyOverride 1 param → 200400401403404500
GET
/company-overrides/count
Count company overrides
countCompanyOverrides 9 params → 200400401403404500
GET
/feature-companies
List feature companies
listFeatureCompanies 4 params → 200400401403404500
GET
/feature-companies/count
Count feature companies
countFeatureCompanies 4 params → 200400401403404500
GET
/feature-usage
List feature usage
listFeatureUsage 8 params → 200400401403404500
GET
/feature-usage-timeseries
Get feature usage time series
getFeatureUsageTimeSeries 5 params → 200401403404500
GET
/feature-usage/count
Count feature usage
countFeatureUsage 8 params → 200400401403404500
GET
/feature-users
List feature users
listFeatureUsers 4 params → 200400401403404500
GET
/feature-users/count
Count feature users
countFeatureUsers 4 params → 200400401403404500
GET
/plan-entitlements
List plan entitlements
listPlanEntitlements 11 params → 200400401403404500
POST
/plan-entitlements
Create plan entitlement
createPlanEntitlement body → 201400401403404500
GET
/plan-entitlements/{plan_entitlement_id}
Get plan entitlement
getPlanEntitlement 1 param → 200401403404500
PUT
/plan-entitlements/{plan_entitlement_id}
Update plan entitlement
updatePlanEntitlement 1 param body → 200400401403404500
DELETE
/plan-entitlements/{plan_entitlement_id}
Delete plan entitlement
deletePlanEntitlement 1 param → 200400401403404500
POST
/plan-entitlements/billing-linked
Upsert plan entitlement for billing product
upsertPlanEntitlementForBillingProduct body → 201400401403404500
GET
/plan-entitlements/count
Count plan entitlements
countPlanEntitlements 11 params → 200400401403404500
POST
/plan-entitlements/duplicate
Duplicate plan entitlements
duplicatePlanEntitlements body → 201400401403404500
GET
/usage-by-company
Get feature usage by company
getFeatureUsageByCompany 1 param → 200401403404500

Schemas 107

The contract defines 107 schemas that model the data the API accepts and returns. The most detailed are FeatureCompanyResponseData (36 properties), FeatureUsageResponseData (34 properties), CreateBillingLinkedPlanEntitlementRequestBody (30 properties), CreatePlanEntitlementRequestBody (28 properties). Each schema is shown below with its type and property counts.

DeleteResponse
object
1 property
InvoiceResponseData
object
19 properties 12 required
CustomPlanActivationStrategy
string
FeatureResponseData
object
13 properties 7 required
ConditionType
string
BillingProductResponseData
object
13 properties 11 required
PreviewObjectResponseData
object
4 properties 2 required
BillingSubscriptionDiscountView
object
14 properties 7 required
FlagDetailResponseData
object
14 properties 9 required
TraitType
string
CreditUsage
object
9 properties
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
FeatureUsageTimeSeriesResponseData
object
5 properties 4 required
FeatureLifecyclePhase
string
FlagInPlanResponseData
object
13 properties 9 required
FeatureCompanyUserResponseData
object
13 properties 4 required
BillingProductPriceTierResponseData
object
4 properties
PlanType
string
FeatureUsageResponseData
object
34 properties 4 required
EntityTraitDetailResponseData
object
7 properties 6 required
CreateBillingLinkedPlanEntitlementRequestBody
object
30 properties 5 required
CreatePriceTierRequestBody
object
4 properties
Rule
object
10 properties 9 required
FeatureType
string
CountResponse
object
1 property
BillingPlanCreditGrantResetCadence
string
FeatureCompanyResponseData
object
36 properties 4 required
UsageTimeSeriesPointResponseData
object
4 properties 2 required
UpdatePlanEntitlementRequestBody
object
25 properties 1 required
EntitlementValueType
string
CompanyEventPeriodMetricsResponseData
object
11 properties 10 required
RuleType
string
BillingProductPriceInterval
string
PaymentMethodResponseData
object
18 properties 8 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
EntityKeyDefinitionResponseData
object
5 properties 5 required
ScheduledDowngradeResponseData
object
11 properties 9 required
TimeSeriesGranularity
string
RuleConditionGroupDetailResponseData
object
7 properties 6 required
FeatureDetailResponseData
object
19 properties 9 required
BillingProviderType
string
EntitlementPriceBehavior
string
CustomPlanBillingStatus
string
CurrencyPriceRequestBody
object
7 properties 1 required
EntityTraitDefinitionResponseData
object
7 properties 7 required
SkippedEntitlementErrorResponseData
object
1 property 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
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
AccountMemberResponseData
object
8 properties 4 required
EntitlementCurrencyPricesResponseData
object
3 properties 1 required
BillingCreditExpiryType
string
BillingCreditView
object
20 properties 12 required
AccountMemberRole
string
FeatureEntitlement
object
14 properties 3 required
BillingPriceUsageType
string
BillingPriceResponseData
object
9 properties 7 required
ComparableOperator
string
BillingPriceScheme
string
CompanyDetailResponseData
object
24 properties 16 required
BillingProductForSubscriptionResponseData
object
22 properties 18 required
RuleConditionDetailResponseData
object
21 properties 10 required
DuplicatePlanEntitlementsRequestBody
object
2 properties 2 required
Condition
object
15 properties 7 required
MetricPeriodMonthReset
string
LimitTimeSeriesPointResponseData
object
6 properties 3 required
UpdateCompanyOverrideRequestBody
object
10 properties 1 required
CreditUsageAggregation
object
4 properties
EventSummaryResponseData
object
6 properties 5 required
CreateCompanyOverrideRequestBody
object
12 properties 3 required
BillingCreditBurnStrategy
string
BillingPlanCreditGrantResetStart
string
CreatePlanEntitlementRequestBody
object
28 properties 3 required
BillingSubscriptionTrialEndSetting
string
UserResponseData
object
6 properties 5 required
DuplicatePlanEntitlementsResponseResponseData
object
2 properties 2 required
BillingTiersMode
string
CustomPlanBillingResponseData
object
11 properties 8 required
ConditionGroup
object
1 property 1 required
CompanyOverrideNoteResponseData
object
6 properties 6 required
SkippedEntitlementResponseData
object
4 properties 4 required
AccountMemberPermission
string
PlanIcon
string
CreditGrantDetail
object
4 properties 2 required
BillingLinkedResourceResponseData
object
3 properties 3 required
BillingCreditExpiryUnit
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

schematic-entitlements-api-openapi.yml Raw ↑

Other APIs Schematic publishes across the network.

Schematic Accounts API
Schematic Billing API
Schematic Checkout API
Schematic Companies API
Schematic Components API
Schematic Componentspublic API
Schematic Credits 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 Entitlements 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.