Skip to content

by Startups.Studio

Finance Commission

Commission.pay

POST /{namespace}/commissions/{commission}/pay

Pay transfers a Commission’s earned, unpaid amount to the Partner’s connected account through Stripe.

Noun: Commission
Mode: do
Event: Commission.paid

You, to your agent

Pay the latest commission.

curl -X POST https://api.sb/routewise.dev/commissions/commission_1/pay \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"

import { $ } from 'startup-builder'

const { commission, transaction } = await $.Commission.pay({ commission: 'commission_1' })

npx startup-builder do Commission.pay --json '{"commission":"commission_1"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Commission.pay({ commission: 'commission_1' })"
  }
}

Inputs

Input	Type	Required	Description
`commission`	Commission	required	The Commission with an amount past its clawback window.

Outputs

Output	Type	Required	Description
`commission`	Commission	required	The Commission, its `paid` raised by the transfer.
`transaction`	Transaction	required	The transfer as the rail reports it.

Effects

Emits Commission.paid.
Performed by the Billing Specialist.
One-way (money): it waits out its delay window, and runs in the send and do modes.
Pays only revenue past the clawback window; a later refund nets against the next payment.
Checks the payout Limit; above it, opens an Approval and the Action waits.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	Commission.pay

When it waits

Gate	Default
Decision class	Medium: one-way, bounded (money)
Delay window	1 business hour, in which a watcher can pause, redirect or cancel it; then it runs.
Limit	The spend Limit of the Permission or Mandate it runs under.
Over the Limit	It waits `pending` for an Approval from the Founder. Approved, it runs; refused, it ends `refused` with `limit-exceeded`; unanswered by its deadline, it ends `canceled`.

Commission.list

Previous Page

Commission.update

Next Page