Check your credit usage

Cost: 0 credits.

You can retrieve your current API usage statistics and limits by using the GET /usage endpoint.

curl -X GET "https://api.shopsavvy.com/v1/usage" \
  -H "Authorization: Bearer ss_live_your_api_key_here"

This will return information about your current billing period usage, including credits used, remaining credits, and the percentage of your monthly limit used.

Example Response

{
  "success": true,
  "data": {
    "current_period": {
      "start_date": "2025-01-01",
      "end_date": "2025-01-31",
      "credits_used": 1500,
      "credits_limit": 10000,
      "credits_remaining": 8500,
      "requests_made": 245
    },
    "usage_percentage": 15,
    "subscription_required": false,
    "subscription_status": "active"
  },
  "meta": {
    "credits_used": 0,
    "credits_remaining": 8500,
    "rate_limit_remaining": 958
  }
}

Response Fields

Field	Description
`start_date` / `end_date`	Your current billing period dates.
`credits_used`	Total credits consumed this billing period.
`credits_limit`	Your monthly credit allowance based on your subscription plan.
`credits_remaining`	Credits left for the current billing period.
`requests_made`	Total API requests made this billing period.
`usage_percentage`	Percentage of your monthly limit used.
`subscription_required`	`true` when no active Data API plan is attached to your account, in which case `credits_limit` is `0` and calls that cost credits will be rejected.
`subscription_status`	The status of your subscription — `active`, `trialing`, `past_due`, or `null` if you do not have one. A `past_due` subscription keeps working during the payment-retry grace period.

Was this page helpful?