com.stripe.param.SubscriptionScheduleCreateParams Maven / Gradle / Ivy
// 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;
import lombok.Getter;
@Getter
public class SubscriptionScheduleCreateParams extends ApiRequestParams {
/** The identifier of the customer to create the subscription schedule for. */
@SerializedName("customer")
String customer;
/** Object representing the subscription schedule's default settings. */
@SerializedName("default_settings")
DefaultSettings defaultSettings;
/**
* Behavior of the subscription schedule and underlying subscription when it ends. Possible values
* are {@code release} or {@code cancel} with the default being {@code release}. {@code release}
* will end the subscription schedule and keep the underlying subscription running. {@code cancel}
* will end the subscription schedule and cancel the underlying subscription.
*/
@SerializedName("end_behavior")
EndBehavior endBehavior;
/** 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;
/**
* Migrate an existing subscription to be managed by a subscription schedule. If this parameter is
* set, a subscription schedule will be created using the subscription's item(s), set to
* auto-renew using the subscription's interval. When using this parameter, other parameters (such
* as phase values) cannot be set. To create a subscription schedule with other modifications, we
* recommend making two separate API calls.
*/
@SerializedName("from_subscription")
String fromSubscription;
/**
* 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;
/**
* List representing phases of the subscription schedule. Each phase can be customized to have
* different durations, plans, and coupons. If there are multiple phases, the {@code end_date} of
* one phase will always equal the {@code start_date} of the next phase.
*/
@SerializedName("phases")
List phases;
/**
* When the subscription schedule starts. We recommend using {@code now} so that it starts the
* subscription immediately. You can also use a Unix timestamp to backdate the subscription so
* that it starts on a past date, or set a future date for the subscription to start on.
*/
@SerializedName("start_date")
Object startDate;
private SubscriptionScheduleCreateParams(
String customer,
DefaultSettings defaultSettings,
EndBehavior endBehavior,
List expand,
Map extraParams,
String fromSubscription,
Object metadata,
List phases,
Object startDate) {
this.customer = customer;
this.defaultSettings = defaultSettings;
this.endBehavior = endBehavior;
this.expand = expand;
this.extraParams = extraParams;
this.fromSubscription = fromSubscription;
this.metadata = metadata;
this.phases = phases;
this.startDate = startDate;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private String customer;
private DefaultSettings defaultSettings;
private EndBehavior endBehavior;
private List expand;
private Map extraParams;
private String fromSubscription;
private Object metadata;
private List phases;
private Object startDate;
/** Finalize and obtain parameter instance from this builder. */
public SubscriptionScheduleCreateParams build() {
return new SubscriptionScheduleCreateParams(
this.customer,
this.defaultSettings,
this.endBehavior,
this.expand,
this.extraParams,
this.fromSubscription,
this.metadata,
this.phases,
this.startDate);
}
/** The identifier of the customer to create the subscription schedule for. */
public Builder setCustomer(String customer) {
this.customer = customer;
return this;
}
/** Object representing the subscription schedule's default settings. */
public Builder setDefaultSettings(
SubscriptionScheduleCreateParams.DefaultSettings defaultSettings) {
this.defaultSettings = defaultSettings;
return this;
}
/**
* Behavior of the subscription schedule and underlying subscription when it ends. Possible
* values are {@code release} or {@code cancel} with the default being {@code release}. {@code
* release} will end the subscription schedule and keep the underlying subscription running.
* {@code cancel} will end the subscription schedule and cancel the underlying subscription.
*/
public Builder setEndBehavior(SubscriptionScheduleCreateParams.EndBehavior endBehavior) {
this.endBehavior = endBehavior;
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
* SubscriptionScheduleCreateParams#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
* SubscriptionScheduleCreateParams#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
* SubscriptionScheduleCreateParams#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 SubscriptionScheduleCreateParams#extraParams} for the field documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/**
* Migrate an existing subscription to be managed by a subscription schedule. If this parameter
* is set, a subscription schedule will be created using the subscription's item(s), set to
* auto-renew using the subscription's interval. When using this parameter, other parameters
* (such as phase values) cannot be set. To create a subscription schedule with other
* modifications, we recommend making two separate API calls.
*/
public Builder setFromSubscription(String fromSubscription) {
this.fromSubscription = fromSubscription;
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
* SubscriptionScheduleCreateParams#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 SubscriptionScheduleCreateParams#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;
}
/**
* Add an element to `phases` list. A list is initialized for the first `add/addAll` call, and
* subsequent calls adds additional elements to the original list. See {@link
* SubscriptionScheduleCreateParams#phases} for the field documentation.
*/
public Builder addPhase(SubscriptionScheduleCreateParams.Phase element) {
if (this.phases == null) {
this.phases = new ArrayList<>();
}
this.phases.add(element);
return this;
}
/**
* Add all elements to `phases` list. A list is initialized for the first `add/addAll` call, and
* subsequent calls adds additional elements to the original list. See {@link
* SubscriptionScheduleCreateParams#phases} for the field documentation.
*/
public Builder addAllPhase(List elements) {
if (this.phases == null) {
this.phases = new ArrayList<>();
}
this.phases.addAll(elements);
return this;
}
/**
* When the subscription schedule starts. We recommend using {@code now} so that it starts the
* subscription immediately. You can also use a Unix timestamp to backdate the subscription so
* that it starts on a past date, or set a future date for the subscription to start on.
*/
public Builder setStartDate(Long startDate) {
this.startDate = startDate;
return this;
}
/**
* When the subscription schedule starts. We recommend using {@code now} so that it starts the
* subscription immediately. You can also use a Unix timestamp to backdate the subscription so
* that it starts on a past date, or set a future date for the subscription to start on.
*/
public Builder setStartDate(SubscriptionScheduleCreateParams.StartDate startDate) {
this.startDate = startDate;
return this;
}
}
@Getter
public static class DefaultSettings {
/**
* A non-negative decimal between 0 and 100, with at most two decimal places. This represents
* the percentage of the subscription invoice total that will be transferred to the application
* owner's Stripe account. The request must be made by a platform account on a connected account
* in order to set an application fee percentage. For more information, see the application fees
* documentation.
*/
@SerializedName("application_fee_percent")
BigDecimal applicationFeePercent;
/** Default settings for automatic tax computation. */
@SerializedName("automatic_tax")
AutomaticTax automaticTax;
/**
* Can be set to {@code phase_start} to set the anchor to the start of the phase or {@code
* automatic} to automatically change it if needed. Cannot be set to {@code phase_start} if this
* phase specifies a trial. For more information, see the billing cycle documentation.
*/
@SerializedName("billing_cycle_anchor")
BillingCycleAnchor billingCycleAnchor;
/**
* Define thresholds at which an invoice will be sent, and the subscription advanced to a new
* billing period. Pass an empty string to remove previously-defined thresholds.
*/
@SerializedName("billing_thresholds")
Object billingThresholds;
/**
* Either {@code charge_automatically}, or {@code send_invoice}. When charging automatically,
* Stripe will attempt to pay the underlying subscription at the end of each billing cycle using
* the default source attached to the customer. When sending an invoice, Stripe will email your
* customer an invoice with payment instructions and mark the subscription as {@code active}.
* Defaults to {@code charge_automatically} on creation.
*/
@SerializedName("collection_method")
CollectionMethod collectionMethod;
/**
* ID of the default payment method for the subscription schedule. It must belong to the
* customer associated with the subscription schedule. If not set, invoices will use the default
* payment method in the customer's invoice settings.
*/
@SerializedName("default_payment_method")
String defaultPaymentMethod;
/**
* Subscription description, meant to be displayable to the customer. Use this field to
* optionally store an explanation of the subscription for rendering in Stripe surfaces and
* certain local payment methods UIs.
*/
@SerializedName("description")
Object description;
/**
* 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;
/** All invoices will be billed using the specified settings. */
@SerializedName("invoice_settings")
InvoiceSettings invoiceSettings;
/**
* The account on behalf of which to charge, for each of the associated subscription's invoices.
*/
@SerializedName("on_behalf_of")
Object onBehalfOf;
/**
* The data with which to automatically create a Transfer for each of the associated
* subscription's invoices.
*/
@SerializedName("transfer_data")
Object transferData;
private DefaultSettings(
BigDecimal applicationFeePercent,
AutomaticTax automaticTax,
BillingCycleAnchor billingCycleAnchor,
Object billingThresholds,
CollectionMethod collectionMethod,
String defaultPaymentMethod,
Object description,
Map extraParams,
InvoiceSettings invoiceSettings,
Object onBehalfOf,
Object transferData) {
this.applicationFeePercent = applicationFeePercent;
this.automaticTax = automaticTax;
this.billingCycleAnchor = billingCycleAnchor;
this.billingThresholds = billingThresholds;
this.collectionMethod = collectionMethod;
this.defaultPaymentMethod = defaultPaymentMethod;
this.description = description;
this.extraParams = extraParams;
this.invoiceSettings = invoiceSettings;
this.onBehalfOf = onBehalfOf;
this.transferData = transferData;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private BigDecimal applicationFeePercent;
private AutomaticTax automaticTax;
private BillingCycleAnchor billingCycleAnchor;
private Object billingThresholds;
private CollectionMethod collectionMethod;
private String defaultPaymentMethod;
private Object description;
private Map extraParams;
private InvoiceSettings invoiceSettings;
private Object onBehalfOf;
private Object transferData;
/** Finalize and obtain parameter instance from this builder. */
public SubscriptionScheduleCreateParams.DefaultSettings build() {
return new SubscriptionScheduleCreateParams.DefaultSettings(
this.applicationFeePercent,
this.automaticTax,
this.billingCycleAnchor,
this.billingThresholds,
this.collectionMethod,
this.defaultPaymentMethod,
this.description,
this.extraParams,
this.invoiceSettings,
this.onBehalfOf,
this.transferData);
}
/**
* A non-negative decimal between 0 and 100, with at most two decimal places. This represents
* the percentage of the subscription invoice total that will be transferred to the
* application owner's Stripe account. The request must be made by a platform account on a
* connected account in order to set an application fee percentage. For more information, see
* the application fees documentation.
*/
public Builder setApplicationFeePercent(BigDecimal applicationFeePercent) {
this.applicationFeePercent = applicationFeePercent;
return this;
}
/** Default settings for automatic tax computation. */
public Builder setAutomaticTax(
SubscriptionScheduleCreateParams.DefaultSettings.AutomaticTax automaticTax) {
this.automaticTax = automaticTax;
return this;
}
/**
* Can be set to {@code phase_start} to set the anchor to the start of the phase or {@code
* automatic} to automatically change it if needed. Cannot be set to {@code phase_start} if
* this phase specifies a trial. For more information, see the billing cycle documentation.
*/
public Builder setBillingCycleAnchor(
SubscriptionScheduleCreateParams.DefaultSettings.BillingCycleAnchor billingCycleAnchor) {
this.billingCycleAnchor = billingCycleAnchor;
return this;
}
/**
* Define thresholds at which an invoice will be sent, and the subscription advanced to a new
* billing period. Pass an empty string to remove previously-defined thresholds.
*/
public Builder setBillingThresholds(
SubscriptionScheduleCreateParams.DefaultSettings.BillingThresholds billingThresholds) {
this.billingThresholds = billingThresholds;
return this;
}
/**
* Define thresholds at which an invoice will be sent, and the subscription advanced to a new
* billing period. Pass an empty string to remove previously-defined thresholds.
*/
public Builder setBillingThresholds(EmptyParam billingThresholds) {
this.billingThresholds = billingThresholds;
return this;
}
/**
* Either {@code charge_automatically}, or {@code send_invoice}. When charging automatically,
* Stripe will attempt to pay the underlying subscription at the end of each billing cycle
* using the default source attached to the customer. When sending an invoice, Stripe will
* email your customer an invoice with payment instructions and mark the subscription as
* {@code active}. Defaults to {@code charge_automatically} on creation.
*/
public Builder setCollectionMethod(
SubscriptionScheduleCreateParams.DefaultSettings.CollectionMethod collectionMethod) {
this.collectionMethod = collectionMethod;
return this;
}
/**
* ID of the default payment method for the subscription schedule. It must belong to the
* customer associated with the subscription schedule. If not set, invoices will use the
* default payment method in the customer's invoice settings.
*/
public Builder setDefaultPaymentMethod(String defaultPaymentMethod) {
this.defaultPaymentMethod = defaultPaymentMethod;
return this;
}
/**
* Subscription description, meant to be displayable to the customer. Use this field to
* optionally store an explanation of the subscription for rendering in Stripe surfaces and
* certain local payment methods UIs.
*/
public Builder setDescription(String description) {
this.description = description;
return this;
}
/**
* Subscription description, meant to be displayable to the customer. Use this field to
* optionally store an explanation of the subscription for rendering in Stripe surfaces and
* certain local payment methods UIs.
*/
public Builder setDescription(EmptyParam description) {
this.description = description;
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
* SubscriptionScheduleCreateParams.DefaultSettings#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 SubscriptionScheduleCreateParams.DefaultSettings#extraParams} for the field
* documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/** All invoices will be billed using the specified settings. */
public Builder setInvoiceSettings(
SubscriptionScheduleCreateParams.DefaultSettings.InvoiceSettings invoiceSettings) {
this.invoiceSettings = invoiceSettings;
return this;
}
/**
* The account on behalf of which to charge, for each of the associated subscription's
* invoices.
*/
public Builder setOnBehalfOf(String onBehalfOf) {
this.onBehalfOf = onBehalfOf;
return this;
}
/**
* The account on behalf of which to charge, for each of the associated subscription's
* invoices.
*/
public Builder setOnBehalfOf(EmptyParam onBehalfOf) {
this.onBehalfOf = onBehalfOf;
return this;
}
/**
* The data with which to automatically create a Transfer for each of the associated
* subscription's invoices.
*/
public Builder setTransferData(
SubscriptionScheduleCreateParams.DefaultSettings.TransferData transferData) {
this.transferData = transferData;
return this;
}
/**
* The data with which to automatically create a Transfer for each of the associated
* subscription's invoices.
*/
public Builder setTransferData(EmptyParam transferData) {
this.transferData = transferData;
return this;
}
}
@Getter
public static class AutomaticTax {
/**
* Required. Enabled automatic tax calculation which will automatically
* compute tax rates on all invoices generated by the subscription.
*/
@SerializedName("enabled")
Boolean enabled;
/**
* 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;
/**
* The account that's liable for tax. If set, the business address and tax registrations
* required to perform the tax calculation are loaded from this account. The tax transaction
* is returned in the report of the connected account.
*/
@SerializedName("liability")
Liability liability;
private AutomaticTax(Boolean enabled, Map extraParams, Liability liability) {
this.enabled = enabled;
this.extraParams = extraParams;
this.liability = liability;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Boolean enabled;
private Map extraParams;
private Liability liability;
/** Finalize and obtain parameter instance from this builder. */
public SubscriptionScheduleCreateParams.DefaultSettings.AutomaticTax build() {
return new SubscriptionScheduleCreateParams.DefaultSettings.AutomaticTax(
this.enabled, this.extraParams, this.liability);
}
/**
* Required. Enabled automatic tax calculation which will automatically
* compute tax rates on all invoices generated by the subscription.
*/
public Builder setEnabled(Boolean enabled) {
this.enabled = enabled;
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
* SubscriptionScheduleCreateParams.DefaultSettings.AutomaticTax#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
* SubscriptionScheduleCreateParams.DefaultSettings.AutomaticTax#extraParams} for the field
* documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/**
* The account that's liable for tax. If set, the business address and tax registrations
* required to perform the tax calculation are loaded from this account. The tax transaction
* is returned in the report of the connected account.
*/
public Builder setLiability(
SubscriptionScheduleCreateParams.DefaultSettings.AutomaticTax.Liability liability) {
this.liability = liability;
return this;
}
}
@Getter
public static class Liability {
/** The connected account being referenced when {@code type} is {@code account}. */
@SerializedName("account")
String account;
/**
* 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;
/** Required. Type of the account referenced in the request. */
@SerializedName("type")
Type type;
private Liability(String account, Map extraParams, Type type) {
this.account = account;
this.extraParams = extraParams;
this.type = type;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private String account;
private Map extraParams;
private Type type;
/** Finalize and obtain parameter instance from this builder. */
public SubscriptionScheduleCreateParams.DefaultSettings.AutomaticTax.Liability build() {
return new SubscriptionScheduleCreateParams.DefaultSettings.AutomaticTax.Liability(
this.account, this.extraParams, this.type);
}
/** The connected account being referenced when {@code type} is {@code account}. */
public Builder setAccount(String account) {
this.account = account;
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
* SubscriptionScheduleCreateParams.DefaultSettings.AutomaticTax.Liability#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
* SubscriptionScheduleCreateParams.DefaultSettings.AutomaticTax.Liability#extraParams}
* for the field documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/** Required. Type of the account referenced in the request. */
public Builder setType(
SubscriptionScheduleCreateParams.DefaultSettings.AutomaticTax.Liability.Type type) {
this.type = type;
return this;
}
}
public enum Type implements ApiRequestParams.EnumParam {
@SerializedName("account")
ACCOUNT("account"),
@SerializedName("self")
SELF("self");
@Getter(onMethod_ = {@Override})
private final String value;
Type(String value) {
this.value = value;
}
}
}
}
@Getter
public static class BillingThresholds {
/** Monetary threshold that triggers the subscription to advance to a new billing period. */
@SerializedName("amount_gte")
Long amountGte;
/**
* 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;
/**
* Indicates if the {@code billing_cycle_anchor} should be reset when a threshold is reached.
* If true, {@code billing_cycle_anchor} will be updated to the date/time the threshold was
* last reached; otherwise, the value will remain unchanged.
*/
@SerializedName("reset_billing_cycle_anchor")
Boolean resetBillingCycleAnchor;
private BillingThresholds(
Long amountGte, Map extraParams, Boolean resetBillingCycleAnchor) {
this.amountGte = amountGte;
this.extraParams = extraParams;
this.resetBillingCycleAnchor = resetBillingCycleAnchor;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Long amountGte;
private Map extraParams;
private Boolean resetBillingCycleAnchor;
/** Finalize and obtain parameter instance from this builder. */
public SubscriptionScheduleCreateParams.DefaultSettings.BillingThresholds build() {
return new SubscriptionScheduleCreateParams.DefaultSettings.BillingThresholds(
this.amountGte, this.extraParams, this.resetBillingCycleAnchor);
}
/** Monetary threshold that triggers the subscription to advance to a new billing period. */
public Builder setAmountGte(Long amountGte) {
this.amountGte = amountGte;
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
* SubscriptionScheduleCreateParams.DefaultSettings.BillingThresholds#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
* SubscriptionScheduleCreateParams.DefaultSettings.BillingThresholds#extraParams} for the
* field documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/**
* Indicates if the {@code billing_cycle_anchor} should be reset when a threshold is
* reached. If true, {@code billing_cycle_anchor} will be updated to the date/time the
* threshold was last reached; otherwise, the value will remain unchanged.
*/
public Builder setResetBillingCycleAnchor(Boolean resetBillingCycleAnchor) {
this.resetBillingCycleAnchor = resetBillingCycleAnchor;
return this;
}
}
}
@Getter
public static class InvoiceSettings {
/**
* The account tax IDs associated with the subscription schedule. Will be set on invoices
* generated by the subscription schedule.
*/
@SerializedName("account_tax_ids")
Object accountTaxIds;
/**
* Number of days within which a customer must pay invoices generated by this subscription
* schedule. This value will be {@code null} for subscription schedules where {@code
* collection_method=charge_automatically}.
*/
@SerializedName("days_until_due")
Long daysUntilDue;
/**
* 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;
/**
* The connected account that issues the invoice. The invoice is presented with the branding
* and support information of the specified account.
*/
@SerializedName("issuer")
Issuer issuer;
private InvoiceSettings(
Object accountTaxIds, Long daysUntilDue, Map extraParams, Issuer issuer) {
this.accountTaxIds = accountTaxIds;
this.daysUntilDue = daysUntilDue;
this.extraParams = extraParams;
this.issuer = issuer;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Object accountTaxIds;
private Long daysUntilDue;
private Map extraParams;
private Issuer issuer;
/** Finalize and obtain parameter instance from this builder. */
public SubscriptionScheduleCreateParams.DefaultSettings.InvoiceSettings build() {
return new SubscriptionScheduleCreateParams.DefaultSettings.InvoiceSettings(
this.accountTaxIds, this.daysUntilDue, this.extraParams, this.issuer);
}
/**
* Add an element to `accountTaxIds` list. A list is initialized for the first `add/addAll`
* call, and subsequent calls adds additional elements to the original list. See {@link
* SubscriptionScheduleCreateParams.DefaultSettings.InvoiceSettings#accountTaxIds} for the
* field documentation.
*/
@SuppressWarnings("unchecked")
public Builder addAccountTaxId(String element) {
if (this.accountTaxIds == null || this.accountTaxIds instanceof EmptyParam) {
this.accountTaxIds = new ArrayList();
}
((List) this.accountTaxIds).add(element);
return this;
}
/**
* Add all elements to `accountTaxIds` list. A list is initialized for the first
* `add/addAll` call, and subsequent calls adds additional elements to the original list.
* See {@link
* SubscriptionScheduleCreateParams.DefaultSettings.InvoiceSettings#accountTaxIds} for the
* field documentation.
*/
@SuppressWarnings("unchecked")
public Builder addAllAccountTaxId(List elements) {
if (this.accountTaxIds == null || this.accountTaxIds instanceof EmptyParam) {
this.accountTaxIds = new ArrayList();
}
((List) this.accountTaxIds).addAll(elements);
return this;
}
/**
* The account tax IDs associated with the subscription schedule. Will be set on invoices
* generated by the subscription schedule.
*/
public Builder setAccountTaxIds(EmptyParam accountTaxIds) {
this.accountTaxIds = accountTaxIds;
return this;
}
/**
* The account tax IDs associated with the subscription schedule. Will be set on invoices
* generated by the subscription schedule.
*/
public Builder setAccountTaxIds(List accountTaxIds) {
this.accountTaxIds = accountTaxIds;
return this;
}
/**
* Number of days within which a customer must pay invoices generated by this subscription
* schedule. This value will be {@code null} for subscription schedules where {@code
* collection_method=charge_automatically}.
*/
public Builder setDaysUntilDue(Long daysUntilDue) {
this.daysUntilDue = daysUntilDue;
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
* SubscriptionScheduleCreateParams.DefaultSettings.InvoiceSettings#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
* SubscriptionScheduleCreateParams.DefaultSettings.InvoiceSettings#extraParams} for the
* field documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/**
* The connected account that issues the invoice. The invoice is presented with the branding
* and support information of the specified account.
*/
public Builder setIssuer(
SubscriptionScheduleCreateParams.DefaultSettings.InvoiceSettings.Issuer issuer) {
this.issuer = issuer;
return this;
}
}
@Getter
public static class Issuer {
/** The connected account being referenced when {@code type} is {@code account}. */
@SerializedName("account")
String account;
/**
* 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;
/** Required. Type of the account referenced in the request. */
@SerializedName("type")
Type type;
private Issuer(String account, Map extraParams, Type type) {
this.account = account;
this.extraParams = extraParams;
this.type = type;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private String account;
private Map extraParams;
private Type type;
/** Finalize and obtain parameter instance from this builder. */
public SubscriptionScheduleCreateParams.DefaultSettings.InvoiceSettings.Issuer build() {
return new SubscriptionScheduleCreateParams.DefaultSettings.InvoiceSettings.Issuer(
this.account, this.extraParams, this.type);
}
/** The connected account being referenced when {@code type} is {@code account}. */
public Builder setAccount(String account) {
this.account = account;
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
* SubscriptionScheduleCreateParams.DefaultSettings.InvoiceSettings.Issuer#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
* SubscriptionScheduleCreateParams.DefaultSettings.InvoiceSettings.Issuer#extraParams}
* for the field documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/** Required. Type of the account referenced in the request. */
public Builder setType(
SubscriptionScheduleCreateParams.DefaultSettings.InvoiceSettings.Issuer.Type type) {
this.type = type;
return this;
}
}
public enum Type implements ApiRequestParams.EnumParam {
@SerializedName("account")
ACCOUNT("account"),
@SerializedName("self")
SELF("self");
@Getter(onMethod_ = {@Override})
private final String value;
Type(String value) {
this.value = value;
}
}
}
}
@Getter
public static class TransferData {
/**
* A non-negative decimal between 0 and 100, with at most two decimal places. This represents
* the percentage of the subscription invoice total that will be transferred to the
* destination account. By default, the entire amount is transferred to the destination.
*/
@SerializedName("amount_percent")
BigDecimal amountPercent;
/** Required. ID of an existing, connected Stripe account. */
@SerializedName("destination")
String destination;
/**
* 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;
private TransferData(
BigDecimal amountPercent, String destination, Map extraParams) {
this.amountPercent = amountPercent;
this.destination = destination;
this.extraParams = extraParams;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private BigDecimal amountPercent;
private String destination;
private Map extraParams;
/** Finalize and obtain parameter instance from this builder. */
public SubscriptionScheduleCreateParams.DefaultSettings.TransferData build() {
return new SubscriptionScheduleCreateParams.DefaultSettings.TransferData(
this.amountPercent, this.destination, this.extraParams);
}
/**
* A non-negative decimal between 0 and 100, with at most two decimal places. This
* represents the percentage of the subscription invoice total that will be transferred to
* the destination account. By default, the entire amount is transferred to the destination.
*/
public Builder setAmountPercent(BigDecimal amountPercent) {
this.amountPercent = amountPercent;
return this;
}
/** Required. ID of an existing, connected Stripe account. */
public Builder setDestination(String destination) {
this.destination = destination;
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
* SubscriptionScheduleCreateParams.DefaultSettings.TransferData#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
* SubscriptionScheduleCreateParams.DefaultSettings.TransferData#extraParams} for the field
* documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
}
}
public enum BillingCycleAnchor implements ApiRequestParams.EnumParam {
@SerializedName("automatic")
AUTOMATIC("automatic"),
@SerializedName("phase_start")
PHASE_START("phase_start");
@Getter(onMethod_ = {@Override})
private final String value;
BillingCycleAnchor(String value) {
this.value = value;
}
}
public enum CollectionMethod implements ApiRequestParams.EnumParam {
@SerializedName("charge_automatically")
CHARGE_AUTOMATICALLY("charge_automatically"),
@SerializedName("send_invoice")
SEND_INVOICE("send_invoice");
@Getter(onMethod_ = {@Override})
private final String value;
CollectionMethod(String value) {
this.value = value;
}
}
}
@Getter
public static class Phase {
/**
* A list of prices and quantities that will generate invoice items appended to the next invoice
* for this phase. You may pass up to 20 items.
*/
@SerializedName("add_invoice_items")
List addInvoiceItems;
/**
* A non-negative decimal between 0 and 100, with at most two decimal places. This represents
* the percentage of the subscription invoice total that will be transferred to the application
* owner's Stripe account. The request must be made by a platform account on a connected account
* in order to set an application fee percentage. For more information, see the application fees
* documentation.
*/
@SerializedName("application_fee_percent")
BigDecimal applicationFeePercent;
/** Automatic tax settings for this phase. */
@SerializedName("automatic_tax")
AutomaticTax automaticTax;
/**
* Can be set to {@code phase_start} to set the anchor to the start of the phase or {@code
* automatic} to automatically change it if needed. Cannot be set to {@code phase_start} if this
* phase specifies a trial. For more information, see the billing cycle documentation.
*/
@SerializedName("billing_cycle_anchor")
BillingCycleAnchor billingCycleAnchor;
/**
* Define thresholds at which an invoice will be sent, and the subscription advanced to a new
* billing period. Pass an empty string to remove previously-defined thresholds.
*/
@SerializedName("billing_thresholds")
Object billingThresholds;
/**
* Either {@code charge_automatically}, or {@code send_invoice}. When charging automatically,
* Stripe will attempt to pay the underlying subscription at the end of each billing cycle using
* the default source attached to the customer. When sending an invoice, Stripe will email your
* customer an invoice with payment instructions and mark the subscription as {@code active}.
* Defaults to {@code charge_automatically} on creation.
*/
@SerializedName("collection_method")
CollectionMethod collectionMethod;
/**
* The ID of the coupon to apply to this phase of the subscription schedule. This field has been
* deprecated and will be removed in a future API version. Use {@code discounts} instead.
*/
@SerializedName("coupon")
String coupon;
/**
* Three-letter ISO currency
* code, in lowercase. Must be a supported
* currency.
*/
@SerializedName("currency")
String currency;
/**
* ID of the default payment method for the subscription schedule. It must belong to the
* customer associated with the subscription schedule. If not set, invoices will use the default
* payment method in the customer's invoice settings.
*/
@SerializedName("default_payment_method")
String defaultPaymentMethod;
/**
* A list of Tax Rate ids. These Tax Rates
* will set the Subscription's {@code
* default_tax_rates}, which means they will be the Invoice's {@code
* default_tax_rates} for any Invoices issued by the Subscription during this Phase.
*/
@SerializedName("default_tax_rates")
Object defaultTaxRates;
/**
* Subscription description, meant to be displayable to the customer. Use this field to
* optionally store an explanation of the subscription for rendering in Stripe surfaces and
* certain local payment methods UIs.
*/
@SerializedName("description")
Object description;
/**
* The coupons to redeem into discounts for the schedule phase. If not specified, inherits the
* discount from the subscription's customer. Pass an empty string to avoid inheriting any
* discounts.
*/
@SerializedName("discounts")
Object discounts;
/**
* The date at which this phase of the subscription schedule ends. If set, {@code iterations}
* must not be set.
*/
@SerializedName("end_date")
Long endDate;
/**
* 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;
/** All invoices will be billed using the specified settings. */
@SerializedName("invoice_settings")
InvoiceSettings invoiceSettings;
/**
* Required. List of configuration items, each with an attached price, to apply
* during this phase of the subscription schedule.
*/
@SerializedName("items")
List items;
/**
* Integer representing the multiplier applied to the price interval. For example, {@code
* iterations=2} applied to a price with {@code interval=month} and {@code interval_count=3}
* results in a phase of duration {@code 2 * 3 months = 6 months}. If set, {@code end_date} must
* not be set.
*/
@SerializedName("iterations")
Long iterations;
/**
* Set of key-value pairs that you can attach
* to a phase. Metadata on a schedule's phase will update the underlying subscription's {@code
* metadata} when the phase is entered, adding new keys and replacing existing keys in the
* subscription's {@code metadata}. Individual keys in the subscription's {@code metadata} can
* be unset by posting an empty value to them in the phase's {@code metadata}. To unset all keys
* in the subscription's {@code metadata}, update the subscription directly or unset every key
* individually from the phase's {@code metadata}.
*/
@SerializedName("metadata")
Map metadata;
/**
* The account on behalf of which to charge, for each of the associated subscription's invoices.
*/
@SerializedName("on_behalf_of")
String onBehalfOf;
/**
* Whether the subscription schedule will create prorations when
* transitioning to this phase. The default value is {@code create_prorations}. This setting
* controls prorations when a phase is started asynchronously and it is persisted as a field on
* the phase. It's different from the request-level proration_behavior
* parameter which controls what happens if the update request affects the billing configuration
* of the current phase.
*/
@SerializedName("proration_behavior")
ProrationBehavior prorationBehavior;
/**
* The data with which to automatically create a Transfer for each of the associated
* subscription's invoices.
*/
@SerializedName("transfer_data")
TransferData transferData;
/**
* If set to true the entire phase is counted as a trial and the customer will not be charged
* for any fees.
*/
@SerializedName("trial")
Boolean trial;
/**
* Sets the phase to trialing from the start date to this date. Must be before the phase end
* date, can not be combined with {@code trial}
*/
@SerializedName("trial_end")
Long trialEnd;
private Phase(
List addInvoiceItems,
BigDecimal applicationFeePercent,
AutomaticTax automaticTax,
BillingCycleAnchor billingCycleAnchor,
Object billingThresholds,
CollectionMethod collectionMethod,
String coupon,
String currency,
String defaultPaymentMethod,
Object defaultTaxRates,
Object description,
Object discounts,
Long endDate,
Map extraParams,
InvoiceSettings invoiceSettings,
List items,
Long iterations,
Map metadata,
String onBehalfOf,
ProrationBehavior prorationBehavior,
TransferData transferData,
Boolean trial,
Long trialEnd) {
this.addInvoiceItems = addInvoiceItems;
this.applicationFeePercent = applicationFeePercent;
this.automaticTax = automaticTax;
this.billingCycleAnchor = billingCycleAnchor;
this.billingThresholds = billingThresholds;
this.collectionMethod = collectionMethod;
this.coupon = coupon;
this.currency = currency;
this.defaultPaymentMethod = defaultPaymentMethod;
this.defaultTaxRates = defaultTaxRates;
this.description = description;
this.discounts = discounts;
this.endDate = endDate;
this.extraParams = extraParams;
this.invoiceSettings = invoiceSettings;
this.items = items;
this.iterations = iterations;
this.metadata = metadata;
this.onBehalfOf = onBehalfOf;
this.prorationBehavior = prorationBehavior;
this.transferData = transferData;
this.trial = trial;
this.trialEnd = trialEnd;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private List addInvoiceItems;
private BigDecimal applicationFeePercent;
private AutomaticTax automaticTax;
private BillingCycleAnchor billingCycleAnchor;
private Object billingThresholds;
private CollectionMethod collectionMethod;
private String coupon;
private String currency;
private String defaultPaymentMethod;
private Object defaultTaxRates;
private Object description;
private Object discounts;
private Long endDate;
private Map extraParams;
private InvoiceSettings invoiceSettings;
private List items;
private Long iterations;
private Map metadata;
private String onBehalfOf;
private ProrationBehavior prorationBehavior;
private TransferData transferData;
private Boolean trial;
private Long trialEnd;
/** Finalize and obtain parameter instance from this builder. */
public SubscriptionScheduleCreateParams.Phase build() {
return new SubscriptionScheduleCreateParams.Phase(
this.addInvoiceItems,
this.applicationFeePercent,
this.automaticTax,
this.billingCycleAnchor,
this.billingThresholds,
this.collectionMethod,
this.coupon,
this.currency,
this.defaultPaymentMethod,
this.defaultTaxRates,
this.description,
this.discounts,
this.endDate,
this.extraParams,
this.invoiceSettings,
this.items,
this.iterations,
this.metadata,
this.onBehalfOf,
this.prorationBehavior,
this.transferData,
this.trial,
this.trialEnd);
}
/**
* Add an element to `addInvoiceItems` list. A list is initialized for the first `add/addAll`
* call, and subsequent calls adds additional elements to the original list. See {@link
* SubscriptionScheduleCreateParams.Phase#addInvoiceItems} for the field documentation.
*/
public Builder addAddInvoiceItem(
SubscriptionScheduleCreateParams.Phase.AddInvoiceItem element) {
if (this.addInvoiceItems == null) {
this.addInvoiceItems = new ArrayList<>();
}
this.addInvoiceItems.add(element);
return this;
}
/**
* Add all elements to `addInvoiceItems` list. A list is initialized for the first
* `add/addAll` call, and subsequent calls adds additional elements to the original list. See
* {@link SubscriptionScheduleCreateParams.Phase#addInvoiceItems} for the field documentation.
*/
public Builder addAllAddInvoiceItem(
List elements) {
if (this.addInvoiceItems == null) {
this.addInvoiceItems = new ArrayList<>();
}
this.addInvoiceItems.addAll(elements);
return this;
}
/**
* A non-negative decimal between 0 and 100, with at most two decimal places. This represents
* the percentage of the subscription invoice total that will be transferred to the
* application owner's Stripe account. The request must be made by a platform account on a
* connected account in order to set an application fee percentage. For more information, see
* the application fees documentation.
*/
public Builder setApplicationFeePercent(BigDecimal applicationFeePercent) {
this.applicationFeePercent = applicationFeePercent;
return this;
}
/** Automatic tax settings for this phase. */
public Builder setAutomaticTax(
SubscriptionScheduleCreateParams.Phase.AutomaticTax automaticTax) {
this.automaticTax = automaticTax;
return this;
}
/**
* Can be set to {@code phase_start} to set the anchor to the start of the phase or {@code
* automatic} to automatically change it if needed. Cannot be set to {@code phase_start} if
* this phase specifies a trial. For more information, see the billing cycle documentation.
*/
public Builder setBillingCycleAnchor(
SubscriptionScheduleCreateParams.Phase.BillingCycleAnchor billingCycleAnchor) {
this.billingCycleAnchor = billingCycleAnchor;
return this;
}
/**
* Define thresholds at which an invoice will be sent, and the subscription advanced to a new
* billing period. Pass an empty string to remove previously-defined thresholds.
*/
public Builder setBillingThresholds(
SubscriptionScheduleCreateParams.Phase.BillingThresholds billingThresholds) {
this.billingThresholds = billingThresholds;
return this;
}
/**
* Define thresholds at which an invoice will be sent, and the subscription advanced to a new
* billing period. Pass an empty string to remove previously-defined thresholds.
*/
public Builder setBillingThresholds(EmptyParam billingThresholds) {
this.billingThresholds = billingThresholds;
return this;
}
/**
* Either {@code charge_automatically}, or {@code send_invoice}. When charging automatically,
* Stripe will attempt to pay the underlying subscription at the end of each billing cycle
* using the default source attached to the customer. When sending an invoice, Stripe will
* email your customer an invoice with payment instructions and mark the subscription as
* {@code active}. Defaults to {@code charge_automatically} on creation.
*/
public Builder setCollectionMethod(
SubscriptionScheduleCreateParams.Phase.CollectionMethod collectionMethod) {
this.collectionMethod = collectionMethod;
return this;
}
/**
* The ID of the coupon to apply to this phase of the subscription schedule. This field has
* been deprecated and will be removed in a future API version. Use {@code discounts} instead.
*/
public Builder setCoupon(String coupon) {
this.coupon = coupon;
return this;
}
/**
* Three-letter ISO currency
* code, in lowercase. Must be a supported
* currency.
*/
public Builder setCurrency(String currency) {
this.currency = currency;
return this;
}
/**
* ID of the default payment method for the subscription schedule. It must belong to the
* customer associated with the subscription schedule. If not set, invoices will use the
* default payment method in the customer's invoice settings.
*/
public Builder setDefaultPaymentMethod(String defaultPaymentMethod) {
this.defaultPaymentMethod = defaultPaymentMethod;
return this;
}
/**
* Add an element to `defaultTaxRates` list. A list is initialized for the first `add/addAll`
* call, and subsequent calls adds additional elements to the original list. See {@link
* SubscriptionScheduleCreateParams.Phase#defaultTaxRates} for the field documentation.
*/
@SuppressWarnings("unchecked")
public Builder addDefaultTaxRate(String element) {
if (this.defaultTaxRates == null || this.defaultTaxRates instanceof EmptyParam) {
this.defaultTaxRates = new ArrayList();
}
((List) this.defaultTaxRates).add(element);
return this;
}
/**
* Add all elements to `defaultTaxRates` list. A list is initialized for the first
* `add/addAll` call, and subsequent calls adds additional elements to the original list. See
* {@link SubscriptionScheduleCreateParams.Phase#defaultTaxRates} for the field documentation.
*/
@SuppressWarnings("unchecked")
public Builder addAllDefaultTaxRate(List elements) {
if (this.defaultTaxRates == null || this.defaultTaxRates instanceof EmptyParam) {
this.defaultTaxRates = new ArrayList();
}
((List) this.defaultTaxRates).addAll(elements);
return this;
}
/**
* A list of Tax Rate ids. These Tax Rates
* will set the Subscription's {@code
* default_tax_rates}, which means they will be the Invoice's {@code
* default_tax_rates} for any Invoices issued by the Subscription during this Phase.
*/
public Builder setDefaultTaxRates(EmptyParam defaultTaxRates) {
this.defaultTaxRates = defaultTaxRates;
return this;
}
/**
* A list of Tax Rate ids. These Tax Rates
* will set the Subscription's {@code
* default_tax_rates}, which means they will be the Invoice's {@code
* default_tax_rates} for any Invoices issued by the Subscription during this Phase.
*/
public Builder setDefaultTaxRates(List defaultTaxRates) {
this.defaultTaxRates = defaultTaxRates;
return this;
}
/**
* Subscription description, meant to be displayable to the customer. Use this field to
* optionally store an explanation of the subscription for rendering in Stripe surfaces and
* certain local payment methods UIs.
*/
public Builder setDescription(String description) {
this.description = description;
return this;
}
/**
* Subscription description, meant to be displayable to the customer. Use this field to
* optionally store an explanation of the subscription for rendering in Stripe surfaces and
* certain local payment methods UIs.
*/
public Builder setDescription(EmptyParam description) {
this.description = description;
return this;
}
/**
* Add an element to `discounts` list. A list is initialized for the first `add/addAll` call,
* and subsequent calls adds additional elements to the original list. See {@link
* SubscriptionScheduleCreateParams.Phase#discounts} for the field documentation.
*/
@SuppressWarnings("unchecked")
public Builder addDiscount(SubscriptionScheduleCreateParams.Phase.Discount element) {
if (this.discounts == null || this.discounts instanceof EmptyParam) {
this.discounts = new ArrayList();
}
((List) this.discounts).add(element);
return this;
}
/**
* Add all elements to `discounts` list. A list is initialized for the first `add/addAll`
* call, and subsequent calls adds additional elements to the original list. See {@link
* SubscriptionScheduleCreateParams.Phase#discounts} for the field documentation.
*/
@SuppressWarnings("unchecked")
public Builder addAllDiscount(
List elements) {
if (this.discounts == null || this.discounts instanceof EmptyParam) {
this.discounts = new ArrayList();
}
((List) this.discounts).addAll(elements);
return this;
}
/**
* The coupons to redeem into discounts for the schedule phase. If not specified, inherits the
* discount from the subscription's customer. Pass an empty string to avoid inheriting any
* discounts.
*/
public Builder setDiscounts(EmptyParam discounts) {
this.discounts = discounts;
return this;
}
/**
* The coupons to redeem into discounts for the schedule phase. If not specified, inherits the
* discount from the subscription's customer. Pass an empty string to avoid inheriting any
* discounts.
*/
public Builder setDiscounts(List discounts) {
this.discounts = discounts;
return this;
}
/**
* The date at which this phase of the subscription schedule ends. If set, {@code iterations}
* must not be set.
*/
public Builder setEndDate(Long endDate) {
this.endDate = endDate;
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
* SubscriptionScheduleCreateParams.Phase#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 SubscriptionScheduleCreateParams.Phase#extraParams} for the field documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/** All invoices will be billed using the specified settings. */
public Builder setInvoiceSettings(
SubscriptionScheduleCreateParams.Phase.InvoiceSettings invoiceSettings) {
this.invoiceSettings = invoiceSettings;
return this;
}
/**
* Add an element to `items` list. A list is initialized for the first `add/addAll` call, and
* subsequent calls adds additional elements to the original list. See {@link
* SubscriptionScheduleCreateParams.Phase#items} for the field documentation.
*/
public Builder addItem(SubscriptionScheduleCreateParams.Phase.Item element) {
if (this.items == null) {
this.items = new ArrayList<>();
}
this.items.add(element);
return this;
}
/**
* Add all elements to `items` list. A list is initialized for the first `add/addAll` call,
* and subsequent calls adds additional elements to the original list. See {@link
* SubscriptionScheduleCreateParams.Phase#items} for the field documentation.
*/
public Builder addAllItem(List elements) {
if (this.items == null) {
this.items = new ArrayList<>();
}
this.items.addAll(elements);
return this;
}
/**
* Integer representing the multiplier applied to the price interval. For example, {@code
* iterations=2} applied to a price with {@code interval=month} and {@code interval_count=3}
* results in a phase of duration {@code 2 * 3 months = 6 months}. If set, {@code end_date}
* must not be set.
*/
public Builder setIterations(Long iterations) {
this.iterations = iterations;
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
* SubscriptionScheduleCreateParams.Phase#metadata} for the field documentation.
*/
public Builder putMetadata(String key, String value) {
if (this.metadata == null) {
this.metadata = new HashMap<>();
}
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 SubscriptionScheduleCreateParams.Phase#metadata} for the field documentation.
*/
public Builder putAllMetadata(Map map) {
if (this.metadata == null) {
this.metadata = new HashMap<>();
}
this.metadata.putAll(map);
return this;
}
/**
* The account on behalf of which to charge, for each of the associated subscription's
* invoices.
*/
public Builder setOnBehalfOf(String onBehalfOf) {
this.onBehalfOf = onBehalfOf;
return this;
}
/**
* Whether the subscription schedule will create prorations when
* transitioning to this phase. The default value is {@code create_prorations}. This setting
* controls prorations when a phase is started asynchronously and it is persisted as a field
* on the phase. It's different from the request-level proration_behavior
* parameter which controls what happens if the update request affects the billing
* configuration of the current phase.
*/
public Builder setProrationBehavior(
SubscriptionScheduleCreateParams.Phase.ProrationBehavior prorationBehavior) {
this.prorationBehavior = prorationBehavior;
return this;
}
/**
* The data with which to automatically create a Transfer for each of the associated
* subscription's invoices.
*/
public Builder setTransferData(
SubscriptionScheduleCreateParams.Phase.TransferData transferData) {
this.transferData = transferData;
return this;
}
/**
* If set to true the entire phase is counted as a trial and the customer will not be charged
* for any fees.
*/
public Builder setTrial(Boolean trial) {
this.trial = trial;
return this;
}
/**
* Sets the phase to trialing from the start date to this date. Must be before the phase end
* date, can not be combined with {@code trial}
*/
public Builder setTrialEnd(Long trialEnd) {
this.trialEnd = trialEnd;
return this;
}
}
@Getter
public static class AddInvoiceItem {
/** The coupons to redeem into discounts for the item. */
@SerializedName("discounts")
List discounts;
/**
* 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;
/** The ID of the price object. One of {@code price} or {@code price_data} is required. */
@SerializedName("price")
String price;
/**
* Data used to generate a new Price object
* inline. One of {@code price} or {@code price_data} is required.
*/
@SerializedName("price_data")
PriceData priceData;
/** Quantity for this item. Defaults to 1. */
@SerializedName("quantity")
Long quantity;
/**
* The tax rates which apply to the item. When set, the {@code default_tax_rates} do not apply
* to this item.
*/
@SerializedName("tax_rates")
Object taxRates;
private AddInvoiceItem(
List discounts,
Map extraParams,
String price,
PriceData priceData,
Long quantity,
Object taxRates) {
this.discounts = discounts;
this.extraParams = extraParams;
this.price = price;
this.priceData = priceData;
this.quantity = quantity;
this.taxRates = taxRates;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private List discounts;
private Map extraParams;
private String price;
private PriceData priceData;
private Long quantity;
private Object taxRates;
/** Finalize and obtain parameter instance from this builder. */
public SubscriptionScheduleCreateParams.Phase.AddInvoiceItem build() {
return new SubscriptionScheduleCreateParams.Phase.AddInvoiceItem(
this.discounts,
this.extraParams,
this.price,
this.priceData,
this.quantity,
this.taxRates);
}
/**
* Add an element to `discounts` list. A list is initialized for the first `add/addAll`
* call, and subsequent calls adds additional elements to the original list. See {@link
* SubscriptionScheduleCreateParams.Phase.AddInvoiceItem#discounts} for the field
* documentation.
*/
public Builder addDiscount(
SubscriptionScheduleCreateParams.Phase.AddInvoiceItem.Discount element) {
if (this.discounts == null) {
this.discounts = new ArrayList<>();
}
this.discounts.add(element);
return this;
}
/**
* Add all elements to `discounts` list. A list is initialized for the first `add/addAll`
* call, and subsequent calls adds additional elements to the original list. See {@link
* SubscriptionScheduleCreateParams.Phase.AddInvoiceItem#discounts} for the field
* documentation.
*/
public Builder addAllDiscount(
List elements) {
if (this.discounts == null) {
this.discounts = new ArrayList<>();
}
this.discounts.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 SubscriptionScheduleCreateParams.Phase.AddInvoiceItem#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 SubscriptionScheduleCreateParams.Phase.AddInvoiceItem#extraParams} for
* the field documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/** The ID of the price object. One of {@code price} or {@code price_data} is required. */
public Builder setPrice(String price) {
this.price = price;
return this;
}
/**
* Data used to generate a new Price object
* inline. One of {@code price} or {@code price_data} is required.
*/
public Builder setPriceData(
SubscriptionScheduleCreateParams.Phase.AddInvoiceItem.PriceData priceData) {
this.priceData = priceData;
return this;
}
/** Quantity for this item. Defaults to 1. */
public Builder setQuantity(Long quantity) {
this.quantity = quantity;
return this;
}
/**
* Add an element to `taxRates` list. A list is initialized for the first `add/addAll` call,
* and subsequent calls adds additional elements to the original list. See {@link
* SubscriptionScheduleCreateParams.Phase.AddInvoiceItem#taxRates} for the field
* documentation.
*/
@SuppressWarnings("unchecked")
public Builder addTaxRate(String element) {
if (this.taxRates == null || this.taxRates instanceof EmptyParam) {
this.taxRates = new ArrayList();
}
((List) this.taxRates).add(element);
return this;
}
/**
* Add all elements to `taxRates` list. A list is initialized for the first `add/addAll`
* call, and subsequent calls adds additional elements to the original list. See {@link
* SubscriptionScheduleCreateParams.Phase.AddInvoiceItem#taxRates} for the field
* documentation.
*/
@SuppressWarnings("unchecked")
public Builder addAllTaxRate(List elements) {
if (this.taxRates == null || this.taxRates instanceof EmptyParam) {
this.taxRates = new ArrayList();
}
((List) this.taxRates).addAll(elements);
return this;
}
/**
* The tax rates which apply to the item. When set, the {@code default_tax_rates} do not
* apply to this item.
*/
public Builder setTaxRates(EmptyParam taxRates) {
this.taxRates = taxRates;
return this;
}
/**
* The tax rates which apply to the item. When set, the {@code default_tax_rates} do not
* apply to this item.
*/
public Builder setTaxRates(List taxRates) {
this.taxRates = taxRates;
return this;
}
}
@Getter
public static class Discount {
/** ID of the coupon to create a new discount for. */
@SerializedName("coupon")
String coupon;
/** ID of an existing discount on the object (or one of its ancestors) to reuse. */
@SerializedName("discount")
String discount;
/**
* 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;
/** ID of the promotion code to create a new discount for. */
@SerializedName("promotion_code")
String promotionCode;
private Discount(
String coupon, String discount, Map extraParams, String promotionCode) {
this.coupon = coupon;
this.discount = discount;
this.extraParams = extraParams;
this.promotionCode = promotionCode;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private String coupon;
private String discount;
private Map extraParams;
private String promotionCode;
/** Finalize and obtain parameter instance from this builder. */
public SubscriptionScheduleCreateParams.Phase.AddInvoiceItem.Discount build() {
return new SubscriptionScheduleCreateParams.Phase.AddInvoiceItem.Discount(
this.coupon, this.discount, this.extraParams, this.promotionCode);
}
/** ID of the coupon to create a new discount for. */
public Builder setCoupon(String coupon) {
this.coupon = coupon;
return this;
}
/** ID of an existing discount on the object (or one of its ancestors) to reuse. */
public Builder setDiscount(String discount) {
this.discount = discount;
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
* SubscriptionScheduleCreateParams.Phase.AddInvoiceItem.Discount#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
* SubscriptionScheduleCreateParams.Phase.AddInvoiceItem.Discount#extraParams} for the
* field documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/** ID of the promotion code to create a new discount for. */
public Builder setPromotionCode(String promotionCode) {
this.promotionCode = promotionCode;
return this;
}
}
}
@Getter
public static class PriceData {
/**
* Required. Three-letter ISO currency code, in
* lowercase. Must be a supported currency.
*/
@SerializedName("currency")
String currency;
/**
* 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;
/** Required. The ID of the product that this price will belong to. */
@SerializedName("product")
String product;
/**
* Only required if a default
* tax behavior was not provided in the Stripe Tax settings. Specifies whether the price
* is considered inclusive of taxes or exclusive of taxes. One of {@code inclusive}, {@code
* exclusive}, or {@code unspecified}. Once specified as either {@code inclusive} or {@code
* exclusive}, it cannot be changed.
*/
@SerializedName("tax_behavior")
TaxBehavior taxBehavior;
/**
* A positive integer in cents (or local equivalent) (or 0 for a free price) representing
* how much to charge or a negative integer representing the amount to credit to the
* customer.
*/
@SerializedName("unit_amount")
Long unitAmount;
/**
* Same as {@code unit_amount}, but accepts a decimal value in cents (or local equivalent)
* with at most 12 decimal places. Only one of {@code unit_amount} and {@code
* unit_amount_decimal} can be set.
*/
@SerializedName("unit_amount_decimal")
BigDecimal unitAmountDecimal;
private PriceData(
String currency,
Map extraParams,
String product,
TaxBehavior taxBehavior,
Long unitAmount,
BigDecimal unitAmountDecimal) {
this.currency = currency;
this.extraParams = extraParams;
this.product = product;
this.taxBehavior = taxBehavior;
this.unitAmount = unitAmount;
this.unitAmountDecimal = unitAmountDecimal;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private String currency;
private Map extraParams;
private String product;
private TaxBehavior taxBehavior;
private Long unitAmount;
private BigDecimal unitAmountDecimal;
/** Finalize and obtain parameter instance from this builder. */
public SubscriptionScheduleCreateParams.Phase.AddInvoiceItem.PriceData build() {
return new SubscriptionScheduleCreateParams.Phase.AddInvoiceItem.PriceData(
this.currency,
this.extraParams,
this.product,
this.taxBehavior,
this.unitAmount,
this.unitAmountDecimal);
}
/**
* Required. Three-letter ISO currency code, in
* lowercase. Must be a supported
* currency.
*/
public Builder setCurrency(String currency) {
this.currency = currency;
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
* SubscriptionScheduleCreateParams.Phase.AddInvoiceItem.PriceData#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
* SubscriptionScheduleCreateParams.Phase.AddInvoiceItem.PriceData#extraParams} for the
* field documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/** Required. The ID of the product that this price will belong to. */
public Builder setProduct(String product) {
this.product = product;
return this;
}
/**
* Only required if a default
* tax behavior was not provided in the Stripe Tax settings. Specifies whether the
* price is considered inclusive of taxes or exclusive of taxes. One of {@code inclusive},
* {@code exclusive}, or {@code unspecified}. Once specified as either {@code inclusive}
* or {@code exclusive}, it cannot be changed.
*/
public Builder setTaxBehavior(
SubscriptionScheduleCreateParams.Phase.AddInvoiceItem.PriceData.TaxBehavior
taxBehavior) {
this.taxBehavior = taxBehavior;
return this;
}
/**
* A positive integer in cents (or local equivalent) (or 0 for a free price) representing
* how much to charge or a negative integer representing the amount to credit to the
* customer.
*/
public Builder setUnitAmount(Long unitAmount) {
this.unitAmount = unitAmount;
return this;
}
/**
* Same as {@code unit_amount}, but accepts a decimal value in cents (or local equivalent)
* with at most 12 decimal places. Only one of {@code unit_amount} and {@code
* unit_amount_decimal} can be set.
*/
public Builder setUnitAmountDecimal(BigDecimal unitAmountDecimal) {
this.unitAmountDecimal = unitAmountDecimal;
return this;
}
}
public enum TaxBehavior implements ApiRequestParams.EnumParam {
@SerializedName("exclusive")
EXCLUSIVE("exclusive"),
@SerializedName("inclusive")
INCLUSIVE("inclusive"),
@SerializedName("unspecified")
UNSPECIFIED("unspecified");
@Getter(onMethod_ = {@Override})
private final String value;
TaxBehavior(String value) {
this.value = value;
}
}
}
}
@Getter
public static class AutomaticTax {
/**
* Required. Enabled automatic tax calculation which will automatically
* compute tax rates on all invoices generated by the subscription.
*/
@SerializedName("enabled")
Boolean enabled;
/**
* 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;
/**
* The account that's liable for tax. If set, the business address and tax registrations
* required to perform the tax calculation are loaded from this account. The tax transaction
* is returned in the report of the connected account.
*/
@SerializedName("liability")
Liability liability;
private AutomaticTax(Boolean enabled, Map extraParams, Liability liability) {
this.enabled = enabled;
this.extraParams = extraParams;
this.liability = liability;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Boolean enabled;
private Map extraParams;
private Liability liability;
/** Finalize and obtain parameter instance from this builder. */
public SubscriptionScheduleCreateParams.Phase.AutomaticTax build() {
return new SubscriptionScheduleCreateParams.Phase.AutomaticTax(
this.enabled, this.extraParams, this.liability);
}
/**
* Required. Enabled automatic tax calculation which will automatically
* compute tax rates on all invoices generated by the subscription.
*/
public Builder setEnabled(Boolean enabled) {
this.enabled = enabled;
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 SubscriptionScheduleCreateParams.Phase.AutomaticTax#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 SubscriptionScheduleCreateParams.Phase.AutomaticTax#extraParams} for the
* field documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/**
* The account that's liable for tax. If set, the business address and tax registrations
* required to perform the tax calculation are loaded from this account. The tax transaction
* is returned in the report of the connected account.
*/
public Builder setLiability(
SubscriptionScheduleCreateParams.Phase.AutomaticTax.Liability liability) {
this.liability = liability;
return this;
}
}
@Getter
public static class Liability {
/** The connected account being referenced when {@code type} is {@code account}. */
@SerializedName("account")
String account;
/**
* 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;
/** Required. Type of the account referenced in the request. */
@SerializedName("type")
Type type;
private Liability(String account, Map extraParams, Type type) {
this.account = account;
this.extraParams = extraParams;
this.type = type;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private String account;
private Map extraParams;
private Type type;
/** Finalize and obtain parameter instance from this builder. */
public SubscriptionScheduleCreateParams.Phase.AutomaticTax.Liability build() {
return new SubscriptionScheduleCreateParams.Phase.AutomaticTax.Liability(
this.account, this.extraParams, this.type);
}
/** The connected account being referenced when {@code type} is {@code account}. */
public Builder setAccount(String account) {
this.account = account;
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
* SubscriptionScheduleCreateParams.Phase.AutomaticTax.Liability#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
* SubscriptionScheduleCreateParams.Phase.AutomaticTax.Liability#extraParams} for the
* field documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/** Required. Type of the account referenced in the request. */
public Builder setType(
SubscriptionScheduleCreateParams.Phase.AutomaticTax.Liability.Type type) {
this.type = type;
return this;
}
}
public enum Type implements ApiRequestParams.EnumParam {
@SerializedName("account")
ACCOUNT("account"),
@SerializedName("self")
SELF("self");
@Getter(onMethod_ = {@Override})
private final String value;
Type(String value) {
this.value = value;
}
}
}
}
@Getter
public static class BillingThresholds {
/** Monetary threshold that triggers the subscription to advance to a new billing period. */
@SerializedName("amount_gte")
Long amountGte;
/**
* 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;
/**
* Indicates if the {@code billing_cycle_anchor} should be reset when a threshold is reached.
* If true, {@code billing_cycle_anchor} will be updated to the date/time the threshold was
* last reached; otherwise, the value will remain unchanged.
*/
@SerializedName("reset_billing_cycle_anchor")
Boolean resetBillingCycleAnchor;
private BillingThresholds(
Long amountGte, Map extraParams, Boolean resetBillingCycleAnchor) {
this.amountGte = amountGte;
this.extraParams = extraParams;
this.resetBillingCycleAnchor = resetBillingCycleAnchor;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Long amountGte;
private Map extraParams;
private Boolean resetBillingCycleAnchor;
/** Finalize and obtain parameter instance from this builder. */
public SubscriptionScheduleCreateParams.Phase.BillingThresholds build() {
return new SubscriptionScheduleCreateParams.Phase.BillingThresholds(
this.amountGte, this.extraParams, this.resetBillingCycleAnchor);
}
/** Monetary threshold that triggers the subscription to advance to a new billing period. */
public Builder setAmountGte(Long amountGte) {
this.amountGte = amountGte;
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 SubscriptionScheduleCreateParams.Phase.BillingThresholds#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 SubscriptionScheduleCreateParams.Phase.BillingThresholds#extraParams} for
* the field documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/**
* Indicates if the {@code billing_cycle_anchor} should be reset when a threshold is
* reached. If true, {@code billing_cycle_anchor} will be updated to the date/time the
* threshold was last reached; otherwise, the value will remain unchanged.
*/
public Builder setResetBillingCycleAnchor(Boolean resetBillingCycleAnchor) {
this.resetBillingCycleAnchor = resetBillingCycleAnchor;
return this;
}
}
}
@Getter
public static class Discount {
/** ID of the coupon to create a new discount for. */
@SerializedName("coupon")
String coupon;
/** ID of an existing discount on the object (or one of its ancestors) to reuse. */
@SerializedName("discount")
String discount;
/**
* 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;
/** ID of the promotion code to create a new discount for. */
@SerializedName("promotion_code")
String promotionCode;
private Discount(
String coupon, String discount, Map extraParams, String promotionCode) {
this.coupon = coupon;
this.discount = discount;
this.extraParams = extraParams;
this.promotionCode = promotionCode;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private String coupon;
private String discount;
private Map extraParams;
private String promotionCode;
/** Finalize and obtain parameter instance from this builder. */
public SubscriptionScheduleCreateParams.Phase.Discount build() {
return new SubscriptionScheduleCreateParams.Phase.Discount(
this.coupon, this.discount, this.extraParams, this.promotionCode);
}
/** ID of the coupon to create a new discount for. */
public Builder setCoupon(String coupon) {
this.coupon = coupon;
return this;
}
/** ID of an existing discount on the object (or one of its ancestors) to reuse. */
public Builder setDiscount(String discount) {
this.discount = discount;
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 SubscriptionScheduleCreateParams.Phase.Discount#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 SubscriptionScheduleCreateParams.Phase.Discount#extraParams} for the
* field documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/** ID of the promotion code to create a new discount for. */
public Builder setPromotionCode(String promotionCode) {
this.promotionCode = promotionCode;
return this;
}
}
}
@Getter
public static class InvoiceSettings {
/**
* The account tax IDs associated with this phase of the subscription schedule. Will be set on
* invoices generated by this phase of the subscription schedule.
*/
@SerializedName("account_tax_ids")
Object accountTaxIds;
/**
* Number of days within which a customer must pay invoices generated by this subscription
* schedule. This value will be {@code null} for subscription schedules where {@code
* billing=charge_automatically}.
*/
@SerializedName("days_until_due")
Long daysUntilDue;
/**
* 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;
/**
* The connected account that issues the invoice. The invoice is presented with the branding
* and support information of the specified account.
*/
@SerializedName("issuer")
Issuer issuer;
private InvoiceSettings(
Object accountTaxIds, Long daysUntilDue, Map extraParams, Issuer issuer) {
this.accountTaxIds = accountTaxIds;
this.daysUntilDue = daysUntilDue;
this.extraParams = extraParams;
this.issuer = issuer;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Object accountTaxIds;
private Long daysUntilDue;
private Map extraParams;
private Issuer issuer;
/** Finalize and obtain parameter instance from this builder. */
public SubscriptionScheduleCreateParams.Phase.InvoiceSettings build() {
return new SubscriptionScheduleCreateParams.Phase.InvoiceSettings(
this.accountTaxIds, this.daysUntilDue, this.extraParams, this.issuer);
}
/**
* Add an element to `accountTaxIds` list. A list is initialized for the first `add/addAll`
* call, and subsequent calls adds additional elements to the original list. See {@link
* SubscriptionScheduleCreateParams.Phase.InvoiceSettings#accountTaxIds} for the field
* documentation.
*/
@SuppressWarnings("unchecked")
public Builder addAccountTaxId(String element) {
if (this.accountTaxIds == null || this.accountTaxIds instanceof EmptyParam) {
this.accountTaxIds = new ArrayList();
}
((List) this.accountTaxIds).add(element);
return this;
}
/**
* Add all elements to `accountTaxIds` list. A list is initialized for the first
* `add/addAll` call, and subsequent calls adds additional elements to the original list.
* See {@link SubscriptionScheduleCreateParams.Phase.InvoiceSettings#accountTaxIds} for the
* field documentation.
*/
@SuppressWarnings("unchecked")
public Builder addAllAccountTaxId(List elements) {
if (this.accountTaxIds == null || this.accountTaxIds instanceof EmptyParam) {
this.accountTaxIds = new ArrayList();
}
((List) this.accountTaxIds).addAll(elements);
return this;
}
/**
* The account tax IDs associated with this phase of the subscription schedule. Will be set
* on invoices generated by this phase of the subscription schedule.
*/
public Builder setAccountTaxIds(EmptyParam accountTaxIds) {
this.accountTaxIds = accountTaxIds;
return this;
}
/**
* The account tax IDs associated with this phase of the subscription schedule. Will be set
* on invoices generated by this phase of the subscription schedule.
*/
public Builder setAccountTaxIds(List accountTaxIds) {
this.accountTaxIds = accountTaxIds;
return this;
}
/**
* Number of days within which a customer must pay invoices generated by this subscription
* schedule. This value will be {@code null} for subscription schedules where {@code
* billing=charge_automatically}.
*/
public Builder setDaysUntilDue(Long daysUntilDue) {
this.daysUntilDue = daysUntilDue;
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 SubscriptionScheduleCreateParams.Phase.InvoiceSettings#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 SubscriptionScheduleCreateParams.Phase.InvoiceSettings#extraParams} for
* the field documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/**
* The connected account that issues the invoice. The invoice is presented with the branding
* and support information of the specified account.
*/
public Builder setIssuer(
SubscriptionScheduleCreateParams.Phase.InvoiceSettings.Issuer issuer) {
this.issuer = issuer;
return this;
}
}
@Getter
public static class Issuer {
/** The connected account being referenced when {@code type} is {@code account}. */
@SerializedName("account")
String account;
/**
* 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;
/** Required. Type of the account referenced in the request. */
@SerializedName("type")
Type type;
private Issuer(String account, Map extraParams, Type type) {
this.account = account;
this.extraParams = extraParams;
this.type = type;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private String account;
private Map extraParams;
private Type type;
/** Finalize and obtain parameter instance from this builder. */
public SubscriptionScheduleCreateParams.Phase.InvoiceSettings.Issuer build() {
return new SubscriptionScheduleCreateParams.Phase.InvoiceSettings.Issuer(
this.account, this.extraParams, this.type);
}
/** The connected account being referenced when {@code type} is {@code account}. */
public Builder setAccount(String account) {
this.account = account;
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
* SubscriptionScheduleCreateParams.Phase.InvoiceSettings.Issuer#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
* SubscriptionScheduleCreateParams.Phase.InvoiceSettings.Issuer#extraParams} for the
* field documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/** Required. Type of the account referenced in the request. */
public Builder setType(
SubscriptionScheduleCreateParams.Phase.InvoiceSettings.Issuer.Type type) {
this.type = type;
return this;
}
}
public enum Type implements ApiRequestParams.EnumParam {
@SerializedName("account")
ACCOUNT("account"),
@SerializedName("self")
SELF("self");
@Getter(onMethod_ = {@Override})
private final String value;
Type(String value) {
this.value = value;
}
}
}
}
@Getter
public static class Item {
/**
* Define thresholds at which an invoice will be sent, and the subscription advanced to a new
* billing period. When updating, pass an empty string to remove previously-defined
* thresholds.
*/
@SerializedName("billing_thresholds")
Object billingThresholds;
/** The coupons to redeem into discounts for the subscription item. */
@SerializedName("discounts")
Object discounts;
/**
* 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;
/**
* Set of key-value pairs that you can
* attach to a configuration item. Metadata on a configuration item will update the underlying
* subscription item's {@code metadata} when the phase is entered, adding new keys and
* replacing existing keys. Individual keys in the subscription item's {@code metadata} can be
* unset by posting an empty value to them in the configuration item's {@code metadata}. To
* unset all keys in the subscription item's {@code metadata}, update the subscription item
* directly or unset every key individually from the configuration item's {@code metadata}.
*/
@SerializedName("metadata")
Map metadata;
/**
* The plan ID to subscribe to. You may specify the same ID in {@code plan} and {@code price}.
*/
@SerializedName("plan")
String plan;
/** The ID of the price object. */
@SerializedName("price")
String price;
/**
* Data used to generate a new Price object
* inline.
*/
@SerializedName("price_data")
PriceData priceData;
/**
* Quantity for the given price. Can be set only if the price's {@code usage_type} is {@code
* licensed} and not {@code metered}.
*/
@SerializedName("quantity")
Long quantity;
/**
* A list of Tax Rate ids. These Tax Rates
* will override the {@code
* default_tax_rates} on the Subscription. When updating, pass an empty string to remove
* previously-defined tax rates.
*/
@SerializedName("tax_rates")
Object taxRates;
private Item(
Object billingThresholds,
Object discounts,
Map extraParams,
Map metadata,
String plan,
String price,
PriceData priceData,
Long quantity,
Object taxRates) {
this.billingThresholds = billingThresholds;
this.discounts = discounts;
this.extraParams = extraParams;
this.metadata = metadata;
this.plan = plan;
this.price = price;
this.priceData = priceData;
this.quantity = quantity;
this.taxRates = taxRates;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Object billingThresholds;
private Object discounts;
private Map extraParams;
private Map metadata;
private String plan;
private String price;
private PriceData priceData;
private Long quantity;
private Object taxRates;
/** Finalize and obtain parameter instance from this builder. */
public SubscriptionScheduleCreateParams.Phase.Item build() {
return new SubscriptionScheduleCreateParams.Phase.Item(
this.billingThresholds,
this.discounts,
this.extraParams,
this.metadata,
this.plan,
this.price,
this.priceData,
this.quantity,
this.taxRates);
}
/**
* Define thresholds at which an invoice will be sent, and the subscription advanced to a
* new billing period. When updating, pass an empty string to remove previously-defined
* thresholds.
*/
public Builder setBillingThresholds(
SubscriptionScheduleCreateParams.Phase.Item.BillingThresholds billingThresholds) {
this.billingThresholds = billingThresholds;
return this;
}
/**
* Define thresholds at which an invoice will be sent, and the subscription advanced to a
* new billing period. When updating, pass an empty string to remove previously-defined
* thresholds.
*/
public Builder setBillingThresholds(EmptyParam billingThresholds) {
this.billingThresholds = billingThresholds;
return this;
}
/**
* Add an element to `discounts` list. A list is initialized for the first `add/addAll`
* call, and subsequent calls adds additional elements to the original list. See {@link
* SubscriptionScheduleCreateParams.Phase.Item#discounts} for the field documentation.
*/
@SuppressWarnings("unchecked")
public Builder addDiscount(SubscriptionScheduleCreateParams.Phase.Item.Discount element) {
if (this.discounts == null || this.discounts instanceof EmptyParam) {
this.discounts = new ArrayList();
}
((List) this.discounts)
.add(element);
return this;
}
/**
* Add all elements to `discounts` list. A list is initialized for the first `add/addAll`
* call, and subsequent calls adds additional elements to the original list. See {@link
* SubscriptionScheduleCreateParams.Phase.Item#discounts} for the field documentation.
*/
@SuppressWarnings("unchecked")
public Builder addAllDiscount(
List elements) {
if (this.discounts == null || this.discounts instanceof EmptyParam) {
this.discounts = new ArrayList();
}
((List) this.discounts)
.addAll(elements);
return this;
}
/** The coupons to redeem into discounts for the subscription item. */
public Builder setDiscounts(EmptyParam discounts) {
this.discounts = discounts;
return this;
}
/** The coupons to redeem into discounts for the subscription item. */
public Builder setDiscounts(
List discounts) {
this.discounts = discounts;
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 SubscriptionScheduleCreateParams.Phase.Item#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 SubscriptionScheduleCreateParams.Phase.Item#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 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
* SubscriptionScheduleCreateParams.Phase.Item#metadata} for the field documentation.
*/
public Builder putMetadata(String key, String value) {
if (this.metadata == null) {
this.metadata = new HashMap<>();
}
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 SubscriptionScheduleCreateParams.Phase.Item#metadata} for the field
* documentation.
*/
public Builder putAllMetadata(Map map) {
if (this.metadata == null) {
this.metadata = new HashMap<>();
}
this.metadata.putAll(map);
return this;
}
/**
* The plan ID to subscribe to. You may specify the same ID in {@code plan} and {@code
* price}.
*/
public Builder setPlan(String plan) {
this.plan = plan;
return this;
}
/** The ID of the price object. */
public Builder setPrice(String price) {
this.price = price;
return this;
}
/**
* Data used to generate a new Price object
* inline.
*/
public Builder setPriceData(
SubscriptionScheduleCreateParams.Phase.Item.PriceData priceData) {
this.priceData = priceData;
return this;
}
/**
* Quantity for the given price. Can be set only if the price's {@code usage_type} is {@code
* licensed} and not {@code metered}.
*/
public Builder setQuantity(Long quantity) {
this.quantity = quantity;
return this;
}
/**
* Add an element to `taxRates` list. A list is initialized for the first `add/addAll` call,
* and subsequent calls adds additional elements to the original list. See {@link
* SubscriptionScheduleCreateParams.Phase.Item#taxRates} for the field documentation.
*/
@SuppressWarnings("unchecked")
public Builder addTaxRate(String element) {
if (this.taxRates == null || this.taxRates instanceof EmptyParam) {
this.taxRates = new ArrayList();
}
((List) this.taxRates).add(element);
return this;
}
/**
* Add all elements to `taxRates` list. A list is initialized for the first `add/addAll`
* call, and subsequent calls adds additional elements to the original list. See {@link
* SubscriptionScheduleCreateParams.Phase.Item#taxRates} for the field documentation.
*/
@SuppressWarnings("unchecked")
public Builder addAllTaxRate(List elements) {
if (this.taxRates == null || this.taxRates instanceof EmptyParam) {
this.taxRates = new ArrayList();
}
((List) this.taxRates).addAll(elements);
return this;
}
/**
* A list of Tax Rate ids. These Tax
* Rates will override the {@code
* default_tax_rates} on the Subscription. When updating, pass an empty string to remove
* previously-defined tax rates.
*/
public Builder setTaxRates(EmptyParam taxRates) {
this.taxRates = taxRates;
return this;
}
/**
* A list of Tax Rate ids. These Tax
* Rates will override the {@code
* default_tax_rates} on the Subscription. When updating, pass an empty string to remove
* previously-defined tax rates.
*/
public Builder setTaxRates(List taxRates) {
this.taxRates = taxRates;
return this;
}
}
@Getter
public static class BillingThresholds {
/**
* 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;
/**
* Required. Number of units that meets the billing threshold to advance
* the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 monetary
* threshold)
*/
@SerializedName("usage_gte")
Long usageGte;
private BillingThresholds(Map extraParams, Long usageGte) {
this.extraParams = extraParams;
this.usageGte = usageGte;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Map extraParams;
private Long usageGte;
/** Finalize and obtain parameter instance from this builder. */
public SubscriptionScheduleCreateParams.Phase.Item.BillingThresholds build() {
return new SubscriptionScheduleCreateParams.Phase.Item.BillingThresholds(
this.extraParams, this.usageGte);
}
/**
* 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
* SubscriptionScheduleCreateParams.Phase.Item.BillingThresholds#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
* SubscriptionScheduleCreateParams.Phase.Item.BillingThresholds#extraParams} for the
* field documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/**
* Required. Number of units that meets the billing threshold to advance
* the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 monetary
* threshold)
*/
public Builder setUsageGte(Long usageGte) {
this.usageGte = usageGte;
return this;
}
}
}
@Getter
public static class Discount {
/** ID of the coupon to create a new discount for. */
@SerializedName("coupon")
String coupon;
/** ID of an existing discount on the object (or one of its ancestors) to reuse. */
@SerializedName("discount")
String discount;
/**
* 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;
/** ID of the promotion code to create a new discount for. */
@SerializedName("promotion_code")
String promotionCode;
private Discount(
String coupon, String discount, Map extraParams, String promotionCode) {
this.coupon = coupon;
this.discount = discount;
this.extraParams = extraParams;
this.promotionCode = promotionCode;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private String coupon;
private String discount;
private Map extraParams;
private String promotionCode;
/** Finalize and obtain parameter instance from this builder. */
public SubscriptionScheduleCreateParams.Phase.Item.Discount build() {
return new SubscriptionScheduleCreateParams.Phase.Item.Discount(
this.coupon, this.discount, this.extraParams, this.promotionCode);
}
/** ID of the coupon to create a new discount for. */
public Builder setCoupon(String coupon) {
this.coupon = coupon;
return this;
}
/** ID of an existing discount on the object (or one of its ancestors) to reuse. */
public Builder setDiscount(String discount) {
this.discount = discount;
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 SubscriptionScheduleCreateParams.Phase.Item.Discount#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 SubscriptionScheduleCreateParams.Phase.Item.Discount#extraParams} for
* the field documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/** ID of the promotion code to create a new discount for. */
public Builder setPromotionCode(String promotionCode) {
this.promotionCode = promotionCode;
return this;
}
}
}
@Getter
public static class PriceData {
/**
* Required. Three-letter ISO currency code, in
* lowercase. Must be a supported currency.
*/
@SerializedName("currency")
String currency;
/**
* 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;
/** Required. The ID of the product that this price will belong to. */
@SerializedName("product")
String product;
/**
* Required. The recurring components of a price such as {@code interval}
* and {@code interval_count}.
*/
@SerializedName("recurring")
Recurring recurring;
/**
* Only required if a default
* tax behavior was not provided in the Stripe Tax settings. Specifies whether the price
* is considered inclusive of taxes or exclusive of taxes. One of {@code inclusive}, {@code
* exclusive}, or {@code unspecified}. Once specified as either {@code inclusive} or {@code
* exclusive}, it cannot be changed.
*/
@SerializedName("tax_behavior")
TaxBehavior taxBehavior;
/**
* A positive integer in cents (or local equivalent) (or 0 for a free price) representing
* how much to charge.
*/
@SerializedName("unit_amount")
Long unitAmount;
/**
* Same as {@code unit_amount}, but accepts a decimal value in cents (or local equivalent)
* with at most 12 decimal places. Only one of {@code unit_amount} and {@code
* unit_amount_decimal} can be set.
*/
@SerializedName("unit_amount_decimal")
BigDecimal unitAmountDecimal;
private PriceData(
String currency,
Map extraParams,
String product,
Recurring recurring,
TaxBehavior taxBehavior,
Long unitAmount,
BigDecimal unitAmountDecimal) {
this.currency = currency;
this.extraParams = extraParams;
this.product = product;
this.recurring = recurring;
this.taxBehavior = taxBehavior;
this.unitAmount = unitAmount;
this.unitAmountDecimal = unitAmountDecimal;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private String currency;
private Map extraParams;
private String product;
private Recurring recurring;
private TaxBehavior taxBehavior;
private Long unitAmount;
private BigDecimal unitAmountDecimal;
/** Finalize and obtain parameter instance from this builder. */
public SubscriptionScheduleCreateParams.Phase.Item.PriceData build() {
return new SubscriptionScheduleCreateParams.Phase.Item.PriceData(
this.currency,
this.extraParams,
this.product,
this.recurring,
this.taxBehavior,
this.unitAmount,
this.unitAmountDecimal);
}
/**
* Required. Three-letter ISO currency code, in
* lowercase. Must be a supported
* currency.
*/
public Builder setCurrency(String currency) {
this.currency = currency;
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 SubscriptionScheduleCreateParams.Phase.Item.PriceData#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 SubscriptionScheduleCreateParams.Phase.Item.PriceData#extraParams} for
* the field documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/** Required. The ID of the product that this price will belong to. */
public Builder setProduct(String product) {
this.product = product;
return this;
}
/**
* Required. The recurring components of a price such as {@code interval}
* and {@code interval_count}.
*/
public Builder setRecurring(
SubscriptionScheduleCreateParams.Phase.Item.PriceData.Recurring recurring) {
this.recurring = recurring;
return this;
}
/**
* Only required if a default
* tax behavior was not provided in the Stripe Tax settings. Specifies whether the
* price is considered inclusive of taxes or exclusive of taxes. One of {@code inclusive},
* {@code exclusive}, or {@code unspecified}. Once specified as either {@code inclusive}
* or {@code exclusive}, it cannot be changed.
*/
public Builder setTaxBehavior(
SubscriptionScheduleCreateParams.Phase.Item.PriceData.TaxBehavior taxBehavior) {
this.taxBehavior = taxBehavior;
return this;
}
/**
* A positive integer in cents (or local equivalent) (or 0 for a free price) representing
* how much to charge.
*/
public Builder setUnitAmount(Long unitAmount) {
this.unitAmount = unitAmount;
return this;
}
/**
* Same as {@code unit_amount}, but accepts a decimal value in cents (or local equivalent)
* with at most 12 decimal places. Only one of {@code unit_amount} and {@code
* unit_amount_decimal} can be set.
*/
public Builder setUnitAmountDecimal(BigDecimal unitAmountDecimal) {
this.unitAmountDecimal = unitAmountDecimal;
return this;
}
}
@Getter
public static class Recurring {
/**
* 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;
/**
* Required. Specifies billing frequency. Either {@code day}, {@code
* week}, {@code month} or {@code year}.
*/
@SerializedName("interval")
Interval interval;
/**
* The number of intervals between subscription billings. For example, {@code
* interval=month} and {@code interval_count=3} bills every 3 months. Maximum of three
* years interval allowed (3 years, 36 months, or 156 weeks).
*/
@SerializedName("interval_count")
Long intervalCount;
private Recurring(
Map extraParams, Interval interval, Long intervalCount) {
this.extraParams = extraParams;
this.interval = interval;
this.intervalCount = intervalCount;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Map extraParams;
private Interval interval;
private Long intervalCount;
/** Finalize and obtain parameter instance from this builder. */
public SubscriptionScheduleCreateParams.Phase.Item.PriceData.Recurring build() {
return new SubscriptionScheduleCreateParams.Phase.Item.PriceData.Recurring(
this.extraParams, this.interval, this.intervalCount);
}
/**
* 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
* SubscriptionScheduleCreateParams.Phase.Item.PriceData.Recurring#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
* SubscriptionScheduleCreateParams.Phase.Item.PriceData.Recurring#extraParams} for the
* field documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/**
* Required. Specifies billing frequency. Either {@code day}, {@code
* week}, {@code month} or {@code year}.
*/
public Builder setInterval(
SubscriptionScheduleCreateParams.Phase.Item.PriceData.Recurring.Interval interval) {
this.interval = interval;
return this;
}
/**
* The number of intervals between subscription billings. For example, {@code
* interval=month} and {@code interval_count=3} bills every 3 months. Maximum of three
* years interval allowed (3 years, 36 months, or 156 weeks).
*/
public Builder setIntervalCount(Long intervalCount) {
this.intervalCount = intervalCount;
return this;
}
}
public enum Interval implements ApiRequestParams.EnumParam {
@SerializedName("day")
DAY("day"),
@SerializedName("month")
MONTH("month"),
@SerializedName("week")
WEEK("week"),
@SerializedName("year")
YEAR("year");
@Getter(onMethod_ = {@Override})
private final String value;
Interval(String value) {
this.value = value;
}
}
}
public enum TaxBehavior implements ApiRequestParams.EnumParam {
@SerializedName("exclusive")
EXCLUSIVE("exclusive"),
@SerializedName("inclusive")
INCLUSIVE("inclusive"),
@SerializedName("unspecified")
UNSPECIFIED("unspecified");
@Getter(onMethod_ = {@Override})
private final String value;
TaxBehavior(String value) {
this.value = value;
}
}
}
}
@Getter
public static class TransferData {
/**
* A non-negative decimal between 0 and 100, with at most two decimal places. This represents
* the percentage of the subscription invoice total that will be transferred to the
* destination account. By default, the entire amount is transferred to the destination.
*/
@SerializedName("amount_percent")
BigDecimal amountPercent;
/** Required. ID of an existing, connected Stripe account. */
@SerializedName("destination")
String destination;
/**
* 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;
private TransferData(
BigDecimal amountPercent, String destination, Map extraParams) {
this.amountPercent = amountPercent;
this.destination = destination;
this.extraParams = extraParams;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private BigDecimal amountPercent;
private String destination;
private Map extraParams;
/** Finalize and obtain parameter instance from this builder. */
public SubscriptionScheduleCreateParams.Phase.TransferData build() {
return new SubscriptionScheduleCreateParams.Phase.TransferData(
this.amountPercent, this.destination, this.extraParams);
}
/**
* A non-negative decimal between 0 and 100, with at most two decimal places. This
* represents the percentage of the subscription invoice total that will be transferred to
* the destination account. By default, the entire amount is transferred to the destination.
*/
public Builder setAmountPercent(BigDecimal amountPercent) {
this.amountPercent = amountPercent;
return this;
}
/** Required. ID of an existing, connected Stripe account. */
public Builder setDestination(String destination) {
this.destination = destination;
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 SubscriptionScheduleCreateParams.Phase.TransferData#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 SubscriptionScheduleCreateParams.Phase.TransferData#extraParams} for the
* field documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
}
}
public enum BillingCycleAnchor implements ApiRequestParams.EnumParam {
@SerializedName("automatic")
AUTOMATIC("automatic"),
@SerializedName("phase_start")
PHASE_START("phase_start");
@Getter(onMethod_ = {@Override})
private final String value;
BillingCycleAnchor(String value) {
this.value = value;
}
}
public enum CollectionMethod implements ApiRequestParams.EnumParam {
@SerializedName("charge_automatically")
CHARGE_AUTOMATICALLY("charge_automatically"),
@SerializedName("send_invoice")
SEND_INVOICE("send_invoice");
@Getter(onMethod_ = {@Override})
private final String value;
CollectionMethod(String value) {
this.value = value;
}
}
public enum ProrationBehavior implements ApiRequestParams.EnumParam {
@SerializedName("always_invoice")
ALWAYS_INVOICE("always_invoice"),
@SerializedName("create_prorations")
CREATE_PRORATIONS("create_prorations"),
@SerializedName("none")
NONE("none");
@Getter(onMethod_ = {@Override})
private final String value;
ProrationBehavior(String value) {
this.value = value;
}
}
}
public enum EndBehavior implements ApiRequestParams.EnumParam {
@SerializedName("cancel")
CANCEL("cancel"),
@SerializedName("none")
NONE("none"),
@SerializedName("release")
RELEASE("release"),
@SerializedName("renew")
RENEW("renew");
@Getter(onMethod_ = {@Override})
private final String value;
EndBehavior(String value) {
this.value = value;
}
}
public enum StartDate implements ApiRequestParams.EnumParam {
@SerializedName("now")
NOW("now");
@Getter(onMethod_ = {@Override})
private final String value;
StartDate(String value) {
this.value = value;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy