Skip to content

by startups.studio

by Startups.Studio

Cost routes

Every Cost Verb as an api.sb route, with its inputs, result, refusals and an example.

Reference for Cost.

Noun	System	Run by
Cost	Ledger	Finance Lead

Cost.get

Returns one Cost by id. Verb page.

Text

GET /{namespace}/costs/{id}

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

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Cost.
`at`	`string`		A time or Version name: the record as it stood then. Unset: as it stands now.

Returns

Output	Type	Required	Description
`cost`	Cost	required	The Cost.

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.	None.

Example

Terminal

curl https://api.sb/leaseline.app/costs/cost_2SqYsIEno0 \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"

JSON

{
  "api": "https://api.sb/leaseline.app",
  "$type": "Cost",
  "$id": "https://api.sb/leaseline.app/costs/cost_2SqYsIEno0",
  "cost": {
    "$id": "https://api.sb/leaseline.app/costs/cost_2SqYsIEno0",
    "$type": "Cost",
    "account": "cash",
    "amount": {
      "amount": 29,
      "currency": "USD"
    },
    "direction": "debit",
    "action": "act_br07HsG8MG"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/costs/cost_2SqYsIEno0",
    "up": "https://api.sb/leaseline.app/costs"
  }
}

Cost.list

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

Text

GET /{namespace}/costs

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

Inputs

Input	Type	Required	Description
`limit`	`integer`		At most this many records, up to 100. The default is 20.
`after`	`string`		The cursor from the previous page.
`where`	`string`		A filter over the properties, such as `paidAt = null and total.amount > 500`.
`sort`	`string`		Properties to sort by, comma-separated; a leading minus sorts descending.
`total`	`boolean`		True adds the match count as `meta.total`, exact up to 10,000 matches and estimated above.
`facets`	`string`		Properties to count by value, comma-separated, returned as `meta.facets`.
`fields`	`string`		Properties to return on each record, comma-separated; `$id` and `$type` always return.
`include`	`string`		Related records to embed in place of their URLs, comma-separated.
`depth`	`integer`		How many levels of related records to embed. The default is 1.
`q`	`string`		Words to match across the text properties, ranked by relevance.
`match`	`string`		Ranks the search by `words`, or `meaning`; words is the default.

Returns

Output	Type	Required	Description
`costs`	list of Cost	required	One page of Costs.

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.	None.

Example

Terminal

curl "https://api.sb/leaseline.app/costs?limit=20" \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"

JSON

{
  "api": "https://api.sb/leaseline.app",
  "$type": "Cost",
  "costs": [
    {
      "$id": "https://api.sb/leaseline.app/costs/cost_2SqYsIEno0",
      "$type": "Cost",
      "account": "cash",
      "amount": {
        "amount": 29,
        "currency": "USD"
      },
      "direction": "debit",
      "action": "act_br07HsG8MG"
    }
  ],
  "meta": {
    "limit": 20,
    "after": "cost_2SqYsIEno0"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/costs?limit=20",
    "next": "https://api.sb/leaseline.app/costs?after=cost_2SqYsIEno0"
  }
}

pay

Previous

Coupon

Next