Skip to main content
GET
/
credits
Get Credits
curl --request GET \
  --url https://api.example.com/credits
Returns everything about your organization’s credit state in a single call: current balance, active plan, billing cycle dates, and auto top-up configuration.

​
Request

curl -X GET "https://api.mosaic.so/credits" \
  -H "Authorization: Bearer mk_your_api_key"

​
Response

{
  "organization_id": "d808af70-fc57-4f90-95ca-186a9cbf2ef7",
  "balance": 1840,
  "plan": "creator",
  "plan_id": "creator_annual",
  "billing_cycle": {
    "current_period_start": "2026-03-01T00:00:00.000Z",
    "current_period_end": "2026-04-01T00:00:00.000Z"
  },
  "auto_topup": {
    "eligible": true,
    "enabled": true,
    "threshold": 1000,
    "quantity": 5000
  }
}

​
Response Fields

FieldTypeDescription
organization_idstringOrganization identifier.
balancenumberCurrent remaining credits.
planstring | nullNormalized plan family (creator or professional).
plan_idstring | nullConcrete active plan ID (creator, creator_annual, professional, etc.).
billing_cycle.current_period_startstring | nullCurrent subscription cycle start in ISO format.
billing_cycle.current_period_endstring | nullCurrent subscription cycle end in ISO format.
auto_topup.eligiblebooleanWhether the current plan can use auto top-ups. Eligible plans are creator, creator_annual, professional, and professional_annual.
auto_topup.enabledbooleanWhether auto top-up is active.
auto_topup.thresholdnumberWhen the credit balance drops below this number, an auto top-up is triggered.
auto_topup.quantitynumberNumber of credits purchased each time an auto top-up fires.
When auto_topup.eligible is false, auto top-ups are unavailable for the current plan and the returned auto top-up config will be disabled (enabled: false, threshold: 0, quantity: 0).