Skip to content

CostItemCreateRequest

A new cost item. The schedule and the start date never change: to change them, end the item and record a new one. ends_on is the last date a payment can fall on, omitted for no end; price is the price of every payment from the start date, 0 or more.

object
schedule
required

The unit of a cost item’s payment schedule: once (one payment on the start date), or every interval weeks, months, or years, counted from the start date. A monthly payment on a day that a month does not have falls on the month’s last day.

string
Allowed values: once weeks months years
interval
required

The N of every N weeks, months, or years, 1 to 99; 1 for once.

integer
starts_on
required

A calendar date YYYY-MM-DD without a time or a time zone, such as the day of a payment on a card statement or an invoice.

string
/^[0-9]{4}-[0-9]{2}-[0-9]{2}$/
ends_on

A calendar date YYYY-MM-DD without a time or a time zone, such as the day of a payment on a card statement or an invoice.

string
/^[0-9]{4}-[0-9]{2}-[0-9]{2}$/
name
required

1 to 100 characters without control characters.

string
provider
required

1 to 100 characters without control characters.

string
category
required

The fixed category of a cost; clients translate its name.

string
Allowed values: compute database storage network domain email software other
memo

Up to 10,000 characters, never published.

string
price
required

Schema: Money

object

Example generated

{
"schedule": "once",
"interval": 1,
"starts_on": "example",
"ends_on": "example",
"name": "example",
"provider": "example",
"category": "compute",
"memo": "example",
"price": {}
}

For LLMs and coding agents:llms.txt,llms-full.txt, llms-small.txt

Analytics on this site