Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Commercetools Provider
  3. API Docs
  4. DiscountCode
commercetools 1.19.2 published on Friday, Mar 7, 2025 by labd
labd/terraform-provider-commercetools

commercetools.DiscountCode

Explore with Pulumi AI

commercetools logo
commercetools 1.19.2 published on Friday, Mar 7, 2025 by labd
labd/terraform-provider-commercetools

    With discount codes it is possible to give specific cart discounts to an eligible set of users. They are defined by a string value which can be added to a cart so that specific cart discounts can be applied to the cart.

    See also the Discount Code Api Documentation

    Create DiscountCode Resource

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

    Constructor syntax

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

@overload
def DiscountCode(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 cart_discounts: Optional[Sequence[str]] = None,
                 code: Optional[str] = None,
                 custom: Optional[DiscountCodeCustomArgs] = None,
                 description: Optional[Mapping[str, str]] = None,
                 discount_code_id: Optional[str] = None,
                 groups: Optional[Sequence[str]] = None,
                 is_active: Optional[bool] = None,
                 max_applications: Optional[float] = None,
                 max_applications_per_customer: Optional[float] = None,
                 name: Optional[Mapping[str, str]] = None,
                 predicate: Optional[str] = None,
                 valid_from: Optional[str] = None,
                 valid_until: Optional[str] = None)
    func NewDiscountCode(ctx *Context, name string, args DiscountCodeArgs, opts ...ResourceOption) (*DiscountCode, error)
    public DiscountCode(string name, DiscountCodeArgs args, CustomResourceOptions? opts = null)
    public DiscountCode(String name, DiscountCodeArgs args)
public DiscountCode(String name, DiscountCodeArgs args, CustomResourceOptions options)

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

    Parameters

    name string
    The unique name of the resource.
    args DiscountCodeArgs
    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 DiscountCodeArgs
    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 DiscountCodeArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DiscountCodeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DiscountCodeArgs
    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 discountCodeResource = new Commercetools.DiscountCode("discountCodeResource", new()
{
    CartDiscounts = new[]
    {
        "string",
    },
    Code = "string",
    Custom = new Commercetools.Inputs.DiscountCodeCustomArgs
    {
        TypeId = "string",
        Fields = 
        {
            { "string", "string" },
        },
    },
    Description = 
    {
        { "string", "string" },
    },
    DiscountCodeId = "string",
    Groups = new[]
    {
        "string",
    },
    IsActive = false,
    MaxApplications = 0,
    MaxApplicationsPerCustomer = 0,
    Name = 
    {
        { "string", "string" },
    },
    Predicate = "string",
    ValidFrom = "string",
    ValidUntil = "string",
});

    example, err := commercetools.NewDiscountCode(ctx, "discountCodeResource", &commercetools.DiscountCodeArgs{
CartDiscounts: pulumi.StringArray{
pulumi.String("string"),
},
Code: pulumi.String("string"),
Custom: &.DiscountCodeCustomArgs{
TypeId: pulumi.String("string"),
Fields: pulumi.StringMap{
"string": pulumi.String("string"),
},
},
Description: pulumi.StringMap{
"string": pulumi.String("string"),
},
DiscountCodeId: pulumi.String("string"),
Groups: pulumi.StringArray{
pulumi.String("string"),
},
IsActive: pulumi.Bool(false),
MaxApplications: pulumi.Float64(0),
MaxApplicationsPerCustomer: pulumi.Float64(0),
Name: pulumi.StringMap{
"string": pulumi.String("string"),
},
Predicate: pulumi.String("string"),
ValidFrom: pulumi.String("string"),
ValidUntil: pulumi.String("string"),
})

    var discountCodeResource = new DiscountCode("discountCodeResource", DiscountCodeArgs.builder()
    .cartDiscounts("string")
    .code("string")
    .custom(DiscountCodeCustomArgs.builder()
        .typeId("string")
        .fields(Map.of("string", "string"))
        .build())
    .description(Map.of("string", "string"))
    .discountCodeId("string")
    .groups("string")
    .isActive(false)
    .maxApplications(0)
    .maxApplicationsPerCustomer(0)
    .name(Map.of("string", "string"))
    .predicate("string")
    .validFrom("string")
    .validUntil("string")
    .build());

    discount_code_resource = commercetools.DiscountCode("discountCodeResource",
    cart_discounts=["string"],
    code="string",
    custom={
        "type_id": "string",
        "fields": {
            "string": "string",
        },
    },
    description={
        "string": "string",
    },
    discount_code_id="string",
    groups=["string"],
    is_active=False,
    max_applications=0,
    max_applications_per_customer=0,
    name={
        "string": "string",
    },
    predicate="string",
    valid_from="string",
    valid_until="string")

    const discountCodeResource = new commercetools.DiscountCode("discountCodeResource", {
    cartDiscounts: ["string"],
    code: "string",
    custom: {
        typeId: "string",
        fields: {
            string: "string",
        },
    },
    description: {
        string: "string",
    },
    discountCodeId: "string",
    groups: ["string"],
    isActive: false,
    maxApplications: 0,
    maxApplicationsPerCustomer: 0,
    name: {
        string: "string",
    },
    predicate: "string",
    validFrom: "string",
    validUntil: "string",
});

    type: commercetools:DiscountCode
