Sign in

v8

OpenAPI 3.1.02026-08-033623795.0 MB
Invoices

Invoice Voided

Sent when a invoice is voided

Required permissions:

  • invoice:basic:read
  • member:email:read
  • webhook_receive:invoices
postWebhookinvoice.voided

Headers

webhook-idstring required

A unique identifier for this webhook request

Example:msg_xxxxxxxxxxxxxxxxxxxxxxxx
webhook-signaturestring required

The signature of the webhook request with the webhook version prepended

Example:v1,BASE64ENCODEDSIGNATURE
webhook-timestampstring required

The timestamp in seconds since the Unix epoch that the webhook was sent at on the server

Example:1727606400

Payload

api_version'v1' required

The API version for this webhook

api_version_datestring nullable required

The dated API version (Api-Version-Date) the payload is serialized to

company_idstring nullable

The account ID that this webhook event is associated with

idstring required

A unique ID for every single webhook request

timestampstring date-time required

The timestamp in ISO 8601 format that the webhook was sent at on the server

type'invoice.voided' required

The webhook event type

Example payload

{
  "api_version": "v1",
  "api_version_date": "2026-07-20",
  "company_id": "biz_xxxxxxxxxxxxxx",
  "data": {
    "automatically_finalizes_at": "2023-12-01T05:00:00.401Z",
    "company": {
      "id": "biz_xxxxxxxxxxxxxx"
    },
    "created_at": "2023-12-01T05:00:00.401Z",
    "current_plan": {
      "description": "Monthly access to all premium analytics dashboards and data exports.",
      "formatted_price": "$10.00",
      "id": "plan_xxxxxxxxxxxxx"
    },
    "customer_name": "Jane Doe",
    "due_date": "2023-12-01T05:00:00.401Z",
    "email_address": "customer@example.com",
    "fetch_invoice_token": "eyJhbGciOiJIUzI1NiJ9...",
    "id": "inv_xxxxxxxxxxxxxx",
    "line_items": [
      {
        "label": "Platform subscription",
        "position": 42,
        "quantity": 6.9,
        "total": 6.9,
        "unit_price": 6.9
      }
    ],
    "number": "#0001",
    "product": {
      "id": "prod_xxxxxxxxxxxxx",
      "title": "Pickaxe Analytics"
    },
    "subscription_billing_anchor_at": "2023-12-01T05:00:00.401Z",
    "updated_at": "2023-12-01T05:00:00.401Z",
    "user": {
      "email": "john.doe@example.com",
      "id": "user_xxxxxxxxxxxxx",
      "name": "John Doe",
      "username": "johndoe42"
    }
  },
  "id": "msg_xxxxxxxxxxxxxxxxxxxxxxxx",
  "timestamp": "2025-01-01T00:00:00.000Z",
  "type": "invoice.voided"
}

Response

Return a 200 status to indicate that the data was received successfully