Overview of the `payoutEntry.created` webhook

When a payoutEntry.created event is triggered, FastSpring sends a webhook payload containing details about the created payout. This webhook fires only when a new payout is generated for an order or return.

If webhook expansion is enabled, the payload includes full account, order, and subscription objects. Otherwise, the payload includes only the corresponding IDs.

This page provides:

A full sample payload showing a populated payoutEntry.created webhook
A detailed table listing every payload property, including name, type, and description
Notes on when this webhook is triggered and which fields appear based on Webhook Expansion

Browse the table sections below or use the quick links to jump to a specific group of fields.

Tip: Not all fields are always included. Refer to the Payload properties table to understand when a field appears.

Webhook payload example (expansion enabled)

When a payoutEntry.created event is triggered, the webhook sends one of the following JSON payloads (JSON - ORDER, JSON - RETURN). The contents of the payload depend on whether the triggering event is an order or return:

{
  "orderId": "aBCDE12fGH3iJkL4mNOpq",
  "quote": null,
  "reference": "ABC123456-7891-01112",
  "live": false,
  "order": {
    "order": "aBCDE12fGH3iJkL4mNOpq",
    "id": "aBCDE12fGH3iJkL4mNOpq",
    "reference": "ABC123456-7891-01112",
    "buyerReference": null,
    "ipAddress": "000.000.00.000",
    "completed": true,
    "changed": 1751897525497,
    "changedValue": 1751897525497,
    "changedInSeconds": 1751897525,
    "changedDisplay": "7/7/25",
    "changedDisplayISO8601": "2025-07-07",
    "changedDisplayEmailEnhancements": "Jul 07, 2025",
    "changedDisplayEmailEnhancementsWithTime": "Jul 07, 2025 02:12:05 PM",
    "language": "en",
    "live": false,
    "currency": "USD",
    "payoutCurrency": "USD",
    "quote": null,
    "invoiceUrl": "https://company.onfastspring.com/account/order/null/invoice",
    "siteId": "LDN5SX4KBZCI2",
    "account": "abCdE1FGH2Hij3KLMnOpqR",
    "total": 14.95,
    "totalDisplay": "$14.95",
    "totalInPayoutCurrency": 14.95,
    "totalInPayoutCurrencyDisplay": "$14.95",
    "tax": 0,
    "taxDisplay": "$0.00",
    "taxInPayoutCurrency": 0,
    "taxInPayoutCurrencyDisplay": "$0.00",
    "subtotal": 14.95,
    "subtotalDisplay": "$14.95",
    "subtotalInPayoutCurrency": 14.95,
    "subtotalInPayoutCurrencyDisplay": "$14.95",
    "discount": 0,
    "discountDisplay": "$0.00",
    "discountInPayoutCurrency": 0,
    "discountInPayoutCurrencyDisplay": "$0.00",
    "discountWithTax": 0,
    "discountWithTaxDisplay": "$0.00",
    "discountWithTaxInPayoutCurrency": 0,
    "discountWithTaxInPayoutCurrencyDisplay": "$0.00",
    "billDescriptor": "FS* fsprg.com",
    "payment": {
      "type": "test",
      "cardEnding": "4242"
    },
    "customer": {
      "first": "Jane",
      "last": "Doe",
      "email": "jane.doe@company.com",
      "company": "ABC Company",
      "phone": "5555555555",
      "subscribed": true
    },
    "address": {
      "city": "Santa Barbara",
      "regionCode": "CA",
      "regionDisplay": "California",
      "region": "California",
      "postalCode": "93101",
      "country": "US",
      "display": "801 Garden St, Suite 201, Santa Barbara, California, 93101, US"
    },
    "recipients": [
      {
        "recipient": {
          "first": "Jane",
          "last": "Doe",
          "email": "jane.doe@company.com",
          "company": "ABC Company",
          "phone": "5555555555",
          "subscribed": true
          "account": "abCdE1FGH2Hij3KLMnOpqR",
          "address": {
            "city": "Santa Barbara",
            "regionCode": "CA",
            "regionDisplay": "California",
            "region": "California",
            "postalCode": "93101",
            "country": "US",
            "display": "801 Garden St, Suite 201, Santa Barbara, California, 93101, US"
          }
        }
      }
    ],
    "notes": [],
    "items": [
      {
        "product": "cloud-storage",
        "quantity": 1,
        "display": "Cloud Storage Service",
        "sku": "SKU-CS-101",
        "imageUrl": null,
        "shortDisplay": "Cloud Storage Service",
        "subtotal": 14.95,
        "subtotalDisplay": "$14.95",
        "subtotalInPayoutCurrency": 14.95,
        "subtotalInPayoutCurrencyDisplay": "$14.95",
        "discount": 0,
        "discountDisplay": "$0.00",
        "discountInPayoutCurrency": 0,
        "discountInPayoutCurrencyDisplay": "$0.00",
        "isAddon": true,
        "fulfillments": {},
        "withholdings": {
          "taxWithholdings": false
        },
        "proratedItemChangeAmount": 0,
        "proratedItemChangeAmountDisplay": "$0.00",
        "proratedItemChangeAmountInPayoutCurrency": 0,
        "proratedItemChangeAmountInPayoutCurrencyDisplay": "$0.00",
        "proratedItemProratedCharge": 0,
        "proratedItemProratedChargeDisplay": "$0.00",
        "proratedItemProratedChargeInPayoutCurrency": 0,
        "proratedItemProratedChargeInPayoutCurrencyDisplay": "$0.00",
        "proratedItemCreditAmount": 0,
        "proratedItemCreditAmountDisplay": "$0.00",
        "proratedItemCreditAmountInPayoutCurrency": 0,
        "proratedItemCreditAmountInPayoutCurrencyDisplay": "$0.00",
        "proratedItemTaxAmount": 0,
        "proratedItemTaxAmountDisplay": "$0.00",
        "proratedItemTaxAmountInPayoutCurrency": 0,
        "proratedItemTaxAmountInPayoutCurrencyDisplay": "$0.00",
        "proratedItemTotal": 0,
        "proratedItemTotalDisplay": "$0.00",
        "proratedItemTotalInPayoutCurrency": 0,
        "proratedItemTotalInPayoutCurrencyDisplay": "$0.00"
      }
    ]
  },
  "account": {
    "id": "abCdE1FGH2Hij3KLMnOpqR",
    "account": "abCdE1FGH2Hij3KLMnOpqR",
    "contact": {
      "first": "Jane",
      "last": "Doe",
      "email": "jane.doe@company.com",
      "company": "ABC Company",
      "phone": "5555555555",
      "subscribed": true
    },
    "address": {
      "address line 1": "801 Garden St",
      "address line 2": "Suite 201",
      "city": "Santa Barbara",
      "country": "US",
      "postal code": "93101",
      "region": "US-CA",
      "region custom": null,
      "company": "ABC Company"
    },
    "language": "en",
    "country": "US",
    "lookup": {
      "global": "8x3FKfUESieeIgGoxHBRLg"
    },
    "url": "https://company.onfastspring.com/account"
  },
  "subscriptions": [],
  "subtractions": {
    "tax": {
      "currency": "USD",
      "amount": 0,
      "percentage": 0
    },
    "fastspring": {
      "currency": "USD",
      "amount": 1.8321,
      "percentage": 12.25
    },
    "withholdings": {
      "withholdings": false
    }
  },
  "payouts": [
    {
      "payee": "yourexamplestore",
      "currency": "USD",
      "payout": "13.12",
      "subtotal": 13.12,
      "total": "14.95"
    }
  ]
}

