Period methods: get, list, update

Reference for Period, one group of Period methods.

Period.get

Returns one Period by id. Verb page.

TypeScript

interface PeriodVerbs {
  get(input: PeriodGetInput, options?: SB.CallOptions): SB.Call<Period>
}

Reads only: it emits no Event.

Inputs

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

Returns

Output	Type	Required	Description
`period`	Period	required	The Period.

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 period = await $.Period.get({ id: 'period_VEVuYACTsH' })

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

TypeScript

interface PeriodVerbs {
  list(input?: PeriodListInput, options?: SB.CallOptions): SB.ListCall<Period>
}

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
`periods`	list of Period	required	One page of Periods.

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

Changes the given properties of a Period. Verb page.

TypeScript

interface PeriodVerbs {
  update(input: PeriodUpdateInput, options?: SB.CallOptions): SB.Call<Period>
}

Emits Period.updated.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Period.
`month`	`date`		The first day of the month it covers.

Returns

Output	Type	Required	Description
`period`	Period	required	The Period.

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 period = await $.Period.update({ id: 'period_VEVuYACTsH', month: '2026-10-22' })