Create Fee Component

cURL

curl --request POST \
  --url https://api.valyx.com/billing/feeComponent \
  --header 'Content-Type: application/json' \
  --header 'X-Valyx-Signature: <x-valyx-signature>' \
  --data '
{
  "name": "<string>",
  "taxRate": [
    {
      "name": "<string>",
      "value": 123,
      "isActive": true,
      "taxCategory": "GST"
    }
  ],
  "hsnOrSacCode": "<string>",
  "sku": "<string>",
  "unit": "<string>",
  "description": "<string>",
  "billLimit": {
    "isUsageBased": false,
    "tiers": [
      {
        "upTo": "Infinity",
        "minValue": 123,
        "maxValue": 123
      }
    ],
    "minValue": 123,
    "maxValue": 123
  },
  "driverUpsertRequest": {
    "upsertRequests": [
      {
        "usageDriverId": "<string>",
        "weight": 123
      }
    ]
  }
}
'

{
  "error": "<string>",
  "message": "<string>",
  "data": {
    "id": "<string>"
  }
}

POST

billing

feeComponent

cURL

curl --request POST \
  --url https://api.valyx.com/billing/feeComponent \
  --header 'Content-Type: application/json' \
  --header 'X-Valyx-Signature: <x-valyx-signature>' \
  --data '
{
  "name": "<string>",
  "taxRate": [
    {
      "name": "<string>",
      "value": 123,
      "isActive": true,
      "taxCategory": "GST"
    }
  ],
  "hsnOrSacCode": "<string>",
  "sku": "<string>",
  "unit": "<string>",
  "description": "<string>",
  "billLimit": {
    "isUsageBased": false,
    "tiers": [
      {
        "upTo": "Infinity",
        "minValue": 123,
        "maxValue": 123
      }
    ],
    "minValue": 123,
    "maxValue": 123
  },
  "driverUpsertRequest": {
    "upsertRequests": [
      {
        "usageDriverId": "<string>",
        "weight": 123
      }
    ]
  }
}
'

{
  "error": "<string>",
  "message": "<string>",
  "data": {
    "id": "<string>"
  }
}

Headers

X-Valyx-Signature

string

required

Auth key to authenticate the request

Body

application/json

name

string

required

The unique name of the fee component.

taxRate

object[]

required

List of taxes applicable to this fee component. Each tax includes its name, value, and category.

Show child attributes

taxRate.name

string

required

The name of the tax, e.g., 'GST', 'CESS', or 'Service Tax'.

taxRate.value

number

required

The percentage value of the tax (e.g., 18 for 18%).

taxRate.isActive

boolean

default:true

Whether this tax is currently active. Defaults to true.

taxRate.taxCategory

enum<string>

The category of the tax. Helps classify taxes for reporting and compliance.

Available options:

GST,

CESS,

SERVICE,

TDS,

OTHER

Example:

"GST"

hsnOrSacCode

string

HSN (Harmonized System of Nomenclature) code or SAC (Service Accounting Code) for GST classification.

sku

string

Stock Keeping Unit (SKU) – a unique identifier for the product or service. Useful for inventory or internal tracking.

unit

string

The unit of measurement for this fee component (e.g., 'GB', 'Hour', 'User'). Used when calculating usage-based charges.

description

string

Optional detailed description of the fee component.

billLimit

object

Optional limits for billing this component, e.g., min/max values or usage-based tiers.

Show child attributes

billLimit.isUsageBased

boolean

default:false

required

Indicates if the report limit is based on usage. If true, the tiers and min/max values are interpreted per usage unit.

billLimit.tiers

object[]

Optional list of tiered limits that apply based on usage thresholds.

Show child attributes

billLimit.tiers.upTo

number

default:Infinity

required

The upper limit of this tier. Usage or billing beyond this value will fall into the next tier. Can be set to a very large number to indicate no limit.

billLimit.tiers.minValue

number

The minimum value for this tier. Billing will start counting from this value. Optional if no lower bound is needed.

billLimit.tiers.maxValue

number

The maximum value for this tier. Optional if no upper bound is required.

billLimit.minValue

number

Minimum allowed value for the billing report. Can be omitted if no minimum is required.

billLimit.maxValue

number

Maximum allowed value for the billing report. Can be omitted if no maximum is required.

driverUpsertRequest

object

Optional usage driver relationships, defining how different usage drivers contribute to this fee component's calculations.

Show child attributes

driverUpsertRequest.upsertRequests

object[]

List of usage driver relationships. Each entry defines a usage driver and its weight in calculating the fee.

Show child attributes

driverUpsertRequest.upsertRequests.usageDriverId

string

required

The unique identifier of the usage driver, e.g., 'API_CALLS', 'STORAGE_GB'.

driverUpsertRequest.upsertRequests.weight

number

required

The factor by which the usage driver contributes to this fee component. For example, 1.5 means 150% of the usage is charged.

Response

200 - application/json

Success

error

string

required

Error message if the operation failed. Null if the operation was successful.

message

string

required

Informational message about the result of the operation.

data

object

required

Show child attributes

data.id

string

required

Unique identifier of the created fee component.

Filter Contracts Filter Fee Components

⌘I

Authentication

Billing

Usage

Customer

Invoice

Credit Notes

Examples

Create Fee Component

Headers

Body

Response