{
  "return": {
    "return": "aBCDE12fGH3iJkL4mNOpq",
    "quote": "QUW6Z4TYTPOJDRTF5DJ7E2CVYAWA",
    "reference": "ABC123456-7891-01112",
    "completed": true,
    "changed": 1753376916507,
    "changedValue": 1753376916507,
    "changedInSeconds": 1753376916,
    "changedDisplay": "7/24/25",
    "changedDisplayISO8601": "2025-07-24",
    "live": false,
    "account": "abCdE1FGH2Hij3KLMnOpqR",
    "currency": "USD",
    "payoutCurrency": "USD",
    "totalReturn": 10.0,
    "totalReturnDisplay": "$10.00",
    "totalReturnInPayoutCurrency": 10.0,
    "totalReturnInPayoutCurrencyDisplay": "$10.00",
    "tax": 0.0,
    "taxDisplay": "$0.00",
    "taxInPayoutCurrency": 0.0,
    "taxInPayoutCurrencyDisplay": "$0.00",
    "subtotal": 10.0,
    "subtotalDisplay": "$10.00",
    "subtotalInPayoutCurrency": 10.0,
    "subtotalInPayoutCurrencyDisplay": "$10.00",
    "totalRefundInPayoutCurrency": 10.0,
    "payment": {
      "type": "test",
      "cardEnding": "4242"
    },
    "reason": "Discount / Coupon",
    "note": "",
    "type": "RETURN",
    "refundPerformerType": "sellerApp",
    "refundSourceComponent": "refund",
    "original": {
      "id": "YxMPvrxHTfiRNCl3XSCGTA",
      "order": "YxMPvrxHTfiRNCl3XSCGTA",
      "reference": "ABC123456-7891-01114",
      "account": "abCdE1FGH2Hij3KLMnOpqR",
      "currency": "USD",
      "payoutCurrency": "USD",
      "total": 60.0,
      "totalDisplay": "$60.00",
      "totalInPayoutCurrency": 60.0,
      "totalInPayoutCurrencyDisplay": "$60.00",
      "tax": 0.0,
      "taxDisplay": "$0.00",
      "taxInPayoutCurrency": 0.0,
      "taxInPayoutCurrencyDisplay": "$0.00",
      "subtotal": 60.0,
      "subtotalDisplay": "$60.00",
      "subtotalInPayoutCurrency": 60.0,
      "subtotalInPayoutCurrencyDisplay": "$60.00",
      "notes": [],
      "tags": {
        "tag-key": "Tag Value"
      }
    },
    "customer": {
      "first": "Jane",
      "last": "Doe",
      "email": "jane.doe@company.com",
      "company": "ABC Company",
      "phone": "5555555555",
      "subscribed": true
    },
    "items": [
      {
        "product": "Cloud Storage",
        "quantity": 0,
        "display": null,
        "sku": null,
        "refundType": "Partial Refund",
        "subtotal": 10.0,
        "subtotalDisplay": "$10.00",
        "subtotalInPayoutCurrency": 10.0,
        "subtotalInPayoutCurrencyDisplay": "$10.00",
        "withholdings": {
          "taxWithholdings": false
        }
      }
    ],
    "refundPerformer": "jane.doe@company.com"
  },
  "account": {
    "id": "abCdE1FGH2Hij3KLMnOpqR",
    "account": "abCdE1FGH2Hij3KLMnOpqR",
    "contact": {
      "first": "Jane",
      "last": "Doe",
      "email": "jane.doe@company.com",
      "company": "ABC Company",
      "phone": "5555555555",
      "subscribed": true
    },
    "address": {
      "address line 1": "801 Garden St",
      "address line 2": "Suite 201",
      "city": "Santa Barbara",
      "country": "US",
      "postal code": "93101",
      "region": "US-CA",
      "region custom": null,
      "company": "ABC Company"
    },
    "language": "en",
    "country": "US",
    "lookup": {
      "global": "8x3FKfUESieeIgGoxHBRLg"
    },
    "url": "https://company.onfastspring.com/account"
  },
  "live": false,
  "subscriptions": [],
  "subtractions": {
    "tax": {
      "amount": 0.0,
      "percentage": 0
    },
    "fastspring": {
      "amount": 0.0000,
      "percentage": 0.0000
    },
    "withholdings": {
      "withholdings": false
    }
  },
  "subtotal": -10.0,
  "payouts": [
    {
      "payee": "yourexamplestore",
      "currency": "USD",
      "payout": "-10.00",
      "totalReturn": "-10.00"
    }
  ]
}

