Skip to main content
GET
/
v1
/
credits
cURL
curl --request GET \
  --url https://api.transmit.dev/v1/credits \
  --header 'Authorization: Bearer <token>'
{
  "balance": 123,
  "monthly_usage": 123,
  "total_consumed": 123,
  "email_consumed": 123,
  "sms_consumed": 123,
  "hourly_limit": 123,
  "daily_limit": 123,
  "monthly_limit": 123,
  "current_hour_usage": 123,
  "current_day_usage": 123,
  "is_paid": true,
  "hourly_reset_at": "2023-11-07T05:31:56Z",
  "daily_reset_at": "2023-11-07T05:31:56Z",
  "monthly_reset_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

Enter your API key with 'tx_' prefix. Get your API key from the dashboard.

Response

Credits information retrieved successfully

balance
number
required

Current credit balance

monthly_usage
number
required

Credits consumed this month

total_consumed
number
required

Credits consumed across the full ledger history

email_consumed
number
required

Credits consumed by email sends across the full ledger history

sms_consumed
number
required

Credits consumed by SMS sends across the full ledger history

hourly_limit
number
required

Hourly sending limit

daily_limit
number
required

Daily sending limit

monthly_limit
number
required

Monthly sending limit

current_hour_usage
number
required

Credits used in current hour

current_day_usage
number
required

Credits used today

is_paid
boolean
required

Whether organization is on paid plan

hourly_reset_at
string<date-time>
required

Next hourly limit reset time

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
daily_reset_at
string<date-time>
required

Next daily limit reset time

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
monthly_reset_at
string<date-time>
required

Next monthly limit reset time

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$