Customer methods: update, delete

Reference for Customer, one group of Customer methods.

Customer.update

Changes the given properties of a Customer. Verb page.

TypeScript

interface CustomerVerbs {
  update(input: CustomerUpdateInput, options?: SB.CallOptions): SB.Call<Customer>
}

Emits Customer.updated.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Customer.
`since`	`datetime`		When the party first accepted an Offer.
`outside`	`boolean`		Computed: true when it shares no owner, account, or sibling chain with the Startup.
`billingEmail`	`email`		Where Invoices and receipts go, when it differs from the sign-in email.
`billingAddress`	`text`		The address printed on new Invoices; Stripe Tax reads it to compute tax.
`taxIds`	`string[]`		The Customer’s tax ids, such as a VAT number, printed on new Invoices and read by Stripe Tax.
`creditRecharge`	`json`		When unspent credit falls below `below`, buy `amount` of the credit Offer with the default Payment Source.

Returns

Output	Type	Required	Description
`customer`	Customer	required	The Customer.

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 customer = await $.Customer.update({ id: 'cus_K1BROJhqzZ', since: '2026-10-22T12:00:00Z' })

Deletes a Customer: a soft delete that keeps its history, undone by Thing.restore. Verb page.

TypeScript

interface CustomerVerbs {
  delete(input: CustomerDeleteInput, options?: SB.CallOptions): SB.Call<Customer>
}

Emits Customer.deleted.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Customer.

Returns

Output	Type	Required	Description
`customer`	Customer	required	The Customer.

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 customer = await $.Customer.delete({ id: 'cus_K1BROJhqzZ' })