fingerlydocs
fingerly.io Log inDashboard
API reference

billing.status_changed

Sent when your organization's billing status changes, including whether it is accepting traffic. Live endpoints only.

POSThttps://your-server.example.com/webhooks/fingerly Signed by Fingerly

Sent when your organization's billing status changes. Only endpoints listening to the live environment can subscribe.

Body

  • idstring
    The event's ID, a UUIDv7. The same on every retry: deduplicate on it. Also sent as X-Fingerly-Event-ID.
  • typestring
    Always billing.status_changed.
  • versioninteger
    The envelope version, 1.
  • organization_idstring
    Your organization.
  • environmentstring
    live for production traffic, test for staging and development.
  • created_atstring
    When the underlying fact happened, RFC 3339 in UTC. Not when it was delivered.
  • dataobject
    The change.
    4 child fields
    • previous_statusstring
      The status before the change.
    • current_statusstring
      The status now.
    • accepting_trafficboolean
      Whether identifications are accepted in the current status.
    • blocked_reasonstring | null
      Why the organization is blocked, when it is. null otherwise.

Statuses

StatusAccepts trafficMeaning
freeYesNo payment method on file. Traffic is paid from credit.
activeYesA payment method is on file.
past_dueYesA payment failed. Update the payment method before the account is blocked.
blockedNoIdentify requests are refused with 402 billing_blocked.

Last updated