1. Packages
  2. Aiven Provider
  3. API Docs
  4. BillingGroup
Viewing docs for Aiven v4.5.2 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
aiven logo
Viewing docs for Aiven v4.5.2 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

    The Billing Group resource allows the creation and management of Aiven Billing Groups and association with the Projects.

    Example Usage

    using Pulumi;
    using Aiven = Pulumi.Aiven;
    
    class MyStack : Stack
    {
        public MyStack()
        {
            var bybg1 = new Aiven.BillingGroup("bybg1", new Aiven.BillingGroupArgs
            {
                BillingCurrency = "USD",
                VatId = "123ABC",
            });
            var pr1 = new Aiven.Project("pr1", new Aiven.ProjectArgs
            {
                Project = "pr1",
                BillingGroup = bybg1.Id,
            });
        }
    
    }
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aiven/sdk/v4/go/aiven"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		bybg1, err := aiven.NewBillingGroup(ctx, "bybg1", &aiven.BillingGroupArgs{
    			BillingCurrency: pulumi.String("USD"),
    			VatId:           pulumi.String("123ABC"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = aiven.NewProject(ctx, "pr1", &aiven.ProjectArgs{
    			Project:      pulumi.String("pr1"),
    			BillingGroup: bybg1.ID(),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    

    Example coming soon!

    import * as pulumi from "@pulumi/pulumi";
    import * as aiven from "@pulumi/aiven";
    
    const bybg1 = new aiven.BillingGroup("bybg1", {
        billingCurrency: "USD",
        vatId: "123ABC",
    });
    const pr1 = new aiven.Project("pr1", {
        project: "pr1",
        billingGroup: bybg1.id,
    });
    
    import pulumi
    import pulumi_aiven as aiven
    
    bybg1 = aiven.BillingGroup("bybg1",
        billing_currency="USD",
        vat_id="123ABC")
    pr1 = aiven.Project("pr1",
        project="pr1",
        billing_group=bybg1.id)
    

    Example coming soon!

    Create BillingGroup Resource

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

    Constructor syntax

    new BillingGroup(name: string, args?: BillingGroupArgs, opts?: CustomResourceOptions);
    @overload
    def BillingGroup(resource_name: str,
                     args: Optional[BillingGroupArgs] = None,
                     opts: Optional[ResourceOptions] = None)
    
    @overload
    def BillingGroup(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     account_id: Optional[str] = None,
                     address_lines: Optional[Sequence[str]] = None,
                     billing_currency: Optional[str] = None,
                     billing_emails: Optional[Sequence[str]] = None,
                     billing_extra_text: Optional[str] = None,
                     card_id: Optional[str] = None,
                     city: Optional[str] = None,
                     company: Optional[str] = None,
                     country_code: Optional[str] = None,
                     name: Optional[str] = None,
                     state: Optional[str] = None,
                     vat_id: Optional[str] = None,
                     zip_code: Optional[str] = None)
    func NewBillingGroup(ctx *Context, name string, args *BillingGroupArgs, opts ...ResourceOption) (*BillingGroup, error)
    public BillingGroup(string name, BillingGroupArgs? args = null, CustomResourceOptions? opts = null)
    public BillingGroup(String name, BillingGroupArgs args)
    public BillingGroup(String name, BillingGroupArgs args, CustomResourceOptions options)
    
    type: aiven:BillingGroup
    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 BillingGroupArgs
    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 BillingGroupArgs
    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 BillingGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BillingGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BillingGroupArgs
    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 billingGroupResource = new Aiven.BillingGroup("billingGroupResource", new()
    {
        AccountId = "string",
        AddressLines = new[]
        {
            "string",
        },
        BillingCurrency = "string",
        BillingEmails = new[]
        {
            "string",
        },
        BillingExtraText = "string",
        CardId = "string",
        City = "string",
        Company = "string",
        CountryCode = "string",
        Name = "string",
        State = "string",
        VatId = "string",
        ZipCode = "string",
    });
    
    example, err := aiven.NewBillingGroup(ctx, "billingGroupResource", &aiven.BillingGroupArgs{
    	AccountId: pulumi.String("string"),
    	AddressLines: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	BillingCurrency: pulumi.String("string"),
    	BillingEmails: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	BillingExtraText: pulumi.String("string"),
    	CardId:           pulumi.String("string"),
    	City:             pulumi.String("string"),
    	Company:          pulumi.String("string"),
    	CountryCode:      pulumi.String("string"),
    	Name:             pulumi.String("string"),
    	State:            pulumi.String("string"),
    	VatId:            pulumi.String("string"),
    	ZipCode:          pulumi.String("string"),
    })
    
    var billingGroupResource = new BillingGroup("billingGroupResource", BillingGroupArgs.builder()
        .accountId("string")
        .addressLines("string")
        .billingCurrency("string")
        .billingEmails("string")
        .billingExtraText("string")
        .cardId("string")
        .city("string")
        .company("string")
        .countryCode("string")
        .name("string")
        .state("string")
        .vatId("string")
        .zipCode("string")
        .build());
    
    billing_group_resource = aiven.BillingGroup("billingGroupResource",
        account_id="string",
        address_lines=["string"],
        billing_currency="string",
        billing_emails=["string"],
        billing_extra_text="string",
        card_id="string",
        city="string",
        company="string",
        country_code="string",
        name="string",
        state="string",
        vat_id="string",
        zip_code="string")
    
    const billingGroupResource = new aiven.BillingGroup("billingGroupResource", {
        accountId: "string",
        addressLines: ["string"],
        billingCurrency: "string",
        billingEmails: ["string"],
        billingExtraText: "string",
        cardId: "string",
        city: "string",
        company: "string",
        countryCode: "string",
        name: "string",
        state: "string",
        vatId: "string",
        zipCode: "string",
    });
    
    type: aiven:BillingGroup
    properties:
        accountId: string
        addressLines:
            - string
        billingCurrency: string
        billingEmails:
            - string
        billingExtraText: string
        cardId: string
        city: string
        company: string
        countryCode: string
        name: string
        state: string
        vatId: string
        zipCode: string
    

    BillingGroup 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 BillingGroup resource accepts the following input properties:

    AccountId string
    Account id
    AddressLines List<string>
    Address lines
    BillingCurrency string
    Billing currency
    BillingEmails List<string>
    Billing contact emails
    BillingExtraText string
    Billing extra text
    CardId string
    Credit card id
    City string
    City
    Company string
    Company name
    CountryCode string
    Country code
    Name string
    Billing Group name
    State string
    State
    VatId string
    VAT id
    ZipCode string
    Zip Code
    AccountId string
    Account id
    AddressLines []string
    Address lines
    BillingCurrency string
    Billing currency
    BillingEmails []string
    Billing contact emails
    BillingExtraText string
    Billing extra text
    CardId string
    Credit card id
    City string
    City
    Company string
    Company name
    CountryCode string
    Country code
    Name string
    Billing Group name
    State string
    State
    VatId string
    VAT id
    ZipCode string
    Zip Code
    accountId String
    Account id
    addressLines List<String>
    Address lines
    billingCurrency String
    Billing currency
    billingEmails List<String>
    Billing contact emails
    billingExtraText String
    Billing extra text
    cardId String
    Credit card id
    city String
    City
    company String
    Company name
    countryCode String
    Country code
    name String
    Billing Group name
    state String
    State
    vatId String
    VAT id
    zipCode String
    Zip Code
    accountId string
    Account id
    addressLines string[]
    Address lines
    billingCurrency string
    Billing currency
    billingEmails string[]
    Billing contact emails
    billingExtraText string
    Billing extra text
    cardId string
    Credit card id
    city string
    City
    company string
    Company name
    countryCode string
    Country code
    name string
    Billing Group name
    state string
    State
    vatId string
    VAT id
    zipCode string
    Zip Code
    account_id str
    Account id
    address_lines Sequence[str]
    Address lines
    billing_currency str
    Billing currency
    billing_emails Sequence[str]
    Billing contact emails
    billing_extra_text str
    Billing extra text
    card_id str
    Credit card id
    city str
    City
    company str
    Company name
    country_code str
    Country code
    name str
    Billing Group name
    state str
    State
    vat_id str
    VAT id
    zip_code str
    Zip Code
    accountId String
    Account id
    addressLines List<String>
    Address lines
    billingCurrency String
    Billing currency
    billingEmails List<String>
    Billing contact emails
    billingExtraText String
    Billing extra text
    cardId String
    Credit card id
    city String
    City
    company String
    Company name
    countryCode String
    Country code
    name String
    Billing Group name
    state String
    State
    vatId String
    VAT id
    zipCode String
    Zip Code

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing BillingGroup Resource

    Get an existing BillingGroup 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?: BillingGroupState, opts?: CustomResourceOptions): BillingGroup
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            account_id: Optional[str] = None,
            address_lines: Optional[Sequence[str]] = None,
            billing_currency: Optional[str] = None,
            billing_emails: Optional[Sequence[str]] = None,
            billing_extra_text: Optional[str] = None,
            card_id: Optional[str] = None,
            city: Optional[str] = None,
            company: Optional[str] = None,
            country_code: Optional[str] = None,
            name: Optional[str] = None,
            state: Optional[str] = None,
            vat_id: Optional[str] = None,
            zip_code: Optional[str] = None) -> BillingGroup
    func GetBillingGroup(ctx *Context, name string, id IDInput, state *BillingGroupState, opts ...ResourceOption) (*BillingGroup, error)
    public static BillingGroup Get(string name, Input<string> id, BillingGroupState? state, CustomResourceOptions? opts = null)
    public static BillingGroup get(String name, Output<String> id, BillingGroupState state, CustomResourceOptions options)
    resources:  _:    type: aiven:BillingGroup    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:
    AccountId string
    Account id
    AddressLines List<string>
    Address lines
    BillingCurrency string
    Billing currency
    BillingEmails List<string>
    Billing contact emails
    BillingExtraText string
    Billing extra text
    CardId string
    Credit card id
    City string
    City
    Company string
    Company name
    CountryCode string
    Country code
    Name string
    Billing Group name
    State string
    State
    VatId string
    VAT id
    ZipCode string
    Zip Code
    AccountId string
    Account id
    AddressLines []string
    Address lines
    BillingCurrency string
    Billing currency
    BillingEmails []string
    Billing contact emails
    BillingExtraText string
    Billing extra text
    CardId string
    Credit card id
    City string
    City
    Company string
    Company name
    CountryCode string
    Country code
    Name string
    Billing Group name
    State string
    State
    VatId string
    VAT id
    ZipCode string
    Zip Code
    accountId String
    Account id
    addressLines List<String>
    Address lines
    billingCurrency String
    Billing currency
    billingEmails List<String>
    Billing contact emails
    billingExtraText String
    Billing extra text
    cardId String
    Credit card id
    city String
    City
    company String
    Company name
    countryCode String
    Country code
    name String
    Billing Group name
    state String
    State
    vatId String
    VAT id
    zipCode String
    Zip Code
    accountId string
    Account id
    addressLines string[]
    Address lines
    billingCurrency string
    Billing currency
    billingEmails string[]
    Billing contact emails
    billingExtraText string
    Billing extra text
    cardId string
    Credit card id
    city string
    City
    company string
    Company name
    countryCode string
    Country code
    name string
    Billing Group name
    state string
    State
    vatId string
    VAT id
    zipCode string
    Zip Code
    account_id str
    Account id
    address_lines Sequence[str]
    Address lines
    billing_currency str
    Billing currency
    billing_emails Sequence[str]
    Billing contact emails
    billing_extra_text str
    Billing extra text
    card_id str
    Credit card id
    city str
    City
    company str
    Company name
    country_code str
    Country code
    name str
    Billing Group name
    state str
    State
    vat_id str
    VAT id
    zip_code str
    Zip Code
    accountId String
    Account id
    addressLines List<String>
    Address lines
    billingCurrency String
    Billing currency
    billingEmails List<String>
    Billing contact emails
    billingExtraText String
    Billing extra text
    cardId String
    Credit card id
    city String
    City
    company String
    Company name
    countryCode String
    Country code
    name String
    Billing Group name
    state String
    State
    vatId String
    VAT id
    zipCode String
    Zip Code

    Package Details

    Repository
    Aiven pulumi/pulumi-aiven
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aiven Terraform Provider.
    aiven logo
    Viewing docs for Aiven v4.5.2 (Older version)
    published on Monday, Mar 9, 2026 by Pulumi
      Try Pulumi Cloud free. Your team will thank you.