Docs

Get Rate Card

GET /rate-cards/{rateCardId}

GET/rate-cards/{rateCardId}

Required Tokens

FieldTypeRequiredDescription
BearerAuthorization: Bearer <api-key>OptionalYour API key. Pass it as the Bearer token on every request.
Organization tokenx-Organization-TokenOptionalRun **Authorize Organization** in the Authorization folder.

Returns one rate card with its minimums, rates and reset definitions, plus the owner it belongs to. Exactly one of owner.resourceTypeId and owner.providerOfferingId is set.

Requires ResourceTypeDatabase.Read permission.

Path Parameters

FieldTypeRequiredDescription
rateCardIdGuidRequiredThe rate card.

Response Fields

FieldTypeDescription
idGuidThe rate card's ID.
namestringThe card's name.
ownerobject`{ resourceTypeId, providerOfferingId, name, trackingType }`. `name` is the owner's name, for a breadcrumb. A composite owner's cards are charge-only.
ratesarrayThe card's rates, one per resource state and period.
resetDefinitionsarrayThe clocks the card's minimums and rates reset on.

Error Codes

HTTP StatusDescription
403Missing ResourceTypeDatabase.Read.
404Rate card not found in this organization.