Skip to Content
Usage

Get usage

RSVPs counted this month and the plan's limits. Any valid key may call this.

GET
/v1/usage

RSVPs counted this month and the plan's limits.

Any valid key may call this.

Authorization

secretKey
headerAuthorizationBearer <token>

A secret key: wc_live_... or wc_test_.... Keep it on your server.

Response Body

Usage for the current period.

application/json
  1. response

Current period usage and plan limits.

mode*string

Mode of the key that asked. Usage itself only counts live RSVPs.

Value in"live""test"
plan*string

New plans may be added.

Value in"free""starter""pro"
period_start*string

Start of the current calendar month in UTC.

Formatdate-time
period_end*string

Start of the next calendar month in UTC.

Formatdate-time
rsvps*
limits*
Example Request
curl -X GET 'https://api.whocoming.com/v1/usage'
Example Response
{  "mode": "live",  "plan": "free",  "period_start": "2019-08-24T14:15:22Z",  "period_end": "2019-08-24T14:15:22Z",  "rsvps": {    "used": 0,    "limit": 0,    "remaining": 0,    "locked": 0,    "overage_blocks": 0  },  "limits": {    "api_keys": 0,    "webhook_endpoints": 0,    "team_members": 0,    "custom_fields_per_event": 0,    "active_series": 0,    "rate_limit_per_minute": 0  }}