Skip to content
Figur

Current credit balance + spend

GET
/v1/credits
 
curl --request GET \
  --url https://example.com/v1/credits \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Header Parameters

Section titled “Header Parameters ”
X-Shopify-Hmac-Sha256
Any of:
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
CreditsResponse

GET /v1/credits — current balance + caps for the calling client.

object
client_id
required
Client Id
string
balance
required
Balance

Remaining credit balance.

integer
plan
required
Any of:
string
daily_spend_today
required
Daily Spend Today

Credits spent so far in today’s window (inline-reset at >24h since last reset).

integer
daily_spend_cap_credits
required
Daily Spend Cap Credits

Per-day spend ceiling. 0 == unlimited.

integer
monthly_credit_quota
required
Monthly Credit Quota

Per-month soft quota. 0 == pay-as-you-go.

integer
rate_limit_per_min
required
Rate Limit Per Min

Per-credential request/min ceiling.

integer
is_active
required
Is Active
boolean
Example generated
{
  "client_id": "example",
  "balance": 1,
  "plan": "example",
  "daily_spend_today": 1,
  "daily_spend_cap_credits": 1,
  "monthly_credit_quota": 1,
  "rate_limit_per_min": 1,
  "is_active": true
}

422

Section titled “422 ”

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Example generated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}