Payment Created

Payload

{
  "api_version": "v1",
  "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",
      "currency": "usd",
      "id": "apfee_xxxxxxxxxxxx"
    },
    "auto_refunded": true,
    "billing_address": {
      "city": "string",
      "country": "string",
      "line1": "string",
      "line2": "string",
      "name": "string",
      "postal_code": "string",
      "state": "string"
    },
    "billing_reason": "subscription_create",
    "card_brand": "mastercard",
    "card_last4": "4242",
    "checkout_configuration_id": "string",
    "company": {
      "id": "biz_xxxxxxxxxxxxxx",
      "route": "string",
      "title": "string"
    },
    "created_at": "2023-12-01T05:00:00.401Z",
    "currency": "usd",
    "dispute_alerted_at": "2023-12-01T05:00:00.401Z",
    "disputes": [
      {
        "amount": 6.9,
        "currency": "usd",
        "editable": true,
        "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",
        "status": "warning_needs_response"
      }
    ],
    "failure_message": "string",
    "financing_installments_count": 42,
    "financing_transactions": [
      {
        "amount": 6.9,
        "created_at": "2023-12-01T05:00:00.401Z",
        "id": "ptx_xxxxxxxxxxxxxx",
        "status": "succeeded",
        "transaction_type": "purchase"
      }
    ],
    "id": "pay_xxxxxxxxxxxxxx",
    "last_payment_attempt": "2023-12-01T05:00:00.401Z",
    "member": {
      "id": "string",
      "phone": "string"
    },
    "membership": {
      "id": "mem_xxxxxxxxxxxxxx",
      "phone_number": "string",
      "status": "trialing"
    },
    "metadata": {},
    "next_payment_attempt": "2023-12-01T05:00:00.401Z",
    "paid_at": "2023-12-01T05:00:00.401Z",
    "payment_method": {
      "card": {
        "brand": "mastercard",
        "exp_month": 42,
        "exp_year": 42,
        "last4": "4242"
      },
      "created_at": "2023-12-01T05:00:00.401Z",
      "id": "payt_xxxxxxxxxxxxx",
      "payment_method_type": "acss_debit"
    },
    "payment_method_type": "acss_debit",
    "payments_failed": 42,
    "plan": {
      "id": "plan_xxxxxxxxxxxxx",
      "internal_notes": "string",
      "metadata": {}
    },
    "product": {
      "id": "prod_xxxxxxxxxxxxx",
      "metadata": {},
      "route": "pickaxe-analytics",
      "title": "Pickaxe Analytics"
    },
    "promo_code": {
      "amount_off": 6.9,
      "base_currency": "usd",
      "code": "string",
      "id": "promo_xxxxxxxxxxxx",
      "number_of_intervals": 42,
      "promo_type": "percentage"
    },
    "refundable": true,
    "refunded_amount": 6.9,
    "refunded_at": "2023-12-01T05:00:00.401Z",
    "resolutions": [
      {
        "customer_appealed": true,
        "customer_response_actions": [
          "respond"
        ],
        "due_date": "2023-12-01T05:00:00.401Z",
        "id": "reso_xxxxxxxxxxxxx",
        "issue": "forgot_to_cancel",
        "merchant_appealed": true,
        "merchant_response_actions": [
          "accept"
        ],
        "platform_response_actions": [
          "request_buyer_info"
        ],
        "status": "merchant_response_needed"
      }
    ],
    "retryable": true,
    "settlement_amount": 6.9,
    "settlement_currency": "usd",
    "settlement_exchange_rate": 6.9,
    "status": "draft",
    "substatus": "succeeded",
    "subtotal": 6.9,
    "tax_amount": 6.9,
    "tax_behavior": "exclusive",
    "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"
    },
    "voidable": true
  },
  "id": "msg_xxxxxxxxxxxxxxxxxxxxxxxx",
  "timestamp": "2025-01-01T00:00:00.000Z",
  "type": "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

Payload

The payload of this webhook request is an object.

api_version"v1"Required

The API version for this webhook

dataobjectRequired

A payment represents a completed or attempted charge. Payments track the amount, status, currency, and payment method used.

idstringRequired

A unique ID for every single webhook request

timestampdatetimeRequired

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

type"payment.created"Required

The webhook event type

company_idstring or nullOptional

The company ID that this webhook event is associated with

Response

200

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

Headers

Payload

Response