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

stripe.PromotionCode

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

    A Promotion Code represents a customer-redeemable code for an underlying promotion. You can create multiple codes for a single promotion.

    If you enable promotion codes in your customer portal configuration, then customers can redeem a code themselves when updating a subscription in the portal. Customers can also view the currently active promotion codes and coupons on each of their subscriptions in the portal.

    Create PromotionCode Resource

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

    Constructor syntax

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

@overload
def PromotionCode(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  active: Optional[bool] = None,
                  code: Optional[str] = None,
                  customer: Optional[str] = None,
                  customer_account: Optional[str] = None,
                  expires_at: Optional[float] = None,
                  max_redemptions: Optional[float] = None,
                  metadata: Optional[Mapping[str, str]] = None,
                  promotions: Optional[Sequence[PromotionCodePromotionArgs]] = None,
                  restrictions: Optional[Sequence[PromotionCodeRestrictionArgs]] = None)
    func NewPromotionCode(ctx *Context, name string, args *PromotionCodeArgs, opts ...ResourceOption) (*PromotionCode, error)
    public PromotionCode(string name, PromotionCodeArgs? args = null, CustomResourceOptions? opts = null)
    public PromotionCode(String name, PromotionCodeArgs args)
public PromotionCode(String name, PromotionCodeArgs args, CustomResourceOptions options)

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


    resource "stripe_promotion_code" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args PromotionCodeArgs
    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 PromotionCodeArgs
    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 PromotionCodeArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PromotionCodeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PromotionCodeArgs
    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 promotionCodeResource = new Stripe.PromotionCode("promotionCodeResource", new()
{
    Active = false,
    Code = "string",
    Customer = "string",
    CustomerAccount = "string",
    ExpiresAt = 0.0,
    MaxRedemptions = 0.0,
    Metadata = 
    {
        { "string", "string" },
    },
    Promotions = new[]
    {
        new Stripe.Inputs.PromotionCodePromotionArgs
        {
            Type = "string",
            Coupon = "string",
        },
    },
    Restrictions = new[]
    {
        new Stripe.Inputs.PromotionCodeRestrictionArgs
        {
            CurrencyOptions = new[]
            {
                new Stripe.Inputs.PromotionCodeRestrictionCurrencyOptionArgs
                {
                    Key = "string",
                    MinimumAmount = 0.0,
                },
            },
            FirstTimeTransaction = false,
            MinimumAmount = 0.0,
            MinimumAmountCurrency = "string",
        },
    },
});

    example, err := stripe.NewPromotionCode(ctx, "promotionCodeResource", &stripe.PromotionCodeArgs{
	Active:          pulumi.Bool(false),
	Code:            pulumi.String("string"),
	Customer:        pulumi.String("string"),
	CustomerAccount: pulumi.String("string"),
	ExpiresAt:       pulumi.Float64(0),
	MaxRedemptions:  pulumi.Float64(0),
	Metadata: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Promotions: stripe.PromotionCodePromotionArray{
		&stripe.PromotionCodePromotionArgs{
			Type:   pulumi.String("string"),
			Coupon: pulumi.String("string"),
		},
	},
	Restrictions: stripe.PromotionCodeRestrictionArray{
		&stripe.PromotionCodeRestrictionArgs{
			CurrencyOptions: stripe.PromotionCodeRestrictionCurrencyOptionArray{
				&stripe.PromotionCodeRestrictionCurrencyOptionArgs{
					Key:           pulumi.String("string"),
					MinimumAmount: pulumi.Float64(0),
				},
			},
			FirstTimeTransaction:  pulumi.Bool(false),
			MinimumAmount:         pulumi.Float64(0),
			MinimumAmountCurrency: pulumi.String("string"),
		},
	},
})

    resource "stripe_promotion_code" "promotionCodeResource" {
  lifecycle {
    create_before_destroy = true
  }
  active           = false
  code             = "string"
  customer         = "string"
  customer_account = "string"
  expires_at       = 0
  max_redemptions  = 0
  metadata = {
    "string" = "string"
  }
  promotions {
    type   = "string"
    coupon = "string"
  }
  restrictions {
    currency_options {
      key            = "string"
      minimum_amount = 0
    }
    first_time_transaction  = false
    minimum_amount          = 0
    minimum_amount_currency = "string"
  }
}

    var promotionCodeResource = new PromotionCode("promotionCodeResource", PromotionCodeArgs.builder()
    .active(false)
    .code("string")
    .customer("string")
    .customerAccount("string")
    .expiresAt(0.0)
    .maxRedemptions(0.0)
    .metadata(Map.of("string", "string"))
    .promotions(PromotionCodePromotionArgs.builder()
        .type("string")
        .coupon("string")
        .build())
    .restrictions(PromotionCodeRestrictionArgs.builder()
        .currencyOptions(PromotionCodeRestrictionCurrencyOptionArgs.builder()
            .key("string")
            .minimumAmount(0.0)
            .build())
        .firstTimeTransaction(false)
        .minimumAmount(0.0)
        .minimumAmountCurrency("string")
        .build())
    .build());

    promotion_code_resource = stripe.PromotionCode("promotionCodeResource",
    active=False,
    code="string",
    customer="string",
    customer_account="string",
    expires_at=float(0),
    max_redemptions=float(0),
    metadata={
        "string": "string",
    },
    promotions=[{
        "type": "string",
        "coupon": "string",
    }],
    restrictions=[{
        "currency_options": [{
            "key": "string",
            "minimum_amount": float(0),
        }],
        "first_time_transaction": False,
        "minimum_amount": float(0),
        "minimum_amount_currency": "string",
    }])

    const promotionCodeResource = new stripe.PromotionCode("promotionCodeResource", {
    active: false,
    code: "string",
    customer: "string",
    customerAccount: "string",
    expiresAt: 0,
    maxRedemptions: 0,
    metadata: {
        string: "string",
    },
    promotions: [{
        type: "string",
        coupon: "string",
    }],
    restrictions: [{
        currencyOptions: [{
            key: "string",
            minimumAmount: 0,
        }],
        firstTimeTransaction: false,
        minimumAmount: 0,
        minimumAmountCurrency: "string",
    }],
});

    type: stripe:PromotionCode
