Skip to content

by Startups.Studio

Order.pay

POST /{namespace}/orders/{order}/pay

Pay settles an Order’s amount through the Startup’s payment account and posts the matching Entries.

Noun: Order
Mode: do
Event: Order.paid

You, to your agent

Pay the latest order.

curl -X POST https://api.sb/tutorloop.com/orders/order_1/pay \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"

import { $ } from 'startup-builder'

const order = await $.Order.pay({ order: 'order_1' })

npx startup-builder do Order.pay --json '{"order":"order_1"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Order.pay({ order: 'order_1' })"
  }
}

Inputs

Input	Type	Required	Description
`order`	Order	required	The placed Order.
`paymentMethod`	`string`		The saved method to charge.

Outputs

Output	Type	Required	Description
`order`	Order	required	The paid Order.

Effects

Emits Order.paid.
Performed by the Billing Specialist.
One-way (money): it waits out its delay window, and runs in the send and do modes.
On an Offer with credit, issues a paid Credit Grant to the Customer for that amount.

Refuses when

Check	Error	Fix	Then call
The operation is part of an Offer the caller has not accepted or paid for.	`payment-required`	Accept the Offer named in the response, then retry the call.	Offer.accept
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.	Order.pay
The record is not in a state that allows this Verb, so the call is refused.	`refused`	Read the record, run the Verb that moves it to an allowed state, then retry.	Order.pay
Stripe disabled charges on the Startup’s payment account because a requirement passed its deadline.	`charges-disabled`	Have the owner of record complete the open requirement Task; charges and paid Offers resume on re-enable.	Order.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`.

Order.list

Previous Page

Order.place

Next Page