- Getting started
- CREDIT ENDPOINTS
- GENERATE ENDPOINTS
- GETText generation rules and limits
- GETAvailable text generation tones
- GETText generation styles
- GETTarget audiences for text generation
- GETAvailable text types for generation
- GETText generation history
- GETStatus of generated texts
- GETGenerated text for multiple records
- GETActive generation requests
- GETDetails of a specific generation request
- POSTText generation
- POSTCancel a bulk generation request
- POSTUpdate generated text fields
- POSTArchive record
- IMAGE ENDPOINTS
- KEYWORDS ENDPOINTS
- GETKeyword optimization data
- POSTOptimize keywords for text
- DELETEKeyword optimization
- PUTKeyword optimization
- GETKeyword optimization list
- PUTKeyword optimization data
- DELETERanking keywords
- PUTKeyword optimization pipelines
- GETKeyword state
- POSTKeyword pipeline
- DELETEKeyword pipeline
- POSTRestore keyword pipeline
- POSTAdd triggers to keyword pipeline
- POSTAdd triggers to a specific keyword pipeline
- POSTLock a specific keyword pipeline
- POSTUnlock a specific keyword pipeline
- GETPipeline snapshots
- PUTUpdate or create a snapshot
- POSTAdd manual keywords
- GETManual keywords
- REVIEW ENDPOINTS
- SUGGESTION ENDPOINTS
- TEMPLATE SETTINGS
- TOKEN
Get user credit balance
get
/text/Credit
This method retrieves information about the authenticated user's credit balance and subscription type, including total available credits, current balance, premium status, and membership tier.
Requirements
Authentication Required
Bearer access_token
Request Headers
Authorization: Bearer access_token
Response
200
401
500
//This status is returned if the API key is missing or invalid.
//The server encountered an error when processing the request.
| Parameter Name | Type | Description |
|---|---|---|
| totalCredits | integer | The total number of credits the user has in their account (used + unused). |
| availableCredits | integer | The number of credits currently available for use. |
| isPremium | boolean | Indicates whether the user has a premium plan (true if premium, false otherwise). |
| membershipType | string | The user’s subscription tier. Possible values: FreeTrial, Starter, Professional, Enterprise. |