properties:
    cartDiscounts:
        - string
    code: string
    custom:
        fields:
            string: string
        typeId: string
    description:
        string: string
    discountCodeId: string
    groups:
        - string
    isActive: false
    maxApplications: 0
    maxApplicationsPerCustomer: 0
    name:
        string: string
    predicate: string
    validFrom: string
    validUntil: string

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

    CartDiscounts List<string>
    The referenced matching cart discounts can be applied to the cart once the DiscountCode is added
    Code string
    Unique identifier of this discount code. This value is added to the cart to enable the related cart discounts in the cart
    Custom DiscountCodeCustom
    Description Dictionary<string, string>
    LocalizedString
    DiscountCodeId string
    The ID of this resource.
    Groups List<string>
    The groups to which this discount code belong
    IsActive bool
    MaxApplications double
    The discount code can only be applied the specified times overall. Note that due to an engine constraint 0 cannot be set for this field, so possible values are either larger than 0 or not set
    MaxApplicationsPerCustomer double
    The discount code can only be applied the specified times per customer. Note that due to an engine constraint 0 cannot be set for this field, so possible values are either larger than 0 or not set
    Name Dictionary<string, string>
    LocalizedString
    Predicate string
    Cart Predicate
    ValidFrom string
    The time from which the discount can be applied on a cart. Before that time the code is invalid
    ValidUntil string
    The time until the discount can be applied on a cart. After that time the code is invalid
    CartDiscounts []string
    The referenced matching cart discounts can be applied to the cart once the DiscountCode is added
    Code string
    Unique identifier of this discount code. This value is added to the cart to enable the related cart discounts in the cart
    Custom DiscountCodeCustomArgs
    Description map[string]string
    LocalizedString
    DiscountCodeId string
    The ID of this resource.
    Groups []string
    The groups to which this discount code belong
    IsActive bool
    MaxApplications float64
    The discount code can only be applied the specified times overall. Note that due to an engine constraint 0 cannot be set for this field, so possible values are either larger than 0 or not set
    MaxApplicationsPerCustomer float64
    The discount code can only be applied the specified times per customer. Note that due to an engine constraint 0 cannot be set for this field, so possible values are either larger than 0 or not set
    Name map[string]string
    LocalizedString
    Predicate string
    Cart Predicate
    ValidFrom string
    The time from which the discount can be applied on a cart. Before that time the code is invalid
    ValidUntil string
    The time until the discount can be applied on a cart. After that time the code is invalid
    cartDiscounts List<String>
    The referenced matching cart discounts can be applied to the cart once the DiscountCode is added
    code String
    Unique identifier of this discount code. This value is added to the cart to enable the related cart discounts in the cart
    custom DiscountCodeCustom
    description Map<String,String>
    LocalizedString
    discountCodeId String
    The ID of this resource.
    groups List<String>
    The groups to which this discount code belong
    isActive Boolean
    maxApplications Double
    The discount code can only be applied the specified times overall. Note that due to an engine constraint 0 cannot be set for this field, so possible values are either larger than 0 or not set
    maxApplicationsPerCustomer Double
    The discount code can only be applied the specified times per customer. Note that due to an engine constraint 0 cannot be set for this field, so possible values are either larger than 0 or not set
    name Map<String,String>
    LocalizedString
    predicate String
    Cart Predicate
    validFrom String
    The time from which the discount can be applied on a cart. Before that time the code is invalid
    validUntil String
    The time until the discount can be applied on a cart. After that time the code is invalid
    cartDiscounts string[]
    The referenced matching cart discounts can be applied to the cart once the DiscountCode is added
    code string
    Unique identifier of this discount code. This value is added to the cart to enable the related cart discounts in the cart
    custom DiscountCodeCustom
    description {[key: string]: string}
    LocalizedString
    discountCodeId string
    The ID of this resource.
    groups string[]
    The groups to which this discount code belong
    isActive boolean
    maxApplications number
    The discount code can only be applied the specified times overall. Note that due to an engine constraint 0 cannot be set for this field, so possible values are either larger than 0 or not set
    maxApplicationsPerCustomer number
    The discount code can only be applied the specified times per customer. Note that due to an engine constraint 0 cannot be set for this field, so possible values are either larger than 0 or not set
    name {[key: string]: string}
    LocalizedString
    predicate string
    Cart Predicate
    validFrom string
    The time from which the discount can be applied on a cart. Before that time the code is invalid
    validUntil string
    The time until the discount can be applied on a cart. After that time the code is invalid
    cart_discounts Sequence[str]
    The referenced matching cart discounts can be applied to the cart once the DiscountCode is added
    code str
    Unique identifier of this discount code. This value is added to the cart to enable the related cart discounts in the cart
    custom DiscountCodeCustomArgs
    description Mapping[str, str]
    LocalizedString
    discount_code_id str
    The ID of this resource.
    groups Sequence[str]
    The groups to which this discount code belong
    is_active bool
    max_applications float
    The discount code can only be applied the specified times overall. Note that due to an engine constraint 0 cannot be set for this field, so possible values are either larger than 0 or not set
    max_applications_per_customer float
    The discount code can only be applied the specified times per customer. Note that due to an engine constraint 0 cannot be set for this field, so possible values are either larger than 0 or not set
    name Mapping[str, str]
    LocalizedString
    predicate str
    Cart Predicate
    valid_from str
    The time from which the discount can be applied on a cart. Before that time the code is invalid
    valid_until str
    The time until the discount can be applied on a cart. After that time the code is invalid
    cartDiscounts List<String>
    The referenced matching cart discounts can be applied to the cart once the DiscountCode is added
    code String
    Unique identifier of this discount code. This value is added to the cart to enable the related cart discounts in the cart
    custom Property Map
    description Map<String>
    LocalizedString
    discountCodeId String
    The ID of this resource.
    groups List<String>
    The groups to which this discount code belong
    isActive Boolean
    maxApplications Number
    The discount code can only be applied the specified times overall. Note that due to an engine constraint 0 cannot be set for this field, so possible values are either larger than 0 or not set
    maxApplicationsPerCustomer Number
    The discount code can only be applied the specified times per customer. Note that due to an engine constraint 0 cannot be set for this field, so possible values are either larger than 0 or not set
    name Map<String>
    LocalizedString
    predicate String
    Cart Predicate
    validFrom String
    The time from which the discount can be applied on a cart. Before that time the code is invalid
    validUntil String
    The time until the discount can be applied on a cart. After that time the code is invalid

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Version double
    Id string
    The provider-assigned unique ID for this managed resource.
    Version float64
    id String
    The provider-assigned unique ID for this managed resource.
    version Double
    id string
    The provider-assigned unique ID for this managed resource.
    version number
    id str
    The provider-assigned unique ID for this managed resource.
    version float
    id String
    The provider-assigned unique ID for this managed resource.
    version Number

    Look up Existing DiscountCode Resource

    Get an existing DiscountCode 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?: DiscountCodeState, opts?: CustomResourceOptions): DiscountCode
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cart_discounts: Optional[Sequence[str]] = None,
        code: Optional[str] = None,
        custom: Optional[DiscountCodeCustomArgs] = None,
        description: Optional[Mapping[str, str]] = None,
        discount_code_id: Optional[str] = None,
        groups: Optional[Sequence[str]] = None,
        is_active: Optional[bool] = None,
        max_applications: Optional[float] = None,
        max_applications_per_customer: Optional[float] = None,
        name: Optional[Mapping[str, str]] = None,
        predicate: Optional[str] = None,
        valid_from: Optional[str] = None,
        valid_until: Optional[str] = None,
        version: Optional[float] = None) -> DiscountCode
    func GetDiscountCode(ctx *Context, name string, id IDInput, state *DiscountCodeState, opts ...ResourceOption) (*DiscountCode, error)
    public static DiscountCode Get(string name, Input<string> id, DiscountCodeState? state, CustomResourceOptions? opts = null)
    public static DiscountCode get(String name, Output<String> id, DiscountCodeState state, CustomResourceOptions options)
    resources:  _:    type: commercetools:DiscountCode    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    CartDiscounts List<string>
    The referenced matching cart discounts can be applied to the cart once the DiscountCode is added
    Code string
    Unique identifier of this discount code. This value is added to the cart to enable the related cart discounts in the cart
    Custom DiscountCodeCustom
    Description Dictionary<string, string>
    LocalizedString
    DiscountCodeId string
    The ID of this resource.
    Groups List<string>
    The groups to which this discount code belong
    IsActive bool
    MaxApplications double
    The discount code can only be applied the specified times overall. Note that due to an engine constraint 0 cannot be set for this field, so possible values are either larger than 0 or not set
    MaxApplicationsPerCustomer double
    The discount code can only be applied the specified times per customer. Note that due to an engine constraint 0 cannot be set for this field, so possible values are either larger than 0 or not set
    Name Dictionary<string, string>
    LocalizedString
    Predicate string
    Cart Predicate
    ValidFrom string
    The time from which the discount can be applied on a cart. Before that time the code is invalid
    ValidUntil string
    The time until the discount can be applied on a cart. After that time the code is invalid
    Version double
    CartDiscounts []string
    The referenced matching cart discounts can be applied to the cart once the DiscountCode is added
    Code string
    Unique identifier of this discount code. This value is added to the cart to enable the related cart discounts in the cart
    Custom DiscountCodeCustomArgs
    Description map[string]string
    LocalizedString
    DiscountCodeId string
    The ID of this resource.
    Groups []string
    The groups to which this discount code belong
    IsActive bool
    MaxApplications float64
    The discount code can only be applied the specified times overall. Note that due to an engine constraint 0 cannot be set for this field, so possible values are either larger than 0 or not set
    MaxApplicationsPerCustomer float64
    The discount code can only be applied the specified times per customer. Note that due to an engine constraint 0 cannot be set for this field, so possible values are either larger than 0 or not set
    Name map[string]string
    LocalizedString
    Predicate string
    Cart Predicate
    ValidFrom string
    The time from which the discount can be applied on a cart. Before that time the code is invalid
    ValidUntil string
    The time until the discount can be applied on a cart. After that time the code is invalid
    Version float64
    cartDiscounts List<String>
    The referenced matching cart discounts can be applied to the cart once the DiscountCode is added
    code String
    Unique identifier of this discount code. This value is added to the cart to enable the related cart discounts in the cart
    custom DiscountCodeCustom
    description Map<String,String>
    LocalizedString
    discountCodeId String
    The ID of this resource.
    groups List<String>
    The groups to which this discount code belong
    isActive Boolean
    maxApplications Double
    The discount code can only be applied the specified times overall. Note that due to an engine constraint 0 cannot be set for this field, so possible values are either larger than 0 or not set
    maxApplicationsPerCustomer Double
    The discount code can only be applied the specified times per customer. Note that due to an engine constraint 0 cannot be set for this field, so possible values are either larger than 0 or not set
    name Map<String,String>
    LocalizedString
    predicate String
    Cart Predicate
    validFrom String
    The time from which the discount can be applied on a cart. Before that time the code is invalid
    validUntil String
    The time until the discount can be applied on a cart. After that time the code is invalid
    version Double
    cartDiscounts string[]
    The referenced matching cart discounts can be applied to the cart once the DiscountCode is added
    code string
    Unique identifier of this discount code. This value is added to the cart to enable the related cart discounts in the cart
    custom DiscountCodeCustom
    description {[key: string]: string}
    LocalizedString
    discountCodeId string
    The ID of this resource.
    groups string[]
    The groups to which this discount code belong
    isActive boolean
    maxApplications number
    The discount code can only be applied the specified times overall. Note that due to an engine constraint 0 cannot be set for this field, so possible values are either larger than 0 or not set
    maxApplicationsPerCustomer number
    The discount code can only be applied the specified times per customer. Note that due to an engine constraint 0 cannot be set for this field, so possible values are either larger than 0 or not set
    name {[key: string]: string}
    LocalizedString
    predicate string
    Cart Predicate
    validFrom string
    The time from which the discount can be applied on a cart. Before that time the code is invalid
    validUntil string
    The time until the discount can be applied on a cart. After that time the code is invalid
    version number
    cart_discounts Sequence[str]
    The referenced matching cart discounts can be applied to the cart once the DiscountCode is added
    code str
    Unique identifier of this discount code. This value is added to the cart to enable the related cart discounts in the cart
    custom DiscountCodeCustomArgs
    description Mapping[str, str]
    LocalizedString
    discount_code_id str
    The ID of this resource.
    groups Sequence[str]
    The groups to which this discount code belong
    is_active bool
    max_applications float
    The discount code can only be applied the specified times overall. Note that due to an engine constraint 0 cannot be set for this field, so possible values are either larger than 0 or not set
    max_applications_per_customer float
    The discount code can only be applied the specified times per customer. Note that due to an engine constraint 0 cannot be set for this field, so possible values are either larger than 0 or not set
    name Mapping[str, str]
    LocalizedString
    predicate str
    Cart Predicate
    valid_from str
    The time from which the discount can be applied on a cart. Before that time the code is invalid
    valid_until str
    The time until the discount can be applied on a cart. After that time the code is invalid
    version float
    cartDiscounts List<String>
    The referenced matching cart discounts can be applied to the cart once the DiscountCode is added
    code String
    Unique identifier of this discount code. This value is added to the cart to enable the related cart discounts in the cart
    custom Property Map
    description Map<String>
    LocalizedString
    discountCodeId String
    The ID of this resource.
    groups List<String>
    The groups to which this discount code belong
    isActive Boolean
    maxApplications Number
    The discount code can only be applied the specified times overall. Note that due to an engine constraint 0 cannot be set for this field, so possible values are either larger than 0 or not set
    maxApplicationsPerCustomer Number
    The discount code can only be applied the specified times per customer. Note that due to an engine constraint 0 cannot be set for this field, so possible values are either larger than 0 or not set
    name Map<String>
    LocalizedString
    predicate String
    Cart Predicate
    validFrom String
    The time from which the discount can be applied on a cart. Before that time the code is invalid
    validUntil String
    The time until the discount can be applied on a cart. After that time the code is invalid
    version Number

    Supporting Types

    DiscountCodeCustom, DiscountCodeCustomArgs

    TypeId string
    Fields Dictionary<string, string>
    Custom fields for this resource. Note that the values need to be provided as JSON encoded strings: my-value = jsonencode({"key": "value"})
    TypeId string
    Fields map[string]string
    Custom fields for this resource. Note that the values need to be provided as JSON encoded strings: my-value = jsonencode({"key": "value"})
    typeId String
    fields Map<String,String>
    Custom fields for this resource. Note that the values need to be provided as JSON encoded strings: my-value = jsonencode({"key": "value"})
    typeId string
    fields {[key: string]: string}
    Custom fields for this resource. Note that the values need to be provided as JSON encoded strings: my-value = jsonencode({"key": "value"})
    type_id str
    fields Mapping[str, str]
    Custom fields for this resource. Note that the values need to be provided as JSON encoded strings: my-value = jsonencode({"key": "value"})
    typeId String
    fields Map<String>
    Custom fields for this resource. Note that the values need to be provided as JSON encoded strings: my-value = jsonencode({"key": "value"})

    Package Details

    Repository
    commercetools labd/terraform-provider-commercetools
    License
    Notes
    This Pulumi package is based on the commercetools Terraform Provider.
    commercetools logo
    commercetools 1.19.2 published on Friday, Mar 7, 2025 by labd
    labd/terraform-provider-commercetools