Billing

Manage subscriptions, view usage metrics, and access invoices. Most billing endpoints require the billing:manage scope.

Plans

Returns all available subscription plans with their features and pricing.

Response

objectstring

Always 'list'

dataarray

Array of plan objects

Example Request

curl https://api.reachscore.co/v1/billing/plans \
  -H "Authorization: Bearer rk_live_xxx"

Example Response

{
  "object": "list",
  "data": [
    {
      "id": "plan_free",
      "name": "Free",
      "price": 0,
      "interval": null,
      "tests_limit": 25,
      "domains_limit": 1,
      "features": ["Basic deliverability testing", "Email authentication checks"]
    },
    {
      "id": "plan_starter",
      "name": "Starter",
      "price": 4900,
      "interval": "month",
      "tests_limit": 250,
      "domains_limit": 3,
      "features": ["Everything in Free", "Domain monitoring", "Webhook notifications"]
    },
    {
      "id": "plan_team",
      "name": "Team",
      "price": 9900,
      "interval": "month",
      "tests_limit": 1000,
      "domains_limit": 10,
      "features": ["Everything in Starter", "Team collaboration", "Advanced analytics"]
    },
    {
      "id": "plan_business",
      "name": "Business",
      "price": 24900,
      "interval": "month",
      "tests_limit": 7500,
      "domains_limit": 50,
      "features": ["Everything in Team", "Priority support", "Custom integrations"]
    }
  ]
}

Usage

Returns current billing period usage including test counts, domain usage, and API calls.

Response

period_startstring<date-time>

period_endstring<date-time>

testsobject

Test usage: used, limit, overage

domainsobject

Domain usage: used, limit

api_callsobject

API call metrics

Example Request

curl https://api.reachscore.co/v1/billing/usage \
  -H "Authorization: Bearer rk_live_xxx"

Example Response

{
  "period_start": "2026-03-01T00:00:00Z",
  "period_end": "2026-03-31T23:59:59Z",
  "tests": {
    "used": 145,
    "limit": 1000,
    "overage": 0
  },
  "domains": {
    "used": 3,
    "limit": 10
  },
  "api_calls": {
    "total": 12450,
    "rate_limited": 0
  }
}

Subscription

Returns the current subscription details including plan, status, and billing dates.

Response

idstring

objectstring

Always 'subscription'

planstring

statusstring

activepast_duecanceledtrialing

current_period_startstring<date-time>

current_period_endstring<date-time>

cancel_at_period_endboolean

Example Request

curl https://api.reachscore.co/v1/billing/subscription \
  -H "Authorization: Bearer rk_live_xxx"

Example Response

{
  "id": "sub_abc123",
  "object": "subscription",
  "plan": "team",
  "status": "active",
  "current_period_start": "2026-03-01T00:00:00Z",
  "current_period_end": "2026-03-31T23:59:59Z",
  "cancel_at_period_end": false
}

Invoices

Returns invoice history for your organization.

Query Parameters

limitintegerdefault: 20

starting_afterstring

Response

objectstring

Always 'list'

dataarray

Array of invoice objects

has_moreboolean

Example Request

curl https://api.reachscore.co/v1/billing/invoices \
  -H "Authorization: Bearer rk_live_xxx"

Example Response

{
  "object": "list",
  "data": [
    {
      "id": "inv_abc123",
      "number": "INV-2026-0003",
      "status": "paid",
      "amount_due": 9900,
      "amount_paid": 9900,
      "currency": "usd",
      "period_start": "2026-03-01T00:00:00Z",
      "period_end": "2026-03-31T23:59:59Z",
      "pdf_url": "https://pay.stripe.com/invoice/abc123/pdf",
      "created_at": "2026-03-01T00:00:00Z"
    },
    {
      "id": "inv_xyz789",
      "number": "INV-2026-0002",
      "status": "paid",
      "amount_due": 9900,
      "amount_paid": 9900,
      "currency": "usd",
      "period_start": "2026-02-01T00:00:00Z",
      "period_end": "2026-02-28T23:59:59Z",
      "pdf_url": "https://pay.stripe.com/invoice/xyz789/pdf",
      "created_at": "2026-02-01T00:00:00Z"
    }
  ],
  "has_more": true
}

Previous: API Keys Next: Errors