Skip to content

by Startups.Studio

Product What you sell Offer

Offer.create

POST /{namespace}/offers

Creates an Offer.

Noun: Offer
Mode: do
Event: Offer.created

You, to your agent

Add an offer to Kiln Bakery.

curl -X POST https://api.sb/kilnbakery.com/offers \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"price":{"amount":9,"currency":"USD"}}'

import { $ } from 'startup-builder'

const offer = await $.Offer.create({ price: { amount: 9, currency: 'USD' } })

npx startup-builder do Offer.create --json '{"price":{"amount":9,"currency":"USD"}}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Offer.create({ price: { amount: 9, currency: 'USD' } })"
  }
}

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

Inputs

Input	Type	Required	Description
`price`	`money`	required	The amount, currency, and unit. Zero is a price. Never randomized.
`terms`	`text`		The conditions the Customer accepts, refund rights included. Never randomized.
`from`	`string`		Lineage: the slot it compiles from, as `Hypothesis#<slot>@v<version>`.
`activation`	`json`		The Event, count and window that mark a Customer activated, such as `Reminder.sent` 20 times within 7 days.
`credit`	`money`		The Credit Grant each purchase issues, for an Offer that sells prepaid credit, such as $50 of calls.
`atBound`	`string`		What a call past an Entitlement’s Limit gets: `stop`, `overage` or `upgrade` (refuse it, bill it through the Meter, or move to the next Offer).
`interval`	`string`		How often it bills: `once`, `day`, `week`, `month` or `year`.
`availableFrom`	`datetime`		When it can first be bought. Unset: from when it is published.
`availableUntil`	`datetime`		When it can last be bought. Existing Subscriptions continue past it.
`trial`	`json`		The free trial every new Customer starts with: `days`, and `card` true to take a card up front. Unset: no trial.
`seats`	`string`		How a per-seat Price counts: `manual` (the buyer sets the quantity) or `members` (people in the Customer’s Tenant, prorated as they change).
`uptime`	`json`		The monthly uptime it promises, and the share of that month’s charge credited back below each level.
`license`	`string`		What a buyer may do with the records it sells: use them `internal`ly, `display` them to its own users, or `redistribute` them.
`attribution`	`text`		The credit line a buyer shows wherever the records appear.
`privateTo`	Party		The one Party who sees it and may accept it, making it a private Offer; no pricing page lists it.
`product`	Product		Each Offer sells one Product; one Product sits inside many Offers at different prices and terms.
`brand`	Brand		Each Offer carries exactly one Brand, whose name, voice and logo the buyer sees.
`motion`	Motion		Each Offer sells through one Motion, which says who buys and who acts for them.

Outputs

Output	Type	Required	Description
`offer`	Offer	required	The Offer.

Effects

Emits Offer.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.	Offer.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`.

Offer.accept

Previous Page

Offer.delete

Next Page