Skip to content
StartupBuilder
by startups.studio
by Startups.Studio
Code
Changelog
APIGrowthCustomer

Customer routes: create, get, list

The Customer Verbs create, get, list as api.sb routes, with inputs, result, refusals and an example.

Reference for Customer, one group of Customer routes.

Customer.create

Creates a Customer. Verb page.

Text
POST /{namespace}/customers

Body, as JSON: the inputs. Emits Customer.created.

Inputs

InputTypeRequiredDescription
sincedatetimerequiredWhen the party first accepted an Offer.
outsidebooleanComputed: true when it shares no owner, account, or sibling chain with the Startup.
billingEmailemailWhere Invoices and receipts go, when it differs from the sign-in email.
billingAddresstextThe address printed on new Invoices; Stripe Tax reads it to compute tax.
taxIdsstring[]The Customer’s tax ids, such as a VAT number, printed on new Invoices and read by Stripe Tax.
creditRechargejsonWhen unspent credit falls below below, buy amount of the credit Offer with the default Payment Source.
portalPortalCustomers sign in to a Portal to order, track delivery, accept work, and pay.
acquisitionAcquisitionA Customer inherits the Acquisition of the Lead it was; Metrics and payouts read this one row.

Returns

OutputTypeRequiredDescription
customerCustomerrequiredThe Customer.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl -X POST https://api.sb/leaseline.app/customers \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"since":"2026-10-22T12:00:00Z"}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "customer": {
    "$id": "https://api.sb/leaseline.app/customers/cus_Gp5HXPKk00",
    "$type": "Customer",
    "since": "2026-10-22T12:00:00Z"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Customer.create",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Customer.get

Returns one Customer by id. Verb page.

Text
GET /{namespace}/customers/{id}

Path: id. Query: the other inputs. Reads only: it emits no Event.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Customer.
atstringA time or Version name: the record as it stood then. Unset: as it stands now.

Returns

OutputTypeRequiredDescription
customerCustomerrequiredThe Customer.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl https://api.sb/leaseline.app/customers/cus_K1BROJhqzZ \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Customer",
  "$id": "https://api.sb/leaseline.app/customers/cus_K1BROJhqzZ",
  "customer": {
    "$id": "https://api.sb/leaseline.app/customers/cus_K1BROJhqzZ",
    "$type": "Customer",
    "since": "2026-04-13T08:00:00Z"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/customers/cus_K1BROJhqzZ",
    "up": "https://api.sb/leaseline.app/customers"
  },
  "actions": {
    "activate": "https://api.sb/leaseline.app/customers/cus_K1BROJhqzZ/activate",
    "exempt": "https://api.sb/leaseline.app/customers/cus_K1BROJhqzZ/exempt"
  }
}

Customer.list

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

Text
GET /{namespace}/customers

Query: the inputs. Reads only: it emits no Event.

Inputs

InputTypeRequiredDescription
limitintegerAt most this many records, up to 100. The default is 20.
afterstringThe cursor from the previous page.
wherestringA filter over the properties, such as paidAt = null and total.amount > 500.
sortstringProperties to sort by, comma-separated; a leading minus sorts descending.
totalbooleanTrue adds the match count as meta.total, exact up to 10,000 matches and estimated above.
facetsstringProperties to count by value, comma-separated, returned as meta.facets.
fieldsstringProperties to return on each record, comma-separated; $id and $type always return.
includestringRelated records to embed in place of their URLs, comma-separated.
depthintegerHow many levels of related records to embed. The default is 1.
qstringWords to match across the text properties, ranked by relevance.
matchstringRanks the search by words, or meaning; words is the default.

Returns

OutputTypeRequiredDescription
customerslist of CustomerrequiredOne page of Customers.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl "https://api.sb/leaseline.app/customers?limit=20" \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Customer",
  "customers": [
    {
      "$id": "https://api.sb/leaseline.app/customers/cus_K1BROJhqzZ",
      "$type": "Customer",
      "since": "2026-04-13T08:00:00Z"
    }
  ],
  "meta": {
    "limit": 20,
    "after": "cus_K1BROJhqzZ"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/customers?limit=20",
    "next": "https://api.sb/leaseline.app/customers?after=cus_K1BROJhqzZ"
  }
}

Customer

Previous

update, delete

Next