Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Vantage Provider
  3. API Docs
  4. BillingRule
vantage 0.1.65 published on Wednesday, Sep 10, 2025 by vantage-sh
vantage-sh/terraform-provider-vantage

vantage.BillingRule

Explore with Pulumi AI

vantage logo
vantage 0.1.65 published on Wednesday, Sep 10, 2025 by vantage-sh
vantage-sh/terraform-provider-vantage

    Create BillingRule Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new BillingRule(name: string, args: BillingRuleArgs, opts?: CustomResourceOptions);
    @overload
def BillingRule(resource_name: str,
                args: BillingRuleArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def BillingRule(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                title: Optional[str] = None,
                type: Optional[str] = None,
                service: Optional[str] = None,
                charge_type: Optional[str] = None,
                end_date: Optional[str] = None,
                percentage: Optional[float] = None,
                amount: Optional[float] = None,
                sql_query: Optional[str] = None,
                start_date: Optional[str] = None,
                start_period: Optional[str] = None,
                sub_category: Optional[str] = None,
                category: Optional[str] = None,
                apply_to_all: Optional[bool] = None)
    func NewBillingRule(ctx *Context, name string, args BillingRuleArgs, opts ...ResourceOption) (*BillingRule, error)
    public BillingRule(string name, BillingRuleArgs args, CustomResourceOptions? opts = null)
    public BillingRule(String name, BillingRuleArgs args)
public BillingRule(String name, BillingRuleArgs args, CustomResourceOptions options)

    type: vantage:BillingRule
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args BillingRuleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args BillingRuleArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args BillingRuleArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BillingRuleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BillingRuleArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var billingRuleResource = new Vantage.BillingRule("billingRuleResource", new()
{
    Title = "string",
    Type = "string",
    Service = "string",
    ChargeType = "string",
    EndDate = "string",
    Percentage = 0,
    Amount = 0,
    SqlQuery = "string",
    StartDate = "string",
    StartPeriod = "string",
    SubCategory = "string",
    Category = "string",
    ApplyToAll = false,
});

    example, err := vantage.NewBillingRule(ctx, "billingRuleResource", &vantage.BillingRuleArgs{
	Title:       pulumi.String("string"),
	Type:        pulumi.String("string"),
	Service:     pulumi.String("string"),
	ChargeType:  pulumi.String("string"),
	EndDate:     pulumi.String("string"),
	Percentage:  pulumi.Float64(0),
	Amount:      pulumi.Float64(0),
	SqlQuery:    pulumi.String("string"),
	StartDate:   pulumi.String("string"),
	StartPeriod: pulumi.String("string"),
	SubCategory: pulumi.String("string"),
	Category:    pulumi.String("string"),
	ApplyToAll:  pulumi.Bool(false),
})

    var billingRuleResource = new BillingRule("billingRuleResource", BillingRuleArgs.builder()
    .title("string")
    .type("string")
    .service("string")
    .chargeType("string")
    .endDate("string")
    .percentage(0.0)
    .amount(0.0)
    .sqlQuery("string")
    .startDate("string")
    .startPeriod("string")
    .subCategory("string")
    .category("string")
    .applyToAll(false)
    .build());

    billing_rule_resource = vantage.BillingRule("billingRuleResource",
    title="string",
    type="string",
    service="string",
    charge_type="string",
    end_date="string",
    percentage=0,
    amount=0,
    sql_query="string",
    start_date="string",
    start_period="string",
    sub_category="string",
    category="string",
    apply_to_all=False)

    const billingRuleResource = new vantage.BillingRule("billingRuleResource", {
    title: "string",
    type: "string",
    service: "string",
    chargeType: "string",
    endDate: "string",
    percentage: 0,
    amount: 0,
    sqlQuery: "string",
    startDate: "string",
    startPeriod: "string",
    subCategory: "string",
    category: "string",
    applyToAll: false,
});

    type: vantage:BillingRule
properties:
    amount: 0
    applyToAll: false
    category: string
    chargeType: string
    endDate: string
    percentage: 0
    service: string
    sqlQuery: string
    startDate: string
    startPeriod: string
    subCategory: string
    title: string
    type: string

    BillingRule Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The BillingRule resource accepts the following input properties:

    Title string
    The title of the BillingRule.
    Type string
    The type of the BillingRule. Note: the values are case insensitive.
    Amount double
    The amount for the BillingRule. Required for Charge and Credit rules. Example value: 300
    ApplyToAll bool
    Determines if the BillingRule applies to all current and future managed accounts.
    Category string
    The category of the BillingRule. Required for Charge and Credit rules.
    ChargeType string
    The charge type of the BillingRule. Required for Exclusion rules.
    EndDate string
    The end date of the BillingRule. ISO 8601 formatted.
    Percentage 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.
    SqlQuery string
    The SQL query for the BillingRule. Required for Custom rules. Example value: UPDATE costs SET costs.amount = costs.amount * 0.95
    StartDate string
    The start date of the BillingRule. ISO 8601 formatted.
    StartPeriod string
    The start period of the BillingRule. DEPRECATED: use start_date instead.
    SubCategory string
    The subcategory of the BillingRule. Required for Charge and Credit rules.
    Title string
    The title of the BillingRule.
    Type string
    The type of the BillingRule. Note: the values are case insensitive.
    Amount float64
    The amount for the BillingRule. Required for Charge and Credit rules. Example value: 300
    ApplyToAll bool
    Determines if the BillingRule applies to all current and future managed accounts.
    Category string
    The category of the BillingRule. Required for Charge and Credit rules.
    ChargeType string
    The charge type of the BillingRule. Required for Exclusion rules.
    EndDate string
    The end date of the BillingRule. ISO 8601 formatted.
    Percentage float64
    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.
    SqlQuery string
    The SQL query for the BillingRule. Required for Custom rules. Example value: UPDATE costs SET costs.amount = costs.amount * 0.95
    StartDate string
    The start date of the BillingRule. ISO 8601 formatted.
    StartPeriod string
    The start period of the BillingRule. DEPRECATED: use start_date instead.
    SubCategory string
    The subcategory of the BillingRule. Required for Charge and Credit rules.
    title String
    The title of the BillingRule.
    type String
    The type of the BillingRule. Note: the values are case insensitive.
    amount Double
    The amount for the BillingRule. Required for Charge and Credit rules. Example value: 300
    applyToAll Boolean
    Determines if the BillingRule applies to all current and future managed accounts.
    category String
    The category of the BillingRule. Required for Charge and Credit rules.
    chargeType String
    The charge type of the BillingRule. Required for Exclusion rules.
    endDate String
    The end date of the BillingRule. ISO 8601 formatted.
    percentage 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.
    sqlQuery String
    The SQL query for the BillingRule. Required for Custom rules. Example value: UPDATE costs SET costs.amount = costs.amount * 0.95
    startDate String
    The start date of the BillingRule. ISO 8601 formatted.
    startPeriod String
    The start period of the BillingRule. DEPRECATED: use start_date instead.
    subCategory String
    The subcategory of the BillingRule. Required for Charge and Credit rules.
    title string
    The title of the BillingRule.
    type string
    The type of the BillingRule. Note: the values are case insensitive.
    amount number
    The amount for the BillingRule. Required for Charge and Credit rules. Example value: 300
    applyToAll boolean
    Determines if the BillingRule applies to all current and future managed accounts.
    category string
    The category of the BillingRule. Required for Charge and Credit rules.
    chargeType string
    The charge type of the BillingRule. Required for Exclusion rules.
    endDate string
    The end date of the BillingRule. ISO 8601 formatted.
    percentage number
    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.
    sqlQuery string
    The SQL query for the BillingRule. Required for Custom rules. Example value: UPDATE costs SET costs.amount = costs.amount * 0.95
    startDate string
    The start date of the BillingRule. ISO 8601 formatted.
    startPeriod string
    The start period of the BillingRule. DEPRECATED: use start_date instead.
    subCategory string
    The subcategory of the BillingRule. Required for Charge and Credit rules.
    title str
    The title of the BillingRule.
    type str
    The type of the BillingRule. Note: the values are case insensitive.
    amount float
    The amount for the BillingRule. Required for Charge and Credit rules. Example value: 300
    apply_to_all bool
    Determines if the BillingRule applies to all current and future managed accounts.
    category str
    The category of the BillingRule. Required for Charge and Credit rules.
    charge_type str
    The charge type of the BillingRule. Required for Exclusion rules.
    end_date str
    The end date of the BillingRule. ISO 8601 formatted.
    percentage float
    The percentage of the cost shown. Required for Adjustment rules. Example value: 75.0
    service str
    The service of the BillingRule. Required for Charge and Credit rules.
    sql_query str
    The SQL query for the BillingRule. Required for Custom rules. Example value: UPDATE costs SET costs.amount = costs.amount * 0.95
    start_date str
    The start date of the BillingRule. ISO 8601 formatted.
    start_period str
    The start period of the BillingRule. DEPRECATED: use start_date instead.
    sub_category str
    The subcategory of the BillingRule. Required for Charge and Credit rules.
    title String
    The title of the BillingRule.
    type String
    The type of the BillingRule. Note: the values are case insensitive.
    amount Number
    The amount for the BillingRule. Required for Charge and Credit rules. Example value: 300
    applyToAll Boolean
    Determines if the BillingRule applies to all current and future managed accounts.
    category String
    The category of the BillingRule. Required for Charge and Credit rules.
    chargeType String
    The charge type of the BillingRule. Required for Exclusion rules.
    endDate String
    The end date of the BillingRule. ISO 8601 formatted.
    percentage Number
    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.
    sqlQuery String
    The SQL query for the BillingRule. Required for Custom rules. Example value: UPDATE costs SET costs.amount = costs.amount * 0.95
    startDate String
    The start date of the BillingRule. ISO 8601 formatted.
    startPeriod String
    The start period of the BillingRule. DEPRECATED: use start_date instead.
    subCategory String
    The subcategory of the BillingRule. Required for Charge and Credit rules.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the BillingRule resource produces the following output properties:

    CreatedAt string
    The date and time, in UTC, the BillingRule was created. ISO 8601 Formatted.
    CreatedByToken string
    The token of the Creator of the BillingRule.
    Id string
    The provider-assigned unique ID for this managed resource.
    Token string
    The token of the billing rule
    CreatedAt string
    The date and time, in UTC, the BillingRule was created. ISO 8601 Formatted.
    CreatedByToken string
    The token of the Creator of the BillingRule.
    Id string
    The provider-assigned unique ID for this managed resource.
    Token string
    The token of the billing rule
    createdAt String
    The date and time, in UTC, the BillingRule was created. ISO 8601 Formatted.
    createdByToken String
    The token of the Creator of the BillingRule.
    id String
    The provider-assigned unique ID for this managed resource.
    token String
    The token of the billing rule
    createdAt string
    The date and time, in UTC, the BillingRule was created. ISO 8601 Formatted.
    createdByToken string
    The token of the Creator of the BillingRule.
    id string
    The provider-assigned unique ID for this managed resource.
    token string
    The token of the billing rule
    created_at str
    The date and time, in UTC, the BillingRule was created. ISO 8601 Formatted.
    created_by_token str
    The token of the Creator of the BillingRule.
    id str
    The provider-assigned unique ID for this managed resource.
    token str
    The token of the billing rule
    createdAt String
    The date and time, in UTC, the BillingRule was created. ISO 8601 Formatted.
    createdByToken String
    The token of the Creator of the BillingRule.
    id String
    The provider-assigned unique ID for this managed resource.
    token String
    The token of the billing rule

    Look up Existing BillingRule Resource

    Get an existing BillingRule resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: BillingRuleState, opts?: CustomResourceOptions): BillingRule
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        amount: Optional[float] = None,
        apply_to_all: Optional[bool] = None,
        category: Optional[str] = None,
        charge_type: Optional[str] = None,
        created_at: Optional[str] = None,
        created_by_token: Optional[str] = None,
        end_date: Optional[str] = None,
        percentage: Optional[float] = None,
        service: Optional[str] = None,
        sql_query: Optional[str] = None,
        start_date: Optional[str] = None,
        start_period: Optional[str] = None,
        sub_category: Optional[str] = None,
        title: Optional[str] = None,
        token: Optional[str] = None,
        type: Optional[str] = None) -> BillingRule
    func GetBillingRule(ctx *Context, name string, id IDInput, state *BillingRuleState, opts ...ResourceOption) (*BillingRule, error)
    public static BillingRule Get(string name, Input<string> id, BillingRuleState? state, CustomResourceOptions? opts = null)
    public static BillingRule get(String name, Output<String> id, BillingRuleState state, CustomResourceOptions options)
    resources:  _:    type: vantage:BillingRule    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Amount double
    The amount for the BillingRule. Required for Charge and Credit rules. Example value: 300
    ApplyToAll bool
    Determines if the BillingRule applies to all current and future managed accounts.
    Category string
    The category of the BillingRule. Required for Charge and Credit rules.
    ChargeType string
    The charge type of the BillingRule. Required for Exclusion rules.
    CreatedAt string
    The date and time, in UTC, the BillingRule was created. ISO 8601 Formatted.
    CreatedByToken string
    The token of the Creator of the BillingRule.
    EndDate string
    The end date of the BillingRule. ISO 8601 formatted.
    Percentage 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.
    SqlQuery string
    The SQL query for the BillingRule. Required for Custom rules. Example value: UPDATE costs SET costs.amount = costs.amount * 0.95
    StartDate string
    The start date of the BillingRule. ISO 8601 formatted.
    StartPeriod string
    The start period of the BillingRule. DEPRECATED: use start_date instead.
    SubCategory string
    The subcategory of the BillingRule. Required for Charge and Credit rules.
    Title string
    The title of the BillingRule.
    Token string
    The token of the billing rule
    Type string
    The type of the BillingRule. Note: the values are case insensitive.
    Amount float64
    The amount for the BillingRule. Required for Charge and Credit rules. Example value: 300
    ApplyToAll bool
    Determines if the BillingRule applies to all current and future managed accounts.
    Category string
    The category of the BillingRule. Required for Charge and Credit rules.
    ChargeType string
    The charge type of the BillingRule. Required for Exclusion rules.
    CreatedAt string
    The date and time, in UTC, the BillingRule was created. ISO 8601 Formatted.
    CreatedByToken string
    The token of the Creator of the BillingRule.
    EndDate string
    The end date of the BillingRule. ISO 8601 formatted.
    Percentage float64
    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.
    SqlQuery string
    The SQL query for the BillingRule. Required for Custom rules. Example value: UPDATE costs SET costs.amount = costs.amount * 0.95
    StartDate string
    The start date of the BillingRule. ISO 8601 formatted.
    StartPeriod string
    The start period of the BillingRule. DEPRECATED: use start_date instead.
    SubCategory string
    The subcategory of the BillingRule. Required for Charge and Credit rules.
    Title string
    The title of the BillingRule.
    Token string
    The token of the billing rule
    Type string
    The type of the BillingRule. Note: the values are case insensitive.
    amount Double
    The amount for the BillingRule. Required for Charge and Credit rules. Example value: 300
    applyToAll Boolean
    Determines if the BillingRule applies to all current and future managed accounts.
    category String
    The category of the BillingRule. Required for Charge and Credit rules.
    chargeType String
    The charge type of the BillingRule. Required for Exclusion rules.
    createdAt String
    The date and time, in UTC, the BillingRule was created. ISO 8601 Formatted.
    createdByToken String
    The token of the Creator of the BillingRule.
    endDate String
    The end date of the BillingRule. ISO 8601 formatted.
    percentage 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.
    sqlQuery String
    The SQL query for the BillingRule. Required for Custom rules. Example value: UPDATE costs SET costs.amount = costs.amount * 0.95
    startDate String
    The start date of the BillingRule. ISO 8601 formatted.
    startPeriod String
    The start period of the BillingRule. DEPRECATED: use start_date instead.
    subCategory String
    The subcategory of the BillingRule. Required for Charge and Credit rules.
    title String
    The title of the BillingRule.
    token String
    The token of the billing rule
    type String
    The type of the BillingRule. Note: the values are case insensitive.
    amount number
    The amount for the BillingRule. Required for Charge and Credit rules. Example value: 300
    applyToAll boolean
    Determines if the BillingRule applies to all current and future managed accounts.
    category string
    The category of the BillingRule. Required for Charge and Credit rules.
    chargeType string
    The charge type of the BillingRule. Required for Exclusion rules.
    createdAt string
    The date and time, in UTC, the BillingRule was created. ISO 8601 Formatted.
    createdByToken string
    The token of the Creator of the BillingRule.
    endDate string
    The end date of the BillingRule. ISO 8601 formatted.
    percentage number
    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.
    sqlQuery string
    The SQL query for the BillingRule. Required for Custom rules. Example value: UPDATE costs SET costs.amount = costs.amount * 0.95
    startDate string
    The start date of the BillingRule. ISO 8601 formatted.
    startPeriod string
    The start period of the BillingRule. DEPRECATED: use start_date instead.
    subCategory string
    The subcategory of the BillingRule. Required for Charge and Credit rules.
    title string
    The title of the BillingRule.
    token string
    The token of the billing rule
    type string
    The type of the BillingRule. Note: the values are case insensitive.
    amount float
    The amount for the BillingRule. Required for Charge and Credit rules. Example value: 300
    apply_to_all bool
    Determines if the BillingRule applies to all current and future managed accounts.
    category str
    The category of the BillingRule. Required for Charge and Credit rules.
    charge_type str
    The charge type of the BillingRule. Required for Exclusion rules.
    created_at str
    The date and time, in UTC, the BillingRule was created. ISO 8601 Formatted.
    created_by_token str
    The token of the Creator of the BillingRule.
    end_date str
    The end date of the BillingRule. ISO 8601 formatted.
    percentage float
    The percentage of the cost shown. Required for Adjustment rules. Example value: 75.0
    service str
    The service of the BillingRule. Required for Charge and Credit rules.
    sql_query str
    The SQL query for the BillingRule. Required for Custom rules. Example value: UPDATE costs SET costs.amount = costs.amount * 0.95
    start_date str
    The start date of the BillingRule. ISO 8601 formatted.
    start_period str
    The start period of the BillingRule. DEPRECATED: use start_date instead.
    sub_category str
    The subcategory of the BillingRule. Required for Charge and Credit rules.
    title str
    The title of the BillingRule.
    token str
    The token of the billing rule
    type str
    The type of the BillingRule. Note: the values are case insensitive.
    amount Number
    The amount for the BillingRule. Required for Charge and Credit rules. Example value: 300
    applyToAll Boolean
    Determines if the BillingRule applies to all current and future managed accounts.
    category String
    The category of the BillingRule. Required for Charge and Credit rules.
    chargeType String
    The charge type of the BillingRule. Required for Exclusion rules.
    createdAt String
    The date and time, in UTC, the BillingRule was created. ISO 8601 Formatted.
    createdByToken String
    The token of the Creator of the BillingRule.
    endDate String
    The end date of the BillingRule. ISO 8601 formatted.
    percentage Number
    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.
    sqlQuery String
    The SQL query for the BillingRule. Required for Custom rules. Example value: UPDATE costs SET costs.amount = costs.amount * 0.95
    startDate String
    The start date of the BillingRule. ISO 8601 formatted.
    startPeriod String
    The start period of the BillingRule. DEPRECATED: use start_date instead.
    subCategory String
    The subcategory of the BillingRule. Required for Charge and Credit rules.
    title String
    The title of the BillingRule.
    token String
    The token of the billing rule
    type String
    The type of the BillingRule. Note: the values are case insensitive.

    Package Details

    Repository
    vantage vantage-sh/terraform-provider-vantage
    License
    Notes
    This Pulumi package is based on the vantage Terraform Provider.
    vantage logo
    vantage 0.1.65 published on Wednesday, Sep 10, 2025 by vantage-sh
    vantage-sh/terraform-provider-vantage