Skip to content

by Startups.Studio

Finance Subscription

Subscription.create

POST /{namespace}/subscriptions

Creates a Subscription.

Noun: Subscription
Mode: do
Event: Subscription.created

You, to your agent

Add a subscription to LedgerLark.

curl -X POST https://api.sb/ledgerlark.com/subscriptions \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"renewsAt":"2026-10-22T12:00:00Z"}'

import { $ } from 'startup-builder'

const subscription = await $.Subscription.create({ renewsAt: '2026-10-22T12:00:00Z' })

npx startup-builder do Subscription.create --json '{"renewsAt":"2026-10-22T12:00:00Z"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Subscription.create({ renewsAt: '2026-10-22T12:00:00Z' })"
  }
}

Create makes a new Subscription from the inputs below. It is inherited: every Noun has get, list, create, update and delete.

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.

Outputs

Output	Type	Required	Description
`subscription`	Subscription	required	The Subscription.

Effects

Emits Subscription.created.
Two-way: try, send, do.

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.	Subscription.create

When it waits

Gate	Default
Decision class	Low: two-way, nothing at stake
Delay window	None: it runs once review passes.
Limit	The call Limit of the Permission it runs under.
Over the Limit	It waits `pending` for an Approval from the Founder. Approved, it runs; refused, it ends `refused` with `limit-exceeded`; unanswered by its deadline, it ends `canceled`.

Subscription

Previous Page

Subscription.get

Next Page