Skip to main content
GET
/
api
/
credits
/
packages
Get credit packages
curl --request GET \
  --url https://api.example.com/api/credits/packages
{
  "id": 123,
  "credits": 123,
  "price": 123,
  "displayName": "<string>",
  "description": "<string>",
  "bonusCredits": 123,
  "popular": true,
  "isActive": true
}
Returns all available credit packages that users can purchase, including pricing and credit amounts.

​
Response

Returns an array of package objects:
​
id
integer
required
Package ID
​
credits
integer
required
Number of credits included
​
price
number
required
Price in USD
​
displayName
string
required
Package display name (e.g., “Starter Pack”, “Power User Pack”)
​
description
string
Package description and value proposition
​
bonusCredits
integer
default:"0"
Bonus credits for this package
​
popular
boolean
default:"false"
Whether this package is marked as most popular
​
isActive
boolean
required
Whether package is currently available for purchase

​
Example Request

curl https://your-domain.com/api/credits/packages \
  -H "Cookie: connect.sid=your-session-cookie"

​
Example Response

[
  {
    "id": 1,
    "credits": 100,
    "price": 9.99,
    "displayName": "Starter Pack",
    "description": "Perfect for trying out premium features",
    "bonusCredits": 0,
    "popular": false,
    "isActive": true
  },
  {
    "id": 2,
    "credits": 500,
    "price": 39.99,
    "displayName": "Power User Pack",
    "description": "Best value - includes 25% bonus credits",
    "bonusCredits": 125,
    "popular": true,
    "isActive": true
  },
  {
    "id": 3,
    "credits": 1000,
    "price": 69.99,
    "displayName": "Ultimate Pack",
    "description": "Maximum credits for serious users",
    "bonusCredits": 300,
    "popular": false,
    "isActive": true
  }
]

​
Response Codes

CodeDescription
200Success - Returns available packages
401Unauthorized - User not authenticated
500Server error

​
Notes

  • Only active packages are returned
  • Packages are ordered by credit amount (ascending)
  • Popular packages are highlighted in the UI
  • Bonus credits are automatically added to the purchase

Build docs developers (and LLMs) love

Get started for freeTalk to us