Commission

PropertiesCopy Anchor Link

ObjectCopy Anchor Link

{
  "$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"
  }
}

RelationshipsCopy Anchor Link

• A Commission has one Referral: the Commission a Partner’s Referral earns on the revenue it brings, self-serve or through a Deal. referral, inverse earns.

VerbsCopy Anchor Link

1. createCreates a Commission.
   POST /{namespace}/commissionsdoCommission.created
2. getReturns one Commission by id.
   GET /{namespace}/commissions/{id}readNo Event
3. listReturns Commissions, newest first, one page at a time.
   GET /{namespace}/commissionsreadNo Event
4. updateChanges the given properties of a Commission.
   PATCH /{namespace}/commissions/{id}doCommission.updated
5. payPay transfers a Commission’s earned, unpaid amount to the Partner’s connected account through Stripe.
   POST /{namespace}/commissions/{commission}/paydoCommission.paid

PermissionsCopy Anchor Link

Which Access level may call each Verb. One-way Verbs wait their delay window.

Call itCopy Anchor Link

Pay the latest commission.

ExampleCopy Anchor Link

An accounting firm refers a client to a payroll app on a Commission of 20% for 12 months with a 30-day clawback. The client pays $300 a month, so the firm earns $60 a month once each payment clears the window.