properties:
    active: false
    code: string
    customer: string
    customerAccount: string
    expiresAt: 0
    maxRedemptions: 0
    metadata:
        string: string
    promotions:
        - coupon: string
          type: string
    restrictions:
        - currencyOptions:
            - key: string
              minimumAmount: 0
          firstTimeTransaction: false
          minimumAmount: 0
          minimumAmountCurrency: string

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

    Active bool
    Whether the promotion code is currently active. A promotion code is only active if the coupon is also valid.
    Code string
    The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for each customer. Valid characters are lower case letters (a-z), upper case letters (A-Z), digits (0-9), and dashes (-).
    Customer string
    The customer who can use this promotion code.
    CustomerAccount string
    The account representing the customer who can use this promotion code.
    ExpiresAt double
    Date at which the promotion code can no longer be redeemed.
    MaxRedemptions double
    Maximum number of times this promotion code can be redeemed.
    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.
    Promotions List<PromotionCodePromotion>
    Restrictions List<PromotionCodeRestriction>
    Active bool
    Whether the promotion code is currently active. A promotion code is only active if the coupon is also valid.
    Code string
    The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for each customer. Valid characters are lower case letters (a-z), upper case letters (A-Z), digits (0-9), and dashes (-).
    Customer string
    The customer who can use this promotion code.
    CustomerAccount string
    The account representing the customer who can use this promotion code.
    ExpiresAt float64
    Date at which the promotion code can no longer be redeemed.
    MaxRedemptions float64
    Maximum number of times this promotion code can be redeemed.
    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.
    Promotions []PromotionCodePromotionArgs
    Restrictions []PromotionCodeRestrictionArgs
    active bool
    Whether the promotion code is currently active. A promotion code is only active if the coupon is also valid.
    code string
    The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for each customer. Valid characters are lower case letters (a-z), upper case letters (A-Z), digits (0-9), and dashes (-).
    customer string
    The customer who can use this promotion code.
    customer_account string
    The account representing the customer who can use this promotion code.
    expires_at number
    Date at which the promotion code can no longer be redeemed.
    max_redemptions number
    Maximum number of times this promotion code can be redeemed.
    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.
    promotions list(object)
    restrictions list(object)
    active Boolean
    Whether the promotion code is currently active. A promotion code is only active if the coupon is also valid.
    code String
    The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for each customer. Valid characters are lower case letters (a-z), upper case letters (A-Z), digits (0-9), and dashes (-).
    customer String
    The customer who can use this promotion code.
    customerAccount String
    The account representing the customer who can use this promotion code.
    expiresAt Double
    Date at which the promotion code can no longer be redeemed.
    maxRedemptions Double
    Maximum number of times this promotion code can be redeemed.
    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.
    promotions List<PromotionCodePromotion>
    restrictions List<PromotionCodeRestriction>
    active boolean
    Whether the promotion code is currently active. A promotion code is only active if the coupon is also valid.
    code string
    The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for each customer. Valid characters are lower case letters (a-z), upper case letters (A-Z), digits (0-9), and dashes (-).
    customer string
    The customer who can use this promotion code.
    customerAccount string
    The account representing the customer who can use this promotion code.
    expiresAt number
    Date at which the promotion code can no longer be redeemed.
    maxRedemptions number
    Maximum number of times this promotion code can be redeemed.
    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.
    promotions PromotionCodePromotion[]
    restrictions PromotionCodeRestriction[]
    active bool
    Whether the promotion code is currently active. A promotion code is only active if the coupon is also valid.
    code str
    The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for each customer. Valid characters are lower case letters (a-z), upper case letters (A-Z), digits (0-9), and dashes (-).
    customer str
    The customer who can use this promotion code.
    customer_account str
    The account representing the customer who can use this promotion code.
    expires_at float
    Date at which the promotion code can no longer be redeemed.
    max_redemptions float
    Maximum number of times this promotion code can be redeemed.
    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.
    promotions Sequence[PromotionCodePromotionArgs]
    restrictions Sequence[PromotionCodeRestrictionArgs]
    active Boolean
    Whether the promotion code is currently active. A promotion code is only active if the coupon is also valid.
    code String
    The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for each customer. Valid characters are lower case letters (a-z), upper case letters (A-Z), digits (0-9), and dashes (-).
    customer String
    The customer who can use this promotion code.
    customerAccount String
    The account representing the customer who can use this promotion code.
    expiresAt Number
    Date at which the promotion code can no longer be redeemed.
    maxRedemptions Number
    Maximum number of times this promotion code can be redeemed.
    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.
    promotions List<Property Map>
    restrictions List<Property Map>

    Outputs

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

    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.
    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.
    TimesRedeemed double
    Number of times this promotion code has been used.
    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.
    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.
    TimesRedeemed float64
    Number of times this promotion code has been used.
    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.
    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.
    times_redeemed number
    Number of times this promotion code has been used.
    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.
    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.
    timesRedeemed Double
    Number of times this promotion code has been used.
    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.
    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.
    timesRedeemed number
    Number of times this promotion code has been used.
    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.
    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.
    times_redeemed float
    Number of times this promotion code has been used.
    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.
    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.
    timesRedeemed Number
    Number of times this promotion code has been used.

    Look up Existing PromotionCode Resource

    Get an existing PromotionCode 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?: PromotionCodeState, opts?: CustomResourceOptions): PromotionCode
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        active: Optional[bool] = None,
        code: Optional[str] = None,
        created: Optional[float] = None,
        customer: Optional[str] = None,
        customer_account: Optional[str] = None,
        expires_at: Optional[float] = None,
        livemode: Optional[bool] = None,
        max_redemptions: Optional[float] = None,
        metadata: Optional[Mapping[str, str]] = None,
        object: Optional[str] = None,
        promotions: Optional[Sequence[PromotionCodePromotionArgs]] = None,
        restrictions: Optional[Sequence[PromotionCodeRestrictionArgs]] = None,
        times_redeemed: Optional[float] = None) -> PromotionCode
    func GetPromotionCode(ctx *Context, name string, id IDInput, state *PromotionCodeState, opts ...ResourceOption) (*PromotionCode, error)
    public static PromotionCode Get(string name, Input<string> id, PromotionCodeState? state, CustomResourceOptions? opts = null)
    public static PromotionCode get(String name, Output<String> id, PromotionCodeState state, CustomResourceOptions options)
    resources:  _:    type: stripe:PromotionCode    get:      id: ${id}
    import {
  to = stripe_promotion_code.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 promotion code is currently active. A promotion code is only active if the coupon is also valid.
    Code string
    The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for each customer. Valid characters are lower case letters (a-z), upper case letters (A-Z), digits (0-9), and dashes (-).
    Created double
    Time at which the object was created. Measured in seconds since the Unix epoch.
    Customer string
    The customer who can use this promotion code.
    CustomerAccount string
    The account representing the customer who can use this promotion code.
    ExpiresAt double
    Date at which the promotion code can no longer be redeemed.
    Livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    MaxRedemptions double
    Maximum number of times this promotion code can be redeemed.
    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.
    Object string
    String representing the object's type. Objects of the same type share the same value.
    Promotions List<PromotionCodePromotion>
    Restrictions List<PromotionCodeRestriction>
    TimesRedeemed double
    Number of times this promotion code has been used.
    Active bool
    Whether the promotion code is currently active. A promotion code is only active if the coupon is also valid.
    Code string
    The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for each customer. Valid characters are lower case letters (a-z), upper case letters (A-Z), digits (0-9), and dashes (-).
    Created float64
    Time at which the object was created. Measured in seconds since the Unix epoch.
    Customer string
    The customer who can use this promotion code.
    CustomerAccount string
    The account representing the customer who can use this promotion code.
    ExpiresAt float64
    Date at which the promotion code can no longer be redeemed.
    Livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    MaxRedemptions float64
    Maximum number of times this promotion code can be redeemed.
    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.
    Object string
    String representing the object's type. Objects of the same type share the same value.
    Promotions []PromotionCodePromotionArgs
    Restrictions []PromotionCodeRestrictionArgs
    TimesRedeemed float64
    Number of times this promotion code has been used.
    active bool
    Whether the promotion code is currently active. A promotion code is only active if the coupon is also valid.
    code string
    The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for each customer. Valid characters are lower case letters (a-z), upper case letters (A-Z), digits (0-9), and dashes (-).
    created number
    Time at which the object was created. Measured in seconds since the Unix epoch.
    customer string
    The customer who can use this promotion code.
    customer_account string
    The account representing the customer who can use this promotion code.
    expires_at number
    Date at which the promotion code can no longer be redeemed.
    livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    max_redemptions number
    Maximum number of times this promotion code can be redeemed.
    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.
    object string
    String representing the object's type. Objects of the same type share the same value.
    promotions list(object)
    restrictions list(object)
    times_redeemed number
    Number of times this promotion code has been used.
    active Boolean
    Whether the promotion code is currently active. A promotion code is only active if the coupon is also valid.
    code String
    The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for each customer. Valid characters are lower case letters (a-z), upper case letters (A-Z), digits (0-9), and dashes (-).
    created Double
    Time at which the object was created. Measured in seconds since the Unix epoch.
    customer String
    The customer who can use this promotion code.
    customerAccount String
    The account representing the customer who can use this promotion code.
    expiresAt Double
    Date at which the promotion code can no longer be redeemed.
    livemode Boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    maxRedemptions Double
    Maximum number of times this promotion code can be redeemed.
    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.
    object String
    String representing the object's type. Objects of the same type share the same value.
    promotions List<PromotionCodePromotion>
    restrictions List<PromotionCodeRestriction>
    timesRedeemed Double
    Number of times this promotion code has been used.
    active boolean
    Whether the promotion code is currently active. A promotion code is only active if the coupon is also valid.
    code string
    The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for each customer. Valid characters are lower case letters (a-z), upper case letters (A-Z), digits (0-9), and dashes (-).
    created number
    Time at which the object was created. Measured in seconds since the Unix epoch.
    customer string
    The customer who can use this promotion code.
    customerAccount string
    The account representing the customer who can use this promotion code.
    expiresAt number
    Date at which the promotion code can no longer be redeemed.
    livemode boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    maxRedemptions number
    Maximum number of times this promotion code can be redeemed.
    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.
    object string
    String representing the object's type. Objects of the same type share the same value.
    promotions PromotionCodePromotion[]
    restrictions PromotionCodeRestriction[]
    timesRedeemed number
    Number of times this promotion code has been used.
    active bool
    Whether the promotion code is currently active. A promotion code is only active if the coupon is also valid.
    code str
    The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for each customer. Valid characters are lower case letters (a-z), upper case letters (A-Z), digits (0-9), and dashes (-).
    created float
    Time at which the object was created. Measured in seconds since the Unix epoch.
    customer str
    The customer who can use this promotion code.
    customer_account str
    The account representing the customer who can use this promotion code.
    expires_at float
    Date at which the promotion code can no longer be redeemed.
    livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    max_redemptions float
    Maximum number of times this promotion code can be redeemed.
    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.
    object str
    String representing the object's type. Objects of the same type share the same value.
    promotions Sequence[PromotionCodePromotionArgs]
    restrictions Sequence[PromotionCodeRestrictionArgs]
    times_redeemed float
    Number of times this promotion code has been used.
    active Boolean
    Whether the promotion code is currently active. A promotion code is only active if the coupon is also valid.
    code String
    The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for each customer. Valid characters are lower case letters (a-z), upper case letters (A-Z), digits (0-9), and dashes (-).
    created Number
    Time at which the object was created. Measured in seconds since the Unix epoch.
    customer String
    The customer who can use this promotion code.
    customerAccount String
    The account representing the customer who can use this promotion code.
    expiresAt Number
    Date at which the promotion code can no longer be redeemed.
    livemode Boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    maxRedemptions Number
    Maximum number of times this promotion code can be redeemed.
    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.
    object String
    String representing the object's type. Objects of the same type share the same value.
    promotions List<Property Map>
    restrictions List<Property Map>
    timesRedeemed Number
    Number of times this promotion code has been used.

    Supporting Types

    PromotionCodePromotion, PromotionCodePromotionArgs

    Type string
    The type of promotion.
    Coupon string
    If promotion type is coupon, the coupon for this promotion.
    Type string
    The type of promotion.
    Coupon string
    If promotion type is coupon, the coupon for this promotion.
    type string
    The type of promotion.
    coupon string
    If promotion type is coupon, the coupon for this promotion.
    type String
    The type of promotion.
    coupon String
    If promotion type is coupon, the coupon for this promotion.
    type string
    The type of promotion.
    coupon string
    If promotion type is coupon, the coupon for this promotion.
    type str
    The type of promotion.
    coupon str
    If promotion type is coupon, the coupon for this promotion.
    type String
    The type of promotion.
    coupon String
    If promotion type is coupon, the coupon for this promotion.

    PromotionCodeRestriction, PromotionCodeRestrictionArgs

    CurrencyOptions List<PromotionCodeRestrictionCurrencyOption>
    Promotion code restrictions defined in each available currency option. Each key must be a three-letter ISO currency code and a supported currency.
    FirstTimeTransaction bool
    A Boolean indicating if the Promotion Code should only be redeemed for Customers without any successful payments or invoices
    MinimumAmount double
    Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work).
    MinimumAmountCurrency string
    Three-letter ISO code for minimum_amount
    CurrencyOptions []PromotionCodeRestrictionCurrencyOption
    Promotion code restrictions defined in each available currency option. Each key must be a three-letter ISO currency code and a supported currency.
    FirstTimeTransaction bool
    A Boolean indicating if the Promotion Code should only be redeemed for Customers without any successful payments or invoices
    MinimumAmount float64
    Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work).
    MinimumAmountCurrency string
    Three-letter ISO code for minimum_amount
    currency_options list(object)
    Promotion code restrictions defined in each available currency option. Each key must be a three-letter ISO currency code and a supported currency.
    first_time_transaction bool
    A Boolean indicating if the Promotion Code should only be redeemed for Customers without any successful payments or invoices
    minimum_amount number
    Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work).
    minimum_amount_currency string
    Three-letter ISO code for minimum_amount
    currencyOptions List<PromotionCodeRestrictionCurrencyOption>
    Promotion code restrictions defined in each available currency option. Each key must be a three-letter ISO currency code and a supported currency.
    firstTimeTransaction Boolean
    A Boolean indicating if the Promotion Code should only be redeemed for Customers without any successful payments or invoices
    minimumAmount Double
    Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work).
    minimumAmountCurrency String
    Three-letter ISO code for minimum_amount
    currencyOptions PromotionCodeRestrictionCurrencyOption[]
    Promotion code restrictions defined in each available currency option. Each key must be a three-letter ISO currency code and a supported currency.
    firstTimeTransaction boolean
    A Boolean indicating if the Promotion Code should only be redeemed for Customers without any successful payments or invoices
    minimumAmount number
    Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work).
    minimumAmountCurrency string
    Three-letter ISO code for minimum_amount
    currency_options Sequence[PromotionCodeRestrictionCurrencyOption]
    Promotion code restrictions defined in each available currency option. Each key must be a three-letter ISO currency code and a supported currency.
    first_time_transaction bool
    A Boolean indicating if the Promotion Code should only be redeemed for Customers without any successful payments or invoices
    minimum_amount float
    Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work).
    minimum_amount_currency str
    Three-letter ISO code for minimum_amount
    currencyOptions List<Property Map>
    Promotion code restrictions defined in each available currency option. Each key must be a three-letter ISO currency code and a supported currency.
    firstTimeTransaction Boolean
    A Boolean indicating if the Promotion Code should only be redeemed for Customers without any successful payments or invoices
    minimumAmount Number
    Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work).
    minimumAmountCurrency String
    Three-letter ISO code for minimum_amount

    PromotionCodeRestrictionCurrencyOption, PromotionCodeRestrictionCurrencyOptionArgs

    Key string
    Key for this entry.
    MinimumAmount double
    Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work).
    Key string
    Key for this entry.
    MinimumAmount float64
    Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work).
    key string
    Key for this entry.
    minimum_amount number
    Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work).
    key String
    Key for this entry.
    minimumAmount Double
    Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work).
    key string
    Key for this entry.
    minimumAmount number
    Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work).
    key str
    Key for this entry.
    minimum_amount float
    Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work).
    key String
    Key for this entry.
    minimumAmount Number
    Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work).

    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