Docs

Update Rate

PUT /rate-cards/{rateCardId}/rates/{rateId}

PUT/rate-cards/{rateCardId}/rates/{rateId}

Required Tokens

FieldTypeRequiredDescription
BearerAuthorization: Bearer <api-key>OptionalYour API key. Pass it as the Bearer token on every request.
Event tokenx-Event-TokenOptionalRun **Get Tokens** in the Authorization folder, or call `GET /Events/{eventId}/authorize` manually.

Replaces a rate row's fields. The state can't change; add a new row instead.

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

FieldTypeRequiredDescription
rateCardIdGuidRequiredThe rate card.
rateIdGuidRequiredThe rate.

Request Body

FieldTypeRequiredDescription
periodstringRequiredOne of `Hour`, `Day`, `Week`, `Month`, `Flat`.
costFixeddecimalRequiredFixed cost per period.
costVariabledecimalRequiredVariable cost per period.
chargeFixeddecimalRequiredFixed charge per period.
chargeVariabledecimalRequiredVariable charge per period.
coversHoursdecimal?OptionalHours one period covers.
costMinimumBillableUnitsdecimal?OptionalCost floor on this row, in its own units.
chargeMinimumBillableUnitsdecimal?OptionalCharge floor on this row, in its own units.
resetDefinitionIdGuid?OptionalOne of this card's reset definitions.

Response

200 OK. No response body.

Error Codes

HTTP StatusDescription
400Invalid arguments or a clock from another card.
404Rate card or rate not found.