Integrate Subscription Plans & Payments

This document outlines the steps to integrate Stykite APIs into your application for managing subscriptions, payments, and usage tracking.

Step 1: Generate an API Key

Click Create API Key.

Provide a label for your key.

Select the scope: API Integration.

Click Generate API Key.

Copy and save the generated key securely.

⚠️ Important: The API key will only be shown once for security purposes.

To subscribe a user to a plan, you’ll use the Payment API.
Full reference: Payment API Docs

{
  "status": true,
  "value": {
    "transaction_tsid": "TRN-0MSC9073DVBTK"
  }
}

Take the transaction_tsid from the response and redirect the user to the checkout URL:

https://checkout.stykite.com/<transaction_tsid>

✅ Example:
https://checkout.stykite.com/TRN-0MSC9073DVBTK

Use Stykite’s Checkpoint API to track usage and trigger billing events.
Full reference: Checkpoint Usage API Docs

checkpoint_key: the usage metric to track (e.g., api_calls, messages_sent).

checkpoint_value: the numeric value to record.

{
  "status": true,
  "message": "Checkpoint recorded successfully"
}

Generate API Key from Stykite dashboard.

Subscribe user to a plan → get transaction_tsid → redirect to checkout.

Record usage via Checkpoint API to track and bill based on consumption.

Monitor billing and usage directly from Stykite dashboard.