Skip to main content
POST
/
billing_rules
Create billing rule
curl --request POST \
  --url https://api.vantage.sh/v2/billing_rules \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "exclusion",
  "title": "<string>",
  "start_period": "<string>",
  "start_date": "<string>",
  "end_date": "<string>",
  "apply_to_all": true,
  "charge_type": "<string>",
  "percentage": 123,
  "service": "<string>",
  "category": "<string>",
  "sub_category": "<string>",
  "amount": 123,
  "sql_query": "<string>"
}
'
{
  "token": "bllng_rule_9cc9eab6bb73266b",
  "title": "Credit for Data Transfer",
  "type": "Credit",
  "created_by_token": "usr_ae0b14f6c9108edc",
  "created_at": "2024-07-02T15:26:52Z",
  "service": "Amazon S3",
  "category": "Data Transfer",
  "sub_category": "Outbound",
  "start_period": "2024-05-01",
  "amount": "300.0"
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json

Create a BillingRule.

​
type
enum<string>
required

The type of the BillingRule. Note: the values are case insensitive.

Available options:
exclusion,
adjustment,
credit,
charge,
custom
​
title
string
required

The title of the BillingRule.

​
start_period
string

The start period of the BillingRule. DEPRECATED: use start_date instead.

​
start_date
string

The start date of the BillingRule. ISO 8601 formatted.

​
end_date
string

The end date of the BillingRule. ISO 8601 formatted.

​
apply_to_all
boolean

Determines if the BillingRule applies to all current and future managed accounts.

​
charge_type
string

The charge type of the BillingRule. Required for Exclusion rules.

​
percentage
number<double>

The percentage of the cost shown. Required for Adjustment rules. Example value: 75.0

​
service
string

The service of the BillingRule. Required for Charge and Credit rules.

​
category
string

The category of the BillingRule. Required for Charge and Credit rules.

​
sub_category
string

The subcategory of the BillingRule. Required for Charge and Credit rules.

​
amount
number<double>

The amount for the BillingRule. Required for Charge and Credit rules. Example value: 300

​
sql_query
string

The SQL query for the BillingRule. Required for Custom rules. Example value: UPDATE costs SET costs.amount = costs.amount * 0.95

Response

BillingRule model

​
token
string
​
title
string

The title of the BillingRule.

Example:

"Credit for Unused EC2 Instances"

​
type
string

The type of the BillingRule.

Example:

"credit"

​
start_date
string

The start date of the BillingRule.

Example:

"2024-06-28T00:00:00Z"

​
end_date
string

The end date of the BillingRule.

Example:

"2024-06-28T00:00:00Z"

​
apply_to_all
boolean

Whether the BillingRule applies to all future managed accounts.

Example:

true

​
created_by_token
string

The token of the Creator of the BillingRule.

Example:

"usr_1234"

​
created_at
string

The date and time, in UTC, the BillingRule was created. ISO 8601 Formatted.

Example:

"2024-06-28T00:00:00Z"

​
service
string

The service for the BillingRule (Charge).

Example:

"AWS Cloudfront"

​
category
string

The category for the BillingRule (Charge).

Example:

"MSP Fee"

​
percentage
string

The percentage of the cost shown for the BillingRule (Adjustment).

Example:

"75.0"

​
charge_type
string

The charge type for the BillingRule.

Example:

"RIFee"

​
sub_category
string

The subcategory for the BillingRule (Charge).

Example:

"One-time"

​
start_period
string

The start period for the BillingRule (Charge).

Example:

"2024-05-01"

​
amount
string

The amount for the BillingRule (Charge).

Example:

"5000.25"

​
sql_query
string

The SQL query for the BillingRule (Custom).

Example:

"UPDATE costs SET costs.amount = costs.amount * 0.95"