README

Schematic API

For more information, please visit https://schematichq.com.

Installation & Usage

Requirements

PHP 7.4 and later. Should also work with PHP 8.0.

Installation

You can install the Schematic PHP SDK via Composer. Run the following command in your project directory:

composer require schematichq/schematic-php

Usage

To initialize the Schematic client, provide a secret API key; you can issue an API key in the API Keys section of settings in the Schematic web app.

<?php

require_once 'vendor/autoload.php';

use Schematic\Schematic;

$schematic = new Schematic('YOUR_SECRET_API_KEY');

Once you have initialized the Schematic client, you can make API calls using the various API classes provided by the SDK.

$companies = $schematic->CompaniesApi->listCompanies();

The SDK throws exceptions in case of API errors. You can catch and handle these exceptions in your code:

try {
    $companies = $schematic->CompaniesApi->listCompanies();
    // Process the companies
} catch (\Exception $e) {
    // Handle the exception
    echo 'Error: ' . $e->getMessage();
}

API Endpoints

The following Schematic API endpoints are accessible via this client library. All URIs are relative to https://api.schematichq.com

Class	Method	HTTP request	Description
AccesstokensApi	issueTemporaryAccessToken	POST /temporary-access-tokens	Issue temporary access token
AccountsApi	countApiKeys	GET /api-keys/count	Count api keys
AccountsApi	countApiRequests	GET /api-requests/count	Count api requests
AccountsApi	countAuditLogs	GET /audit-log/count	Count audit logs
AccountsApi	createApiKey	POST /api-keys	Create api key
AccountsApi	createEnvironment	POST /environments	Create environment
AccountsApi	deleteApiKey	DELETE /api-keys/{api_key_id}	Delete api key
AccountsApi	deleteEnvironment	DELETE /environments/{environment_id}	Delete environment
AccountsApi	getApiKey	GET /api-keys/{api_key_id}	Get api key
AccountsApi	getApiRequest	GET /api-requests/{api_request_id}	Get api request
AccountsApi	getAuditLog	GET /audit-log/{audit_log_id}	Get audit log
AccountsApi	getEnvironment	GET /environments/{environment_id}	Get environment
AccountsApi	getWhoAmI	GET /whoami	Get who am i
AccountsApi	listApiKeys	GET /api-keys	List api keys
AccountsApi	listApiRequests	GET /api-requests	List api requests
AccountsApi	listAuditLogs	GET /audit-log	List audit logs
AccountsApi	listEnvironments	GET /environments	List environments
AccountsApi	quickstart	POST /quickstart	Quickstart
AccountsApi	updateApiKey	PUT /api-keys/{api_key_id}	Update api key
AccountsApi	updateEnvironment	PUT /environments/{environment_id}	Update environment
BillingApi	countBillingProducts	GET /billing/products/count	Count billing products
BillingApi	countCustomers	GET /billing/customers/count	Count customers
BillingApi	deleteBillingProduct	DELETE /billing/product/{billing_id}	Delete billing product
BillingApi	deleteProductPrice	DELETE /billing/product/prices/{billing_id}	Delete product price
BillingApi	listBillingPrices	GET /billing/price	List billing prices
BillingApi	listBillingProductPrices	GET /billing/product/prices	List billing product prices
BillingApi	listBillingProducts	GET /billing/products	List billing products
BillingApi	listCoupons	GET /billing/coupons	List coupons
BillingApi	listCustomersWithSubscriptions	GET /billing/customers	List customers with subscriptions
BillingApi	listInvoices	GET /billing/invoices	List invoices
BillingApi	listMeters	GET /billing/meter	List meters
BillingApi	listPaymentMethods	GET /billing/payment-methods	List payment methods
BillingApi	upsertBillingCoupon	POST /billing/coupons	Upsert billing coupon
BillingApi	upsertBillingCustomer	POST /billing/customer/upsert	Upsert billing customer
BillingApi	upsertBillingMeter	POST /billing/meter/upsert	Upsert billing meter
BillingApi	upsertBillingPrice	POST /billing/price/upsert	Upsert billing price
BillingApi	upsertBillingProduct	POST /billing/product/upsert	Upsert billing product
BillingApi	upsertBillingSubscription	POST /billing/subscription/upsert	Upsert billing subscription
BillingApi	upsertInvoice	POST /billing/invoices	Upsert invoice
BillingApi	upsertPaymentMethod	POST /billing/payment-methods	Upsert payment method
CheckoutApi	cancelSubscription	POST /manage-plan/subscription/cancel	Cancel subscription
CheckoutApi	checkoutInternal	POST /checkout-internal	Checkout internal
CheckoutApi	getCheckoutData	POST /checkout-internal/data	Get checkout data
CheckoutApi	managePlan	POST /manage-plan	Manage plan
CheckoutApi	previewCheckoutInternal	POST /checkout-internal/preview	Preview checkout internal
CheckoutApi	previewManagePlan	POST /manage-plan/preview	Preview manage plan
CheckoutApi	updateCustomerSubscriptionTrialEnd	PUT /subscription/{subscription_id}/edit-trial-end	Update customer subscription trial end
CompaniesApi	countCompanies	GET /companies/count	Count companies
CompaniesApi	countCompaniesForAdvancedFilter	GET /companies/count2	Count companies for advanced filter
CompaniesApi	countEntityKeyDefinitions	GET /entity-key-definitions/count	Count entity key definitions
CompaniesApi	countEntityTraitDefinitions	GET /entity-trait-definitions/count	Count entity trait definitions
CompaniesApi	countPlanTraits	GET /plan-traits/count	Count plan traits
CompaniesApi	countUsers	GET /users/count	Count users
CompaniesApi	createCompany	POST /companies/create	Create company
CompaniesApi	createPlanTrait	POST /plan-traits	Create plan trait
CompaniesApi	createUser	POST /users/create	Create user
CompaniesApi	deleteCompany	DELETE /companies/{company_id}	Delete company
CompaniesApi	deleteCompanyByKeys	POST /companies/delete	Delete company by keys
CompaniesApi	deleteCompanyMembership	DELETE /company-memberships/{company_membership_id}	Delete company membership
CompaniesApi	deletePlanTrait	DELETE /plan-traits/{plan_trait_id}	Delete plan trait
CompaniesApi	deleteUser	DELETE /users/{user_id}	Delete user
CompaniesApi	deleteUserByKeys	POST /users/delete	Delete user by keys
CompaniesApi	getActiveCompanySubscription	GET /company-subscriptions	Get active company subscription
CompaniesApi	getCompany	GET /companies/{company_id}	Get company
CompaniesApi	getEntityTraitDefinition	GET /entity-trait-definitions/{entity_trait_definition_id}	Get entity trait definition
CompaniesApi	getEntityTraitValues	GET /entity-trait-values	Get entity trait values
CompaniesApi	getOrCreateCompanyMembership	POST /company-memberships	Get or create company membership
CompaniesApi	getOrCreateEntityTraitDefinition	POST /entity-trait-definitions	Get or create entity trait definition
CompaniesApi	getPlanChange	GET /plan-changes/{plan_change_id}	Get plan change
CompaniesApi	getPlanTrait	GET /plan-traits/{plan_trait_id}	Get plan trait
CompaniesApi	getUser	GET /users/{user_id}	Get user
CompaniesApi	listCompanies	GET /companies	List companies
CompaniesApi	listCompaniesForAdvancedFilter	GET /companies/list2	List companies for advanced filter
CompaniesApi	listCompanyMemberships	GET /company-memberships	List company memberships
CompaniesApi	listEntityKeyDefinitions	GET /entity-key-definitions	List entity key definitions
CompaniesApi	listEntityTraitDefinitions	GET /entity-trait-definitions	List entity trait definitions
CompaniesApi	listPlanChanges	GET /plan-changes	List plan changes
CompaniesApi	listPlanTraits	GET /plan-traits	List plan traits
CompaniesApi	listUsers	GET /users	List users
CompaniesApi	lookupCompany	GET /companies/lookup	Lookup company
CompaniesApi	lookupUser	GET /users/lookup	Lookup user
CompaniesApi	updateEntityTraitDefinition	PUT /entity-trait-definitions/{entity_trait_definition_id}	Update entity trait definition
CompaniesApi	updatePlanTrait	PUT /plan-traits/{plan_trait_id}	Update plan trait
CompaniesApi	updatePlanTraitsBulk	POST /plan-traits/bulk	Update plan traits bulk
CompaniesApi	upsertCompany	POST /companies	Upsert company
CompaniesApi	upsertCompanyTrait	POST /company-traits	Upsert company trait
CompaniesApi	upsertUser	POST /users	Upsert user
CompaniesApi	upsertUserTrait	POST /user-traits	Upsert user trait
ComponentsApi	countComponents	GET /components/count	Count components
ComponentsApi	createComponent	POST /components	Create component
ComponentsApi	deleteComponent	DELETE /components/{component_id}	Delete component
ComponentsApi	getComponent	GET /components/{component_id}	Get component
ComponentsApi	listComponents	GET /components	List components
ComponentsApi	previewComponentData	GET /components/preview-data	Preview component data
ComponentsApi	updateComponent	PUT /components/{component_id}	Update component
ComponentspublicApi	getPublicPlans	GET /public/plans	Get public plans
CreditsApi	countBillingCredits	GET /billing/credits/count	Count billing credits
CreditsApi	countBillingCreditsGrants	GET /billing/credits/grants/count	Count billing credits grants
CreditsApi	countBillingPlanCreditGrants	GET /billing/credits/plan-grants/count	Count billing plan credit grants
CreditsApi	countCompanyGrants	GET /billing/credits/grants/company/count	Count company grants
CreditsApi	countCreditBundles	GET /billing/credits/bundles/count	Count credit bundles
CreditsApi	countCreditLedger	GET /billing/credits/ledger/count	Count credit ledger
CreditsApi	createBillingCredit	POST /billing/credits	Create billing credit
CreditsApi	createBillingPlanCreditGrant	POST /billing/credits/plan-grants	Create billing plan credit grant
CreditsApi	createCreditBundle	POST /billing/credits/bundles	Create credit bundle
CreditsApi	deleteBillingPlanCreditGrant	DELETE /billing/credits/plan-grants/{plan_grant_id}	Delete billing plan credit grant
CreditsApi	deleteCreditBundle	DELETE /billing/credits/bundles/{bundle_id}	Delete credit bundle
CreditsApi	getCreditBundle	GET /billing/credits/bundles/{bundle_id}	Get credit bundle
CreditsApi	getEnrichedCreditLedger	GET /billing/credits/ledger	Get enriched credit ledger
CreditsApi	getSingleBillingCredit	GET /billing/credits/{credit_id}	Get single billing credit
CreditsApi	grantBillingCreditsToCompany	POST /billing/credits/grants/company	Grant billing credits to company
CreditsApi	listBillingCredits	GET /billing/credits	List billing credits
CreditsApi	listBillingPlanCreditGrants	GET /billing/credits/plan-grants	List billing plan credit grants
CreditsApi	listCompanyGrants	GET /billing/credits/grants/company/list	List company grants
CreditsApi	listCreditBundles	GET /billing/credits/bundles	List credit bundles
CreditsApi	listGrantsForCredit	GET /billing/credits/grants/list	List grants for credit
CreditsApi	softDeleteBillingCredit	DELETE /billing/credits/{credit_id}	Soft delete billing credit
CreditsApi	updateBillingCredit	PUT /billing/credits/{credit_id}	Update billing credit
CreditsApi	updateBillingPlanCreditGrant	PUT /billing/credits/plan-grants/{plan_grant_id}	Update billing plan credit grant
CreditsApi	updateCreditBundleDetails	PUT /billing/credits/bundles/{bundle_id}	Update credit bundle details
CreditsApi	zeroOutGrant	PUT /billing/credits/grants/{grant_id}/zero-out	Zero out grant
DataexportsApi	createDataExport	POST /data-exports	Create data export
DataexportsApi	getDataExportArtifact	GET /data-exports/{data_export_id}/artifact	Get data export artifact
EntitlementsApi	countCompanyOverrides	GET /company-overrides/count	Count company overrides
EntitlementsApi	countFeatureCompanies	GET /feature-companies/count	Count feature companies
EntitlementsApi	countFeatureUsage	GET /feature-usage/count	Count feature usage
EntitlementsApi	countFeatureUsers	GET /feature-users/count	Count feature users
EntitlementsApi	countPlanEntitlements	GET /plan-entitlements/count	Count plan entitlements
EntitlementsApi	createCompanyOverride	POST /company-overrides	Create company override
EntitlementsApi	createPlanEntitlement	POST /plan-entitlements	Create plan entitlement
EntitlementsApi	deleteCompanyOverride	DELETE /company-overrides/{company_override_id}	Delete company override
EntitlementsApi	deletePlanEntitlement	DELETE /plan-entitlements/{plan_entitlement_id}	Delete plan entitlement
EntitlementsApi	duplicatePlanEntitlements	POST /plan-entitlements/duplicate	Duplicate plan entitlements
EntitlementsApi	getCompanyOverride	GET /company-overrides/{company_override_id}	Get company override
EntitlementsApi	getFeatureUsageByCompany	GET /usage-by-company	Get feature usage by company
EntitlementsApi	getFeatureUsageTimeSeries	GET /feature-usage-timeseries	Get feature usage time series
EntitlementsApi	getPlanEntitlement	GET /plan-entitlements/{plan_entitlement_id}	Get plan entitlement
EntitlementsApi	listCompanyOverrides	GET /company-overrides	List company overrides
EntitlementsApi	listFeatureCompanies	GET /feature-companies	List feature companies
EntitlementsApi	listFeatureUsage	GET /feature-usage	List feature usage
EntitlementsApi	listFeatureUsers	GET /feature-users	List feature users
EntitlementsApi	listPlanEntitlements	GET /plan-entitlements	List plan entitlements
EntitlementsApi	updateCompanyOverride	PUT /company-overrides/{company_override_id}	Update company override
EntitlementsApi	updatePlanEntitlement	PUT /plan-entitlements/{plan_entitlement_id}	Update plan entitlement
EventsApi	createEvent	POST /events	Create event
EventsApi	createEventBatch	POST /event-batch	Create event batch
EventsApi	getEvent	GET /events/{event_id}	Get event
EventsApi	getEventSummaries	GET /event-types	Get event summaries
EventsApi	getSegmentIntegrationStatus	GET /segment-integration	Get segment integration status
EventsApi	listEvents	GET /events	List events
FeaturesApi	checkFlag	POST /flags/{key}/check	Check flag
FeaturesApi	checkFlags	POST /flags/check	Check flags
FeaturesApi	checkFlagsBulk	POST /flags/check-bulk	Check flags bulk
FeaturesApi	countFeatures	GET /features/count	Count features
FeaturesApi	countFlags	GET /flags/count	Count flags
FeaturesApi	createFeature	POST /features	Create feature
FeaturesApi	createFlag	POST /flags	Create flag
FeaturesApi	deleteFeature	DELETE /features/{feature_id}	Delete feature
FeaturesApi	deleteFlag	DELETE /flags/{flag_id}	Delete flag
FeaturesApi	getFeature	GET /features/{feature_id}	Get feature
FeaturesApi	getFlag	GET /flags/{flag_id}	Get flag
FeaturesApi	listFeatures	GET /features	List features
FeaturesApi	listFlags	GET /flags	List flags
FeaturesApi	updateFeature	PUT /features/{feature_id}	Update feature
FeaturesApi	updateFlag	PUT /flags/{flag_id}	Update flag
FeaturesApi	updateFlagRules	PUT /flags/{flag_id}/rules	Update flag rules
PlanbundleApi	createPlanBundle	POST /plan-bundles	Create plan bundle
PlanbundleApi	updatePlanBundle	PUT /plan-bundles/{plan_bundle_id}	Update plan bundle
PlangroupsApi	createPlanGroup	POST /plan-groups	Create plan group
PlangroupsApi	getPlanGroup	GET /plan-groups	Get plan group
PlangroupsApi	updatePlanGroup	PUT /plan-groups/{plan_group_id}	Update plan group
PlansApi	countPlans	GET /plans/count	Count plans
PlansApi	createPlan	POST /plans	Create plan
PlansApi	deletePlan	DELETE /plans/{plan_id}	Delete plan
PlansApi	getPlan	GET /plans/{plan_id}	Get plan
PlansApi	listPlanIssues	GET /plans/issues	List plan issues
PlansApi	listPlans	GET /plans	List plans
PlansApi	updateCompanyPlans	PUT /company-plans/{company_plan_id}	Update company plans
PlansApi	updatePlan	PUT /plans/{plan_id}	Update plan
PlansApi	upsertBillingProductPlan	PUT /plans/{plan_id}/billing_products	Upsert billing product plan
WebhooksApi	countWebhookEvents	GET /webhook-events/count	Count webhook events
WebhooksApi	countWebhooks	GET /webhooks/count	Count webhooks
WebhooksApi	createWebhook	POST /webhooks	Create webhook
WebhooksApi	deleteWebhook	DELETE /webhooks/{webhook_id}	Delete webhook
WebhooksApi	getWebhook	GET /webhooks/{webhook_id}	Get webhook
WebhooksApi	getWebhookEvent	GET /webhook-events/{webhook_event_id}	Get webhook event
WebhooksApi	listWebhookEvents	GET /webhook-events	List webhook events
WebhooksApi	listWebhooks	GET /webhooks	List webhooks
WebhooksApi	updateWebhook	PUT /webhooks/{webhook_id}	Update webhook

Models

Author

engineering@schematichq.com

Support

If you encounter any issues or have questions regarding the Schematic PHP SDK, please contact our support team at support@schematic.com.

schematichq / schematic-php

Maintainers

Details