API Documentation

Integrate SolSub directly into your applications with our simple and powerful API.

Check Match ID Create Match ID

Check Match ID Status

GET

Use this endpoint to verify the status of a Match ID for your cluster.

Endpoint
GET https://api.solsub.online/check-match-id/
Request Parameters

Send these parameters as Query Parameters in your GET request.

Parameter Type Required Description
match_id String Yes The unique Match ID provided to the user (alphanumeric).
Request Headers
Header Type Required Description
api-key String Yes Your Cluster API Key for authentication.
Response Codes
Status Code Meaning Description
200 OK Paid Active The Match ID is valid and the subscription is Paid & Active.
201 Created Trial Active The Match ID is valid and currently under Trial Active period.
400 Bad Request Error Missing required parameters like API key or match_id.
405 Method Not Allowed Limit Reached The API usage limit has been exceeded.
410 Gone Expired The Match ID has expired and is no longer valid.
422 Unprocessable Entity Not Found The Match ID does not belong to the specified cluster.
Example Response (JSON)

// For Status -> 200
{
        "detail": "Paid Active"
}
// For Status -> 201
{
        "detail": "Trial Active"
}
// For Status -> 400
{
        "detail": "API key and match ID are required"
}
// For Status -> 405
{
        "detail": "API Limit Reached"
}
// For Status -> 410
{
        "detail": "Match ID expired"
}
// For Status -> 422
{
        "detail": "Match ID not found for this cluster"
}
Example Request (Screenshots)

Here's how to configure the request in your API client:

Query Parameters:

Query Parameters Example

API Key Header:

API Key Header Example

Create Match ID

POST

Use this endpoint to create a new Match ID under your cluster. Only available for clusters with match_id_type = admin_generated.

Endpoint
POST https://api.solsub.online/create-match-id/
Request Headers
Header Type Required Description
api-key String Yes Your Cluster API Key for authentication.
Content-Type String Yes Must be application/json.
Request Body

Send the body as raw JSON.

Field Type Required Description
match_id String Yes The unique Match ID to register under your cluster (alphanumeric). 

{
    "match_id": "MATCH_001"
}
Response Codes
Status Code Meaning Description
201 Created Success Match ID was created successfully under your cluster.
409 Conflict Duplicate The Match ID already exists in this cluster.
403 Forbidden Not Allowed Your cluster's match_id_type is not admin_generated. Action not permitted.
404 Not Found Invalid Key The provided api-key does not match any cluster.
500 Server Error Server Error An unexpected error occurred on the server.
Example Response (JSON)

// For Status -> 201
{
    "detail": "Match ID created successfully",
    "match_id": "MATCH_001",
    "cluster": "my_cluster",
    "is_trial": true,
    "valid_till": "2025-05-07T12:00:00+00:00"
}

// For Status -> 409
{
    "detail": "Match ID 'MATCH_001' already exists in this cluster."
}

// For Status -> 403
{
    "detail": "Action forbidden: Cluster match_id_type is 'user_generated', expected 'admin_generated'."
}

// For Status -> 404
{
    "detail": "Invalid API key or cluster not found"
}
Notes
  • The hit_limit is automatically set to 60 for all newly created Match IDs.
  • If your cluster has a trial_period configured, the Match ID will be created in trial mode and valid_till will be set accordingly.
  • If trial_period is 0 or NULL, is_trial will be false.
  • This endpoint is only accessible to clusters with match_id_type = admin_generated.