Skip to main content
WEBHOOK
payment.created
{
  "id": "pay_123",
  "status": "created",
  "substatus": "incomplete",
  "customerId": "usr_123",
  "customerEmail": "customer@example.com",
  "customerName": "John Doe",
  "customerUsername": "johndoe",
  "productTitle": "SaaS Pro Access",
  "productRoute": "saas-pro-access",
  "planId": "plan_123",
  "membershipId": "mem_123",
  "membershipStatus": "drafted",
  "billingReason": "subscription_create",
  "amount": "29.00",
  "subtotal": "29.00",
  "usdTotal": "29.00",
  "feeAmount": "1.50",
  "amountAfterFees": "27.50",
  "taxAmount": null,
  "taxBehavior": null,
  "taxRefundedAmount": null,
  "refundedAmount": "0",
  "settlementAmount": "29.00",
  "settlementCurrency": "usd",
  "settlementExchangeRate": null,
  "currency": "USD",
  "refundable": false,
  "retryable": false,
  "autoRefunded": false,
  "paymentMethod": null,
  "cardBrand": null,
  "cardLast4": null,
  "cardExpMonth": null,
  "cardExpYear": null,
  "billingAddress": {
    "name": "John Doe",
    "line1": "123 Main St",
    "line2": "",
    "city": "San Francisco",
    "state": "CA",
    "country": "US",
    "postal_code": "94105"
  },
  "licenseKey": null,
  "filesSnapshot": null,
  "checkoutId": null,
  "discountCode": null,
  "failureMessage": null,
  "paidAt": "2026-05-25T20:20:05.000Z",
  "refundedAt": null,
  "disputeAlertedAt": null,
  "lastPaymentAttempt": null,
  "nextPaymentAttempt": "2026-05-25T20:20:05.000Z",
  "createdAt": "2026-05-25T20:20:06.000Z",
  "updatedAt": "2026-05-25T20:20:06.000Z",
  "paymentEventType": "payment.created",
  "lastEventType": "payment.created",
  "businessId": "biz_123"
}

Authorizations

Authorization
string
header
required

Authenticate requests using your standard bearer API key (e.g. YOUR_API_KEY).

Body

application/json
id
string

Internal payment ID.

Example:

"pay_019e60cb..."

status
string
Example:

"created"

substatus
string | null
Example:

"incomplete"

customerId
string | null
customerEmail
string | null
customerName
string | null
customerUsername
string | null
productTitle
string | null
productRoute
string | null
planId
string | null
membershipId
string | null
membershipStatus
string | null
billingReason
string | null
Example:

"subscription_create"

amount
string | null

Dollar value, 2 d.p.

Example:

"100.00"

subtotal
string | null
Example:

"100.00"

usdTotal
string | null
Example:

"100.00"

feeAmount
string | null
Example:

"3.25"

amountAfterFees
string | null
Example:

"96.75"

taxAmount
string | null
taxBehavior
string | null
taxRefundedAmount
string | null
refundedAmount
string
Example:

"0"

settlementAmount
string | null
settlementCurrency
string | null
settlementExchangeRate
string | null
currency
string
Example:

"USD"

refundable
boolean
retryable
boolean
autoRefunded
boolean
paymentMethod
string | null
Example:

"card"

cardBrand
string | null
Example:

"visa"

cardLast4
string | null
Example:

"4242"

cardExpMonth
integer | null
cardExpYear
integer | null
billingAddress
object
licenseKey
string | null
filesSnapshot
object[] | null
checkoutId
string | null
discountCode
string | null
failureMessage
string | null
paidAt
string<date-time> | null
refundedAt
string<date-time> | null
disputeAlertedAt
string<date-time> | null
lastPaymentAttempt
string<date-time> | null
nextPaymentAttempt
string<date-time> | null
createdAt
string<date-time>
updatedAt
string<date-time>
paymentEventType
string | null
lastEventType
string | null
businessId
string

Response

200

Webhook processed successfully.