Credit Grant methods: create, get, list

CreditGrant.create

Creates a Credit Grant. Verb page.

TypeScript

interface CreditGrantVerbs {
  create(input: CreditGrantCreateInput, options?: SB.CallOptions): SB.Call<CreditGrant>
}

Emits CreditGrant.created.

Inputs

Input	Type	Required	Description
`amount`	`money`	required	The balance granted. Never randomized.
`category`	`string`	required	`paid` (bought through an Order, deferred revenue until spent) or `promotional` (given; never cash). Never randomized.
`priority`	`integer`		Order of use when several grants apply: a lower number spends first, then the earliest expiry.
`expiresAt`	`datetime`		When any remaining balance lapses. Absent means it never lapses.
`appliesTo`	Offer		The metered Offer the balance pays for. Absent means every metered Offer of the Startup.
`customer`	Customer		The Customer whose metered calls spend the balance; credits never move to another Customer.

Returns

Output	Type	Required	Description
`creditGrant`	Credit Grant	required	The Credit Grant.

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 creditGrant = await $.CreditGrant.create({ amount: { amount: 29, currency: 'USD' }, category: 'paid' })

Returns one Credit Grant by id. Verb page.

TypeScript

interface CreditGrantVerbs {
  get(input: CreditGrantGetInput, options?: SB.CallOptions): SB.Call<CreditGrant>
}

Reads only: it emits no Event.

Inputs

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

Returns

Output	Type	Required	Description
`creditGrant`	Credit Grant	required	The Credit Grant.

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 creditGrant = await $.CreditGrant.get({ id: 'credgr_PduV9IB1HF' })

Returns Credit Grants, newest first, one page at a time. Verb page.

TypeScript

interface CreditGrantVerbs {
  list(input?: CreditGrantListInput, options?: SB.CallOptions): SB.ListCall<CreditGrant>
}

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
`creditGrants`	list of Credit Grant	required	One page of Credit Grants.

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