Skip to content

by Startups.Studio

Bill.pay

POST /{namespace}/bills/{bill}/pay

Pay sends an approved Bill’s amount to its Organization on the due date and reconciles the payment to Entries.

Noun: Bill
Mode: do
Event: Bill.paid

You, to your agent

Pay the latest bill.

curl -X POST https://api.sb/patentpad.com/bills/bill_1/pay \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"

import { $ } from 'startup-builder'

const { transaction, bill } = await $.Bill.pay({ bill: 'bill_1' })

npx startup-builder do Bill.pay --json '{"bill":"bill_1"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Bill.pay({ bill: 'bill_1' })"
  }
}

Inputs

Input	Type	Required	Description
`bill`	Bill	required	The approved Bill.

Outputs

Output	Type	Required	Description
`transaction`	Transaction	required	The payment Transaction.
`bill`	Bill	required	The Bill, now paid.

Effects

Emits Bill.paid.
Performed by the Treasurer.
One-way (money): it waits out its delay window, and runs in the send and do modes.
Pays from the Startup’s Stripe balance or a linked bank account.

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.	Bill.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`.

Bill.list

Previous Page

Bill.update

Next Page