Skip to main content
GET
/
billing
/
ratecard
/
feeComponent
/
fetch
/
{fee_component_id}
cURL
curl --request GET \
  --url https://api.valyx.com/billing/ratecard/feeComponent/fetch/{fee_component_id} \
  --header 'X-Valyx-Signature: <x-valyx-signature>'
{
  "error": "<string>",
  "message": "<string>",
  "data": {
    "tags": {},
    "ratecards": [
      {
        "id": {},
        "name": {},
        "ratecardDescription": {},
        "feeComponentId": {},
        "description": {},
        "ratecardDetail": {},
        "tags": {},
        "companyId": {},
        "contractId": {},
        "currency": {},
        "currencyId": {},
        "createdBy": {},
        "isDefault": {},
        "status": {},
        "isTierSplitEnabled": {},
        "startDate": {},
        "endDate": {},
        "fallBackRatecardId": {}
      }
    ]
  }
}

Headers

X-Valyx-Signature
string
required

Auth key for fetching ledger entries

X-Fields
string<mask>

An optional fields mask

Path Parameters

fee_component_id
string
required

Query Parameters

contractId
string

If passed will return all the ratecards available for a contract

showEmptyCombinations
string
default:false

If false will return only the combinations of tags that have at least one ratecard

Response

200 - application/json

Success

error
string
message
string
data
object