WEBHOOK
invoice.created
{
  "id": "msg_xxxxxxxxxxxxxxxxxxxxxxxx",
  "api_version": "v1",
  "created_at": "1727606400",
  "type": "invoice.created",
  "data": {
    "id": "inv_xxxxxxxxxxxxxx",
    "created_at": 1701406800,
    "status": "open",
    "number": "<string>",
    "due_date": 1701406800,
    "email_address": "<string>",
    "fetch_invoice_token": "<string>",
    "current_plan": {
      "id": "plan_xxxxxxxxxxxxx",
      "formatted_price": "<string>",
      "currency": "usd"
    },
    "user": {
      "id": "user_xxxxxxxxxxxxx",
      "name": "<string>",
      "username": "<string>"
    }
  }
}

Headers

​
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

Send when a Invoice is Created

​
id
string

A unique ID for every single webhook request

Example:

"msg_xxxxxxxxxxxxxxxxxxxxxxxx"

​
api_version
string

The API version for this webhook

Allowed value: "v1"
Example:

"v1"

​
created_at
string

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

Example:

"1727606400"

​
type
string

The webhook event type

Allowed value: "invoice.created"
Example:

"invoice.created"

​
data
object

A statement that defines an amount due by a customer.

Response

200

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