Keys

Current period usage for the calling key

Free, and does not consume a document.

get/v1/usage

Request

  • Base URL: https://api.attestwire.com
  • URL: https://api.attestwire.com/v1/usage
  • Auth: HTTP bearer

Response

Usage for the current UTC month.

tierstring required
periodstring required
usedinteger required
limitinteger required
remaininginteger required
resets_atstring date-time required
past_dueboolean required

True when the last subscription payment failed and the provider is still retrying. The paid allowance is UNCHANGED while this is true; only if every retry fails does the key drop to the free tier. This is the only in-band billing warning the API gives — poll it if you want to detect trouble programmatically.

billing_warningstring

Human-readable explanation, present only when past_due is true.

portal_endpointstring

The ROUTE that mints a billing-portal link — not a link. Always /v1/billing/portal. Call it with the customer's own key and it returns a one-time URL where they change plan, update the card, download invoices and cancel.

It is an endpoint rather than a URL because Paddle has no static portal page: each link is a session bound to one customer and it expires, so there is nothing durable to publish here, and minting one on every /v1/usage poll would spend a live API call on a link nobody opens.

Present on /v1/usage only for keys that actually have a subscription — a free key has nothing to manage, and pointing one at a route that will answer 409 is worse than saying nothing. Absent, never null.

tier_expiresstring date-time

Present only on a key whose tier is TIME-LIMITED — today, a key minted by an Invoice Fix Report claim (POST /v1/fix/claim), which carries 30 days of starter. Published both before and after the date passes: once past, tier above already reads free, and this field is the whole explanation of why. The key itself never expires and is never deleted; only the monthly allowance changes.

Example response

{
  "period": "2026-08",
  "portal_endpoint": "/v1/billing/portal"
}

Changes

No recorded changes to this operation across all 1 revision of this API.