Create Ratecard

Rate Card Description

Flat Fee
Per Unit Fee
Volume Based
Graduated

Billing Scheme (Required)- defines type of the rate card being used. Should be passed as FIXED_RATE for flat fee rate card.
Fixed Price(Required) - Fixed price that is to be charged irrespective of usage

{
	"billingScheme": "FIXED_RATE",
	"fixedPrice": 100
}

Billing Scheme (Required)- defines type of the rate card being used. Should be passed as PER_UNIT for per unit fee rate card.
Per Unit Price (Required) - Fixed price that is to be charged per unit of usage.
Is Percentage (Optional) - Determines if the rate is a percentage of usage value. Default to False.

Per Unit Price	Is Percentage	Usage Value	Amount Charged
10	False	50	500
10	False	50	5

{
	"billingScheme": "PER_UNIT",
	"perUnitPrice": 10,
	"isPercentage": False 
}

What does this rate card mean?

Billing Scheme (Required)- defines type of the rate card being used. Should be passed as VOLUME for volume based rate card.
Tiers (Required) - Defines different tiers in the rate card -
- Name (Required) - Name of the tier
- UpTo (Required) - The upper usage limit of the tier (inclusive)
- Unit Price (Required) - Price per usage for this tier
- Flat Price (Optional) - Additional flat fee charged for this tier
- Is Percentage (Optional) - Determines if the rate is a percentage of usage value. Default to False.
- Repeat Tier (Optional) - If set to true, all the immediately following tiers will be ignored and this tier will be repeated at the same interval all the way to infinity. Defaults to False.

{
	"billingScheme": "VOLUME",
	"tiers": [
		{
			"name": "10_rs_for_quantity_below_100",
			"upTo": 100,
			"unitPrice": 10,
			"flatPrice": 50
		}, {
			"name": "8_rs_for_quantity_above_100_but_less_than_500",
			"upTo": 500,
			"unitPrice": 8
		}, {
			"name": "2_percent_for_quantity_above_500",
			"upTo": infinity,
			"unitPrice": 2,
			"isPercentage": True
		}
	]
}

Billing Scheme (Required)- defines type of the rate card being used. Should be passed as GRADUATED for volume based rate card.
Tiers (Required) - Defines different tiers in the rate card -
- Name (Required) - Name of the tier
- UpTo (Required) - The upper usage limit of the tier (inclusive)
- Unit Price (Required) - Price per usage for this tier
- Flat Price (Optional) - Additional flat fee charged for this tier
- Is Percentage (Optional) - Determines if the rate is a percentage of usage value. Default to False.
- Repeat Tier (Optional) - If set to true, all the immediately following tiers will be ignored and this tier will be repeated at the same interval all the way to infinity. Defaults to False.

{
	"billingScheme": "GRADUATED",
	"tiers": [
		{
			"name": "10_rs_for_quantity_below_100",
			"upTo": 100,
			"unitPrice": 10,
			"flatPrice": 50
		}, {
			"name": "8_rs_for_quantity_above_100_but_less_than_500",
			"upTo": 500,
			"unitPrice": 8
		}, {
			"name": "2_percent_for_quantity_above_500",
			"upTo": infinity,
			"unitPrice": 2,
			"isPercentage": True
		}
	]
}

Headers

X-Valyx-Signature

string

required

Auth key to authenticate the request

Body

application/json

name

string

required

The name of the rate card.

feeComponentId

string

required

Identifier of the fee component associated with this rate card.

description

any

Pricing strategy details for the rate card, including billing scheme, tiers, and prorated settings.

currency

string

Currency used for this rate card. Must be a valid ISO 4217 currency code. See: https://www.iso.org/iso-4217-currency-codes.html

Example:

"INR"

currencyId

string

Optional currency identifier if multiple currencies are supported.

Response

200 - application/json

Success

error

string

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

message

string

Informational message about the result of the operation.

data

object

Data object containing the result of the operation.

Show child attributes

data.id

string

Unique identifier of the created or updated rate card.

Authentication

Billing

Usage

Customer

Invoice

Credit Notes

Examples

Rate Card Description

Headers

Body

Response

Authentication

Billing

Usage

Customer

Invoice

Credit Notes

Examples

​Rate Card Description

Headers

Body

Response

Rate Card Description