<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 + Create

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

At any time, a new SMS quota can be set for an endpoint. At an initial state when no SMS quota is set, the endpoint will be denied from using SMS services. To top-up the SMS volume one need to retrieve the currently left volume, increase it by the top-up volume and set it as the new quota volume.

The following parameters can be configured:

• status - The status of the quota (mandatory):
  • 1: ACTIVE
  • 2: EXHAUSTED
  • 3: EXPIRED
• volume: The volume left on this quota in MB
• expiry_date: Timestamp when this quota will expire and the endpoint will definitely be denied from using further data services (mandatory)
• auto_refill: Wether the quota shall be refilled on a daily basis (defaults to disabled):
  • 0: disabled
  • 1: enabled
• threshold_percentage: The percentage of remaining quota at which the system should generate a threshold reached event
• action_on_exhaustion: The behaviour of the system after the quota is exhausted:
  • id: ID of the action on quota exhaustion (mandatory)
    • 1: Block
    • 2: Throttle (will not take any effect on SMS quota)
  • peak_throughput: The maximum bandwidth in octets per second after the endpoint has been throttled. Allowed values are 64000, 128000, 256000, 384000. (will not take any effect on SMS quota)

<Note> The endpoint can instantly use the SMS service after the API call is successfully made. Any timestamp with a future date can be set, this allows to create SMS packages (e.g. for 1 hour, 24 hour, 7 days or any other timeframe) as required. </Note>