Samva
DashboardAPI
ChannelsPlatformDevelopersEmail templatesIntegrationsAPI Reference
Billing

Set the organization's overage limits

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

PATCH
/v1/billing/overage

Sets whether this organization can send beyond its included allowance and replaces its email overage spend limit. Both are sent together because the underlying write replaces the organization's controls rather than merging into them.

Authorization

apiKey
x-api-key<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

spendLimitDollars*number|null
overageAllowed*boolean

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/v1/billing/overage" \  -H "Content-Type: application/json" \  -d '{    "spendLimitDollars": 0,    "overageAllowed": true  }'
{  "overageSupported": true,  "includedEmails": 0,  "usedEmails": 0,  "extraEmails": 0,  "extraEmailCostDollars": 0,  "spendLimitDollars": 0,  "spendLimitSource": "workspace",  "overageAllowed": true,  "overageAllowedSource": "workspace"}

Related documentation

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 an asynchronous operation

Returns one durable asynchronous operation from the active organization. Use this endpoint to get an asynchronous operation through the Samva email API.