Skip to main content
WEBHOOK
dispute.created
{
  "id": "msg_xxxxxxxxxxxxxxxxxxxxxxxx",
  "api_version": "v1",
  "timestamp": "2025-01-01T00:00:00.000Z",
  "type": "dispute.created",
  "data": {
    "id": "dspt_xxxxxxxxxxxxx",
    "amount": 6.9,
    "currency": "usd",
    "status": "warning_needs_response",
    "editable": true,
    "created_at": "2023-12-01T05:00:00.401Z",
    "visa_rdr": true,
    "needs_response_by": "2023-12-01T05:00:00.401Z",
    "reason": "<string>",
    "plan": {
      "id": "plan_xxxxxxxxxxxxx"
    },
    "product": {
      "id": "prod_xxxxxxxxxxxxx",
      "title": "<string>"
    },
    "company": {
      "id": "biz_xxxxxxxxxxxxxx",
      "title": "<string>"
    },
    "payment": {
      "id": "pay_xxxxxxxxxxxxxx",
      "total": 6.9,
      "subtotal": 6.9,
      "usd_total": 6.9,
      "currency": "usd",
      "created_at": "2023-12-01T05:00:00.401Z",
      "paid_at": "2023-12-01T05:00:00.401Z",
      "dispute_alerted_at": "2023-12-01T05:00:00.401Z",
      "payment_method_type": "acss_debit",
      "billing_reason": "subscription_create",
      "card_brand": "mastercard",
      "card_last4": "<string>",
      "user": {
        "id": "user_xxxxxxxxxxxxx",
        "name": "John Doe",
        "username": "johndoe42",
        "email": "[email protected]"
      },
      "member": {
        "id": "<string>",
        "phone": "<string>"
      },
      "membership": {
        "id": "mem_xxxxxxxxxxxxxx",
        "status": "trialing"
      }
    },
    "access_activity_log": "<string>",
    "billing_address": "<string>",
    "cancellation_policy_disclosure": "<string>",
    "customer_email_address": "<string>",
    "customer_name": "<string>",
    "notes": "<string>",
    "product_description": "<string>",
    "refund_policy_disclosure": "<string>",
    "refund_refusal_explanation": "<string>",
    "service_date": "<string>",
    "cancellation_policy_attachment": {
      "id": "<string>",
      "filename": "<string>",
      "content_type": "<string>",
      "url": "<string>"
    },
    "customer_communication_attachment": {
      "id": "<string>",
      "filename": "<string>",
      "content_type": "<string>",
      "url": "<string>"
    },
    "refund_policy_attachment": {
      "id": "<string>",
      "filename": "<string>",
      "content_type": "<string>",
      "url": "<string>"
    },
    "uncategorized_attachment": {
      "id": "<string>",
      "filename": "<string>",
      "content_type": "<string>",
      "url": "<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
​
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: "dispute.created"
Example:

"dispute.created"

​
data
object
required

An object representing a dispute against a company.

Response

200

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