Customer methods: create, get, list

Reference for Customer, one group of Customer methods.

Customer.create

Creates a Customer. Verb page.

TypeScript

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

Emits Customer.created.

Inputs

Input	Type	Required	Description
`since`	`datetime`	required	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.
`portal`	Portal		Customers sign in to a Portal to order, track delivery, accept work, and pay.
`acquisition`	Acquisition		A Customer inherits the Acquisition of the Lead it was; Metrics and payouts read this one row.

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.create({ since: '2026-10-22T12:00:00Z' })

Returns one Customer by id. Verb page.

TypeScript

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

Reads only: it emits no Event.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Customer.
`at`	`string`		A time or Version name: the record as it stood then. Unset: as it stands now.

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.get({ id: 'cus_K1BROJhqzZ' })

Returns Customers, newest first, one page at a time. Verb page.

TypeScript

interface CustomerVerbs {
  list(input?: CustomerListInput, options?: SB.CallOptions): SB.ListCall<Customer>
}

Reads only: it emits no Event.

Inputs

Input	Type	Description
`limit`	`integer`	At most this many records, up to 100. The default is 20.
`after`	`string`	The cursor from the previous page.
`where`	`string`	A filter over the properties, such as `paidAt = null and total.amount > 500`.
`sort`	`string`	Properties to sort by, comma-separated; a leading minus sorts descending.
`total`	`boolean`	True adds the match count as `meta.total`, exact up to 10,000 matches and estimated above.
`facets`	`string`	Properties to count by value, comma-separated, returned as `meta.facets`.
`fields`	`string`	Properties to return on each record, comma-separated; `$id` and `$type` always return.
`include`	`string`	Related records to embed in place of their URLs, comma-separated.
`depth`	`integer`	How many levels of related records to embed. The default is 1.
`q`	`string`	Words to match across the text properties, ranked by relevance.
`match`	`string`	Ranks the search by `words`, or `meaning`; words is the default.

Returns

Output	Type	Required	Description
`customers`	list of Customer	required	One page of Customers.

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 customers = await $.Customer.list({ limit: 20 })