Order methods: update · StartupBuilder

Reference for Order, one group of Order methods.

Order.update

Changes the given properties of an Order. Verb page.

TypeScript

interface OrderVerbs {
  update(input: OrderUpdateInput, options?: SB.CallOptions): SB.Call<Order>
}

Emits Order.updated.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Order.
`total`	`money`		The amount charged.
`merchantOfRecord`	Party		The Party that charges and books the revenue.
`outside`	`boolean`		Computed: true when its Customer shares no owner, Studio account, Agreement, or sibling chain with the Startup.
`lines`	`json`		Each Offer bought, its quantity, amount and the Party that charges for it; a Service line carries its own verdict.
`fulfillment`	`string`		Where a Service Order’s work stands between `paid` and `fulfilled`.
`payment`	`string`		`authorized` when the Quote is accepted; `captured` on the Event the Outcome Contract `earns` names.
`revisionsUsed`	`integer`		Revisions the Customer has asked for, counted against the Outcome Contract’s `revisions`.
`risk`	`number`		The payment’s fraud risk score from 0 to 99 at screening, as Stripe scored it.
`tax`	`money`		The sales tax, VAT or GST computed at placement for the buyer’s location and the Offer’s tax category.
`taxJurisdiction`	`string`		Where the tax is owed, such as `US-CA` or `EU-DE`, or `none` when no registration applies.
`brief`	`json`		The scope a Service Order bought, from its Quote request: sizes, inputs and turnaround. Intake checks the inputs against it.
`dueAt`	`datetime`		When a Service Order’s work is due; time waiting on the Customer moves it later.
`collectedBy`	`string`		The id of the venue that charged the buyer and pays the Startup; unset when the Startup’s own checkout collected.

Returns

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

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.	None.

Example

TypeScript

import { $ } from 'startup-builder'

const order = await $.Order.update({ id: 'order_dswDnxf2vt', total: { amount: 29, currency: 'USD' } })