Docs
Add Rate
POST /rate-cards/{rateCardId}/rates
POST
/rate-cards/{rateCardId}/ratesRequired Tokens
| Field | Type | Required | Description |
|---|---|---|---|
| Bearer | Authorization: Bearer <api-key> | Optional | Your API key. Pass it as the Bearer token on every request. |
| Event token | x-Event-Token | Optional | Run **Get Tokens** in the Authorization folder, or call `GET /Events/{eventId}/authorize` manually. |
Adds a rate row: what one resource state costs and charges per period.
Requires
EventSettings permission on the event.Event scoping: This endpoint does not include
{eventId} in the URL. The event is determined automatically from your x-Event-Token.Path Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| rateCardId | Guid | Required | The rate card. |
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
| resourceStateId | Guid | Required | The state this row prices. |
| period | string | Required | One of `Hour`, `Day`, `Week`, `Month`, `Flat`. |
| costFixed | decimal | Required | Fixed cost per period. |
| costVariable | decimal | Required | Variable cost per period. |
| chargeFixed | decimal | Required | Fixed charge per period. |
| chargeVariable | decimal | Required | Variable charge per period. |
| coversHours | decimal? | Optional | Hours one period covers. |
| costMinimumBillableUnits | decimal? | Optional | Cost floor on this row, in its own units. |
| chargeMinimumBillableUnits | decimal? | Optional | Charge floor on this row, in its own units. |
| resetDefinitionId | Guid? | Optional | One of this card's reset definitions. |
On a composite type's card, cost fields are ignored in pricing: cost rolls up from the components.
Response
201 Created. No response body.
Error Codes
| HTTP Status | Description |
|---|---|
| 400 | Invalid arguments, a duplicate state and period, or a clock from another card. |
| 404 | Rate card or state not found. |