Billing

Usage, limits, and plan

Current-month usage, the monthly caps, the plan and its per-cycle email quota, computed reputation, and subscription state in one call.

get/v1/billing

Request

  • Base URL: https://api.volanea.com
  • URL: https://api.volanea.com/v1/billing
  • Auth: HTTP bearer

Response

The billing overview.

monthstring required

Current period, "YYYY-MM".

usedinteger required

Non-test emails sent this month.

limitinteger nullable

Overall monthly send cap; null = unlimited.

plan'free' | 'starter' | 'growth' | 'scale' | 'enterprise' required
emailQuotainteger nullable required

Email credits per monthly cycle for the current plan. Hard cap — sending stops when it's used up. null = unlimited (an enterprise contract with no monthly cap).

freeTierCreditsinteger
creditsUsedinteger required

Credits used this cycle (1/email, 2 with attachments).

reputationobject

Computed deliverability metrics. The worst of three windows (24h/7d/all-time) wins; windows breaks each one down. New projects (<30 days old) enforce at a lower volume floor.

reputationState'ok' | 'warn' | 'throttled' | 'paused' required
reputationReasonstring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.