Skip to content
StartupBuilderby Startups.Studio
Business
Changelog
Events

Commission.paid

Emitted each time a Commission is paid.

Commission.pay emits Commission.paid when it completes on a Commission.

PropertyValue
Emitted byCommission.pay
NounCommission
WakesNone.

Payload

Each delivery is an Event record. data holds what Commission.pay returns.

FieldTypeRequiredDescription
namestringrequiredCommission.paid.
atdatetimerequiredWhen it happened.
seqintegerIts position in the namespace, one more than the Event before; any seq is a cursor into the history.
datajsonrequiredThe Thing as the Action left it.
data.commissionCommissionrequiredThe Commission, its paid raised by the transfer.
data.commission.ratenumberrequiredThe share of collected revenue earned, as a percent, such as 20.
data.commission.termintegerrequiredMonths after the first payment over which revenue earns the rate, such as 12.
data.commission.clawbackDaysintegerrequiredDays a payment waits before it earns, so a refund inside the window earns nothing.
data.commission.earnedmoneyCollected revenue net of refunds, times the rate, for payments past the clawback window.
data.commission.paidmoneyWhat has reached the Partner so far.
data.transactionTransactionrequiredThe transfer as the rail reports it.

Example

JSON
{
  "$id": "https://api.sb/patentpad.com/events/event_1",
  "$type": "Event",
  "name": "Commission.paid",
  "at": "2026-10-22T12:00:00Z",
  "data": {
    "commission": {
      "$id": "https://api.sb/patentpad.com/commissions/commission_1",
      "$type": "Commission",
      "rate": 1,
      "term": 1,
      "clawbackDays": 1,
      "earned": {
        "amount": 499,
        "currency": "USD"
      },
      "paid": {
        "amount": 499,
        "currency": "USD"
      }
    },
    "transaction": {
      "$id": "https://api.sb/patentpad.com/transactions/transaction_1",
      "$type": "Transaction",
      "kind": "charge",
      "amount": {
        "amount": 499,
        "currency": "USD"
      }
    }
  },
  "seq": 1
}