Skip to main content
GET
/
billing
/
contract
/
feeComponent
/
{contract_id}
cURL
curl --request GET \
  --url https://api.valyx.com/billing/contract/feeComponent/{contract_id} \
  --header 'X-Valyx-Signature: <x-valyx-signature>'
{
  "error": "<string>",
  "message": "<string>",
  "data": [
    {
      "id": "<string>",
      "productId": "<string>",
      "productName": "<string>",
      "sku": "<string>",
      "includedInUsage": true,
      "name": "<string>",
      "description": "<string>",
      "hsnOrSacCode": "<string>",
      "usage": 123,
      "billedAmount": 123,
      "estimatedUsage": 123,
      "estimatedBilledAmount": 123,
      "adjustment": 123,
      "taxRate": [
        {
          "name": "<string>",
          "value": 123,
          "isActive": true,
          "taxCategory": "GST"
        }
      ],
      "billLimit": {
        "isUsageBased": false,
        "tiers": [
          {
            "upTo": "Infinity",
            "minValue": 123,
            "maxValue": 123
          }
        ],
        "minValue": 123,
        "maxValue": 123,
        "isProrated": true
      },
      "activePeriod": {
        "startDate": "2023-12-25",
        "endDate": "2023-12-25"
      },
      "billingFrequency": {
        "value": 123,
        "unit": "DAY"
      },
      "unit": "<string>",
      "isFlatFee": false,
      "companyId": "<string>",
      "createdBy": "<string>",
      "updatedBy": "<string>",
      "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

contract_id
string
required

Response

200 - application/json

Success

error
string
message
string
data
object[]