v8

latestOpenAPI 3.1.02026-08-033623795.0 MB

Refunds

Refund Updated

Sent when a refund is updated

Required permissions:

payment:basic:read
plan:basic:read
access_pass:basic:read
member:email:read
member:basic:read
member:phone:read
webhook_receive:refunds

postWebhookrefund.updated

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'refund.updated' required

The webhook event type

Example payload

{
  "api_version": "v1",
  "api_version_date": "2026-07-20",
  "company_id": "biz_xxxxxxxxxxxxxx",
  "data": {
    "amount": 6.9,
    "created_at": "2023-12-01T05:00:00.401Z",
    "id": "rf_xxxxxxxxxxxxxxx",
    "payment": {
      "card_last4": "4242",
      "created_at": "2023-12-01T05:00:00.401Z",
      "dispute_alerted_at": "2023-12-01T05:00:00.401Z",
      "id": "pay_xxxxxxxxxxxxxx",
      "membership": {
        "id": "mem_xxxxxxxxxxxxxx"
      },
      "paid_at": "2023-12-01T05:00:00.401Z",
      "plan": {
        "id": "plan_xxxxxxxxxxxxx"
      },
      "product": {
        "id": "prod_xxxxxxxxxxxxx"
      },
      "subtotal": 6.9,
      "tax_amount": 6.9,
      "tax_refunded_amount": 6.9,
      "total": 6.9,
      "usd_total": 6.9,
      "user": {
        "email": "john.doe@example.com",
        "id": "user_xxxxxxxxxxxxx",
        "name": "John Doe",
        "username": "johndoe42"
      }
    },
    "provider_created_at": "2023-12-01T05:00:00.401Z",
    "reference_value": "74850120752"
  },
  "id": "msg_xxxxxxxxxxxxxxxxxxxxxxxx",
  "timestamp": "2025-01-01T00:00:00.000Z",
  "type": "refund.updated"
}

Response

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