Billing

Read your balance, plan, usage, and payment history. Topping up and changing payment methods is done interactively in the console. Paths are relative to https://app.blacklistguard.com/api/v1.

Balance & usage

GET /billing/overview
GET /billing/usage

overview returns your current balance. usage returns { balance, plan, this_month, recent_charges } — this_month breaks spend into email / validation / subscription, and recent_charges lists individual charges with quantity, unit_rate, and amount.

Subscription

GET  /billing/subscription
GET  /billing/plans
POST /billing/subscription          { "plan_id", "billing_interval" }
POST /billing/subscription/cancel

subscription returns your current plan and period: { subscription: { plan_id, status, billing_interval, current_period_start, current_period_end, plan } } (or null on pay-as-you-go). status is active, canceled, past_due, or suspended. plans lists the subscribable plans. Subscribing charges the difference immediately; cancelling reverts to pay-as-you-go at the end of the current period.

Transactions

GET /billing/transactions?page&limit&status&gateway
GET /billing/transactions/export        (CSV download)

Payment and top-up history, newest first. Filter by status (pending, completed, failed) or gateway (stripe, paypal). Returns { pagination, transactions: [{ id, gateway, transaction_type, amount, currency, status, receipt_number, created_at }] }.