Skip to content

Customer routes: update, delete

The Customer Verbs update, delete as api.sb routes, with inputs, result, refusals and an example.

Reference for Customer, one group of Customer routes.

Customer.update

Changes the given properties of a Customer. Verb page.

Text
PATCH /{namespace}/customers/{id}

Path: id. Body, as JSON: the other inputs. Emits Customer.updated.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Customer.
sincedatetimeWhen 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.

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 PATCH https://api.sb/leaseline.app/customers/cus_K1BROJhqzZ \
  -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_K1BROJhqzZ",
    "$type": "Customer",
    "since": "2026-10-22T12:00:00Z"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Customer.update",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Customer.delete

Deletes a Customer: a soft delete that keeps its history, undone by Thing.restore. Verb page.

Text
DELETE /{namespace}/customers/{id}

Path: id. Emits Customer.deleted.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Customer.

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 DELETE https://api.sb/leaseline.app/customers/cus_K1BROJhqzZ \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "customer": {
    "$id": "https://api.sb/leaseline.app/customers/cus_K1BROJhqzZ",
    "$type": "Customer",
    "since": "2026-04-13T08:00:00Z"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Customer.delete",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}