Navigate this webhook

The payoutEntry.created webhook payload includes details about the payout entry generated when an order or return is processed. Use the cards below to jump to a specific section of the property reference.

Payload properties

All fields below are included in the payoutEntry.created webhook payload. The payload structure varies slightly depending on whether it was triggered by an Order or Return event.

Name	Type	Description
Payout entry
orderId	string	Order ID associated with this payout entry (present in `JSON – ORDER` only)
quote	string\|null	Associated quote ID if the payout originated from a quote; otherwise `null`
reference	string	Customer-facing reference number of the related order or return
live	boolean	Indicates whether the payout event occurred in live or test mode
subscriptions	array	List of subscriptions associated with this payout, if applicable
Order object (JSON – ORDER)
order.order	string	Unique identifier for the order
order.reference	string	Customer-facing order reference
order.language	string	Two-letter ISO language code
order.live	boolean	Whether the order was processed in live mode
order.currency	string	Transaction currency used for the order
order.payoutCurrency	string	Payout currency applied to this order
order.invoiceUrl	string	Direct URL to view or download the invoice
order.account	string	FastSpring account ID associated with the buyer
order.total	number	Total order amount in transaction currency
order.totalDisplay	string	Formatted total order amount
order.tax	number	Tax amount applied to the order
order.taxDisplay	string	Formatted display of tax amount
order.subtotal	number	Subtotal before taxes and discounts
order.subtotalDisplay	string	Formatted display of subtotal
order.discount	number	Discount amount applied to the order
order.discountDisplay	string	Formatted display of discount
order.billDescriptor	string	Billing descriptor that appears on the buyer’s payment method
order.payment.type	string	Payment method type (e.g., `test`, `creditcard`, `paypal`)
order.payment.cardEnding	string	Last four digits of the payment card when applicable
order.customer.first	string	Customer’s first name
order.customer.last	string	Customer’s last name
order.customer.email	string	Customer’s email address
order.address.display	string	Formatted billing address
order.items	array	Array of items included in the order
order.items.product	string	Product identifier or path
order.items.subtotal	number	Item subtotal in transaction currency
order.items.discount	number	Discount applied to the item
Return object (JSON – RETURN)
return.return	string	Unique identifier for the return
return.quote	string	Associated quote ID for the return
return.reference	string	Customer-facing order reference for the return
return.completed	boolean	Indicates whether the return has completed processing
return.currency	string	Transaction currency used for the return
return.payoutCurrency	string	Payout currency used for the return
return.totalReturn	number	Total return amount in transaction currency
return.totalReturnDisplay	string	Formatted display of the total return
return.tax	number	Tax amount refunded
return.taxDisplay	string	Formatted display of refunded tax
return.subtotal	number	Subtotal of refunded items before tax
return.subtotalDisplay	string	Formatted display of refunded subtotal
return.reason	string	Reason for the return (e.g., `Discount / Coupon`)
return.refundPerformer	string	Email address of the user who performed the refund
return.refundPerformerType	string	Source of the refund action, e.g., `sellerApp`
return.original.id	string	Original order ID related to the return
return.original.reference	string	Original customer-facing order reference
return.customer.first	string	Customer’s first name on the original order
return.customer.email	string	Customer’s email address
return.items	array	List of items returned in this transaction
return.items.product	string	Returned product name or identifier
return.items.refundType	string	Type of refund, e.g., `Partial Refund`
return.items.subtotal	number	Amount refunded for this item
Account object
account.id	string	Unique FastSpring account ID
account.contact.first	string	Account contact’s first name
account.contact.email	string	Account contact’s email address
account.address.city	string	City of the account address
account.country	string	Two-letter ISO country code
account.language	string	Preferred language of the account
account.url	string	Customer-facing account management URL
Subtractions object
subtractions.tax.amount	number	Tax subtracted from payout amount
subtractions.fastspring.amount	number	FastSpring service fee amount
subtractions.fastspring.percentage	number	Percentage of service fee relative to total payout
subtractions.withholdings.withholdings	boolean	Indicates whether withholdings were applied to this payout
Payouts array
payouts	array	Array of payout entries included in this webhook
payouts.payee	string	Identifier or name of the payout recipient
payouts.currency	string	Currency code of the payout
payouts.payout	string\|number	Payout amount in payout currency
payouts.subtotal	number	Payout subtotal amount
payouts.total	string\|number	Total amount associated with the payout entry (order or return)