<Info icon="fa-light fa-lock" className="permission-callout"> <div className="permission-callout__header"><span className="permission-callout__title"><span className="permission-callout__label">Required permissions</span> <span className="fern-docs-badge small blue subtle rounded-full permission-callout__beta">Beta</span></span> <span className="permission-callout__learn-more">[Learn more](/developers/api-guidelines/permissions#how-permissions-work)</span></div>

Endpoint.Quota.Sms + Get

<div className="permission-callout__roles"><span className="permission-callout__roles-label">Roles:</span> <Badge intent="info">Administrator</Badge> <Badge intent="info">User</Badge> <Badge intent="info">Observer</Badge></div> </Info>

Returns details about the assigned SMS Quota for an endpoint.

You can retrieve the current SMS quota status for an endpoint with the following API call. It will return following properties:

• status: this indicates the status of the quota and may contain the following values:
  • ACTIVE: the endpoint has quota left and can use SMS services
  • EXHAUSTED: the endpoint has exceeded the quota volume; the endpoint is denied from using SMS services (until new quota is added)
  • EXPIRED: the quota has expired; the endpoint is denied from using SMS services (until new quota is added)
• volume: the amount of SMS left on this quota
• expiry_date: timestamp when this quota will expire and the endpoint will definitely be denied from using further SMS services (regardless if the quota volume was used up or not)
• threshold_percentage: optional threshold in percentage indicating when a "Threshold Reached" event shall be sent.
• action_on_exhaustion: returns the behaviour defined to be applied when quota volume is used up (exhausted).
  • Throttle: bandwidth will be throttle to the defined peak throughput until quota expires
  • Block: data service will be instantly blocked once volume used up, regardless if the expiry date is already reached or not
  • auto_refill: 0 (false) / 1 (true), refill the quota with the last added volume on a daily basis