import * as pulumi from "@pulumi/pulumi"; export declare class Coupon extends pulumi.CustomResource { /** * Get an existing Coupon resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, state?: CouponState, opts?: pulumi.CustomResourceOptions): Coupon; /** * Returns true if the given object is an instance of Coupon. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is Coupon; /** * Amount (in the currency specified) that will be taken off the subtotal of any invoices for this customer. */ readonly amountOff: pulumi.Output; /** * A list of product IDs this coupon applies to */ readonly appliesTos: pulumi.Output; /** * Unique string of your choice that will be used to identify this coupon when applying it to a customer. If you don’t * want to specify a particular code, you can leave the ID blank and we’ll generate a random code for you. */ readonly couponId: pulumi.Output; /** * If amountOff has been set, the three-letter ISO code for the currency of the amount to take off. */ readonly currency: pulumi.Output; /** * One of forever, once, and repeating. Describes how long a customer who applies this coupon will get the discount. */ readonly duration: pulumi.Output; /** * If duration is repeating, the number of months the coupon applies. Null if coupon duration is forever or once. */ readonly durationInMonths: pulumi.Output; /** * Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid. */ readonly maxRedemptions: pulumi.Output; /** * 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. */ readonly metadata: pulumi.Output<{ [key: string]: string; } | undefined>; /** * Name of the coupon displayed to customers on for instance invoices or receipts. */ readonly name: pulumi.Output; /** * Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon. For * example, a coupon with percentOff of 50 will make a $100 invoice $50 instead. */ readonly percentOff: pulumi.Output; /** * Date after which the coupon can no longer be redeemed. Expected format is RFC3339 */ readonly redeemBy: pulumi.Output; /** * Number of times this coupon has been applied to a customer. */ readonly timesRedeemed: pulumi.Output; /** * Taking account of the above properties, whether this coupon can still be applied to a customer. */ readonly valid: pulumi.Output; /** * Create a Coupon resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args?: CouponArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering Coupon resources. */ export interface CouponState { /** * Amount (in the currency specified) that will be taken off the subtotal of any invoices for this customer. */ amountOff?: pulumi.Input; /** * A list of product IDs this coupon applies to */ appliesTos?: pulumi.Input[]>; /** * Unique string of your choice that will be used to identify this coupon when applying it to a customer. If you don’t * want to specify a particular code, you can leave the ID blank and we’ll generate a random code for you. */ couponId?: pulumi.Input; /** * If amountOff has been set, the three-letter ISO code for the currency of the amount to take off. */ currency?: pulumi.Input; /** * One of forever, once, and repeating. Describes how long a customer who applies this coupon will get the discount. */ duration?: pulumi.Input; /** * If duration is repeating, the number of months the coupon applies. Null if coupon duration is forever or once. */ durationInMonths?: pulumi.Input; /** * Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid. */ maxRedemptions?: pulumi.Input; /** * 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. */ metadata?: pulumi.Input<{ [key: string]: pulumi.Input; }>; /** * Name of the coupon displayed to customers on for instance invoices or receipts. */ name?: pulumi.Input; /** * Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon. For * example, a coupon with percentOff of 50 will make a $100 invoice $50 instead. */ percentOff?: pulumi.Input; /** * Date after which the coupon can no longer be redeemed. Expected format is RFC3339 */ redeemBy?: pulumi.Input; /** * Number of times this coupon has been applied to a customer. */ timesRedeemed?: pulumi.Input; /** * Taking account of the above properties, whether this coupon can still be applied to a customer. */ valid?: pulumi.Input; } /** * The set of arguments for constructing a Coupon resource. */ export interface CouponArgs { /** * Amount (in the currency specified) that will be taken off the subtotal of any invoices for this customer. */ amountOff?: pulumi.Input; /** * A list of product IDs this coupon applies to */ appliesTos?: pulumi.Input[]>; /** * Unique string of your choice that will be used to identify this coupon when applying it to a customer. If you don’t * want to specify a particular code, you can leave the ID blank and we’ll generate a random code for you. */ couponId?: pulumi.Input; /** * If amountOff has been set, the three-letter ISO code for the currency of the amount to take off. */ currency?: pulumi.Input; /** * One of forever, once, and repeating. Describes how long a customer who applies this coupon will get the discount. */ duration?: pulumi.Input; /** * If duration is repeating, the number of months the coupon applies. Null if coupon duration is forever or once. */ durationInMonths?: pulumi.Input; /** * Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid. */ maxRedemptions?: pulumi.Input; /** * 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. */ metadata?: pulumi.Input<{ [key: string]: pulumi.Input; }>; /** * Name of the coupon displayed to customers on for instance invoices or receipts. */ name?: pulumi.Input; /** * Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon. For * example, a coupon with percentOff of 50 will make a $100 invoice $50 instead. */ percentOff?: pulumi.Input; /** * Date after which the coupon can no longer be redeemed. Expected format is RFC3339 */ redeemBy?: pulumi.Input; }