Subscription commands: create, get, list
The Subscription Verbs create, get, list as CLI commands, with inputs, result, refusals and an example.
Reference for Subscription, one group of Subscription commands.
Subscription.create
Creates a Subscription. Verb page.
npx startup-builder do Subscription.create --json '<input>' [--try | --send | --do]Emits Subscription.created.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
renewsAt | datetime | When it next renews. | |
quantity | integer | How many units of the Offer’s Price it holds, such as 12 members; 1 by default. | |
trialEndsAt | datetime | When a trial ends and the first paid period starts. | |
termEndsAt | datetime | When a committed term ends; the Renewal and the renewal notice read it. | |
customer | Customer | A Customer holds Subscriptions, each billed once per Period. | |
offer | Offer | A Subscription bills one recurring Offer each Period until canceled. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
subscription | Subscription | required | The Subscription. |
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
npx startup-builder do Subscription.create --json '{"renewsAt":Subscription.get
Returns one Subscription by id. Verb page.
npx startup-builder do Subscription.get --json '<input>' [--try]Reads only: it emits no Event.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Subscription. |
at | string | A time or Version name: the record as it stood then. Unset: as it stands now. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
subscription | Subscription | required | The Subscription. |
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
npx startup-builder do Subscription.get --json '{"id":Subscription.list
Returns Subscriptions, newest first, one page at a time. Verb page.
npx startup-builder do Subscription.list --json '<input>' [--try]Reads only: it emits no Event.
Inputs
| Input | Type | Required | 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 |
|---|---|---|---|
subscriptions | list of Subscription | required | One page of Subscriptions. |
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
npx startup-builder do Subscription.list --json '{"limit":