Class CouponCreateParams

    • Method Detail

      • getAmountOff

        public java.lang.Long getAmountOff()
        A positive integer representing the amount to subtract from an invoice total (required if percent_off is not passed).
      • getAppliesTo

        public CouponCreateParams.AppliesTo getAppliesTo()
        A hash containing directions for what this Coupon will apply discounts to.
      • getCurrency

        public java.lang.String getCurrency()
        Three-letter ISO code for the currency of the amount_off parameter (required if amount_off is passed).
      • getDuration

        public CouponCreateParams.Duration getDuration()
        Specifies how long the discount will be in effect if used on a subscription. Can be forever, once, or repeating. Defaults to once.
      • getDurationInMonths

        public java.lang.Long getDurationInMonths()
        Required only if duration is repeating, in which case it must be a positive integer that specifies the number of months the discount will be in effect.
      • getExpand

        public java.util.List<java.lang.String> getExpand()
        Specifies which fields in the response should be expanded.
      • getExtraParams

        public java.util.Map<java.lang.String,​java.lang.Object> getExtraParams()
        Map of extra parameters for custom features not available in this client library. The content in this map is not serialized under this field's @SerializedName value. Instead, each key/value pair is serialized as if the key is a root-level field (serialized) name in this param object. Effectively, this map is flattened to its parent instance.
      • getId

        public java.lang.String getId()
        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.
      • getMaxRedemptions

        public java.lang.Long getMaxRedemptions()
        A positive integer specifying the number of times the coupon can be redeemed before it's no longer valid. For example, you might have a 50% off coupon that the first 20 readers of your blog can use.
      • getMetadata

        public java.lang.Object getMetadata()
        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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.
      • getName

        public java.lang.String getName()
        Name of the coupon displayed to customers on, for instance invoices, or receipts. By default the id is shown if name is not set.
      • getPercentOff

        public java.math.BigDecimal getPercentOff()
        A positive float larger than 0, and smaller or equal to 100, that represents the discount the coupon will apply (required if amount_off is not passed).
      • getRedeemBy

        public java.lang.Long getRedeemBy()
        Unix timestamp specifying the last time at which the coupon can be redeemed. After the redeem_by date, the coupon can no longer be applied to new customers.