Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Stripe Provider
  4. API Docs
  5. BillingPortalConfiguration
Viewing docs for Stripe 0.3.0
published on Friday, Aug 14, 2026 by Pulumi
Schema (JSON)
stripe/terraform-provider-stripe

stripe.BillingPortalConfiguration

Viewing docs for Stripe 0.3.0
published on Friday, Aug 14, 2026 by Pulumi
Schema (JSON)
stripe/terraform-provider-stripe

    A portal configuration describes the functionality and behavior you embed in a portal session. Related guide: Configure the customer portal.

    Create BillingPortalConfiguration Resource

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

    Constructor syntax

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

@overload
def BillingPortalConfiguration(resource_name: str,
                               opts: Optional[ResourceOptions] = None,
                               features: Optional[BillingPortalConfigurationFeaturesArgs] = None,
                               active: Optional[bool] = None,
                               business_profile: Optional[BillingPortalConfigurationBusinessProfileArgs] = None,
                               default_return_url: Optional[str] = None,
                               login_page: Optional[BillingPortalConfigurationLoginPageArgs] = None,
                               metadata: Optional[Mapping[str, str]] = None,
                               name: Optional[str] = None)
    func NewBillingPortalConfiguration(ctx *Context, name string, args BillingPortalConfigurationArgs, opts ...ResourceOption) (*BillingPortalConfiguration, error)
    public BillingPortalConfiguration(string name, BillingPortalConfigurationArgs args, CustomResourceOptions? opts = null)
    public BillingPortalConfiguration(String name, BillingPortalConfigurationArgs args)
