Invoice commands: create, get, list

Reference for Invoice, one group of Invoice commands.

Invoice.create

Creates an Invoice. Verb page.

Text

npx startup-builder do Invoice.create --json '<input>' [--try | --send | --do]

Emits Invoice.created.

Inputs

Input	Type	Required	Description
`total`	`money`	required	The amount due.
`due`	`date`	required	When payment is due.
`paidAt`	`datetime`		When it was paid.
`collection`	`string`		`charge` charges the saved payment method; `send` sends the Invoice and waits for a transfer. `charge` by default.
`terms`	`integer`		Days from issue until a `send` Invoice is due, such as 30; sets `due`.
`purchaseOrder`	`string`		The Customer’s purchase order number, printed on the Invoice.
`refunded`	`money`		The total returned to the Customer, from zero up to the amount paid.
`number`	`string`		The Invoice number, sequential per Startup and never reused, voided Invoices included.
`lines`	`json`		Each Offer billed: its quantity, Period and amount, with any Coupon or Credit Grant applied.
`pdf`	`url`		The Invoice, or its receipt once paid, as a PDF on the Startup’s Domain that names the seller of record.
`payUrl`	`url`		The page on the Startup’s Domain where the Customer pays it by card or bank transfer.
`subscription`	Subscription		The Invoices the Subscription issues, one for each period it renews.
`customer`	Customer		Each Invoice is owed by one Customer.

Returns

Output	Type	Required	Description
`invoice`	Invoice	required	The Invoice.

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

Terminal

npx startup-builder do Invoice.create --json '{"total":{"amount":29,"currency":"USD"},"due":"2026-10-22"}'

Returns one Invoice by id. Verb page.

Text

npx startup-builder do Invoice.get --json '<input>' [--try]

Reads only: it emits no Event.

Inputs

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

Returns

Output	Type	Required	Description
`invoice`	Invoice	required	The Invoice.

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

Terminal

npx startup-builder do Invoice.get --json '{"id":"inv_9sfvgeRT7L"}'

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

Text

npx startup-builder do Invoice.list --json '<input>' [--try]

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
`invoices`	list of Invoice	required	One page of Invoices.

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

Terminal

npx startup-builder do Invoice.list --json '{"limit":20}'