Invoice created

Sent when a invoice is created

Required permissions:

• invoice:basic:read
• webhook_receive:invoices

WEBHOOK invoice.created

Example

{
  "id": "msg_xxxxxxxxxxxxxxxxxxxxxxxx",
  "api_version": "v1",
  "timestamp": "2025-01-01T00:00:00.000Z",
  "type": "invoice.created",
  "data": {
    "id": "inv_xxxxxxxxxxxxxx",
    "created_at": "2023-12-01T05:00:00.401Z",
    "number": "#0001",
    "due_date": "2023-12-01T05:00:00.401Z",
    "email_address": "[e-mail]",
    "fetch_invoice_token": "eyJhbGciOiJIUzI1NiJ9...",
    "current_plan": {
      "id": "plan_xxxxxxxxxxxxx",
      "formatted_price": "$10.00"
    },
    "user": {
      "id": "user_xxxxxxxxxxxxx",
      "name": "John Doe",
      "username": "johndoe42"
    }
  },
  "company_id": "biz_xxxxxxxxxxxxxx"
}

Headers

webhook-id · string · required

A unique identifier for this webhook request

Example:

"msg_xxxxxxxxxxxxxxxxxxxxxxxx"

webhook-signature · string · required

The signature of the webhook request with the webhook version prepended

Example:

"v1,BASE64ENCODEDSIGNATURE"

webhook-timestamp · string · required

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

Example:

"1727606400"

Body

application/json

id · string · required

A unique ID for every single webhook request

Example:

"msg_xxxxxxxxxxxxxxxxxxxxxxxx"

api_version · string · required

The API version for this webhook

Allowed value: "v1"

Example:

"v1"

timestamp · string<date-time> · required

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

Example:

"2025-01-01T00:00:00.000Z"

type · string · required

The webhook event type

Allowed value: "invoice.created"

Example:

"invoice.created"

data · object · required

An invoice represents an itemized bill sent by a company to a customer for a specific product and plan, tracking the amount owed, due date, and payment status.

Show child attributes

company_id · string | null

The company ID that this webhook event is associated with

Example:

"biz_xxxxxxxxxxxxxx"

Response

200

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