Skip to content

by Startups.Studio

Growth Customer

Customer.create

POST /{namespace}/customers

Creates a Customer.

Noun: Customer
Mode: do
Event: Customer.created

You, to your agent

Add a customer to PetPantry.

curl -X POST https://api.sb/petpantry.shop/customers \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"since":"2026-10-22T12:00:00Z"}'

import { $ } from 'startup-builder'

const customer = await $.Customer.create({ since: '2026-10-22T12:00:00Z' })

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

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

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

Inputs

Input	Type	Required	Description
`since`	`datetime`	required	When the party first accepted an Offer.
`outside`	`boolean`		Computed: true when it shares no owner, account, or sibling chain with the Startup.
`billingEmail`	`email`		Where Invoices and receipts go, when it differs from the sign-in email.
`billingAddress`	`text`		The address printed on new Invoices; Stripe Tax reads it to compute tax.
`taxIds`	`string[]`		The Customer’s tax ids, such as a VAT number, printed on new Invoices and read by Stripe Tax.
`creditRecharge`	`json`		When unspent credit falls below `below`, buy `amount` of the credit Offer with the default Payment Source.
`portal`	Portal		Customers sign in to a Portal to order, track delivery, accept work, and pay.
`acquisition`	Acquisition		A Customer inherits the Acquisition of the Lead it was; Metrics and payouts read this one row.

Outputs

Output	Type	Required	Description
`customer`	Customer	required	The Customer.

Effects

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

Customer.activate

Previous Page

Customer.delete

Next Page