Knowledgebase

In the dashboard go to Developers → API Keys, click New Key, choose scopes, and copy the value. Use it as a Bearer token in the Authorization header.

curl -X POST https://subscriberapi.io/api/subscribers \
  -H "Authorization: Bearer <key>" -H "Content-Type: application/json" \
  -d '{"email":"user@example.com","name":"Ada"}'

PATCH /api/subscribers/sub_123
{
  "name": "Ada Lovelace",
  "metadata": {"team_size": 8}
}

Soft-delete or purge PII per your policy. Example: DELETE /api/subscribers/sub_123.

POST /api/plans
{
  "name": "Pro",
  "price_cents": 2900,
  "billing_interval": "monthly",
  "features": ["priority_support","sso","audit_logs"]
}

PATCH /api/plans/plan_pro
{"price_cents": 3900}

POST /api/licenses
{"plan_id":"plan_pro","seats":5,"notes":"Acme desktop"}

POST /api/licenses/activate
{"key":"key_xxx","device_id":"macbook-ada"}

Store the signed token after activation and validate signature/expiry locally; renew on next heartbeat.

POST /api/meters/record
{"user_id":"sub_123","meter":"projects.create","amount":1}

Poll /api/meters/summary and render a progress bar based on usage / limit.

POST /api/custom-fields
{
  "key": "team_size",
  "label": "Team Size",
  "type": "number",
  "scope": "subscriber",
  "required": false,
  "default": 1
}

Update a subscriber or plan with values under metadata:

PATCH /api/subscribers/sub_123
{
  "metadata": {"team_size": 12}
}

Validate the X-Subscriber-Signature header using your shared secret (HMAC SHA-256).

We retry with backoff for up to 24h on non-2xx responses. Example events: subscription.updated, license.activated, quota.exceeded.

Check your Bearer token, key scope, and HTTPS usage.

Implement exponential backoff and honor Retry-After.