Check Credits

Check your remaining credits and usage plan details for your API key.

Endpoint

GET /creditos

Authentication

Required - must provide valid API key in X-API-Key header.

Parameters

None required.

Example Request

curl "https://a7qq5h74ej.execute-api.us-west-2.amazonaws.com/production/creditos" \
  -H "X-API-Key: your-api-key-here"

Actual Response

{
  "message": "✅ Sistema de créditos ativo",
  "creditos_disponiveis": 199,
  "tipo_plano": "complete",
  "tier": "complete",
  "endpoints_permitidos": [
    "crm_basico",
    "crm", 
    "analisar",
    "analisar-extensao-chrome"
  ],
  "total_creditos_utilizados": 0,
  "custos_por_endpoint": {
    "crm_basico": 1,
    "analisar": 1,
    "crm": 2,
    "analisar-extensao-chrome": 1
  },
  "api_key_info": {
    "tier": "complete",
    "access_level": "Completo",
    "upgrade_available": false
  }
}
      "crm_basico": 89,
      "crm": 32,
      "total_requests": 121
    },
    "last_30_days": {
      "average_per_day": 4.2,
      "peak_day_usage": 28
    }
  },
  "endpoint_access": {
    "crm_basico": true,
    "crm": true,
    "health": true,
    "status": true,
    "creditos": true,
    "tiers-disponiveis": true
  }
}

Response Fields

Credit Information

Field	Type	Description
creditos_restantes	integer	Credits remaining in current period
creditos_totais	integer	Total credits in your plan
creditos_utilizados	integer	Credits used in current period
tipo_plano	string	Your current usage plan
periodo_renovacao	string	When credits reset (ISO 8601)
status_plano	string	Plan status: active, suspended, expired

Rate Limit Information

Field	Type	Description
requests_per_minute	integer	Your rate limit per minute
requests_remaining_this_minute	integer	Requests left in current minute
reset_time	string	When rate limit resets (ISO 8601)

Usage Statistics

Field	Type	Description
this_month	object	Current month usage breakdown
last_30_days	object	Rolling 30-day statistics

Access Permissions

Field	Type	Description
endpoint_access	object	Boolean access for each endpoint

Plan Types

Plan ID	Display Name	Credits/Month
crm_enterprise	CRM Enterprise	10,000
crm_business	CRM Business	5,000
platform_professional	Platform Professional	500
platform_essentials	Platform Essentials	100

Error Responses

Invalid API Key (401)

{
  "error": "Invalid API key provided",
  "error_code": "INVALID_API_KEY"
}

Plan Suspended (402)

{
  "error": "Your plan is currently suspended due to billing issues",
  "error_code": "PLAN_SUSPENDED",
  "contact": "support@tryfluence.tech"
}

Use Cases

• Usage Monitoring: Track credit consumption
• Budget Planning: Understand usage patterns
• Access Verification: Confirm endpoint permissions
• Rate Limit Monitoring: Check remaining requests
• Billing Integration: Automated usage tracking

Performance

• Response Time: < 200ms
• Credits Used: 0
• Rate Limits: Standard plan limits apply
• Caching: Results cached for 30 seconds