Skip to content
Talki DevelopersBeta

usage.extra_credits_low

POST

A call ends with the extra-minutes balance below the floor the account owner set (10 minutes unless changed). Not sent again until the balance is back over the floor or the owner changes the floor; never sent with a floor of 0, with no extra minutes, or on a plan with no minute cap. Sent to the account’s webhooks and to the app of the partner that pays for the account; no other app receives it.

Parameters

Section titled “ Parameters ”

Header Parameters

Section titled “Header Parameters”
X-Talki-Signature
required
string

t=<unix seconds>,v1=<hex HMAC-SHA256>, the HMAC computed over <t>.<raw body> with the signing secret. During a secret rotation it carries one v1 per secret: accept the request if any matches.

X-Talki-Event
required
string

The event type, as in type.

X-Talki-Delivery
required
string

The event ID, as in id.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
id
required
Id

The event’s ID, evt_ and 32 hex characters. Equal to the X-Talki-Delivery header and unchanged on a redelivery: deduplicate on it.

string
type
required
string
Allowed values: usage.extra_credits_low
created_at
required
Created At

When the event was written, ISO 8601 with a +00:00 offset, possibly with microseconds. Parse it as an instant.

string format: date-time
api_version
required
Api Version

The dated contract version data is shaped for: the endpoint’s version on a webhook, the app’s on an app event.

string
account_id
required
Account Id

The Talki account the event happened on.

string
livemode
required
Livemode

false for an event from a sandbox account.

boolean
origin
required
Any of:
EventOrigin
object
source
required
Source

Where the change came from: voice (the assistant, during a call), dashboard (a person in the Talki web or mobile app), api (a credential through the API) or system (a rule Talki applied on its own). New values may be added; treat one you do not recognise as unknown.

string
credential_id
required
Any of:
string
idempotency_key
required
Any of:
string
installation_id
Any of:
string
data
required

The event’s payload.

object
extra_seconds
required
Extra Seconds

Extra seconds still unspent after this call. Can be 0.

integer
extra_minutes_balance
required
Extra Minutes Balance

extra_seconds in whole minutes, rounded down. Can be 0.

integer
threshold_minutes
required
Threshold Minutes

The account owner’s floor, in minutes, that the balance is now below.

integer
used_seconds
required
Used Seconds

Seconds used in the current billing period, this call included: plan and extra minutes together.

integer
minutes_included
required
Minutes Included

Minutes included in the period, without extra minutes: Usage.included_seconds in minutes.

integer
extra_seconds_balance
required
Extra Seconds Balance

The same value as extra_seconds.

integer
seconds_used
required
Seconds Used

The same value as used_seconds.

integer
Example
{
  "id": "evt_04d8e87897db4ecab459a456ea55e754",
  "type": "usage.extra_credits_low",
  "created_at": "2026-09-22T15:04:06.218734+00:00",
  "api_version": "2026-10-01",
  "account_id": "f7e39b9a-1ac8-45e4-93da-2600f17cb286",
  "livemode": true,
  "origin": {
    "source": "voice",
    "credential_id": null,
    "idempotency_key": null
  },
  "data": {
    "extra_seconds_balance": 505,
    "extra_minutes_balance": 8,
    "threshold_minutes": 10,
    "seconds_used": 21095,
    "minutes_included": 300,
    "used_seconds": 21095,
    "extra_seconds": 505
  }
}

Responses

Section titled “ Responses ”

2XX

Section titled “2XX”

Any 2xx acknowledges the event. Any other status, a redirect, or no answer within 10 seconds is a failure and is retried; 410 disables a webhook endpoint at once.