Skip to content
Thrive Tech Services
Thrive Tech Services
HomeServicesProductsDocsEnterpriseContactAbout
LoginRegister

API Reference

The ThriveTech Platform API is a RESTful API for managing licenses, subscriptions, customers, and products programmatically.

Base URL: https://api.thrivetechservice.com API Version: v1


Authentication

All API requests require authentication via API key:

Authorization: Bearer YOUR_API_KEY

Key Types

TypePermissionsUse Case
Admin KeyFull accessServer-side integrations
Read-Only KeyRead operations onlyAnalytics, reporting
Channel KeyActivation onlyClient applications

Rate Limits

PlanRequests/MinuteRequests/Hour
Starter601,000
Growth30010,000
EnterpriseCustomCustom

Rate limit headers included in all responses:

X-RateLimit-Limit: 60 X-RateLimit-Remaining: 45 X-RateLimit-Reset: 1640000000

Response Format

Success

json
{
"success": true,
"data": { ... },
"meta": { "timestamp": "2026-01-26T12:00:00Z", "request_id": "req_abc123" }
}

Error

json
{
"success": false,
"error": { "code": "VALIDATION_ERROR", "message": "Invalid license key format" },
"meta": { "timestamp": "2026-01-26T12:00:00Z", "request_id": "req_abc123" }
}

HTTP Status Codes

CodeMeaning
200Success
201Created
400Bad Request
401Unauthorized
403Forbidden
404Not Found
409Conflict
429Rate Limited
500Server Error

Platform Billing API

Plans

MethodEndpointDescription
GET/api/v1/platform/plansList all available plans
GET/api/v1/platform/plans/:planCodeGet plan by code

Subscriptions

MethodEndpointDescription
GET/api/v1/billing/subscriptionGet current subscription
POST/api/v1/billing/subscribeCreate subscription
PUT/api/v1/billing/upgradeUpgrade plan
PUT/api/v1/billing/downgradeDowngrade plan
POST/api/v1/billing/cancelCancel subscription

Usage & Invoices

MethodEndpointDescription
GET/api/v1/billing/usageGet current usage
GET/api/v1/billing/usage/historyGet usage history
GET/api/v1/billing/invoicesList invoices
GET/api/v1/billing/invoices/:invoiceIdGet invoice

License Management API

MethodEndpointDescription
POST/api/v1/licensesCreate license
GET/api/v1/licensesList licenses (filterable)
GET/api/v1/licenses/:licenseIdGet license
PUT/api/v1/licenses/:licenseIdUpdate license
POST/api/v1/licenses/:licenseId/revokeRevoke license

Activations

MethodEndpointDescription
POST/api/v1/activateActivate license
POST/api/v1/activate/validateValidate license
POST/api/v1/activate/deactivateDeactivate device
POST/api/v1/activate/trialActivate trial

See Activation API for full endpoint documentation.


Product Management API

MethodEndpointDescription
GET/api/v1/productsList products
POST/api/v1/productsCreate product
GET/api/v1/products/:productIdGet product
PUT/api/v1/products/:productIdUpdate product
DELETE/api/v1/products/:productIdDelete product

Customer API

MethodEndpointDescription
GET/api/v1/customersList customers
POST/api/v1/customersCreate customer
GET/api/v1/customers/:customerIdGet customer
PUT/api/v1/customers/:customerIdUpdate customer
GET/api/v1/customers/:customerId/licensesGet customer licenses

Webhooks

Events

EventDescription
license.createdNew license created
license.activatedLicense activated on device
license.deactivatedDevice deactivated
license.expiredLicense expired
license.revokedLicense revoked
subscription.createdNew subscription
subscription.updatedPlan changed
subscription.canceledSubscription canceled
subscription.renewedSubscription renewed
payment.succeededPayment successful
payment.failedPayment failed

Webhook Payload

json
{
"id": "evt_abc123",
"type": "license.activated",
"created_at": "2026-01-26T12:00:00Z",
"data": {
"license_id": "lic_xyz789",
"device_id": "dev_123",
"customer_email": "customer@example.com"
}
}

Webhooks include an X-Webhook-Signature header for verification.


Error Codes

CodeDescription
AUTHENTICATION_REQUIREDNo valid authentication provided
INVALID_TOKENToken is invalid or expired
PERMISSION_DENIEDInsufficient permissions
RESOURCE_NOT_FOUNDRequested resource doesn't exist
VALIDATION_ERRORRequest validation failed
RATE_LIMIT_EXCEEDEDToo many requests
LICENSE_EXPIREDLicense has expired
LICENSE_REVOKEDLicense has been revoked
DEVICE_LIMIT_REACHEDMaximum devices activated
PLAN_LIMIT_REACHEDPlan limit exceeded
PAYMENT_REQUIREDPayment method required
SUBSCRIPTION_INACTIVESubscription not active

SDKs

PlatformInstall
JavaScript/TypeScriptnpm install @thrivetech/sdk
Pythonpip install thrivetech-sdk
.NETInstall-Package ThriveTech.SDK
JavaMaven/Gradle available
Gogo get github.com/thrivetech/sdk-go

Support

  • Documentation: docs.thrivetechservice.com
  • API Status: status.thrivetechservice.com
  • Developer Support: developers@thrivetechservice.com
Error HandlingActivation API

Was this helpful?