public BillingPortalConfiguration(String name, BillingPortalConfigurationArgs args, CustomResourceOptions options)

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


    resource "stripe_billing_portal_configuration" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args BillingPortalConfigurationArgs
    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 BillingPortalConfigurationArgs
    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 BillingPortalConfigurationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BillingPortalConfigurationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BillingPortalConfigurationArgs
    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 billingPortalConfigurationResource = new Stripe.BillingPortalConfiguration("billingPortalConfigurationResource", new()
{
    Features = new Stripe.Inputs.BillingPortalConfigurationFeaturesArgs
    {
        CustomerUpdate = new Stripe.Inputs.BillingPortalConfigurationFeaturesCustomerUpdateArgs
        {
            Enabled = false,
            AllowedUpdates = new[]
            {
                "string",
            },
        },
        InvoiceHistory = new Stripe.Inputs.BillingPortalConfigurationFeaturesInvoiceHistoryArgs
        {
            Enabled = false,
        },
        PaymentMethodUpdate = new Stripe.Inputs.BillingPortalConfigurationFeaturesPaymentMethodUpdateArgs
        {
            Enabled = false,
            PaymentMethodConfiguration = "string",
        },
        SubscriptionCancel = new Stripe.Inputs.BillingPortalConfigurationFeaturesSubscriptionCancelArgs
        {
            Enabled = false,
            CancellationReason = new Stripe.Inputs.BillingPortalConfigurationFeaturesSubscriptionCancelCancellationReasonArgs
            {
                Enabled = false,
                Options = new[]
                {
                    "string",
                },
            },
            Mode = "string",
            ProrationBehavior = "string",
        },
        SubscriptionUpdate = new Stripe.Inputs.BillingPortalConfigurationFeaturesSubscriptionUpdateArgs
        {
            Enabled = false,
            BillingCycleAnchor = "string",
            DefaultAllowedUpdates = new[]
            {
                "string",
            },
            Products = new[]
            {
                new Stripe.Inputs.BillingPortalConfigurationFeaturesSubscriptionUpdateProductArgs
                {
                    Prices = new[]
                    {
                        "string",
                    },
                    Product = "string",
                    AdjustableQuantity = new Stripe.Inputs.BillingPortalConfigurationFeaturesSubscriptionUpdateProductAdjustableQuantityArgs
                    {
                        Enabled = false,
                        Maximum = 0.0,
                        Minimum = 0.0,
                    },
                },
            },
            ProrationBehavior = "string",
            ScheduleAtPeriodEnd = new Stripe.Inputs.BillingPortalConfigurationFeaturesSubscriptionUpdateScheduleAtPeriodEndArgs
            {
                Conditions = new[]
                {
                    new Stripe.Inputs.BillingPortalConfigurationFeaturesSubscriptionUpdateScheduleAtPeriodEndConditionArgs
                    {
                        Type = "string",
                    },
                },
            },
            TrialUpdateBehavior = "string",
        },
    },
    Active = false,
    BusinessProfile = new Stripe.Inputs.BillingPortalConfigurationBusinessProfileArgs
    {
        Headline = "string",
        PrivacyPolicyUrl = "string",
        TermsOfServiceUrl = "string",
    },
    DefaultReturnUrl = "string",
    LoginPage = new Stripe.Inputs.BillingPortalConfigurationLoginPageArgs
    {
        Enabled = false,
        Url = "string",
    },
    Metadata = 
    {
        { "string", "string" },
    },
    Name = "string",
});

    example, err := stripe.NewBillingPortalConfiguration(ctx, "billingPortalConfigurationResource", &stripe.BillingPortalConfigurationArgs{
	Features: &stripe.BillingPortalConfigurationFeaturesArgs{
		CustomerUpdate: &stripe.BillingPortalConfigurationFeaturesCustomerUpdateArgs{
			Enabled: pulumi.Bool(false),
			AllowedUpdates: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
		InvoiceHistory: &stripe.BillingPortalConfigurationFeaturesInvoiceHistoryArgs{
			Enabled: pulumi.Bool(false),
		},
		PaymentMethodUpdate: &stripe.BillingPortalConfigurationFeaturesPaymentMethodUpdateArgs{
			Enabled:                    pulumi.Bool(false),
			PaymentMethodConfiguration: pulumi.String("string"),
		},
		SubscriptionCancel: &stripe.BillingPortalConfigurationFeaturesSubscriptionCancelArgs{
			Enabled: pulumi.Bool(false),
			CancellationReason: &stripe.BillingPortalConfigurationFeaturesSubscriptionCancelCancellationReasonArgs{
				Enabled: pulumi.Bool(false),
				Options: pulumi.StringArray{
					pulumi.String("string"),
				},
			},
			Mode:              pulumi.String("string"),
			ProrationBehavior: pulumi.String("string"),
		},
		SubscriptionUpdate: &stripe.BillingPortalConfigurationFeaturesSubscriptionUpdateArgs{
			Enabled:            pulumi.Bool(false),
			BillingCycleAnchor: pulumi.String("string"),
			DefaultAllowedUpdates: pulumi.StringArray{
				pulumi.String("string"),
			},
			Products: stripe.BillingPortalConfigurationFeaturesSubscriptionUpdateProductArray{
				&stripe.BillingPortalConfigurationFeaturesSubscriptionUpdateProductArgs{
					Prices: pulumi.StringArray{
						pulumi.String("string"),
					},
					Product: pulumi.String("string"),
					AdjustableQuantity: &stripe.BillingPortalConfigurationFeaturesSubscriptionUpdateProductAdjustableQuantityArgs{
						Enabled: pulumi.Bool(false),
						Maximum: pulumi.Float64(0),
						Minimum: pulumi.Float64(0),
					},
				},
			},
			ProrationBehavior: pulumi.String("string"),
			ScheduleAtPeriodEnd: &stripe.BillingPortalConfigurationFeaturesSubscriptionUpdateScheduleAtPeriodEndArgs{
				Conditions: stripe.BillingPortalConfigurationFeaturesSubscriptionUpdateScheduleAtPeriodEndConditionArray{
					&stripe.BillingPortalConfigurationFeaturesSubscriptionUpdateScheduleAtPeriodEndConditionArgs{
						Type: pulumi.String("string"),
					},
				},
			},
			TrialUpdateBehavior: pulumi.String("string"),
		},
	},
	Active: pulumi.Bool(false),
	BusinessProfile: &stripe.BillingPortalConfigurationBusinessProfileArgs{
		Headline:          pulumi.String("string"),
		PrivacyPolicyUrl:  pulumi.String("string"),
		TermsOfServiceUrl: pulumi.String("string"),
	},
	DefaultReturnUrl: pulumi.String("string"),
	LoginPage: &stripe.BillingPortalConfigurationLoginPageArgs{
		Enabled: pulumi.Bool(false),
		Url:     pulumi.String("string"),
	},
	Metadata: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Name: pulumi.String("string"),
})

    resource "stripe_billing_portal_configuration" "billingPortalConfigurationResource" {
  lifecycle {
    create_before_destroy = true
  }
  features = {
    customer_update = {
      enabled         = false
      allowed_updates = ["string"]
    }
    invoice_history = {
      enabled = false
    }
    payment_method_update = {
      enabled                      = false
      payment_method_configuration = "string"
    }
    subscription_cancel = {
      enabled = false
      cancellation_reason = {
        enabled = false
        options = ["string"]
      }
      mode               = "string"
      proration_behavior = "string"
    }
    subscription_update = {
      enabled                 = false
      billing_cycle_anchor    = "string"
      default_allowed_updates = ["string"]
      products = [{
        prices  = ["string"]
        product = "string"
        adjustable_quantity = {
          enabled = false
          maximum = 0
          minimum = 0
        }
      }]
      proration_behavior = "string"
      schedule_at_period_end = {
        conditions = [{
          type = "string"
        }]
      }
      trial_update_behavior = "string"
    }
  }
  active = false
  business_profile = {
    headline             = "string"
    privacy_policy_url   = "string"
    terms_of_service_url = "string"
  }
  default_return_url = "string"
  login_page = {
    enabled = false
    url     = "string"
  }
  metadata = {
    "string" = "string"
  }
  name = "string"
}

    var billingPortalConfigurationResource = new BillingPortalConfiguration("billingPortalConfigurationResource", BillingPortalConfigurationArgs.builder()
    .features(BillingPortalConfigurationFeaturesArgs.builder()
        .customerUpdate(BillingPortalConfigurationFeaturesCustomerUpdateArgs.builder()
            .enabled(false)
            .allowedUpdates("string")
            .build())
        .invoiceHistory(BillingPortalConfigurationFeaturesInvoiceHistoryArgs.builder()
            .enabled(false)
            .build())
        .paymentMethodUpdate(BillingPortalConfigurationFeaturesPaymentMethodUpdateArgs.builder()
            .enabled(false)
            .paymentMethodConfiguration("string")
            .build())
        .subscriptionCancel(BillingPortalConfigurationFeaturesSubscriptionCancelArgs.builder()
            .enabled(false)
            .cancellationReason(BillingPortalConfigurationFeaturesSubscriptionCancelCancellationReasonArgs.builder()
                .enabled(false)
                .options("string")
                .build())
            .mode("string")
            .prorationBehavior("string")
            .build())
        .subscriptionUpdate(BillingPortalConfigurationFeaturesSubscriptionUpdateArgs.builder()
            .enabled(false)
            .billingCycleAnchor("string")
            .defaultAllowedUpdates("string")
            .products(BillingPortalConfigurationFeaturesSubscriptionUpdateProductArgs.builder()
                .prices("string")
                .product("string")
                .adjustableQuantity(BillingPortalConfigurationFeaturesSubscriptionUpdateProductAdjustableQuantityArgs.builder()
                    .enabled(false)
                    .maximum(0.0)
                    .minimum(0.0)
                    .build())
                .build())
            .prorationBehavior("string")
            .scheduleAtPeriodEnd(BillingPortalConfigurationFeaturesSubscriptionUpdateScheduleAtPeriodEndArgs.builder()
                .conditions(BillingPortalConfigurationFeaturesSubscriptionUpdateScheduleAtPeriodEndConditionArgs.builder()
                    .type("string")
                    .build())
                .build())
            .trialUpdateBehavior("string")
            .build())
        .build())
    .active(false)
    .businessProfile(BillingPortalConfigurationBusinessProfileArgs.builder()
        .headline("string")
        .privacyPolicyUrl("string")
        .termsOfServiceUrl("string")
        .build())
    .defaultReturnUrl("string")
    .loginPage(BillingPortalConfigurationLoginPageArgs.builder()
        .enabled(false)
        .url("string")
        .build())
    .metadata(Map.of("string", "string"))
    .name("string")
    .build());

    billing_portal_configuration_resource = stripe.BillingPortalConfiguration("billingPortalConfigurationResource",
    features={
        "customer_update": {
            "enabled": False,
            "allowed_updates": ["string"],
        },
        "invoice_history": {
            "enabled": False,
        },
        "payment_method_update": {
            "enabled": False,
            "payment_method_configuration": "string",
        },
        "subscription_cancel": {
            "enabled": False,
            "cancellation_reason": {
                "enabled": False,
                "options": ["string"],
            },
            "mode": "string",
            "proration_behavior": "string",
        },
        "subscription_update": {
            "enabled": False,
            "billing_cycle_anchor": "string",
            "default_allowed_updates": ["string"],
            "products": [{
                "prices": ["string"],
                "product": "string",
                "adjustable_quantity": {
                    "enabled": False,
                    "maximum": float(0),
                    "minimum": float(0),
                },
            }],
            "proration_behavior": "string",
            "schedule_at_period_end": {
                "conditions": [{
                    "type": "string",
                }],
            },
            "trial_update_behavior": "string",
        },
    },
    active=False,
    business_profile={
        "headline": "string",
        "privacy_policy_url": "string",
        "terms_of_service_url": "string",
    },
    default_return_url="string",
    login_page={
        "enabled": False,
        "url": "string",
    },
    metadata={
        "string": "string",
    },
    name="string")

    const billingPortalConfigurationResource = new stripe.BillingPortalConfiguration("billingPortalConfigurationResource", {
    features: {
        customerUpdate: {
            enabled: false,
            allowedUpdates: ["string"],
        },
        invoiceHistory: {
            enabled: false,
        },
        paymentMethodUpdate: {
            enabled: false,
            paymentMethodConfiguration: "string",
        },
        subscriptionCancel: {
            enabled: false,
            cancellationReason: {
                enabled: false,
                options: ["string"],
            },
            mode: "string",
            prorationBehavior: "string",
        },
        subscriptionUpdate: {
            enabled: false,
            billingCycleAnchor: "string",
            defaultAllowedUpdates: ["string"],
            products: [{
                prices: ["string"],
                product: "string",
                adjustableQuantity: {
                    enabled: false,
                    maximum: 0,
                    minimum: 0,
                },
            }],
            prorationBehavior: "string",
            scheduleAtPeriodEnd: {
                conditions: [{
                    type: "string",
                }],
            },
            trialUpdateBehavior: "string",
        },
    },
    active: false,
    businessProfile: {
        headline: "string",
        privacyPolicyUrl: "string",
        termsOfServiceUrl: "string",
    },
    defaultReturnUrl: "string",
    loginPage: {
        enabled: false,
        url: "string",
    },
    metadata: {
        string: "string",
    },
    name: "string",
});

    type: stripe:BillingPortalConfiguration
properties:
    active: false
    businessProfile:
        headline: string
        privacyPolicyUrl: string
        termsOfServiceUrl: string
    defaultReturnUrl: string
    features:
        customerUpdate:
            allowedUpdates:
                - string
            enabled: false
        invoiceHistory:
            enabled: false
        paymentMethodUpdate:
            enabled: false
            paymentMethodConfiguration: string
        subscriptionCancel:
            cancellationReason:
                enabled: false
                options:
                    - string
            enabled: false
            mode: string
            prorationBehavior: string
        subscriptionUpdate:
            billingCycleAnchor: string
            defaultAllowedUpdates:
                - string
            enabled: false
            products:
                - adjustableQuantity:
                    enabled: false
                    maximum: 0
                    minimum: 0
                  prices:
                    - string
                  product: string
            prorationBehavior: string
            scheduleAtPeriodEnd:
                conditions:
                    - type: string
            trialUpdateBehavior: string
    loginPage:
        enabled: false
        url: string
    metadata:
        string: string
    name: string

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

    Features BillingPortalConfigurationFeatures
    Active bool
    Whether the configuration is active and can be used to create portal sessions.
    BusinessProfile BillingPortalConfigurationBusinessProfile
    DefaultReturnUrl string
    The default URL to redirect customers to when they click on the portal's link to return to your website. This can be overriden when creating the session.
    LoginPage BillingPortalConfigurationLoginPage
    Metadata Dictionary<string, string>
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    Name string
    The name of the configuration.
    Features BillingPortalConfigurationFeaturesArgs
    Active bool
    Whether the configuration is active and can be used to create portal sessions.
    BusinessProfile BillingPortalConfigurationBusinessProfileArgs
    DefaultReturnUrl string
    The default URL to redirect customers to when they click on the portal's link to return to your website. This can be overriden when creating the session.
    LoginPage BillingPortalConfigurationLoginPageArgs
    Metadata map[string]string
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    Name string
    The name of the configuration.
    features object
    active bool
    Whether the configuration is active and can be used to create portal sessions.
    business_profile object
    default_return_url string
    The default URL to redirect customers to when they click on the portal's link to return to your website. This can be overriden when creating the session.
    login_page object
    metadata map(string)
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    name string
    The name of the configuration.
    features BillingPortalConfigurationFeatures
    active Boolean
    Whether the configuration is active and can be used to create portal sessions.
    businessProfile BillingPortalConfigurationBusinessProfile
    defaultReturnUrl String
    The default URL to redirect customers to when they click on the portal's link to return to your website. This can be overriden when creating the session.
    loginPage BillingPortalConfigurationLoginPage
    metadata Map<String,String>
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    name String
    The name of the configuration.
    features BillingPortalConfigurationFeatures
    active boolean
    Whether the configuration is active and can be used to create portal sessions.
    businessProfile BillingPortalConfigurationBusinessProfile
    defaultReturnUrl string
    The default URL to redirect customers to when they click on the portal's link to return to your website. This can be overriden when creating the session.
    loginPage BillingPortalConfigurationLoginPage
    metadata {[key: string]: string}
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    name string
    The name of the configuration.
    features BillingPortalConfigurationFeaturesArgs
    active bool
    Whether the configuration is active and can be used to create portal sessions.
    business_profile BillingPortalConfigurationBusinessProfileArgs
    default_return_url str
    The default URL to redirect customers to when they click on the portal's link to return to your website. This can be overriden when creating the session.
    login_page BillingPortalConfigurationLoginPageArgs
    metadata Mapping[str, str]
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    name str
    The name of the configuration.
    features Property Map
    active Boolean
    Whether the configuration is active and can be used to create portal sessions.
    businessProfile Property Map
    defaultReturnUrl String
    The default URL to redirect customers to when they click on the portal's link to return to your website. This can be overriden when creating the session.
    loginPage Property Map
    metadata Map<String>
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    name String
    The name of the configuration.

    Outputs

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

    Application string
    ID of the Connect Application that created the configuration.
    Created double
    Time at which the object was created. Measured in seconds since the Unix epoch.
    Id string
    The provider-assigned unique ID for this managed resource.
    IsDefault bool
    Whether the configuration is the default. If true, this configuration can be managed in the Dashboard and portal sessions will use this configuration unless it is overriden when creating the session.
    Livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    Object string
    String representing the object's type. Objects of the same type share the same value.
    Application string
    ID of the Connect Application that created the configuration.
    Created float64
    Time at which the object was created. Measured in seconds since the Unix epoch.
    Id string
    The provider-assigned unique ID for this managed resource.
    IsDefault bool
    Whether the configuration is the default. If true, this configuration can be managed in the Dashboard and portal sessions will use this configuration unless it is overriden when creating the session.
    Livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    Object string
    String representing the object's type. Objects of the same type share the same value.
    application string
    ID of the Connect Application that created the configuration.
    created number
    Time at which the object was created. Measured in seconds since the Unix epoch.
    id string
    The provider-assigned unique ID for this managed resource.
    is_default bool
    Whether the configuration is the default. If true, this configuration can be managed in the Dashboard and portal sessions will use this configuration unless it is overriden when creating the session.
    livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    object string
    String representing the object's type. Objects of the same type share the same value.
    application String
    ID of the Connect Application that created the configuration.
    created Double
    Time at which the object was created. Measured in seconds since the Unix epoch.
    id String
    The provider-assigned unique ID for this managed resource.
    isDefault Boolean
    Whether the configuration is the default. If true, this configuration can be managed in the Dashboard and portal sessions will use this configuration unless it is overriden when creating the session.
    livemode Boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    object String
    String representing the object's type. Objects of the same type share the same value.
    application string
    ID of the Connect Application that created the configuration.
    created number
    Time at which the object was created. Measured in seconds since the Unix epoch.
    id string
    The provider-assigned unique ID for this managed resource.
    isDefault boolean
    Whether the configuration is the default. If true, this configuration can be managed in the Dashboard and portal sessions will use this configuration unless it is overriden when creating the session.
    livemode boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    object string
    String representing the object's type. Objects of the same type share the same value.
    application str
    ID of the Connect Application that created the configuration.
    created float
    Time at which the object was created. Measured in seconds since the Unix epoch.
    id str
    The provider-assigned unique ID for this managed resource.
    is_default bool
    Whether the configuration is the default. If true, this configuration can be managed in the Dashboard and portal sessions will use this configuration unless it is overriden when creating the session.
    livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    object str
    String representing the object's type. Objects of the same type share the same value.
    application String
    ID of the Connect Application that created the configuration.
    created Number
    Time at which the object was created. Measured in seconds since the Unix epoch.
    id String
    The provider-assigned unique ID for this managed resource.
    isDefault Boolean
    Whether the configuration is the default. If true, this configuration can be managed in the Dashboard and portal sessions will use this configuration unless it is overriden when creating the session.
    livemode Boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    object String
    String representing the object's type. Objects of the same type share the same value.

    Look up Existing BillingPortalConfiguration Resource

    Get an existing BillingPortalConfiguration 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?: BillingPortalConfigurationState, opts?: CustomResourceOptions): BillingPortalConfiguration
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        active: Optional[bool] = None,
        application: Optional[str] = None,
        business_profile: Optional[BillingPortalConfigurationBusinessProfileArgs] = None,
        created: Optional[float] = None,
        default_return_url: Optional[str] = None,
        features: Optional[BillingPortalConfigurationFeaturesArgs] = None,
        is_default: Optional[bool] = None,
        livemode: Optional[bool] = None,
        login_page: Optional[BillingPortalConfigurationLoginPageArgs] = None,
        metadata: Optional[Mapping[str, str]] = None,
        name: Optional[str] = None,
        object: Optional[str] = None) -> BillingPortalConfiguration
    func GetBillingPortalConfiguration(ctx *Context, name string, id IDInput, state *BillingPortalConfigurationState, opts ...ResourceOption) (*BillingPortalConfiguration, error)
    public static BillingPortalConfiguration Get(string name, Input<string> id, BillingPortalConfigurationState? state, CustomResourceOptions? opts = null)
    public static BillingPortalConfiguration get(String name, Output<String> id, BillingPortalConfigurationState state, CustomResourceOptions options)
    resources:  _:    type: stripe:BillingPortalConfiguration    get:      id: ${id}
    import {
  to = stripe_billing_portal_configuration.example
  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:
    Active bool
    Whether the configuration is active and can be used to create portal sessions.
    Application string
    ID of the Connect Application that created the configuration.
    BusinessProfile BillingPortalConfigurationBusinessProfile
    Created double
    Time at which the object was created. Measured in seconds since the Unix epoch.
    DefaultReturnUrl string
    The default URL to redirect customers to when they click on the portal's link to return to your website. This can be overriden when creating the session.
    Features BillingPortalConfigurationFeatures
    IsDefault bool
    Whether the configuration is the default. If true, this configuration can be managed in the Dashboard and portal sessions will use this configuration unless it is overriden when creating the session.
    Livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    LoginPage BillingPortalConfigurationLoginPage
    Metadata Dictionary<string, string>
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    Name string
    The name of the configuration.
    Object string
    String representing the object's type. Objects of the same type share the same value.
    Active bool
    Whether the configuration is active and can be used to create portal sessions.
    Application string
    ID of the Connect Application that created the configuration.
    BusinessProfile BillingPortalConfigurationBusinessProfileArgs
    Created float64
    Time at which the object was created. Measured in seconds since the Unix epoch.
    DefaultReturnUrl string
    The default URL to redirect customers to when they click on the portal's link to return to your website. This can be overriden when creating the session.
    Features BillingPortalConfigurationFeaturesArgs
    IsDefault bool
    Whether the configuration is the default. If true, this configuration can be managed in the Dashboard and portal sessions will use this configuration unless it is overriden when creating the session.
    Livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    LoginPage BillingPortalConfigurationLoginPageArgs
    Metadata map[string]string
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    Name string
    The name of the configuration.
    Object string
    String representing the object's type. Objects of the same type share the same value.
    active bool
    Whether the configuration is active and can be used to create portal sessions.
    application string
    ID of the Connect Application that created the configuration.
    business_profile object
    created number
    Time at which the object was created. Measured in seconds since the Unix epoch.
    default_return_url string
    The default URL to redirect customers to when they click on the portal's link to return to your website. This can be overriden when creating the session.
    features object
    is_default bool
    Whether the configuration is the default. If true, this configuration can be managed in the Dashboard and portal sessions will use this configuration unless it is overriden when creating the session.
    livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    login_page object
    metadata map(string)
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    name string
    The name of the configuration.
    object string
    String representing the object's type. Objects of the same type share the same value.
    active Boolean
    Whether the configuration is active and can be used to create portal sessions.
    application String
    ID of the Connect Application that created the configuration.
    businessProfile BillingPortalConfigurationBusinessProfile
    created Double
    Time at which the object was created. Measured in seconds since the Unix epoch.
    defaultReturnUrl String
    The default URL to redirect customers to when they click on the portal's link to return to your website. This can be overriden when creating the session.
    features BillingPortalConfigurationFeatures
    isDefault Boolean
    Whether the configuration is the default. If true, this configuration can be managed in the Dashboard and portal sessions will use this configuration unless it is overriden when creating the session.
    livemode Boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    loginPage BillingPortalConfigurationLoginPage
    metadata Map<String,String>
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    name String
    The name of the configuration.
    object String
    String representing the object's type. Objects of the same type share the same value.
    active boolean
    Whether the configuration is active and can be used to create portal sessions.
    application string
    ID of the Connect Application that created the configuration.
    businessProfile BillingPortalConfigurationBusinessProfile
    created number
    Time at which the object was created. Measured in seconds since the Unix epoch.
    defaultReturnUrl string
    The default URL to redirect customers to when they click on the portal's link to return to your website. This can be overriden when creating the session.
    features BillingPortalConfigurationFeatures
    isDefault boolean
    Whether the configuration is the default. If true, this configuration can be managed in the Dashboard and portal sessions will use this configuration unless it is overriden when creating the session.
    livemode boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    loginPage BillingPortalConfigurationLoginPage
    metadata {[key: string]: string}
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    name string
    The name of the configuration.
    object string
    String representing the object's type. Objects of the same type share the same value.
    active bool
    Whether the configuration is active and can be used to create portal sessions.
    application str
    ID of the Connect Application that created the configuration.
    business_profile BillingPortalConfigurationBusinessProfileArgs
    created float
    Time at which the object was created. Measured in seconds since the Unix epoch.
    default_return_url str
    The default URL to redirect customers to when they click on the portal's link to return to your website. This can be overriden when creating the session.
    features BillingPortalConfigurationFeaturesArgs
    is_default bool
    Whether the configuration is the default. If true, this configuration can be managed in the Dashboard and portal sessions will use this configuration unless it is overriden when creating the session.
    livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    login_page BillingPortalConfigurationLoginPageArgs
    metadata Mapping[str, str]
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    name str
    The name of the configuration.
    object str
    String representing the object's type. Objects of the same type share the same value.
    active Boolean
    Whether the configuration is active and can be used to create portal sessions.
    application String
    ID of the Connect Application that created the configuration.
    businessProfile Property Map
    created Number
    Time at which the object was created. Measured in seconds since the Unix epoch.
    defaultReturnUrl String
    The default URL to redirect customers to when they click on the portal's link to return to your website. This can be overriden when creating the session.
    features Property Map
    isDefault Boolean
    Whether the configuration is the default. If true, this configuration can be managed in the Dashboard and portal sessions will use this configuration unless it is overriden when creating the session.
    livemode Boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    loginPage Property Map
    metadata Map<String>
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    name String
    The name of the configuration.
    object String
    String representing the object's type. Objects of the same type share the same value.

    Supporting Types

    BillingPortalConfigurationBusinessProfile, BillingPortalConfigurationBusinessProfileArgs

    Headline string
    The messaging shown to customers in the portal.
    PrivacyPolicyUrl string
    A link to the business’s publicly available privacy policy.
    TermsOfServiceUrl string
    A link to the business’s publicly available terms of service.
    Headline string
    The messaging shown to customers in the portal.
    PrivacyPolicyUrl string
    A link to the business’s publicly available privacy policy.
    TermsOfServiceUrl string
    A link to the business’s publicly available terms of service.
    headline string
    The messaging shown to customers in the portal.
    privacy_policy_url string
    A link to the business’s publicly available privacy policy.
    terms_of_service_url string
    A link to the business’s publicly available terms of service.
    headline String
    The messaging shown to customers in the portal.
    privacyPolicyUrl String
    A link to the business’s publicly available privacy policy.
    termsOfServiceUrl String
    A link to the business’s publicly available terms of service.
    headline string
    The messaging shown to customers in the portal.
    privacyPolicyUrl string
    A link to the business’s publicly available privacy policy.
    termsOfServiceUrl string
    A link to the business’s publicly available terms of service.
    headline str
    The messaging shown to customers in the portal.
    privacy_policy_url str
    A link to the business’s publicly available privacy policy.
    terms_of_service_url str
    A link to the business’s publicly available terms of service.
    headline String
    The messaging shown to customers in the portal.
    privacyPolicyUrl String
    A link to the business’s publicly available privacy policy.
    termsOfServiceUrl String
    A link to the business’s publicly available terms of service.

    BillingPortalConfigurationFeatures, BillingPortalConfigurationFeaturesArgs

    BillingPortalConfigurationFeaturesCustomerUpdate, BillingPortalConfigurationFeaturesCustomerUpdateArgs

    Enabled bool
    Whether the feature is enabled.
    AllowedUpdates List<string>
    The types of customer updates that are supported. When empty, customers are not updateable.
    Enabled bool
    Whether the feature is enabled.
    AllowedUpdates []string
    The types of customer updates that are supported. When empty, customers are not updateable.
    enabled bool
    Whether the feature is enabled.
    allowed_updates list(string)
    The types of customer updates that are supported. When empty, customers are not updateable.
    enabled Boolean
    Whether the feature is enabled.
    allowedUpdates List<String>
    The types of customer updates that are supported. When empty, customers are not updateable.
    enabled boolean
    Whether the feature is enabled.
    allowedUpdates string[]
    The types of customer updates that are supported. When empty, customers are not updateable.
    enabled bool
    Whether the feature is enabled.
    allowed_updates Sequence[str]
    The types of customer updates that are supported. When empty, customers are not updateable.
    enabled Boolean
    Whether the feature is enabled.
    allowedUpdates List<String>
    The types of customer updates that are supported. When empty, customers are not updateable.

    BillingPortalConfigurationFeaturesInvoiceHistory, BillingPortalConfigurationFeaturesInvoiceHistoryArgs

    Enabled bool
    Whether the feature is enabled.
    Enabled bool
    Whether the feature is enabled.
    enabled bool
    Whether the feature is enabled.
    enabled Boolean
    Whether the feature is enabled.
    enabled boolean
    Whether the feature is enabled.
    enabled bool
    Whether the feature is enabled.
    enabled Boolean
    Whether the feature is enabled.

    BillingPortalConfigurationFeaturesPaymentMethodUpdate, BillingPortalConfigurationFeaturesPaymentMethodUpdateArgs

    Enabled bool
    Whether the feature is enabled.
    PaymentMethodConfiguration string
    The Payment Method Configuration to use for this portal session. When specified, customers will be able to update their payment method to one of the options specified by the payment method configuration. If not set, the default payment method configuration is used.
    Enabled bool
    Whether the feature is enabled.
    PaymentMethodConfiguration string
    The Payment Method Configuration to use for this portal session. When specified, customers will be able to update their payment method to one of the options specified by the payment method configuration. If not set, the default payment method configuration is used.
    enabled bool
    Whether the feature is enabled.
    payment_method_configuration string
    The Payment Method Configuration to use for this portal session. When specified, customers will be able to update their payment method to one of the options specified by the payment method configuration. If not set, the default payment method configuration is used.
    enabled Boolean
    Whether the feature is enabled.
    paymentMethodConfiguration String
    The Payment Method Configuration to use for this portal session. When specified, customers will be able to update their payment method to one of the options specified by the payment method configuration. If not set, the default payment method configuration is used.
    enabled boolean
    Whether the feature is enabled.
    paymentMethodConfiguration string
    The Payment Method Configuration to use for this portal session. When specified, customers will be able to update their payment method to one of the options specified by the payment method configuration. If not set, the default payment method configuration is used.
    enabled bool
    Whether the feature is enabled.
    payment_method_configuration str
    The Payment Method Configuration to use for this portal session. When specified, customers will be able to update their payment method to one of the options specified by the payment method configuration. If not set, the default payment method configuration is used.
    enabled Boolean
    Whether the feature is enabled.
    paymentMethodConfiguration String
    The Payment Method Configuration to use for this portal session. When specified, customers will be able to update their payment method to one of the options specified by the payment method configuration. If not set, the default payment method configuration is used.

    BillingPortalConfigurationFeaturesSubscriptionCancel, BillingPortalConfigurationFeaturesSubscriptionCancelArgs

    Enabled bool
    Whether the feature is enabled.
    CancellationReason BillingPortalConfigurationFeaturesSubscriptionCancelCancellationReason
    Mode string
    Whether to cancel subscriptions immediately or at the end of the billing period.
    ProrationBehavior string
    Whether to create prorations when canceling subscriptions. Possible values are none and create_prorations.
    Enabled bool
    Whether the feature is enabled.
    CancellationReason BillingPortalConfigurationFeaturesSubscriptionCancelCancellationReason
    Mode string
    Whether to cancel subscriptions immediately or at the end of the billing period.
    ProrationBehavior string
    Whether to create prorations when canceling subscriptions. Possible values are none and create_prorations.
    enabled bool
    Whether the feature is enabled.
    cancellation_reason object
    mode string
    Whether to cancel subscriptions immediately or at the end of the billing period.
    proration_behavior string
    Whether to create prorations when canceling subscriptions. Possible values are none and create_prorations.
    enabled Boolean
    Whether the feature is enabled.
    cancellationReason BillingPortalConfigurationFeaturesSubscriptionCancelCancellationReason
    mode String
    Whether to cancel subscriptions immediately or at the end of the billing period.
    prorationBehavior String
    Whether to create prorations when canceling subscriptions. Possible values are none and create_prorations.
    enabled boolean
    Whether the feature is enabled.
    cancellationReason BillingPortalConfigurationFeaturesSubscriptionCancelCancellationReason
    mode string
    Whether to cancel subscriptions immediately or at the end of the billing period.
    prorationBehavior string
    Whether to create prorations when canceling subscriptions. Possible values are none and create_prorations.
    enabled bool
    Whether the feature is enabled.
    cancellation_reason BillingPortalConfigurationFeaturesSubscriptionCancelCancellationReason
    mode str
    Whether to cancel subscriptions immediately or at the end of the billing period.
    proration_behavior str
    Whether to create prorations when canceling subscriptions. Possible values are none and create_prorations.
    enabled Boolean
    Whether the feature is enabled.
    cancellationReason Property Map
    mode String
    Whether to cancel subscriptions immediately or at the end of the billing period.
    prorationBehavior String
    Whether to create prorations when canceling subscriptions. Possible values are none and create_prorations.

    BillingPortalConfigurationFeaturesSubscriptionCancelCancellationReason, BillingPortalConfigurationFeaturesSubscriptionCancelCancellationReasonArgs

    Enabled bool
    Whether the feature is enabled.
    Options List<string>
    Which cancellation reasons will be given as options to the customer.
    Enabled bool
    Whether the feature is enabled.
    Options []string
    Which cancellation reasons will be given as options to the customer.
    enabled bool
    Whether the feature is enabled.
    options list(string)
    Which cancellation reasons will be given as options to the customer.
    enabled Boolean
    Whether the feature is enabled.
    options List<String>
    Which cancellation reasons will be given as options to the customer.
    enabled boolean
    Whether the feature is enabled.
    options string[]
    Which cancellation reasons will be given as options to the customer.
    enabled bool
    Whether the feature is enabled.
    options Sequence[str]
    Which cancellation reasons will be given as options to the customer.
    enabled Boolean
    Whether the feature is enabled.
    options List<String>
    Which cancellation reasons will be given as options to the customer.

    BillingPortalConfigurationFeaturesSubscriptionUpdate, BillingPortalConfigurationFeaturesSubscriptionUpdateArgs

    Enabled bool
    Whether the feature is enabled.
    BillingCycleAnchor string
    Determines the value to use for the billing cycle anchor on subscription updates. Valid values are now or unchanged, and the default value is unchanged. Setting the value to now resets the subscription's billing cycle anchor to the current time (in UTC). For more information, see the billing cycle documentation.
    DefaultAllowedUpdates List<string>
    The types of subscription updates that are supported for items listed in the products attribute. When empty, subscriptions are not updateable.
    Products List<BillingPortalConfigurationFeaturesSubscriptionUpdateProduct>
    The list of up to 10 products that support subscription updates.
    ProrationBehavior string
    Determines how to handle prorations resulting from subscription updates. Valid values are none, create_prorations, and always_invoice. Defaults to a value of none if you don't set it during creation.
    ScheduleAtPeriodEnd BillingPortalConfigurationFeaturesSubscriptionUpdateScheduleAtPeriodEnd
    TrialUpdateBehavior string
    Determines how handle updates to trialing subscriptions. Valid values are end_trial and continue_trial. Defaults to a value of end_trial if you don't set it during creation.
    Enabled bool
    Whether the feature is enabled.
    BillingCycleAnchor string
    Determines the value to use for the billing cycle anchor on subscription updates. Valid values are now or unchanged, and the default value is unchanged. Setting the value to now resets the subscription's billing cycle anchor to the current time (in UTC). For more information, see the billing cycle documentation.
    DefaultAllowedUpdates []string
    The types of subscription updates that are supported for items listed in the products attribute. When empty, subscriptions are not updateable.
    Products []BillingPortalConfigurationFeaturesSubscriptionUpdateProduct
    The list of up to 10 products that support subscription updates.
    ProrationBehavior string
    Determines how to handle prorations resulting from subscription updates. Valid values are none, create_prorations, and always_invoice. Defaults to a value of none if you don't set it during creation.
    ScheduleAtPeriodEnd BillingPortalConfigurationFeaturesSubscriptionUpdateScheduleAtPeriodEnd
    TrialUpdateBehavior string
    Determines how handle updates to trialing subscriptions. Valid values are end_trial and continue_trial. Defaults to a value of end_trial if you don't set it during creation.
    enabled bool
    Whether the feature is enabled.
    billing_cycle_anchor string
    Determines the value to use for the billing cycle anchor on subscription updates. Valid values are now or unchanged, and the default value is unchanged. Setting the value to now resets the subscription's billing cycle anchor to the current time (in UTC). For more information, see the billing cycle documentation.
    default_allowed_updates list(string)
    The types of subscription updates that are supported for items listed in the products attribute. When empty, subscriptions are not updateable.
    products list(object)
    The list of up to 10 products that support subscription updates.
    proration_behavior string
    Determines how to handle prorations resulting from subscription updates. Valid values are none, create_prorations, and always_invoice. Defaults to a value of none if you don't set it during creation.
    schedule_at_period_end object
    trial_update_behavior string
    Determines how handle updates to trialing subscriptions. Valid values are end_trial and continue_trial. Defaults to a value of end_trial if you don't set it during creation.
    enabled Boolean
    Whether the feature is enabled.
    billingCycleAnchor String
    Determines the value to use for the billing cycle anchor on subscription updates. Valid values are now or unchanged, and the default value is unchanged. Setting the value to now resets the subscription's billing cycle anchor to the current time (in UTC). For more information, see the billing cycle documentation.
    defaultAllowedUpdates List<String>
    The types of subscription updates that are supported for items listed in the products attribute. When empty, subscriptions are not updateable.
    products List<BillingPortalConfigurationFeaturesSubscriptionUpdateProduct>
    The list of up to 10 products that support subscription updates.
    prorationBehavior String
    Determines how to handle prorations resulting from subscription updates. Valid values are none, create_prorations, and always_invoice. Defaults to a value of none if you don't set it during creation.
    scheduleAtPeriodEnd BillingPortalConfigurationFeaturesSubscriptionUpdateScheduleAtPeriodEnd
    trialUpdateBehavior String
    Determines how handle updates to trialing subscriptions. Valid values are end_trial and continue_trial. Defaults to a value of end_trial if you don't set it during creation.
    enabled boolean
    Whether the feature is enabled.
    billingCycleAnchor string
    Determines the value to use for the billing cycle anchor on subscription updates. Valid values are now or unchanged, and the default value is unchanged. Setting the value to now resets the subscription's billing cycle anchor to the current time (in UTC). For more information, see the billing cycle documentation.
    defaultAllowedUpdates string[]
    The types of subscription updates that are supported for items listed in the products attribute. When empty, subscriptions are not updateable.
    products BillingPortalConfigurationFeaturesSubscriptionUpdateProduct[]
    The list of up to 10 products that support subscription updates.
    prorationBehavior string
    Determines how to handle prorations resulting from subscription updates. Valid values are none, create_prorations, and always_invoice. Defaults to a value of none if you don't set it during creation.
    scheduleAtPeriodEnd BillingPortalConfigurationFeaturesSubscriptionUpdateScheduleAtPeriodEnd
    trialUpdateBehavior string
    Determines how handle updates to trialing subscriptions. Valid values are end_trial and continue_trial. Defaults to a value of end_trial if you don't set it during creation.
    enabled bool
    Whether the feature is enabled.
    billing_cycle_anchor str
    Determines the value to use for the billing cycle anchor on subscription updates. Valid values are now or unchanged, and the default value is unchanged. Setting the value to now resets the subscription's billing cycle anchor to the current time (in UTC). For more information, see the billing cycle documentation.
    default_allowed_updates Sequence[str]
    The types of subscription updates that are supported for items listed in the products attribute. When empty, subscriptions are not updateable.
    products Sequence[BillingPortalConfigurationFeaturesSubscriptionUpdateProduct]
    The list of up to 10 products that support subscription updates.
    proration_behavior str
    Determines how to handle prorations resulting from subscription updates. Valid values are none, create_prorations, and always_invoice. Defaults to a value of none if you don't set it during creation.
    schedule_at_period_end BillingPortalConfigurationFeaturesSubscriptionUpdateScheduleAtPeriodEnd
    trial_update_behavior str
    Determines how handle updates to trialing subscriptions. Valid values are end_trial and continue_trial. Defaults to a value of end_trial if you don't set it during creation.
    enabled Boolean
    Whether the feature is enabled.
    billingCycleAnchor String
    Determines the value to use for the billing cycle anchor on subscription updates. Valid values are now or unchanged, and the default value is unchanged. Setting the value to now resets the subscription's billing cycle anchor to the current time (in UTC). For more information, see the billing cycle documentation.
    defaultAllowedUpdates List<String>
    The types of subscription updates that are supported for items listed in the products attribute. When empty, subscriptions are not updateable.
    products List<Property Map>
    The list of up to 10 products that support subscription updates.
    prorationBehavior String
    Determines how to handle prorations resulting from subscription updates. Valid values are none, create_prorations, and always_invoice. Defaults to a value of none if you don't set it during creation.
    scheduleAtPeriodEnd Property Map
    trialUpdateBehavior String
    Determines how handle updates to trialing subscriptions. Valid values are end_trial and continue_trial. Defaults to a value of end_trial if you don't set it during creation.

    BillingPortalConfigurationFeaturesSubscriptionUpdateProduct, BillingPortalConfigurationFeaturesSubscriptionUpdateProductArgs

    Prices List<string>
    The list of price IDs which, when subscribed to, a subscription can be updated.
    Product string
    The product ID.
    AdjustableQuantity BillingPortalConfigurationFeaturesSubscriptionUpdateProductAdjustableQuantity
    Prices []string
    The list of price IDs which, when subscribed to, a subscription can be updated.
    Product string
    The product ID.
    AdjustableQuantity BillingPortalConfigurationFeaturesSubscriptionUpdateProductAdjustableQuantity
    prices list(string)
    The list of price IDs which, when subscribed to, a subscription can be updated.
    product string
    The product ID.
    adjustable_quantity object
    prices List<String>
    The list of price IDs which, when subscribed to, a subscription can be updated.
    product String
    The product ID.
    adjustableQuantity BillingPortalConfigurationFeaturesSubscriptionUpdateProductAdjustableQuantity
    prices string[]
    The list of price IDs which, when subscribed to, a subscription can be updated.
    product string
    The product ID.
    adjustableQuantity BillingPortalConfigurationFeaturesSubscriptionUpdateProductAdjustableQuantity
    prices Sequence[str]
    The list of price IDs which, when subscribed to, a subscription can be updated.
    product str
    The product ID.
    adjustable_quantity BillingPortalConfigurationFeaturesSubscriptionUpdateProductAdjustableQuantity
    prices List<String>
    The list of price IDs which, when subscribed to, a subscription can be updated.
    product String
    The product ID.
    adjustableQuantity Property Map

    BillingPortalConfigurationFeaturesSubscriptionUpdateProductAdjustableQuantity, BillingPortalConfigurationFeaturesSubscriptionUpdateProductAdjustableQuantityArgs

    Enabled bool
    If true, the quantity can be adjusted to any non-negative integer.
    Maximum double
    The maximum quantity that can be set for the product.
    Minimum double
    The minimum quantity that can be set for the product.
    Enabled bool
    If true, the quantity can be adjusted to any non-negative integer.
    Maximum float64
    The maximum quantity that can be set for the product.
    Minimum float64
    The minimum quantity that can be set for the product.
    enabled bool
    If true, the quantity can be adjusted to any non-negative integer.
    maximum number
    The maximum quantity that can be set for the product.
    minimum number
    The minimum quantity that can be set for the product.
    enabled Boolean
    If true, the quantity can be adjusted to any non-negative integer.
    maximum Double
    The maximum quantity that can be set for the product.
    minimum Double
    The minimum quantity that can be set for the product.
    enabled boolean
    If true, the quantity can be adjusted to any non-negative integer.
    maximum number
    The maximum quantity that can be set for the product.
    minimum number
    The minimum quantity that can be set for the product.
    enabled bool
    If true, the quantity can be adjusted to any non-negative integer.
    maximum float
    The maximum quantity that can be set for the product.
    minimum float
    The minimum quantity that can be set for the product.
    enabled Boolean
    If true, the quantity can be adjusted to any non-negative integer.
    maximum Number
    The maximum quantity that can be set for the product.
    minimum Number
    The minimum quantity that can be set for the product.

    BillingPortalConfigurationFeaturesSubscriptionUpdateScheduleAtPeriodEnd, BillingPortalConfigurationFeaturesSubscriptionUpdateScheduleAtPeriodEndArgs

    Conditions List<BillingPortalConfigurationFeaturesSubscriptionUpdateScheduleAtPeriodEndCondition>
    List of conditions. When any condition is true, an update will be scheduled at the end of the current period.
    Conditions []BillingPortalConfigurationFeaturesSubscriptionUpdateScheduleAtPeriodEndCondition
    List of conditions. When any condition is true, an update will be scheduled at the end of the current period.
    conditions list(object)
    List of conditions. When any condition is true, an update will be scheduled at the end of the current period.
    conditions List<BillingPortalConfigurationFeaturesSubscriptionUpdateScheduleAtPeriodEndCondition>
    List of conditions. When any condition is true, an update will be scheduled at the end of the current period.
    conditions BillingPortalConfigurationFeaturesSubscriptionUpdateScheduleAtPeriodEndCondition[]
    List of conditions. When any condition is true, an update will be scheduled at the end of the current period.
    conditions Sequence[BillingPortalConfigurationFeaturesSubscriptionUpdateScheduleAtPeriodEndCondition]
    List of conditions. When any condition is true, an update will be scheduled at the end of the current period.
    conditions List<Property Map>
    List of conditions. When any condition is true, an update will be scheduled at the end of the current period.

    BillingPortalConfigurationFeaturesSubscriptionUpdateScheduleAtPeriodEndCondition, BillingPortalConfigurationFeaturesSubscriptionUpdateScheduleAtPeriodEndConditionArgs

    Type string
    The type of condition.
    Type string
    The type of condition.
    type string
    The type of condition.
    type String
    The type of condition.
    type string
    The type of condition.
    type str
    The type of condition.
    type String
    The type of condition.

    BillingPortalConfigurationLoginPage, BillingPortalConfigurationLoginPageArgs

    Enabled bool
    If true, a shareable url will be generated that will take your customers to a hosted login page for the customer portal.
    Url string
    A shareable URL to the hosted portal login page. Your customers will be able to log in with their email and receive a link to their customer portal.
    Enabled bool
    If true, a shareable url will be generated that will take your customers to a hosted login page for the customer portal.
    Url string
    A shareable URL to the hosted portal login page. Your customers will be able to log in with their email and receive a link to their customer portal.
    enabled bool
    If true, a shareable url will be generated that will take your customers to a hosted login page for the customer portal.
    url string
    A shareable URL to the hosted portal login page. Your customers will be able to log in with their email and receive a link to their customer portal.
    enabled Boolean
    If true, a shareable url will be generated that will take your customers to a hosted login page for the customer portal.
    url String
    A shareable URL to the hosted portal login page. Your customers will be able to log in with their email and receive a link to their customer portal.
    enabled boolean
    If true, a shareable url will be generated that will take your customers to a hosted login page for the customer portal.
    url string
    A shareable URL to the hosted portal login page. Your customers will be able to log in with their email and receive a link to their customer portal.
    enabled bool
    If true, a shareable url will be generated that will take your customers to a hosted login page for the customer portal.
    url str
    A shareable URL to the hosted portal login page. Your customers will be able to log in with their email and receive a link to their customer portal.
    enabled Boolean
    If true, a shareable url will be generated that will take your customers to a hosted login page for the customer portal.
    url String
    A shareable URL to the hosted portal login page. Your customers will be able to log in with their email and receive a link to their customer portal.

    Package Details

    Repository
    stripe stripe/terraform-provider-stripe
    License
    Notes
    This Pulumi package is based on the stripe Terraform Provider.
    Viewing docs for Stripe 0.3.0
    published on Friday, Aug 14, 2026 by Pulumi
    Schema (JSON)
    stripe/terraform-provider-stripe

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial