v8

OpenAPI 3.1.02026-08-033623795.0 MB

Payments

Payment Created

Sent when a payment is created

Required permissions:

payment:basic:read
plan:basic:read
access_pass:basic:read
member:email:read
member:basic:read
member:phone:read
promo_code:basic:read
payment:dispute:read
payment:resolution_center_case:read
webhook_receive:payments

postWebhookpayment.created

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'payment.created' required

The webhook event type

Example payload

{
  "api_version": "v1",
  "api_version_date": "2026-07-20",
  "company_id": "biz_xxxxxxxxxxxxxx",
  "data": {
    "amount_after_fees": 6.9,
    "application_fee": {
      "amount": 6.9,
      "amount_captured": 6.9,
      "amount_refunded": 6.9,
      "created_at": "2023-12-01T05:00:00.401Z",
      "id": "apfee_xxxxxxxxxxxx"
    },
    "card_last4": "4242",
    "company": {
      "id": "biz_xxxxxxxxxxxxxx"
    },
    "created_at": "2023-12-01T05:00:00.401Z",
    "dispute_alerted_at": "2023-12-01T05:00:00.401Z",
    "disputes": [
      {
        "amount": 6.9,
        "id": "dspt_xxxxxxxxxxxxx",
        "needs_response_by": "2023-12-01T05:00:00.401Z",
        "notes": "Customer used the product for 3 months before disputing.",
        "reason": "Product Not Received"
      }
    ],
    "financing_installments_count": 42,
    "financing_transactions": [
      {
        "amount": 6.9,
        "created_at": "2023-12-01T05:00:00.401Z",
        "id": "ptx_xxxxxxxxxxxxxx"
      }
    ],
    "id": "pay_xxxxxxxxxxxxxx",
    "last_payment_attempt": "2023-12-01T05:00:00.401Z",
    "membership": {
      "id": "mem_xxxxxxxxxxxxxx"
    },
    "next_payment_attempt": "2023-12-01T05:00:00.401Z",
    "paid_at": "2023-12-01T05:00:00.401Z",
    "payment_method": {
      "card": {
        "exp_month": 42,
        "exp_year": 42,
        "last4": "4242"
      },
      "created_at": "2023-12-01T05:00:00.401Z",
      "id": "payt_xxxxxxxxxxxxx"
    },
    "payments_failed": 42,
    "plan": {
      "id": "plan_xxxxxxxxxxxxx"
    },
    "product": {
      "id": "prod_xxxxxxxxxxxxx",
      "route": "pickaxe-analytics",
      "title": "Pickaxe Analytics"
    },
    "promo_code": {
      "amount_off": 6.9,
      "id": "promo_xxxxxxxxxxxx",
      "number_of_intervals": 42
    },
    "refunded_amount": 6.9,
    "refunded_at": "2023-12-01T05:00:00.401Z",
    "refunds": [
      {
        "amount": 6.9,
        "created_at": "2023-12-01T05:00:00.401Z",
        "id": "rf_xxxxxxxxxxxxxxx"
      }
    ],
    "resolutions": [
      {
        "due_date": "2023-12-01T05:00:00.401Z",
        "id": "reso_xxxxxxxxxxxxx"
      }
    ],
    "risk_score": 42,
    "settlement_amount": 6.9,
    "settlement_exchange_rate": 6.9,
    "settlement_time_at": "2023-12-01T05:00:00.401Z",
    "subtotal": 6.9,
    "tax_amount": 6.9,
    "tax_refunded_amount": 6.9,
    "total": 6.9,
    "updated_at": "2023-12-01T05:00:00.401Z",
    "usd_total": 6.9,
    "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": "payment.created"
}

Response

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