com.stripe.param.CouponCreateParams Maven / Gradle / Ivy
// Generated by delombok at Wed Jun 30 19:13:16 EDT 2021
// File generated from our OpenAPI spec
package com.stripe.param;
import com.google.gson.annotations.SerializedName;
import com.stripe.net.ApiRequestParams;
import com.stripe.param.common.EmptyParam;
import java.math.BigDecimal;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
public class CouponCreateParams extends ApiRequestParams {
/**
* A positive integer representing the amount to subtract from an invoice total (required if
* {@code percent_off} is not passed).
*/
@SerializedName("amount_off")
Long amountOff;
/**
* A hash containing directions for what this Coupon will apply discounts to.
*/
@SerializedName("applies_to")
AppliesTo appliesTo;
/**
* Three-letter ISO code for the currency of the
* {@code amount_off} parameter (required if {@code amount_off} is passed).
*/
@SerializedName("currency")
String currency;
/**
* Specifies how long the discount will be in effect if used on a subscription. Can be {@code
* forever}, {@code once}, or {@code repeating}. Defaults to {@code once}.
*/
@SerializedName("duration")
Duration duration;
/**
* Required only if {@code duration} is {@code repeating}, in which case it must be a positive
* integer that specifies the number of months the discount will be in effect.
*/
@SerializedName("duration_in_months")
Long durationInMonths;
/**
* Specifies which fields in the response should be expanded.
*/
@SerializedName("expand")
List expand;
/**
* 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 {@code @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.
*/
@SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY)
Map extraParams;
/**
* 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.
*/
@SerializedName("id")
String id;
/**
* 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.
*/
@SerializedName("max_redemptions")
Long maxRedemptions;
/**
* 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 {@code metadata}.
*/
@SerializedName("metadata")
Object metadata;
/**
* Name of the coupon displayed to customers on, for instance invoices, or receipts. By default
* the {@code id} is shown if {@code name} is not set.
*/
@SerializedName("name")
String name;
/**
* A positive float larger than 0, and smaller or equal to 100, that represents the discount the
* coupon will apply (required if {@code amount_off} is not passed).
*/
@SerializedName("percent_off")
BigDecimal percentOff;
/**
* 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.
*/
@SerializedName("redeem_by")
Long redeemBy;
private CouponCreateParams(Long amountOff, AppliesTo appliesTo, String currency, Duration duration, Long durationInMonths, List expand, Map extraParams, String id, Long maxRedemptions, Object metadata, String name, BigDecimal percentOff, Long redeemBy) {
this.amountOff = amountOff;
this.appliesTo = appliesTo;
this.currency = currency;
this.duration = duration;
this.durationInMonths = durationInMonths;
this.expand = expand;
this.extraParams = extraParams;
this.id = id;
this.maxRedemptions = maxRedemptions;
this.metadata = metadata;
this.name = name;
this.percentOff = percentOff;
this.redeemBy = redeemBy;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Long amountOff;
private AppliesTo appliesTo;
private String currency;
private Duration duration;
private Long durationInMonths;
private List expand;
private Map extraParams;
private String id;
private Long maxRedemptions;
private Object metadata;
private String name;
private BigDecimal percentOff;
private Long redeemBy;
/**
* Finalize and obtain parameter instance from this builder.
*/
public CouponCreateParams build() {
return new CouponCreateParams(this.amountOff, this.appliesTo, this.currency, this.duration, this.durationInMonths, this.expand, this.extraParams, this.id, this.maxRedemptions, this.metadata, this.name, this.percentOff, this.redeemBy);
}
/**
* A positive integer representing the amount to subtract from an invoice total (required if
* {@code percent_off} is not passed).
*/
public Builder setAmountOff(Long amountOff) {
this.amountOff = amountOff;
return this;
}
/**
* A hash containing directions for what this Coupon will apply discounts to.
*/
public Builder setAppliesTo(AppliesTo appliesTo) {
this.appliesTo = appliesTo;
return this;
}
/**
* Three-letter ISO code for the currency of
* the {@code amount_off} parameter (required if {@code amount_off} is passed).
*/
public Builder setCurrency(String currency) {
this.currency = currency;
return this;
}
/**
* Specifies how long the discount will be in effect if used on a subscription. Can be {@code
* forever}, {@code once}, or {@code repeating}. Defaults to {@code once}.
*/
public Builder setDuration(Duration duration) {
this.duration = duration;
return this;
}
/**
* Required only if {@code duration} is {@code repeating}, in which case it must be a positive
* integer that specifies the number of months the discount will be in effect.
*/
public Builder setDurationInMonths(Long durationInMonths) {
this.durationInMonths = durationInMonths;
return this;
}
/**
* Add an element to `expand` list. A list is initialized for the first `add/addAll` call, and
* subsequent calls adds additional elements to the original list. See {@link
* CouponCreateParams#expand} for the field documentation.
*/
public Builder addExpand(String element) {
if (this.expand == null) {
this.expand = new ArrayList<>();
}
this.expand.add(element);
return this;
}
/**
* Add all elements to `expand` list. A list is initialized for the first `add/addAll` call, and
* subsequent calls adds additional elements to the original list. See {@link
* CouponCreateParams#expand} for the field documentation.
*/
public Builder addAllExpand(List elements) {
if (this.expand == null) {
this.expand = new ArrayList<>();
}
this.expand.addAll(elements);
return this;
}
/**
* Add a key/value pair to `extraParams` map. A map is initialized for the first `put/putAll`
* call, and subsequent calls add additional key/value pairs to the original map. See {@link
* CouponCreateParams#extraParams} for the field documentation.
*/
public Builder putExtraParam(String key, Object value) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.put(key, value);
return this;
}
/**
* Add all map key/value pairs to `extraParams` map. A map is initialized for the first
* `put/putAll` call, and subsequent calls add additional key/value pairs to the original map.
* See {@link CouponCreateParams#extraParams} for the field documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/**
* 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.
*/
public Builder setId(String id) {
this.id = id;
return this;
}
/**
* 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.
*/
public Builder setMaxRedemptions(Long maxRedemptions) {
this.maxRedemptions = maxRedemptions;
return this;
}
/**
* Add a key/value pair to `metadata` map. A map is initialized for the first `put/putAll` call,
* and subsequent calls add additional key/value pairs to the original map. See {@link
* CouponCreateParams#metadata} for the field documentation.
*/
@SuppressWarnings("unchecked")
public Builder putMetadata(String key, String value) {
if (this.metadata == null || this.metadata instanceof EmptyParam) {
this.metadata = new HashMap();
}
((Map) this.metadata).put(key, value);
return this;
}
/**
* Add all map key/value pairs to `metadata` map. A map is initialized for the first
* `put/putAll` call, and subsequent calls add additional key/value pairs to the original map.
* See {@link CouponCreateParams#metadata} for the field documentation.
*/
@SuppressWarnings("unchecked")
public Builder putAllMetadata(Map map) {
if (this.metadata == null || this.metadata instanceof EmptyParam) {
this.metadata = new HashMap();
}
((Map) this.metadata).putAll(map);
return this;
}
/**
* 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 {@code metadata}.
*/
public Builder setMetadata(EmptyParam metadata) {
this.metadata = metadata;
return this;
}
/**
* 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 {@code metadata}.
*/
public Builder setMetadata(Map metadata) {
this.metadata = metadata;
return this;
}
/**
* Name of the coupon displayed to customers on, for instance invoices, or receipts. By default
* the {@code id} is shown if {@code name} is not set.
*/
public Builder setName(String name) {
this.name = name;
return this;
}
/**
* A positive float larger than 0, and smaller or equal to 100, that represents the discount the
* coupon will apply (required if {@code amount_off} is not passed).
*/
public Builder setPercentOff(BigDecimal percentOff) {
this.percentOff = percentOff;
return this;
}
/**
* 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.
*/
public Builder setRedeemBy(Long redeemBy) {
this.redeemBy = redeemBy;
return this;
}
}
public static class AppliesTo {
/**
* 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 {@code @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.
*/
@SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY)
Map extraParams;
/**
* An array of Product IDs that this Coupon will apply to.
*/
@SerializedName("products")
List products;
private AppliesTo(Map extraParams, List products) {
this.extraParams = extraParams;
this.products = products;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Map extraParams;
private List products;
/** Finalize and obtain parameter instance from this builder. */
public AppliesTo build() {
return new AppliesTo(this.extraParams, this.products);
}
/**
* Add a key/value pair to `extraParams` map. A map is initialized for the first `put/putAll`
* call, and subsequent calls add additional key/value pairs to the original map. See {@link
* CouponCreateParams.AppliesTo#extraParams} for the field documentation.
*/
public Builder putExtraParam(String key, Object value) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.put(key, value);
return this;
}
/**
* Add all map key/value pairs to `extraParams` map. A map is initialized for the first
* `put/putAll` call, and subsequent calls add additional key/value pairs to the original map.
* See {@link CouponCreateParams.AppliesTo#extraParams} for the field documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/**
* Add an element to `products` list. A list is initialized for the first `add/addAll` call,
* and subsequent calls adds additional elements to the original list. See {@link
* CouponCreateParams.AppliesTo#products} for the field documentation.
*/
public Builder addProduct(String element) {
if (this.products == null) {
this.products = new ArrayList<>();
}
this.products.add(element);
return this;
}
public Builder addAllProduct(List elements) {
if (this.products == null) {
this.products = new ArrayList<>();
}
this.products.addAll(elements);
return this;
}
}
/**
* 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 {@code @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.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Map getExtraParams() {
return this.extraParams;
}
/**
* An array of Product IDs that this Coupon will apply to.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public List getProducts() {
return this.products;
}
}
/**
* Add all elements to `products` list. A list is initialized for the first `add/addAll` call,
* and subsequent calls adds additional elements to the original list. See {@link
* CouponCreateParams.AppliesTo#products} for the field documentation.
*/
public enum Duration implements ApiRequestParams.EnumParam {
@SerializedName("forever")
FOREVER("forever"), @SerializedName("once")
ONCE("once"), @SerializedName("repeating")
REPEATING("repeating");
private final String value;
Duration(String value) {
this.value = value;
}
@Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getValue() {
return this.value;
}
}
/**
* A positive integer representing the amount to subtract from an invoice total (required if
* {@code percent_off} is not passed).
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Long getAmountOff() {
return this.amountOff;
}
/**
* A hash containing directions for what this Coupon will apply discounts to.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public AppliesTo getAppliesTo() {
return this.appliesTo;
}
/**
* Three-letter ISO code for the currency of the
* {@code amount_off} parameter (required if {@code amount_off} is passed).
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getCurrency() {
return this.currency;
}
/**
* Specifies how long the discount will be in effect if used on a subscription. Can be {@code
* forever}, {@code once}, or {@code repeating}. Defaults to {@code once}.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Duration getDuration() {
return this.duration;
}
/**
* Required only if {@code duration} is {@code repeating}, in which case it must be a positive
* integer that specifies the number of months the discount will be in effect.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Long getDurationInMonths() {
return this.durationInMonths;
}
/**
* Specifies which fields in the response should be expanded.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public List getExpand() {
return this.expand;
}
/**
* 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 {@code @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.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Map getExtraParams() {
return this.extraParams;
}
/**
* 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.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getId() {
return this.id;
}
/**
* 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.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Long getMaxRedemptions() {
return this.maxRedemptions;
}
/**
* 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 {@code metadata}.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Object getMetadata() {
return this.metadata;
}
/**
* Name of the coupon displayed to customers on, for instance invoices, or receipts. By default
* the {@code id} is shown if {@code name} is not set.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getName() {
return this.name;
}
/**
* A positive float larger than 0, and smaller or equal to 100, that represents the discount the
* coupon will apply (required if {@code amount_off} is not passed).
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public BigDecimal getPercentOff() {
return this.percentOff;
}
/**
* 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.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Long getRedeemBy() {
return this.redeemBy;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy