API Documentation

Introduction

Welcome to the API reference. Our API is built on REST principles and uses JSON for all requests and responses. The base URL for all API endpoints is https://thoughtsit.com/api/v1.

Authentication

All API requests require authentication using an API Key. You must pass your site's unique API Key with every request. Keep your API key secure and do not share it in client-side code.

You can provide the API key in two ways:

• Header: X-Billing-API-Key: YOUR_API_KEY (Recommended)
• Query / Body Parameter: api_key=YOUR_API_KEY

Check Credit Balance

Retrieve the current credit balance and active status of your site. This is useful for verifying if an action can be performed before attempting it.

Example Response (200 OK):

{
    "site": "My E-commerce Store",
    "has_credit": true,
    "balance": 150.50
}
                        

Deduct Credit

Deduct a specific amount of credits from a client's account when a billable action is performed (e.g., an order is placed).

Request Body Parameters:

Example Request Body:

{
    "amount": 5
}
                        

Example Response (200 OK):

{
    "success": true,
    "balance": 145.50
}
                        

Error Codes

If an error occurs, the API will return standard HTTP status codes along with a JSON response containing an error key detailing the issue.

Changelog