Skip to main content
GET
List credit usage events
Lists charges newest first, one entry per charge with its refund, attributed to a feature, project, job, member, key and channel where known (key, member and channel for charges of v3 jobs). Deleted projects are included and named. Grants and top-ups are not usage and are not listed. When to use: to audit individual charges, e.g. to reconcile a job’s cost. Side effects: None. Cost: Free. Idempotency: safe and pure (never writes); retry freely. Pagination: limit (default 20, max 100) and cursor; follow next_cursor until has_more is false. Required scopes: account:read Errors: invalid_date_range (422)

Authorizations

Authorization
string
header
required

API key from Settings -> API keys, sent as Authorization: Bearer <key> (SDK environment variable RASK_API_KEY). Bound to one workspace and one acting user. Operations list the scopes they need (OpenAPI 3.1 scopes on a bearer scheme).

Scopes

account:read

Query Parameters

from
string<date-time>

Start (inclusive, RFC 3339). Default: the payer's current billing period, else the last 30 days.

to
string<date-time>

End (exclusive). The span may not exceed 400 days.

period
enum<string>

A billing period instead of from/to; explicit from or to replace it. A billing-period shortcut for from and to (explicit from or to replace it).

  • current: the payer's current billing period (without a subscription: the last 30 days)
  • previous: the billing period before it (without a subscription: the 30 days before those)
Available options:
current,
previous
credit_type
enum<string>

Only this pool. A credit pool. Money-shaped schemas are unions on this value.

  • minutes: the main minute pool
  • lipsync_free_minutes: free lip-sync minutes
  • projects: the project-credit pool; counts projects, not minutes
Available options:
minutes,
lipsync_free_minutes,
projects
feature
enum<string>

Only this feature. Usage vocabulary for charges, cost lines and usage reports.

  • project_creation: creating a project (project credit)
  • project_copy: copying a project (project credit)
  • dub: a full dub
  • redub: a dub of changed segments
  • segment_generation: paid voicing of chosen segments
  • lipsync_legacy: a Legacy lip-sync run
  • lipsync_enhanced: an Enhanced lip-sync run
  • lipsync_free: the free lip-sync run
  • onscreen: on-screen text translation
  • other: anything else (manual adjustments by Rask, other products)
  • lipsync_unknown_model: a lip-sync run not started through v3 (its model is not recorded)

A charge without a v3 job reports the feature of what it paid for: project_creation, project_copy, dub, redub, onscreen, lipsync_unknown_model or lipsync_free (by pool), else other. Refunds follow their charge.

Available options:
project_creation,
project_copy,
dub,
redub,
segment_generation,
lipsync_legacy,
lipsync_enhanced,
lipsync_free,
onscreen,
other,
lipsync_unknown_model
project_id
string

Only this project.

Maximum string length: 64
credential_id
string

Only this API key or OAuth grant.

Maximum string length: 64
member_user_id
string

Only this acting member.

Maximum string length: 64
limit
integer<int32>
default:20

Page size.

Required range: 1 <= x <= 100
cursor
string

Opaque cursor from next_cursor; keep the same filters on every page.

Maximum string length: 2048

Response

OK: UsageEventList.

A page of UsageEvent (the list envelope shared by every list).

object
enum<string>
required

Always list.

Available options:
list
data
object[]
required

Items of this page.

One charge and its refund: a union on credit_type.

next_cursor
string | null
required

Pass as cursor for the next page; null on the last page.

has_more
boolean
required

More items exist (a page may hold fewer than limit items while has_more is true).