Skip to content

by Startups.Studio

Order.refund

POST /{namespace}/orders/{order}/refund

Refund returns all or part of an Order’s payment to the Customer and posts the reversing Entries.

Noun: Order
Mode: do
Event: Order.refunded

You, to your agent

Refund the latest order.

curl -X POST https://api.sb/kilnbakery.com/orders/order_1/refund \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"reason":"Example reason"}'

import { $ } from 'startup-builder'

const order = await $.Order.refund({ order: 'order_1', reason: 'Example reason' })

npx startup-builder do Order.refund --json '{"order":"order_1","reason":"Example reason"}'

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

Inputs

Input	Type	Required	Description
`order`	Order	required	The paid Order.
`amount`	`money`		The amount. Defaults to the full payment.
`reason`	`text`	required	Why the money goes back.

Outputs

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

Effects

Emits Order.refunded.
Performed by the Billing Specialist.
One-way (money, customer): it waits out its delay window, and runs in the send and do modes.
Checks the refund Limit; above it, opens an Approval and the Action waits.

Refuses when

Check	Error	Fix	Then call
The input does not match the schema of the operation.	`invalid-input`	Read the schema of the operation, then send every required field with the right type.	Order.refund
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.refund
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.refund

When it waits

Gate	Default
Decision class	Medium: one-way, bounded (money, customer)
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.place

Previous Page

Order.revise

Next Page