Samva
DashboardAPI
ChannelsPlatformDevelopersEmail templatesIntegrationsAPI Reference
Billing

Get the organization's overage usage and limits

Get the organization's overage usage and limits. View request and response details for this Samva email API endpoint.

GET
/v1/billing/overage

Returns the included email allowance, what has been used, the extra emails billed past it, and the spend limit and pause switch that bound them, each with the level it resolves from.

Authorization

apiKey
x-api-key<token>

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/billing/overage"
{  "overageSupported": true,  "includedEmails": 0,  "usedEmails": 0,  "extraEmails": 0,  "extraEmailCostDollars": 0,  "spendLimitDollars": 0,  "spendLimitSource": "workspace",  "overageAllowed": true,  "overageAllowedSource": "workspace"}

Related documentation

Update the current organization

Updates the current organization's profile, regional defaults, design, reply-to, and unsubscribe-group defaults and returns the saved organization.

Set the organization's overage limits

Sets whether this organization can send beyond its included allowance and replaces its email overage spend limit.