Skip to main content
GET
/
v1
/
billing
/
summary
Get billing summary
curl --request GET \
  --url https://api.ticksupply.com/v1/billing/summary \
  --header 'X-Api-Key: <api-key>'
{
  "access_status": "ACTIVE",
  "usage": {
    "extra_stream_minutes_total": 0,
    "export_gb_total": "12.5",
    "export_gb_extra": 0
  },
  "grace_until": "2026-05-01T00:00:00Z",
  "plan_code": "starter",
  "current_period_end": "2026-05-12T23:34:19Z"
}

Authorizations

​
X-Api-Key
string
header
required

Your API key. Get one from the dashboard at https://app.ticksupply.com/api-keys

Response

Billing summary for the authenticated account.

​
access_status
enum<string>
required

Current access state for the account.

  • ACTIVE: Full access, payment current.
  • TRIALING: Full access, trial-plan caps enforced (no overage).
  • GRACE: Limited access, payment overdue but within grace period. grace_until will be set.
  • SUSPENDED: No access, payment overdue beyond grace period.
  • NONE: Account has no active subscription.
Available options:
ACTIVE,
TRIALING,
GRACE,
SUSPENDED,
NONE
Example:

"ACTIVE"

​
usage
object
required

Usage totals for the current billing period.

​
grace_until
string<date-time> | null

When the grace period ends. Present only when access_status is GRACE.

Example:

"2026-05-01T00:00:00Z"

​
plan_code
string | null

Plan identifier (e.g., trial, starter, pro). Null if the account has no plan.

Example:

"starter"

​
current_period_end
string<date-time> | null

End of the current billing period. Null if the account has no active subscription.

Example:

"2026-05-12T23:34:19Z"

Last modified on April 17, 2026