1. Packages
  2. Planetscale Provider
  3. API Docs
  4. getOrganization
Viewing docs for planetscale 1.0.0
published on Monday, Mar 2, 2026 by planetscale
Schema (JSON)
planetscale/terraform-provider-planetscale

planetscale.getOrganization

planetscale logo
Viewing docs for planetscale 1.0.0
published on Monday, Mar 2, 2026 by planetscale
Schema (JSON)
planetscale/terraform-provider-planetscale

    Organization DataSource

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as planetscale from "@pulumi/planetscale";

const myOrganization = planetscale.getOrganization({
    organization: "...my_organization...",
});

    import pulumi
import pulumi_planetscale as planetscale

my_organization = planetscale.get_organization(organization="...my_organization...")

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/planetscale/planetscale"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := planetscale.GetOrganization(ctx, &planetscale.GetOrganizationArgs{
			Organization: "...my_organization...",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Planetscale = Pulumi.Planetscale;

return await Deployment.RunAsync(() => 
{
    var myOrganization = Planetscale.GetOrganization.Invoke(new()
    {
        Organization = "...my_organization...",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.planetscale.PlanetscaleFunctions;
import com.pulumi.planetscale.inputs.GetOrganizationArgs;
import java.util.List;
import java.util.ArrayList;
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 myOrganization = PlanetscaleFunctions.getOrganization(GetOrganizationArgs.builder()
            .organization("...my_organization...")
            .build());

    }
}

    variables:
  myOrganization:
    fn::invoke:
      function: planetscale:getOrganization
      arguments:
        organization: '...my_organization...'

    Using getOrganization

    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 getOrganization(args: GetOrganizationArgs, opts?: InvokeOptions): Promise<GetOrganizationResult>
function getOrganizationOutput(args: GetOrganizationOutputArgs, opts?: InvokeOptions): Output<GetOrganizationResult>
    def get_organization(organization: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetOrganizationResult
def get_organization_output(organization: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetOrganizationResult]
    func GetOrganization(ctx *Context, args *GetOrganizationArgs, opts ...InvokeOption) (*GetOrganizationResult, error)
func GetOrganizationOutput(ctx *Context, args *GetOrganizationOutputArgs, opts ...InvokeOption) GetOrganizationResultOutput

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

    public static class GetOrganization 
{
    public static Task<GetOrganizationResult> InvokeAsync(GetOrganizationArgs args, InvokeOptions? opts = null)
    public static Output<GetOrganizationResult> Invoke(GetOrganizationInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetOrganizationResult> getOrganization(GetOrganizationArgs args, InvokeOptions options)
public static Output<GetOrganizationResult> getOrganization(GetOrganizationArgs args, InvokeOptions options)

    fn::invoke:
  function: planetscale:index/getOrganization:getOrganization
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Organization string
    Organization name slug from list_organizations. Example: acme.
    Organization string
    Organization name slug from list_organizations. Example: acme.
    organization String
    Organization name slug from list_organizations. Example: acme.
    organization string
    Organization name slug from list_organizations. Example: acme.
    organization str
    Organization name slug from list_organizations. Example: acme.
    organization String
    Organization name slug from list_organizations. Example: acme.

    getOrganization Result

    The following output properties are available:

    BillingEmail string
    The billing email of the organization
    CreatedAt string
    When the organization was created
    DatabaseCount double
    The number of databases in the organization
    Features Dictionary<string, string>
    Features that can be enabled on the organization
    HasCard bool
    Whether or not the organization has a payment method on file
    HasPastDueInvoices bool
    Whether or not the organization has past due billing invoices
    Id string
    The ID for the organization
    IdpManagedRoles bool
    Whether or not the IdP provider is be responsible for managing roles in PlanetScale
    InvoiceBudgetAmount string
    The expected monthly budget for the organization
    KeyspaceShardLimit double
    The keyspace shard limit for the organization
    ManagedTenancy bool
    Whether or not the organization has managed tenancy enabled
    Name string
    The name of the organization
    Organization string
    Organization name slug from list_organizations. Example: acme.
    PaymentInfoRequired bool
    Whether or not the organization requires payment information
    Plan string
    The billing plan of the organization
    SingleTenancy bool
    Whether or not the organization has single tenancy enabled
    Sso bool
    Whether or not SSO is enabled on the organization
    SsoDirectory bool
    Whether or not the organization uses an SSO directory
    SsoPortalUrl string
    The URL of the organization's SSO portal
    UpdatedAt string
    When the organization was last updated
    ValidBillingInfo bool
    Whether or not the organization's billing information is valid
    BillingEmail string
    The billing email of the organization
    CreatedAt string
    When the organization was created
    DatabaseCount float64
    The number of databases in the organization
    Features map[string]string
    Features that can be enabled on the organization
    HasCard bool
    Whether or not the organization has a payment method on file
    HasPastDueInvoices bool
    Whether or not the organization has past due billing invoices
    Id string
    The ID for the organization
    IdpManagedRoles bool
    Whether or not the IdP provider is be responsible for managing roles in PlanetScale
    InvoiceBudgetAmount string
    The expected monthly budget for the organization
    KeyspaceShardLimit float64
    The keyspace shard limit for the organization
    ManagedTenancy bool
    Whether or not the organization has managed tenancy enabled
    Name string
    The name of the organization
    Organization string
    Organization name slug from list_organizations. Example: acme.
    PaymentInfoRequired bool
    Whether or not the organization requires payment information
    Plan string
    The billing plan of the organization
    SingleTenancy bool
    Whether or not the organization has single tenancy enabled
    Sso bool
    Whether or not SSO is enabled on the organization
    SsoDirectory bool
    Whether or not the organization uses an SSO directory
    SsoPortalUrl string
    The URL of the organization's SSO portal
    UpdatedAt string
    When the organization was last updated
    ValidBillingInfo bool
    Whether or not the organization's billing information is valid
    billingEmail String
    The billing email of the organization
    createdAt String
    When the organization was created
    databaseCount Double
    The number of databases in the organization
    features Map<String,String>
    Features that can be enabled on the organization
    hasCard Boolean
    Whether or not the organization has a payment method on file
    hasPastDueInvoices Boolean
    Whether or not the organization has past due billing invoices
    id String
    The ID for the organization
    idpManagedRoles Boolean
    Whether or not the IdP provider is be responsible for managing roles in PlanetScale
    invoiceBudgetAmount String
    The expected monthly budget for the organization
    keyspaceShardLimit Double
    The keyspace shard limit for the organization
    managedTenancy Boolean
    Whether or not the organization has managed tenancy enabled
    name String
    The name of the organization
    organization String
    Organization name slug from list_organizations. Example: acme.
    paymentInfoRequired Boolean
    Whether or not the organization requires payment information
    plan String
    The billing plan of the organization
    singleTenancy Boolean
    Whether or not the organization has single tenancy enabled
    sso Boolean
    Whether or not SSO is enabled on the organization
    ssoDirectory Boolean
    Whether or not the organization uses an SSO directory
    ssoPortalUrl String
    The URL of the organization's SSO portal
    updatedAt String
    When the organization was last updated
    validBillingInfo Boolean
    Whether or not the organization's billing information is valid
    billingEmail string
    The billing email of the organization
    createdAt string
    When the organization was created
    databaseCount number
    The number of databases in the organization
    features {[key: string]: string}
    Features that can be enabled on the organization
    hasCard boolean
    Whether or not the organization has a payment method on file
    hasPastDueInvoices boolean
    Whether or not the organization has past due billing invoices
    id string
    The ID for the organization
    idpManagedRoles boolean
    Whether or not the IdP provider is be responsible for managing roles in PlanetScale
    invoiceBudgetAmount string
    The expected monthly budget for the organization
    keyspaceShardLimit number
    The keyspace shard limit for the organization
    managedTenancy boolean
    Whether or not the organization has managed tenancy enabled
    name string
    The name of the organization
    organization string
    Organization name slug from list_organizations. Example: acme.
    paymentInfoRequired boolean
    Whether or not the organization requires payment information
    plan string
    The billing plan of the organization
    singleTenancy boolean
    Whether or not the organization has single tenancy enabled
    sso boolean
    Whether or not SSO is enabled on the organization
    ssoDirectory boolean
    Whether or not the organization uses an SSO directory
    ssoPortalUrl string
    The URL of the organization's SSO portal
    updatedAt string
    When the organization was last updated
    validBillingInfo boolean
    Whether or not the organization's billing information is valid
    billing_email str
    The billing email of the organization
    created_at str
    When the organization was created
    database_count float
    The number of databases in the organization
    features Mapping[str, str]
    Features that can be enabled on the organization
    has_card bool
    Whether or not the organization has a payment method on file
    has_past_due_invoices bool
    Whether or not the organization has past due billing invoices
    id str
    The ID for the organization
    idp_managed_roles bool
    Whether or not the IdP provider is be responsible for managing roles in PlanetScale
    invoice_budget_amount str
    The expected monthly budget for the organization
    keyspace_shard_limit float
    The keyspace shard limit for the organization
    managed_tenancy bool
    Whether or not the organization has managed tenancy enabled
    name str
    The name of the organization
    organization str
    Organization name slug from list_organizations. Example: acme.
    payment_info_required bool
    Whether or not the organization requires payment information
    plan str
    The billing plan of the organization
    single_tenancy bool
    Whether or not the organization has single tenancy enabled
    sso bool
    Whether or not SSO is enabled on the organization
    sso_directory bool
    Whether or not the organization uses an SSO directory
    sso_portal_url str
    The URL of the organization's SSO portal
    updated_at str
    When the organization was last updated
    valid_billing_info bool
    Whether or not the organization's billing information is valid
    billingEmail String
    The billing email of the organization
    createdAt String
    When the organization was created
    databaseCount Number
    The number of databases in the organization
    features Map<String>
    Features that can be enabled on the organization
    hasCard Boolean
    Whether or not the organization has a payment method on file
    hasPastDueInvoices Boolean
    Whether or not the organization has past due billing invoices
    id String
    The ID for the organization
    idpManagedRoles Boolean
    Whether or not the IdP provider is be responsible for managing roles in PlanetScale
    invoiceBudgetAmount String
    The expected monthly budget for the organization
    keyspaceShardLimit Number
    The keyspace shard limit for the organization
    managedTenancy Boolean
    Whether or not the organization has managed tenancy enabled
    name String
    The name of the organization
    organization String
    Organization name slug from list_organizations. Example: acme.
    paymentInfoRequired Boolean
    Whether or not the organization requires payment information
    plan String
    The billing plan of the organization
    singleTenancy Boolean
    Whether or not the organization has single tenancy enabled
    sso Boolean
    Whether or not SSO is enabled on the organization
    ssoDirectory Boolean
    Whether or not the organization uses an SSO directory
    ssoPortalUrl String
    The URL of the organization's SSO portal
    updatedAt String
    When the organization was last updated
    validBillingInfo Boolean
    Whether or not the organization's billing information is valid

    Package Details

    Repository
    planetscale planetscale/terraform-provider-planetscale
    License
    Notes
    This Pulumi package is based on the planetscale Terraform Provider.
    planetscale logo
    Viewing docs for planetscale 1.0.0
    published on Monday, Mar 2, 2026 by planetscale
    Schema (JSON)
    planetscale/terraform-provider-planetscale
      Try Pulumi Cloud free. Your team will thank you.