1. Registry
  2. Packages
  3. dbt Cloud Provider
  4. API Docs
  5. getAccountAddOn
Viewing docs for dbt Cloud v1.11.7
published on Thursday, Sep 24, 2026 by Pulumi
dbtcloud logo
Viewing docs for dbt Cloud v1.11.7
published on Thursday, Sep 24, 2026 by Pulumi

    Retrieve the state of one usage-based add-on product of the account, such as dbt Wizard or dbt State.

    The token needs the billing permission of the account. A product that is turned off for the account cannot be read at all, and wizard is only available while AI features are turned on.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as dbtcloud from "@pulumi/dbtcloud";
    
    const wizard = dbtcloud.getAccountAddOn({
        product: "wizard",
    });
    export const wizardState = wizard.then(wizard => wizard.state);
    
    import pulumi
    import pulumi_dbtcloud as dbtcloud
    
    wizard = dbtcloud.get_account_add_on(product="wizard")
    pulumi.export("wizardState", wizard.state)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-dbtcloud/sdk/go/dbtcloud"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		wizard, err := dbtcloud.GetAccountAddOn(ctx, &dbtcloud.GetAccountAddOnArgs{
    			Product: "wizard",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("wizardState", wizard.State)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using DbtCloud = Pulumi.DbtCloud;
    
    return await Deployment.RunAsync(() => 
    {
        var wizard = DbtCloud.GetAccountAddOn.Invoke(new()
        {
            Product = "wizard",
        });
    
        return new Dictionary<string, object?>
        {
            ["wizardState"] = wizard.Apply(getAccountAddOnResult => getAccountAddOnResult.State),
        };
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.dbtcloud.DbtcloudFunctions;
    import com.pulumi.dbtcloud.inputs.GetAccountAddOnArgs;
    import java.util.ArrayList;
    import java.util.Arrays;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var wizard = DbtcloudFunctions.getAccountAddOn(GetAccountAddOnArgs.builder()
                .product("wizard")
                .build());
    
            ctx.export("wizardState", wizard.state());
        }
    }
    
    variables:
      wizard:
        fn::invoke:
          function: dbtcloud:getAccountAddOn
          arguments:
            product: wizard
    outputs:
      wizardState: ${wizard.state}
    
    pulumi {
      required_providers {
        dbtcloud = {
          source = "pulumi/dbtcloud"
        }
      }
    }
    
    data "dbtcloud_getaccountaddon" "wizard" {
      product = "wizard"
    }
    
    output "wizardState" {
      value = data.dbtcloud_getaccountaddon.wizard.state
    }
    

    Using getAccountAddOn

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getAccountAddOn(args: GetAccountAddOnArgs, opts?: InvokeOptions): Promise<GetAccountAddOnResult>
    function getAccountAddOnOutput(args: GetAccountAddOnOutputArgs, opts?: InvokeOutputOptions): Output<GetAccountAddOnResult>
    def get_account_add_on(product: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetAccountAddOnResult
    def get_account_add_on_output(product: pulumi.Input[Optional[str]] = None,
                           opts: Optional[InvokeOutputOptions] = None) -> Output[GetAccountAddOnResult]
    func GetAccountAddOn(ctx *Context, args *GetAccountAddOnArgs, opts ...InvokeOption) (*GetAccountAddOnResult, error)
    func GetAccountAddOnOutput(ctx *Context, args *GetAccountAddOnOutputArgs, opts ...InvokeOption) GetAccountAddOnResultOutput

    > Note: This function is named GetAccountAddOn in the Go SDK.

    public static class GetAccountAddOn 
    {
        public static Task<GetAccountAddOnResult> InvokeAsync(GetAccountAddOnArgs args, InvokeOptions? opts = null)
        public static Output<GetAccountAddOnResult> Invoke(GetAccountAddOnInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetAccountAddOnResult> Invoke(GetAccountAddOnInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetAccountAddOnResult> getAccountAddOn(GetAccountAddOnArgs args, InvokeOptions options)
    public static Output<GetAccountAddOnResult> getAccountAddOn(GetAccountAddOnArgs args, InvokeOptions options)
    public static Output<GetAccountAddOnResult> getAccountAddOn(GetAccountAddOnArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: dbtcloud:index/getAccountAddOn:getAccountAddOn
      arguments:
        # arguments dictionary
    data "dbtcloud_get_account_add_on" "name" {
        # arguments
    }

    The following arguments are supported:

    Product string
    The add-on product to look up. One of wizard or state
    Product string
    The add-on product to look up. One of wizard or state
    product string
    The add-on product to look up. One of wizard or state
    product String
    The add-on product to look up. One of wizard or state
    product string
    The add-on product to look up. One of wizard or state
    product str
    The add-on product to look up. One of wizard or state
    product String
    The add-on product to look up. One of wizard or state

    getAccountAddOn Result

    The following output properties are available:

    CanActivate bool
    Whether the account can start paid use of this product now
    CanTrial bool
    Whether the account can start a trial of this product now
    Id string
    The add-on product
    Product string
    The add-on product to look up. One of wizard or state
    SpendLimitNanodollars int
    The spend limit set for the add-on, in nanodollars. 1 USD is 1,000,000,000 nanodollars. Empty when no limit is set. The limit works differently for each product. For wizard it stops usage: the account can no longer use the product once it reaches the limit. For state nothing is stopped, and the limit only raises a usage alert. Change the limit in the dbt platform, because this provider only reads it.
    State string
    The lifecycle state of the add-on: TRIAL, ACTIVE, CANCELLED or EXPIRED. Empty when the account has never turned the product on. A trial moves to EXPIRED on its own when it ends
    TrialConsumed bool
    Whether the account has used its one trial of this product
    TrialEndsAt string
    When the trial ends
    TrialStartedAt string
    When the trial started
    CanActivate bool
    Whether the account can start paid use of this product now
    CanTrial bool
    Whether the account can start a trial of this product now
    Id string
    The add-on product
    Product string
    The add-on product to look up. One of wizard or state
    SpendLimitNanodollars int
    The spend limit set for the add-on, in nanodollars. 1 USD is 1,000,000,000 nanodollars. Empty when no limit is set. The limit works differently for each product. For wizard it stops usage: the account can no longer use the product once it reaches the limit. For state nothing is stopped, and the limit only raises a usage alert. Change the limit in the dbt platform, because this provider only reads it.
    State string
    The lifecycle state of the add-on: TRIAL, ACTIVE, CANCELLED or EXPIRED. Empty when the account has never turned the product on. A trial moves to EXPIRED on its own when it ends
    TrialConsumed bool
    Whether the account has used its one trial of this product
    TrialEndsAt string
    When the trial ends
    TrialStartedAt string
    When the trial started
    can_activate bool
    Whether the account can start paid use of this product now
    can_trial bool
    Whether the account can start a trial of this product now
    id string
    The add-on product
    product string
    The add-on product to look up. One of wizard or state
    spend_limit_nanodollars number
    The spend limit set for the add-on, in nanodollars. 1 USD is 1,000,000,000 nanodollars. Empty when no limit is set. The limit works differently for each product. For wizard it stops usage: the account can no longer use the product once it reaches the limit. For state nothing is stopped, and the limit only raises a usage alert. Change the limit in the dbt platform, because this provider only reads it.
    state string
    The lifecycle state of the add-on: TRIAL, ACTIVE, CANCELLED or EXPIRED. Empty when the account has never turned the product on. A trial moves to EXPIRED on its own when it ends
    trial_consumed bool
    Whether the account has used its one trial of this product
    trial_ends_at string
    When the trial ends
    trial_started_at string
    When the trial started
    canActivate Boolean
    Whether the account can start paid use of this product now
    canTrial Boolean
    Whether the account can start a trial of this product now
    id String
    The add-on product
    product String
    The add-on product to look up. One of wizard or state
    spendLimitNanodollars Integer
    The spend limit set for the add-on, in nanodollars. 1 USD is 1,000,000,000 nanodollars. Empty when no limit is set. The limit works differently for each product. For wizard it stops usage: the account can no longer use the product once it reaches the limit. For state nothing is stopped, and the limit only raises a usage alert. Change the limit in the dbt platform, because this provider only reads it.
    state String
    The lifecycle state of the add-on: TRIAL, ACTIVE, CANCELLED or EXPIRED. Empty when the account has never turned the product on. A trial moves to EXPIRED on its own when it ends
    trialConsumed Boolean
    Whether the account has used its one trial of this product
    trialEndsAt String
    When the trial ends
    trialStartedAt String
    When the trial started
    canActivate boolean
    Whether the account can start paid use of this product now
    canTrial boolean
    Whether the account can start a trial of this product now
    id string
    The add-on product
    product string
    The add-on product to look up. One of wizard or state
    spendLimitNanodollars number
    The spend limit set for the add-on, in nanodollars. 1 USD is 1,000,000,000 nanodollars. Empty when no limit is set. The limit works differently for each product. For wizard it stops usage: the account can no longer use the product once it reaches the limit. For state nothing is stopped, and the limit only raises a usage alert. Change the limit in the dbt platform, because this provider only reads it.
    state string
    The lifecycle state of the add-on: TRIAL, ACTIVE, CANCELLED or EXPIRED. Empty when the account has never turned the product on. A trial moves to EXPIRED on its own when it ends
    trialConsumed boolean
    Whether the account has used its one trial of this product
    trialEndsAt string
    When the trial ends
    trialStartedAt string
    When the trial started
    can_activate bool
    Whether the account can start paid use of this product now
    can_trial bool
    Whether the account can start a trial of this product now
    id str
    The add-on product
    product str
    The add-on product to look up. One of wizard or state
    spend_limit_nanodollars int
    The spend limit set for the add-on, in nanodollars. 1 USD is 1,000,000,000 nanodollars. Empty when no limit is set. The limit works differently for each product. For wizard it stops usage: the account can no longer use the product once it reaches the limit. For state nothing is stopped, and the limit only raises a usage alert. Change the limit in the dbt platform, because this provider only reads it.
    state str
    The lifecycle state of the add-on: TRIAL, ACTIVE, CANCELLED or EXPIRED. Empty when the account has never turned the product on. A trial moves to EXPIRED on its own when it ends
    trial_consumed bool
    Whether the account has used its one trial of this product
    trial_ends_at str
    When the trial ends
    trial_started_at str
    When the trial started
    canActivate Boolean
    Whether the account can start paid use of this product now
    canTrial Boolean
    Whether the account can start a trial of this product now
    id String
    The add-on product
    product String
    The add-on product to look up. One of wizard or state
    spendLimitNanodollars Number
    The spend limit set for the add-on, in nanodollars. 1 USD is 1,000,000,000 nanodollars. Empty when no limit is set. The limit works differently for each product. For wizard it stops usage: the account can no longer use the product once it reaches the limit. For state nothing is stopped, and the limit only raises a usage alert. Change the limit in the dbt platform, because this provider only reads it.
    state String
    The lifecycle state of the add-on: TRIAL, ACTIVE, CANCELLED or EXPIRED. Empty when the account has never turned the product on. A trial moves to EXPIRED on its own when it ends
    trialConsumed Boolean
    Whether the account has used its one trial of this product
    trialEndsAt String
    When the trial ends
    trialStartedAt String
    When the trial started

    Package Details

    Repository
    dbtcloud pulumi/pulumi-dbtcloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the dbtcloud Terraform Provider.
    dbtcloud logo
    Viewing docs for dbt Cloud v1.11.7
    published on Thursday, Sep 24, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial