Get subscription details

GET

/v1/billing/subscription

curl --request GET \
  --url https://api.hookbridge.io/v1/billing/subscription \
  --header 'Authorization: Bearer <token>'

• Production

Retrieve the current subscription status, plan limits, and usage. Returns free tier limits if no paid subscription exists.

Authorizations

• BearerAuth

Responses

200

Subscription details retrieved successfully

Media typeapplication/json

object

data

object

plan

Current subscription plan

string

Allowed values: free starter pro business enterprise

status

Subscription status

string

Allowed values: active canceled past_due trialing unpaid

limits

object

plan

string

messages_per_month

integer

max_projects

integer

max_endpoints

integer

retention_days

integer

overage_rate_per_message

Cost per message over the plan limit

number

usage

object

messages_used

Messages used in current period

integer

overage_count

Number of messages over the plan limit

integer

overage_rate

Rate charged per overage message

number

estimated_overage_charge

Estimated overage charge for current period

number

period_start

string format: date-time

period_end

string format: date-time

cancel_at_period_end

Whether subscription will cancel at period end

boolean

current_period_end

When current billing period ends

string format: date-time

meta

object

request_id

Unique identifier for this request (useful for support)

string

Example

{
  "data": {
    "plan": "pro",
    "status": "active",
    "limits": {
      "plan": "pro",
      "messages_per_month": 50000,
      "max_projects": 100,
      "max_endpoints": 10000,
      "retention_days": 7
    },
    "usage": {
      "messages_used": 12500,
      "period_start": "2025-12-01T00:00:00Z",
      "period_end": "2025-12-31T23:59:59Z"
    },
    "cancel_at_period_end": false,
    "current_period_end": "2025-12-31T23:59:59Z"
  },
  "meta": {
    "request_id": "req_xyz123"
  }
}

401

Unauthorized - Invalid or missing API key

Media typeapplication/json

object

error

object

code

Machine-readable error code

string

message

Human-readable error message

string

meta

object

request_id

Unique identifier for this request (useful for support)

string

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid or missing API key"
  },
  "meta": {
    "request_id": "req_xyz123"
  }
}