Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
// 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 InvoiceUpcomingLinesParams extends ApiRequestParams {
/** Settings for automatic tax lookup for this invoice preview. */
@SerializedName("automatic_tax")
AutomaticTax automaticTax;
/**
* 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;
/**
* The currency to preview this invoice in. Defaults to that of {@code customer} if not specified.
*/
@SerializedName("currency")
String currency;
/**
* The identifier of the customer whose upcoming invoice you'd like to retrieve. If {@code
* automatic_tax} is enabled then one of {@code customer}, {@code customer_details}, {@code
* subscription}, or {@code schedule} must be set.
*/
@SerializedName("customer")
String customer;
/**
* Details about the customer you want to invoice or overrides for an existing customer. If {@code
* automatic_tax} is enabled then one of {@code customer}, {@code customer_details}, {@code
* subscription}, or {@code schedule} must be set.
*/
@SerializedName("customer_details")
CustomerDetails customerDetails;
/**
* The coupons to redeem into discounts for the invoice preview. If not specified, inherits the
* discount from the subscription or customer. This works for both coupons directly applied to an
* invoice and coupons applied to a subscription. Pass an empty string to avoid inheriting any
* discounts.
*/
@SerializedName("discounts")
Object discounts;
/**
* A cursor for use in pagination. {@code ending_before} is an object ID that defines your place
* in the list. For instance, if you make a list request and receive 100 objects, starting with
* {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to
* fetch the previous page of the list.
*/
@SerializedName("ending_before")
String endingBefore;
/** 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;
/** List of invoice items to add or update in the upcoming invoice preview (up to 250). */
@SerializedName("invoice_items")
List invoiceItems;
/**
* 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;
/**
* A limit on the number of objects to be returned. Limit can range between 1 and 100, and the
* default is 10.
*/
@SerializedName("limit")
Long limit;
/**
* The account (if any) for which the funds of the invoice payment are intended. If set, the
* invoice will be presented with the branding and support information of the specified account.
* See the Invoices with Connect
* documentation for details.
*/
@SerializedName("on_behalf_of")
Object onBehalfOf;
/**
* Customizes the types of values to include when calculating the invoice. Defaults to {@code
* next} if unspecified.
*/
@SerializedName("preview_mode")
PreviewMode previewMode;
/**
* The identifier of the schedule whose upcoming invoice you'd like to retrieve. Cannot be used
* with subscription or subscription fields.
*/
@SerializedName("schedule")
String schedule;
/**
* The schedule creation or modification params to apply as a preview. Cannot be used with {@code
* subscription} or {@code subscription_} prefixed fields.
*/
@SerializedName("schedule_details")
ScheduleDetails scheduleDetails;
/**
* A cursor for use in pagination. {@code starting_after} is an object ID that defines your place
* in the list. For instance, if you make a list request and receive 100 objects, ending with
* {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in order to
* fetch the next page of the list.
*/
@SerializedName("starting_after")
String startingAfter;
/**
* The identifier of the subscription for which you'd like to retrieve the upcoming invoice. If
* not provided, but a {@code subscription_details.items} is provided, you will preview creating a
* subscription with those items. If neither {@code subscription} nor {@code
* subscription_details.items} is provided, you will retrieve the next upcoming invoice from among
* the customer's subscriptions.
*/
@SerializedName("subscription")
String subscription;
/**
* For new subscriptions, a future timestamp to anchor the subscription's billing cycle. This is used to
* determine the date of the first full invoice, and, for plans with {@code month} or {@code year}
* intervals, the day of the month for subsequent invoices. For existing subscriptions, the value
* can only be set to {@code now} or {@code unchanged}. This field has been deprecated and will be
* removed in a future API version. Use {@code subscription_details.billing_cycle_anchor} instead.
*/
@SerializedName("subscription_billing_cycle_anchor")
Object subscriptionBillingCycleAnchor;
/**
* A timestamp at which the subscription should cancel. If set to a date before the current period
* ends, this will cause a proration if prorations have been enabled using {@code
* proration_behavior}. If set during a future period, this will always cause a proration for that
* period. This field has been deprecated and will be removed in a future API version. Use {@code
* subscription_details.cancel_at} instead.
*/
@SerializedName("subscription_cancel_at")
Object subscriptionCancelAt;
/**
* Indicate whether this subscription should cancel at the end of the current period ({@code
* current_period_end}). Defaults to {@code false}. This field has been deprecated and will be
* removed in a future API version. Use {@code subscription_details.cancel_at_period_end} instead.
*/
@SerializedName("subscription_cancel_at_period_end")
Boolean subscriptionCancelAtPeriodEnd;
/**
* This simulates the subscription being canceled or expired immediately. This field has been
* deprecated and will be removed in a future API version. Use {@code
* subscription_details.cancel_now} instead.
*/
@SerializedName("subscription_cancel_now")
Boolean subscriptionCancelNow;
/**
* If provided, the invoice returned will preview updating or creating a subscription with these
* default tax rates. The default tax rates will apply to any line item that does not have {@code
* tax_rates} set. This field has been deprecated and will be removed in a future API version. Use
* {@code subscription_details.default_tax_rates} instead.
*/
@SerializedName("subscription_default_tax_rates")
Object subscriptionDefaultTaxRates;
/**
* The subscription creation or modification params to apply as a preview. Cannot be used with
* {@code schedule} or {@code schedule_details} fields.
*/
@SerializedName("subscription_details")
SubscriptionDetails subscriptionDetails;
/**
* A list of up to 20 subscription items, each with an attached price. This field has been
* deprecated and will be removed in a future API version. Use {@code subscription_details.items}
* instead.
*/
@SerializedName("subscription_items")
List subscriptionItems;
/**
* The pre-billing to apply to the subscription as a preview. This field has been deprecated and
* will be removed in a future API version. Use {@code subscription_details.prebilling} instead.
*/
@SerializedName("subscription_prebilling")
SubscriptionPrebilling subscriptionPrebilling;
/**
* Determines how to handle prorations when the billing
* cycle changes (e.g., when switching plans, resetting {@code billing_cycle_anchor=now}, or
* starting a trial), or if an item's {@code quantity} changes. The default value is {@code
* create_prorations}. This field has been deprecated and will be removed in a future API version.
* Use {@code subscription_details.proration_behavior} instead.
*/
@SerializedName("subscription_proration_behavior")
SubscriptionProrationBehavior subscriptionProrationBehavior;
/**
* If previewing an update to a subscription, and doing proration, {@code
* subscription_proration_date} forces the proration to be calculated as though the update was
* done at the specified time. The time given must be within the current subscription period and
* within the current phase of the schedule backing this subscription, if the schedule exists. If
* set, {@code subscription}, and one of {@code subscription_items}, or {@code
* subscription_trial_end} are required. Also, {@code subscription_proration_behavior} cannot be
* set to 'none'. This field has been deprecated and will be removed in a future API version. Use
* {@code subscription_details.proration_date} instead.
*/
@SerializedName("subscription_proration_date")
Long subscriptionProrationDate;
/**
* For paused subscriptions, setting {@code subscription_resume_at} to {@code now} will preview
* the invoice that will be generated if the subscription is resumed. This field has been
* deprecated and will be removed in a future API version. Use {@code
* subscription_details.resume_at} instead.
*/
@SerializedName("subscription_resume_at")
SubscriptionResumeAt subscriptionResumeAt;
/**
* Date a subscription is intended to start (can be future or past). This field has been
* deprecated and will be removed in a future API version. Use {@code
* subscription_details.start_date} instead.
*/
@SerializedName("subscription_start_date")
Long subscriptionStartDate;
/**
* If provided, the invoice returned will preview updating or creating a subscription with that
* trial end. If set, one of {@code subscription_items} or {@code subscription} is required. This
* field has been deprecated and will be removed in a future API version. Use {@code
* subscription_details.trial_end} instead.
*/
@SerializedName("subscription_trial_end")
Object subscriptionTrialEnd;
/**
* Indicates if a plan's {@code trial_period_days} should be applied to the subscription. Setting
* {@code subscription_trial_end} per subscription is preferred, and this defaults to {@code
* false}. Setting this flag to {@code true} together with {@code subscription_trial_end} is not
* allowed. See Using trial periods
* on subscriptions to learn more.
*/
@SerializedName("subscription_trial_from_plan")
Boolean subscriptionTrialFromPlan;
private InvoiceUpcomingLinesParams(
AutomaticTax automaticTax,
String coupon,
String currency,
String customer,
CustomerDetails customerDetails,
Object discounts,
String endingBefore,
List expand,
Map extraParams,
List invoiceItems,
Issuer issuer,
Long limit,
Object onBehalfOf,
PreviewMode previewMode,
String schedule,
ScheduleDetails scheduleDetails,
String startingAfter,
String subscription,
Object subscriptionBillingCycleAnchor,
Object subscriptionCancelAt,
Boolean subscriptionCancelAtPeriodEnd,
Boolean subscriptionCancelNow,
Object subscriptionDefaultTaxRates,
SubscriptionDetails subscriptionDetails,
List subscriptionItems,
SubscriptionPrebilling subscriptionPrebilling,
SubscriptionProrationBehavior subscriptionProrationBehavior,
Long subscriptionProrationDate,
SubscriptionResumeAt subscriptionResumeAt,
Long subscriptionStartDate,
Object subscriptionTrialEnd,
Boolean subscriptionTrialFromPlan) {
this.automaticTax = automaticTax;
this.coupon = coupon;
this.currency = currency;
this.customer = customer;
this.customerDetails = customerDetails;
this.discounts = discounts;
this.endingBefore = endingBefore;
this.expand = expand;
this.extraParams = extraParams;
this.invoiceItems = invoiceItems;
this.issuer = issuer;
this.limit = limit;
this.onBehalfOf = onBehalfOf;
this.previewMode = previewMode;
this.schedule = schedule;
this.scheduleDetails = scheduleDetails;
this.startingAfter = startingAfter;
this.subscription = subscription;
this.subscriptionBillingCycleAnchor = subscriptionBillingCycleAnchor;
this.subscriptionCancelAt = subscriptionCancelAt;
this.subscriptionCancelAtPeriodEnd = subscriptionCancelAtPeriodEnd;
this.subscriptionCancelNow = subscriptionCancelNow;
this.subscriptionDefaultTaxRates = subscriptionDefaultTaxRates;
this.subscriptionDetails = subscriptionDetails;
this.subscriptionItems = subscriptionItems;
this.subscriptionPrebilling = subscriptionPrebilling;
this.subscriptionProrationBehavior = subscriptionProrationBehavior;
this.subscriptionProrationDate = subscriptionProrationDate;
this.subscriptionResumeAt = subscriptionResumeAt;
this.subscriptionStartDate = subscriptionStartDate;
this.subscriptionTrialEnd = subscriptionTrialEnd;
this.subscriptionTrialFromPlan = subscriptionTrialFromPlan;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private AutomaticTax automaticTax;
private String coupon;
private String currency;
private String customer;
private CustomerDetails customerDetails;
private Object discounts;
private String endingBefore;
private List expand;
private Map extraParams;
private List invoiceItems;
private Issuer issuer;
private Long limit;
private Object onBehalfOf;
private PreviewMode previewMode;
private String schedule;
private ScheduleDetails scheduleDetails;
private String startingAfter;
private String subscription;
private Object subscriptionBillingCycleAnchor;
private Object subscriptionCancelAt;
private Boolean subscriptionCancelAtPeriodEnd;
private Boolean subscriptionCancelNow;
private Object subscriptionDefaultTaxRates;
private SubscriptionDetails subscriptionDetails;
private List subscriptionItems;
private SubscriptionPrebilling subscriptionPrebilling;
private SubscriptionProrationBehavior subscriptionProrationBehavior;
private Long subscriptionProrationDate;
private SubscriptionResumeAt subscriptionResumeAt;
private Long subscriptionStartDate;
private Object subscriptionTrialEnd;
private Boolean subscriptionTrialFromPlan;
/** Finalize and obtain parameter instance from this builder. */
public InvoiceUpcomingLinesParams build() {
return new InvoiceUpcomingLinesParams(
this.automaticTax,
this.coupon,
this.currency,
this.customer,
this.customerDetails,
this.discounts,
this.endingBefore,
this.expand,
this.extraParams,
this.invoiceItems,
this.issuer,
this.limit,
this.onBehalfOf,
this.previewMode,
this.schedule,
this.scheduleDetails,
this.startingAfter,
this.subscription,
this.subscriptionBillingCycleAnchor,
this.subscriptionCancelAt,
this.subscriptionCancelAtPeriodEnd,
this.subscriptionCancelNow,
this.subscriptionDefaultTaxRates,
this.subscriptionDetails,
this.subscriptionItems,
this.subscriptionPrebilling,
this.subscriptionProrationBehavior,
this.subscriptionProrationDate,
this.subscriptionResumeAt,
this.subscriptionStartDate,
this.subscriptionTrialEnd,
this.subscriptionTrialFromPlan);
}
/** Settings for automatic tax lookup for this invoice preview. */
public Builder setAutomaticTax(InvoiceUpcomingLinesParams.AutomaticTax automaticTax) {
this.automaticTax = automaticTax;
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;
}
/**
* The currency to preview this invoice in. Defaults to that of {@code customer} if not
* specified.
*/
public Builder setCurrency(String currency) {
this.currency = currency;
return this;
}
/**
* The identifier of the customer whose upcoming invoice you'd like to retrieve. If {@code
* automatic_tax} is enabled then one of {@code customer}, {@code customer_details}, {@code
* subscription}, or {@code schedule} must be set.
*/
public Builder setCustomer(String customer) {
this.customer = customer;
return this;
}
/**
* Details about the customer you want to invoice or overrides for an existing customer. If
* {@code automatic_tax} is enabled then one of {@code customer}, {@code customer_details},
* {@code subscription}, or {@code schedule} must be set.
*/
public Builder setCustomerDetails(InvoiceUpcomingLinesParams.CustomerDetails customerDetails) {
this.customerDetails = customerDetails;
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
* InvoiceUpcomingLinesParams#discounts} for the field documentation.
*/
@SuppressWarnings("unchecked")
public Builder addDiscount(InvoiceUpcomingLinesParams.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
* InvoiceUpcomingLinesParams#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 invoice preview. If not specified, inherits the
* discount from the subscription or customer. This works for both coupons directly applied to
* an invoice and coupons applied to a subscription. 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 invoice preview. If not specified, inherits the
* discount from the subscription or customer. This works for both coupons directly applied to
* an invoice and coupons applied to a subscription. Pass an empty string to avoid inheriting
* any discounts.
*/
public Builder setDiscounts(List discounts) {
this.discounts = discounts;
return this;
}
/**
* A cursor for use in pagination. {@code ending_before} is an object ID that defines your place
* in the list. For instance, if you make a list request and receive 100 objects, starting with
* {@code obj_bar}, your subsequent call can include {@code ending_before=obj_bar} in order to
* fetch the previous page of the list.
*/
public Builder setEndingBefore(String endingBefore) {
this.endingBefore = endingBefore;
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
* InvoiceUpcomingLinesParams#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
* InvoiceUpcomingLinesParams#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
* InvoiceUpcomingLinesParams#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 InvoiceUpcomingLinesParams#extraParams} for the field documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/**
* Add an element to `invoiceItems` list. A list is initialized for the first `add/addAll` call,
* and subsequent calls adds additional elements to the original list. See {@link
* InvoiceUpcomingLinesParams#invoiceItems} for the field documentation.
*/
public Builder addInvoiceItem(InvoiceUpcomingLinesParams.InvoiceItem element) {
if (this.invoiceItems == null) {
this.invoiceItems = new ArrayList<>();
}
this.invoiceItems.add(element);
return this;
}
/**
* Add all elements to `invoiceItems` list. A list is initialized for the first `add/addAll`
* call, and subsequent calls adds additional elements to the original list. See {@link
* InvoiceUpcomingLinesParams#invoiceItems} for the field documentation.
*/
public Builder addAllInvoiceItem(List elements) {
if (this.invoiceItems == null) {
this.invoiceItems = new ArrayList<>();
}
this.invoiceItems.addAll(elements);
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(InvoiceUpcomingLinesParams.Issuer issuer) {
this.issuer = issuer;
return this;
}
/**
* A limit on the number of objects to be returned. Limit can range between 1 and 100, and the
* default is 10.
*/
public Builder setLimit(Long limit) {
this.limit = limit;
return this;
}
/**
* The account (if any) for which the funds of the invoice payment are intended. If set, the
* invoice will be presented with the branding and support information of the specified account.
* See the Invoices with Connect
* documentation for details.
*/
public Builder setOnBehalfOf(String onBehalfOf) {
this.onBehalfOf = onBehalfOf;
return this;
}
/**
* The account (if any) for which the funds of the invoice payment are intended. If set, the
* invoice will be presented with the branding and support information of the specified account.
* See the Invoices with Connect
* documentation for details.
*/
public Builder setOnBehalfOf(EmptyParam onBehalfOf) {
this.onBehalfOf = onBehalfOf;
return this;
}
/**
* Customizes the types of values to include when calculating the invoice. Defaults to {@code
* next} if unspecified.
*/
public Builder setPreviewMode(InvoiceUpcomingLinesParams.PreviewMode previewMode) {
this.previewMode = previewMode;
return this;
}
/**
* The identifier of the schedule whose upcoming invoice you'd like to retrieve. Cannot be used
* with subscription or subscription fields.
*/
public Builder setSchedule(String schedule) {
this.schedule = schedule;
return this;
}
/**
* The schedule creation or modification params to apply as a preview. Cannot be used with
* {@code subscription} or {@code subscription_} prefixed fields.
*/
public Builder setScheduleDetails(InvoiceUpcomingLinesParams.ScheduleDetails scheduleDetails) {
this.scheduleDetails = scheduleDetails;
return this;
}
/**
* A cursor for use in pagination. {@code starting_after} is an object ID that defines your
* place in the list. For instance, if you make a list request and receive 100 objects, ending
* with {@code obj_foo}, your subsequent call can include {@code starting_after=obj_foo} in
* order to fetch the next page of the list.
*/
public Builder setStartingAfter(String startingAfter) {
this.startingAfter = startingAfter;
return this;
}
/**
* The identifier of the subscription for which you'd like to retrieve the upcoming invoice. If
* not provided, but a {@code subscription_details.items} is provided, you will preview creating
* a subscription with those items. If neither {@code subscription} nor {@code
* subscription_details.items} is provided, you will retrieve the next upcoming invoice from
* among the customer's subscriptions.
*/
public Builder setSubscription(String subscription) {
this.subscription = subscription;
return this;
}
/**
* For new subscriptions, a future timestamp to anchor the subscription's billing cycle. This is used to
* determine the date of the first full invoice, and, for plans with {@code month} or {@code
* year} intervals, the day of the month for subsequent invoices. For existing subscriptions,
* the value can only be set to {@code now} or {@code unchanged}. This field has been deprecated
* and will be removed in a future API version. Use {@code
* subscription_details.billing_cycle_anchor} instead.
*/
public Builder setSubscriptionBillingCycleAnchor(
InvoiceUpcomingLinesParams.SubscriptionBillingCycleAnchor subscriptionBillingCycleAnchor) {
this.subscriptionBillingCycleAnchor = subscriptionBillingCycleAnchor;
return this;
}
/**
* For new subscriptions, a future timestamp to anchor the subscription's billing cycle. This is used to
* determine the date of the first full invoice, and, for plans with {@code month} or {@code
* year} intervals, the day of the month for subsequent invoices. For existing subscriptions,
* the value can only be set to {@code now} or {@code unchanged}. This field has been deprecated
* and will be removed in a future API version. Use {@code
* subscription_details.billing_cycle_anchor} instead.
*/
public Builder setSubscriptionBillingCycleAnchor(Long subscriptionBillingCycleAnchor) {
this.subscriptionBillingCycleAnchor = subscriptionBillingCycleAnchor;
return this;
}
/**
* A timestamp at which the subscription should cancel. If set to a date before the current
* period ends, this will cause a proration if prorations have been enabled using {@code
* proration_behavior}. If set during a future period, this will always cause a proration for
* that period. This field has been deprecated and will be removed in a future API version. Use
* {@code subscription_details.cancel_at} instead.
*/
public Builder setSubscriptionCancelAt(Long subscriptionCancelAt) {
this.subscriptionCancelAt = subscriptionCancelAt;
return this;
}
/**
* A timestamp at which the subscription should cancel. If set to a date before the current
* period ends, this will cause a proration if prorations have been enabled using {@code
* proration_behavior}. If set during a future period, this will always cause a proration for
* that period. This field has been deprecated and will be removed in a future API version. Use
* {@code subscription_details.cancel_at} instead.
*/
public Builder setSubscriptionCancelAt(EmptyParam subscriptionCancelAt) {
this.subscriptionCancelAt = subscriptionCancelAt;
return this;
}
/**
* Indicate whether this subscription should cancel at the end of the current period ({@code
* current_period_end}). Defaults to {@code false}. This field has been deprecated and will be
* removed in a future API version. Use {@code subscription_details.cancel_at_period_end}
* instead.
*/
public Builder setSubscriptionCancelAtPeriodEnd(Boolean subscriptionCancelAtPeriodEnd) {
this.subscriptionCancelAtPeriodEnd = subscriptionCancelAtPeriodEnd;
return this;
}
/**
* This simulates the subscription being canceled or expired immediately. This field has been
* deprecated and will be removed in a future API version. Use {@code
* subscription_details.cancel_now} instead.
*/
public Builder setSubscriptionCancelNow(Boolean subscriptionCancelNow) {
this.subscriptionCancelNow = subscriptionCancelNow;
return this;
}
/**
* Add an element to `subscriptionDefaultTaxRates` list. A list is initialized for the first
* `add/addAll` call, and subsequent calls adds additional elements to the original list. See
* {@link InvoiceUpcomingLinesParams#subscriptionDefaultTaxRates} for the field documentation.
*/
@SuppressWarnings("unchecked")
public Builder addSubscriptionDefaultTaxRate(String element) {
if (this.subscriptionDefaultTaxRates == null
|| this.subscriptionDefaultTaxRates instanceof EmptyParam) {
this.subscriptionDefaultTaxRates = new ArrayList();
}
((List) this.subscriptionDefaultTaxRates).add(element);
return this;
}
/**
* Add all elements to `subscriptionDefaultTaxRates` list. A list is initialized for the first
* `add/addAll` call, and subsequent calls adds additional elements to the original list. See
* {@link InvoiceUpcomingLinesParams#subscriptionDefaultTaxRates} for the field documentation.
*/
@SuppressWarnings("unchecked")
public Builder addAllSubscriptionDefaultTaxRate(List elements) {
if (this.subscriptionDefaultTaxRates == null
|| this.subscriptionDefaultTaxRates instanceof EmptyParam) {
this.subscriptionDefaultTaxRates = new ArrayList();
}
((List) this.subscriptionDefaultTaxRates).addAll(elements);
return this;
}
/**
* If provided, the invoice returned will preview updating or creating a subscription with these
* default tax rates. The default tax rates will apply to any line item that does not have
* {@code tax_rates} set. This field has been deprecated and will be removed in a future API
* version. Use {@code subscription_details.default_tax_rates} instead.
*/
public Builder setSubscriptionDefaultTaxRates(EmptyParam subscriptionDefaultTaxRates) {
this.subscriptionDefaultTaxRates = subscriptionDefaultTaxRates;
return this;
}
/**
* If provided, the invoice returned will preview updating or creating a subscription with these
* default tax rates. The default tax rates will apply to any line item that does not have
* {@code tax_rates} set. This field has been deprecated and will be removed in a future API
* version. Use {@code subscription_details.default_tax_rates} instead.
*/
public Builder setSubscriptionDefaultTaxRates(List subscriptionDefaultTaxRates) {
this.subscriptionDefaultTaxRates = subscriptionDefaultTaxRates;
return this;
}
/**
* The subscription creation or modification params to apply as a preview. Cannot be used with
* {@code schedule} or {@code schedule_details} fields.
*/
public Builder setSubscriptionDetails(
InvoiceUpcomingLinesParams.SubscriptionDetails subscriptionDetails) {
this.subscriptionDetails = subscriptionDetails;
return this;
}
/**
* Add an element to `subscriptionItems` list. A list is initialized for the first `add/addAll`
* call, and subsequent calls adds additional elements to the original list. See {@link
* InvoiceUpcomingLinesParams#subscriptionItems} for the field documentation.
*/
public Builder addSubscriptionItem(InvoiceUpcomingLinesParams.SubscriptionItem element) {
if (this.subscriptionItems == null) {
this.subscriptionItems = new ArrayList<>();
}
this.subscriptionItems.add(element);
return this;
}
/**
* Add all elements to `subscriptionItems` list. A list is initialized for the first
* `add/addAll` call, and subsequent calls adds additional elements to the original list. See
* {@link InvoiceUpcomingLinesParams#subscriptionItems} for the field documentation.
*/
public Builder addAllSubscriptionItem(
List elements) {
if (this.subscriptionItems == null) {
this.subscriptionItems = new ArrayList<>();
}
this.subscriptionItems.addAll(elements);
return this;
}
/**
* The pre-billing to apply to the subscription as a preview. This field has been deprecated and
* will be removed in a future API version. Use {@code subscription_details.prebilling} instead.
*/
public Builder setSubscriptionPrebilling(
InvoiceUpcomingLinesParams.SubscriptionPrebilling subscriptionPrebilling) {
this.subscriptionPrebilling = subscriptionPrebilling;
return this;
}
/**
* Determines how to handle prorations when the
* billing cycle changes (e.g., when switching plans, resetting {@code
* billing_cycle_anchor=now}, or starting a trial), or if an item's {@code quantity} changes.
* The default value is {@code create_prorations}. This field has been deprecated and will be
* removed in a future API version. Use {@code subscription_details.proration_behavior} instead.
*/
public Builder setSubscriptionProrationBehavior(
InvoiceUpcomingLinesParams.SubscriptionProrationBehavior subscriptionProrationBehavior) {
this.subscriptionProrationBehavior = subscriptionProrationBehavior;
return this;
}
/**
* If previewing an update to a subscription, and doing proration, {@code
* subscription_proration_date} forces the proration to be calculated as though the update was
* done at the specified time. The time given must be within the current subscription period and
* within the current phase of the schedule backing this subscription, if the schedule exists.
* If set, {@code subscription}, and one of {@code subscription_items}, or {@code
* subscription_trial_end} are required. Also, {@code subscription_proration_behavior} cannot be
* set to 'none'. This field has been deprecated and will be removed in a future API version.
* Use {@code subscription_details.proration_date} instead.
*/
public Builder setSubscriptionProrationDate(Long subscriptionProrationDate) {
this.subscriptionProrationDate = subscriptionProrationDate;
return this;
}
/**
* For paused subscriptions, setting {@code subscription_resume_at} to {@code now} will preview
* the invoice that will be generated if the subscription is resumed. This field has been
* deprecated and will be removed in a future API version. Use {@code
* subscription_details.resume_at} instead.
*/
public Builder setSubscriptionResumeAt(
InvoiceUpcomingLinesParams.SubscriptionResumeAt subscriptionResumeAt) {
this.subscriptionResumeAt = subscriptionResumeAt;
return this;
}
/**
* Date a subscription is intended to start (can be future or past). This field has been
* deprecated and will be removed in a future API version. Use {@code
* subscription_details.start_date} instead.
*/
public Builder setSubscriptionStartDate(Long subscriptionStartDate) {
this.subscriptionStartDate = subscriptionStartDate;
return this;
}
/**
* If provided, the invoice returned will preview updating or creating a subscription with that
* trial end. If set, one of {@code subscription_items} or {@code subscription} is required.
* This field has been deprecated and will be removed in a future API version. Use {@code
* subscription_details.trial_end} instead.
*/
public Builder setSubscriptionTrialEnd(
InvoiceUpcomingLinesParams.SubscriptionTrialEnd subscriptionTrialEnd) {
this.subscriptionTrialEnd = subscriptionTrialEnd;
return this;
}
/**
* If provided, the invoice returned will preview updating or creating a subscription with that
* trial end. If set, one of {@code subscription_items} or {@code subscription} is required.
* This field has been deprecated and will be removed in a future API version. Use {@code
* subscription_details.trial_end} instead.
*/
public Builder setSubscriptionTrialEnd(Long subscriptionTrialEnd) {
this.subscriptionTrialEnd = subscriptionTrialEnd;
return this;
}
/**
* Indicates if a plan's {@code trial_period_days} should be applied to the subscription.
* Setting {@code subscription_trial_end} per subscription is preferred, and this defaults to
* {@code false}. Setting this flag to {@code true} together with {@code subscription_trial_end}
* is not allowed. See Using
* trial periods on subscriptions to learn more.
*/
public Builder setSubscriptionTrialFromPlan(Boolean subscriptionTrialFromPlan) {
this.subscriptionTrialFromPlan = subscriptionTrialFromPlan;
return this;
}
}
@Getter
public static class AutomaticTax {
/**
* Required. Whether Stripe automatically computes tax on this invoice. Note
* that incompatible invoice items (invoice items with manually specified tax rates, negative amounts, or {@code
* tax_behavior=unspecified}) cannot be added to automatic tax invoices.
*/
@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 InvoiceUpcomingLinesParams.AutomaticTax build() {
return new InvoiceUpcomingLinesParams.AutomaticTax(
this.enabled, this.extraParams, this.liability);
}
/**
* Required. Whether Stripe automatically computes tax on this invoice. Note
* that incompatible invoice items (invoice items with manually specified tax rates, negative amounts, or {@code
* tax_behavior=unspecified}) cannot be added to automatic tax invoices.
*/
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
* InvoiceUpcomingLinesParams.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 InvoiceUpcomingLinesParams.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(InvoiceUpcomingLinesParams.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 InvoiceUpcomingLinesParams.AutomaticTax.Liability build() {
return new InvoiceUpcomingLinesParams.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 InvoiceUpcomingLinesParams.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 InvoiceUpcomingLinesParams.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(InvoiceUpcomingLinesParams.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 CustomerDetails {
/** The customer's address. */
@SerializedName("address")
Object address;
/**
* 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 customer's shipping information. Appears on invoices emailed to this customer. */
@SerializedName("shipping")
Object shipping;
/** Tax details about the customer. */
@SerializedName("tax")
Tax tax;
/** The customer's tax exemption. One of {@code none}, {@code exempt}, or {@code reverse}. */
@SerializedName("tax_exempt")
ApiRequestParams.EnumParam taxExempt;
/** The customer's tax IDs. */
@SerializedName("tax_ids")
List taxIds;
private CustomerDetails(
Object address,
Map extraParams,
Object shipping,
Tax tax,
ApiRequestParams.EnumParam taxExempt,
List taxIds) {
this.address = address;
this.extraParams = extraParams;
this.shipping = shipping;
this.tax = tax;
this.taxExempt = taxExempt;
this.taxIds = taxIds;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Object address;
private Map extraParams;
private Object shipping;
private Tax tax;
private ApiRequestParams.EnumParam taxExempt;
private List taxIds;
/** Finalize and obtain parameter instance from this builder. */
public InvoiceUpcomingLinesParams.CustomerDetails build() {
return new InvoiceUpcomingLinesParams.CustomerDetails(
this.address, this.extraParams, this.shipping, this.tax, this.taxExempt, this.taxIds);
}
/** The customer's address. */
public Builder setAddress(InvoiceUpcomingLinesParams.CustomerDetails.Address address) {
this.address = address;
return this;
}
/** The customer's address. */
public Builder setAddress(EmptyParam address) {
this.address = address;
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
* InvoiceUpcomingLinesParams.CustomerDetails#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 InvoiceUpcomingLinesParams.CustomerDetails#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 customer's shipping information. Appears on invoices emailed to this customer. */
public Builder setShipping(InvoiceUpcomingLinesParams.CustomerDetails.Shipping shipping) {
this.shipping = shipping;
return this;
}
/** The customer's shipping information. Appears on invoices emailed to this customer. */
public Builder setShipping(EmptyParam shipping) {
this.shipping = shipping;
return this;
}
/** Tax details about the customer. */
public Builder setTax(InvoiceUpcomingLinesParams.CustomerDetails.Tax tax) {
this.tax = tax;
return this;
}
/** The customer's tax exemption. One of {@code none}, {@code exempt}, or {@code reverse}. */
public Builder setTaxExempt(InvoiceUpcomingLinesParams.CustomerDetails.TaxExempt taxExempt) {
this.taxExempt = taxExempt;
return this;
}
/** The customer's tax exemption. One of {@code none}, {@code exempt}, or {@code reverse}. */
public Builder setTaxExempt(EmptyParam taxExempt) {
this.taxExempt = taxExempt;
return this;
}
/**
* Add an element to `taxIds` list. A list is initialized for the first `add/addAll` call, and
* subsequent calls adds additional elements to the original list. See {@link
* InvoiceUpcomingLinesParams.CustomerDetails#taxIds} for the field documentation.
*/
public Builder addTaxId(InvoiceUpcomingLinesParams.CustomerDetails.TaxId element) {
if (this.taxIds == null) {
this.taxIds = new ArrayList<>();
}
this.taxIds.add(element);
return this;
}
/**
* Add all elements to `taxIds` list. A list is initialized for the first `add/addAll` call,
* and subsequent calls adds additional elements to the original list. See {@link
* InvoiceUpcomingLinesParams.CustomerDetails#taxIds} for the field documentation.
*/
public Builder addAllTaxId(List elements) {
if (this.taxIds == null) {
this.taxIds = new ArrayList<>();
}
this.taxIds.addAll(elements);
return this;
}
}
@Getter
public static class Address {
/** City, district, suburb, town, or village. */
@SerializedName("city")
String city;
/**
* Two-letter country code (ISO
* 3166-1 alpha-2).
*/
@SerializedName("country")
String country;
/**
* 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;
/** Address line 1 (e.g., street, PO Box, or company name). */
@SerializedName("line1")
String line1;
/** Address line 2 (e.g., apartment, suite, unit, or building). */
@SerializedName("line2")
String line2;
/** ZIP or postal code. */
@SerializedName("postal_code")
String postalCode;
/** State, county, province, or region. */
@SerializedName("state")
String state;
private Address(
String city,
String country,
Map extraParams,
String line1,
String line2,
String postalCode,
String state) {
this.city = city;
this.country = country;
this.extraParams = extraParams;
this.line1 = line1;
this.line2 = line2;
this.postalCode = postalCode;
this.state = state;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private String city;
private String country;
private Map extraParams;
private String line1;
private String line2;
private String postalCode;
private String state;
/** Finalize and obtain parameter instance from this builder. */
public InvoiceUpcomingLinesParams.CustomerDetails.Address build() {
return new InvoiceUpcomingLinesParams.CustomerDetails.Address(
this.city,
this.country,
this.extraParams,
this.line1,
this.line2,
this.postalCode,
this.state);
}
/** City, district, suburb, town, or village. */
public Builder setCity(String city) {
this.city = city;
return this;
}
/**
* Two-letter country code (ISO
* 3166-1 alpha-2).
*/
public Builder setCountry(String country) {
this.country = country;
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 InvoiceUpcomingLinesParams.CustomerDetails.Address#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 InvoiceUpcomingLinesParams.CustomerDetails.Address#extraParams} for the
* field documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/** Address line 1 (e.g., street, PO Box, or company name). */
public Builder setLine1(String line1) {
this.line1 = line1;
return this;
}
/** Address line 2 (e.g., apartment, suite, unit, or building). */
public Builder setLine2(String line2) {
this.line2 = line2;
return this;
}
/** ZIP or postal code. */
public Builder setPostalCode(String postalCode) {
this.postalCode = postalCode;
return this;
}
/** State, county, province, or region. */
public Builder setState(String state) {
this.state = state;
return this;
}
}
}
@Getter
public static class Shipping {
/** Required. Customer shipping address. */
@SerializedName("address")
Address address;
/**
* 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. Customer name. */
@SerializedName("name")
String name;
/** Customer phone (including extension). */
@SerializedName("phone")
String phone;
private Shipping(
Address address, Map extraParams, String name, String phone) {
this.address = address;
this.extraParams = extraParams;
this.name = name;
this.phone = phone;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Address address;
private Map extraParams;
private String name;
private String phone;
/** Finalize and obtain parameter instance from this builder. */
public InvoiceUpcomingLinesParams.CustomerDetails.Shipping build() {
return new InvoiceUpcomingLinesParams.CustomerDetails.Shipping(
this.address, this.extraParams, this.name, this.phone);
}
/** Required. Customer shipping address. */
public Builder setAddress(
InvoiceUpcomingLinesParams.CustomerDetails.Shipping.Address address) {
this.address = address;
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 InvoiceUpcomingLinesParams.CustomerDetails.Shipping#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 InvoiceUpcomingLinesParams.CustomerDetails.Shipping#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. Customer name. */
public Builder setName(String name) {
this.name = name;
return this;
}
/** Customer phone (including extension). */
public Builder setPhone(String phone) {
this.phone = phone;
return this;
}
}
@Getter
public static class Address {
/** City, district, suburb, town, or village. */
@SerializedName("city")
String city;
/**
* Two-letter country code (ISO
* 3166-1 alpha-2).
*/
@SerializedName("country")
String country;
/**
* 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;
/** Address line 1 (e.g., street, PO Box, or company name). */
@SerializedName("line1")
String line1;
/** Address line 2 (e.g., apartment, suite, unit, or building). */
@SerializedName("line2")
String line2;
/** ZIP or postal code. */
@SerializedName("postal_code")
String postalCode;
/** State, county, province, or region. */
@SerializedName("state")
String state;
private Address(
String city,
String country,
Map extraParams,
String line1,
String line2,
String postalCode,
String state) {
this.city = city;
this.country = country;
this.extraParams = extraParams;
this.line1 = line1;
this.line2 = line2;
this.postalCode = postalCode;
this.state = state;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private String city;
private String country;
private Map extraParams;
private String line1;
private String line2;
private String postalCode;
private String state;
/** Finalize and obtain parameter instance from this builder. */
public InvoiceUpcomingLinesParams.CustomerDetails.Shipping.Address build() {
return new InvoiceUpcomingLinesParams.CustomerDetails.Shipping.Address(
this.city,
this.country,
this.extraParams,
this.line1,
this.line2,
this.postalCode,
this.state);
}
/** City, district, suburb, town, or village. */
public Builder setCity(String city) {
this.city = city;
return this;
}
/**
* Two-letter country code (ISO
* 3166-1 alpha-2).
*/
public Builder setCountry(String country) {
this.country = country;
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
* InvoiceUpcomingLinesParams.CustomerDetails.Shipping.Address#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
* InvoiceUpcomingLinesParams.CustomerDetails.Shipping.Address#extraParams} for the field
* documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/** Address line 1 (e.g., street, PO Box, or company name). */
public Builder setLine1(String line1) {
this.line1 = line1;
return this;
}
/** Address line 2 (e.g., apartment, suite, unit, or building). */
public Builder setLine2(String line2) {
this.line2 = line2;
return this;
}
/** ZIP or postal code. */
public Builder setPostalCode(String postalCode) {
this.postalCode = postalCode;
return this;
}
/** State, county, province, or region. */
public Builder setState(String state) {
this.state = state;
return this;
}
}
}
}
@Getter
public static class Tax {
/**
* 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;
/**
* A recent IP address of the customer used for tax reporting and tax location inference.
* Stripe recommends updating the IP address when a new PaymentMethod is attached or the
* address field on the customer is updated. We recommend against updating this field more
* frequently since it could result in unexpected tax location/reporting outcomes.
*/
@SerializedName("ip_address")
Object ipAddress;
private Tax(Map extraParams, Object ipAddress) {
this.extraParams = extraParams;
this.ipAddress = ipAddress;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Map extraParams;
private Object ipAddress;
/** Finalize and obtain parameter instance from this builder. */
public InvoiceUpcomingLinesParams.CustomerDetails.Tax build() {
return new InvoiceUpcomingLinesParams.CustomerDetails.Tax(
this.extraParams, this.ipAddress);
}
/**
* 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 InvoiceUpcomingLinesParams.CustomerDetails.Tax#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 InvoiceUpcomingLinesParams.CustomerDetails.Tax#extraParams} for the field
* documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/**
* A recent IP address of the customer used for tax reporting and tax location inference.
* Stripe recommends updating the IP address when a new PaymentMethod is attached or the
* address field on the customer is updated. We recommend against updating this field more
* frequently since it could result in unexpected tax location/reporting outcomes.
*/
public Builder setIpAddress(String ipAddress) {
this.ipAddress = ipAddress;
return this;
}
/**
* A recent IP address of the customer used for tax reporting and tax location inference.
* Stripe recommends updating the IP address when a new PaymentMethod is attached or the
* address field on the customer is updated. We recommend against updating this field more
* frequently since it could result in unexpected tax location/reporting outcomes.
*/
public Builder setIpAddress(EmptyParam ipAddress) {
this.ipAddress = ipAddress;
return this;
}
}
}
@Getter
public static class TaxId {
/**
* 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 tax ID, one of {@code ad_nrt}, {@code ae_trn},
* {@code ar_cuit}, {@code au_abn}, {@code au_arn}, {@code bg_uic}, {@code bh_vat}, {@code
* bo_tin}, {@code br_cnpj}, {@code br_cpf}, {@code ca_bn}, {@code ca_gst_hst}, {@code
* ca_pst_bc}, {@code ca_pst_mb}, {@code ca_pst_sk}, {@code ca_qst}, {@code ch_uid}, {@code
* ch_vat}, {@code cl_tin}, {@code cn_tin}, {@code co_nit}, {@code cr_tin}, {@code de_stn},
* {@code do_rcn}, {@code ec_ruc}, {@code eg_tin}, {@code es_cif}, {@code eu_oss_vat}, {@code
* eu_vat}, {@code gb_vat}, {@code ge_vat}, {@code hk_br}, {@code hr_oib}, {@code hu_tin},
* {@code id_npwp}, {@code il_vat}, {@code in_gst}, {@code is_vat}, {@code jp_cn}, {@code
* jp_rn}, {@code jp_trn}, {@code ke_pin}, {@code kr_brn}, {@code kz_bin}, {@code li_uid},
* {@code mx_rfc}, {@code my_frp}, {@code my_itn}, {@code my_sst}, {@code ng_tin}, {@code
* no_vat}, {@code no_voec}, {@code nz_gst}, {@code om_vat}, {@code pe_ruc}, {@code ph_tin},
* {@code ro_tin}, {@code rs_pib}, {@code ru_inn}, {@code ru_kpp}, {@code sa_vat}, {@code
* sg_gst}, {@code sg_uen}, {@code si_tin}, {@code sv_nit}, {@code th_vat}, {@code tr_tin},
* {@code tw_vat}, {@code ua_vat}, {@code us_ein}, {@code uy_ruc}, {@code ve_rif}, {@code
* vn_tin}, or {@code za_vat}
*/
@SerializedName("type")
Type type;
/** Required. Value of the tax ID. */
@SerializedName("value")
String value;
private TaxId(Map extraParams, Type type, String value) {
this.extraParams = extraParams;
this.type = type;
this.value = value;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Map extraParams;
private Type type;
private String value;
/** Finalize and obtain parameter instance from this builder. */
public InvoiceUpcomingLinesParams.CustomerDetails.TaxId build() {
return new InvoiceUpcomingLinesParams.CustomerDetails.TaxId(
this.extraParams, this.type, this.value);
}
/**
* 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 InvoiceUpcomingLinesParams.CustomerDetails.TaxId#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 InvoiceUpcomingLinesParams.CustomerDetails.TaxId#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 tax ID, one of {@code ad_nrt}, {@code ae_trn},
* {@code ar_cuit}, {@code au_abn}, {@code au_arn}, {@code bg_uic}, {@code bh_vat}, {@code
* bo_tin}, {@code br_cnpj}, {@code br_cpf}, {@code ca_bn}, {@code ca_gst_hst}, {@code
* ca_pst_bc}, {@code ca_pst_mb}, {@code ca_pst_sk}, {@code ca_qst}, {@code ch_uid}, {@code
* ch_vat}, {@code cl_tin}, {@code cn_tin}, {@code co_nit}, {@code cr_tin}, {@code de_stn},
* {@code do_rcn}, {@code ec_ruc}, {@code eg_tin}, {@code es_cif}, {@code eu_oss_vat},
* {@code eu_vat}, {@code gb_vat}, {@code ge_vat}, {@code hk_br}, {@code hr_oib}, {@code
* hu_tin}, {@code id_npwp}, {@code il_vat}, {@code in_gst}, {@code is_vat}, {@code jp_cn},
* {@code jp_rn}, {@code jp_trn}, {@code ke_pin}, {@code kr_brn}, {@code kz_bin}, {@code
* li_uid}, {@code mx_rfc}, {@code my_frp}, {@code my_itn}, {@code my_sst}, {@code ng_tin},
* {@code no_vat}, {@code no_voec}, {@code nz_gst}, {@code om_vat}, {@code pe_ruc}, {@code
* ph_tin}, {@code ro_tin}, {@code rs_pib}, {@code ru_inn}, {@code ru_kpp}, {@code sa_vat},
* {@code sg_gst}, {@code sg_uen}, {@code si_tin}, {@code sv_nit}, {@code th_vat}, {@code
* tr_tin}, {@code tw_vat}, {@code ua_vat}, {@code us_ein}, {@code uy_ruc}, {@code ve_rif},
* {@code vn_tin}, or {@code za_vat}
*/
public Builder setType(InvoiceUpcomingLinesParams.CustomerDetails.TaxId.Type type) {
this.type = type;
return this;
}
/** Required. Value of the tax ID. */
public Builder setValue(String value) {
this.value = value;
return this;
}
}
public enum Type implements ApiRequestParams.EnumParam {
@SerializedName("ad_nrt")
AD_NRT("ad_nrt"),
@SerializedName("ae_trn")
AE_TRN("ae_trn"),
@SerializedName("ar_cuit")
AR_CUIT("ar_cuit"),
@SerializedName("au_abn")
AU_ABN("au_abn"),
@SerializedName("au_arn")
AU_ARN("au_arn"),
@SerializedName("bg_uic")
BG_UIC("bg_uic"),
@SerializedName("bh_vat")
BH_VAT("bh_vat"),
@SerializedName("bo_tin")
BO_TIN("bo_tin"),
@SerializedName("br_cnpj")
BR_CNPJ("br_cnpj"),
@SerializedName("br_cpf")
BR_CPF("br_cpf"),
@SerializedName("ca_bn")
CA_BN("ca_bn"),
@SerializedName("ca_gst_hst")
CA_GST_HST("ca_gst_hst"),
@SerializedName("ca_pst_bc")
CA_PST_BC("ca_pst_bc"),
@SerializedName("ca_pst_mb")
CA_PST_MB("ca_pst_mb"),
@SerializedName("ca_pst_sk")
CA_PST_SK("ca_pst_sk"),
@SerializedName("ca_qst")
CA_QST("ca_qst"),
@SerializedName("ch_uid")
CH_UID("ch_uid"),
@SerializedName("ch_vat")
CH_VAT("ch_vat"),
@SerializedName("cl_tin")
CL_TIN("cl_tin"),
@SerializedName("cn_tin")
CN_TIN("cn_tin"),
@SerializedName("co_nit")
CO_NIT("co_nit"),
@SerializedName("cr_tin")
CR_TIN("cr_tin"),
@SerializedName("de_stn")
DE_STN("de_stn"),
@SerializedName("do_rcn")
DO_RCN("do_rcn"),
@SerializedName("ec_ruc")
EC_RUC("ec_ruc"),
@SerializedName("eg_tin")
EG_TIN("eg_tin"),
@SerializedName("es_cif")
ES_CIF("es_cif"),
@SerializedName("eu_oss_vat")
EU_OSS_VAT("eu_oss_vat"),
@SerializedName("eu_vat")
EU_VAT("eu_vat"),
@SerializedName("gb_vat")
GB_VAT("gb_vat"),
@SerializedName("ge_vat")
GE_VAT("ge_vat"),
@SerializedName("hk_br")
HK_BR("hk_br"),
@SerializedName("hr_oib")
HR_OIB("hr_oib"),
@SerializedName("hu_tin")
HU_TIN("hu_tin"),
@SerializedName("id_npwp")
ID_NPWP("id_npwp"),
@SerializedName("il_vat")
IL_VAT("il_vat"),
@SerializedName("in_gst")
IN_GST("in_gst"),
@SerializedName("is_vat")
IS_VAT("is_vat"),
@SerializedName("jp_cn")
JP_CN("jp_cn"),
@SerializedName("jp_rn")
JP_RN("jp_rn"),
@SerializedName("jp_trn")
JP_TRN("jp_trn"),
@SerializedName("ke_pin")
KE_PIN("ke_pin"),
@SerializedName("kr_brn")
KR_BRN("kr_brn"),
@SerializedName("kz_bin")
KZ_BIN("kz_bin"),
@SerializedName("li_uid")
LI_UID("li_uid"),
@SerializedName("mx_rfc")
MX_RFC("mx_rfc"),
@SerializedName("my_frp")
MY_FRP("my_frp"),
@SerializedName("my_itn")
MY_ITN("my_itn"),
@SerializedName("my_sst")
MY_SST("my_sst"),
@SerializedName("ng_tin")
NG_TIN("ng_tin"),
@SerializedName("no_vat")
NO_VAT("no_vat"),
@SerializedName("no_voec")
NO_VOEC("no_voec"),
@SerializedName("nz_gst")
NZ_GST("nz_gst"),
@SerializedName("om_vat")
OM_VAT("om_vat"),
@SerializedName("pe_ruc")
PE_RUC("pe_ruc"),
@SerializedName("ph_tin")
PH_TIN("ph_tin"),
@SerializedName("ro_tin")
RO_TIN("ro_tin"),
@SerializedName("rs_pib")
RS_PIB("rs_pib"),
@SerializedName("ru_inn")
RU_INN("ru_inn"),
@SerializedName("ru_kpp")
RU_KPP("ru_kpp"),
@SerializedName("sa_vat")
SA_VAT("sa_vat"),
@SerializedName("sg_gst")
SG_GST("sg_gst"),
@SerializedName("sg_uen")
SG_UEN("sg_uen"),
@SerializedName("si_tin")
SI_TIN("si_tin"),
@SerializedName("sv_nit")
SV_NIT("sv_nit"),
@SerializedName("th_vat")
TH_VAT("th_vat"),
@SerializedName("tr_tin")
TR_TIN("tr_tin"),
@SerializedName("tw_vat")
TW_VAT("tw_vat"),
@SerializedName("ua_vat")
UA_VAT("ua_vat"),
@SerializedName("us_ein")
US_EIN("us_ein"),
@SerializedName("uy_ruc")
UY_RUC("uy_ruc"),
@SerializedName("ve_rif")
VE_RIF("ve_rif"),
@SerializedName("vn_tin")
VN_TIN("vn_tin"),
@SerializedName("za_vat")
ZA_VAT("za_vat");
@Getter(onMethod_ = {@Override})
private final String value;
Type(String value) {
this.value = value;
}
}
}
public enum TaxExempt implements ApiRequestParams.EnumParam {
@SerializedName("exempt")
EXEMPT("exempt"),
@SerializedName("none")
NONE("none"),
@SerializedName("reverse")
REVERSE("reverse");
@Getter(onMethod_ = {@Override})
private final String value;
TaxExempt(String value) {
this.value = value;
}
}
}
@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;
/** Details to determine how long the discount should be applied for. */
@SerializedName("discount_end")
DiscountEnd discountEnd;
/**
* 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,
DiscountEnd discountEnd,
Map extraParams,
String promotionCode) {
this.coupon = coupon;
this.discount = discount;
this.discountEnd = discountEnd;
this.extraParams = extraParams;
this.promotionCode = promotionCode;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private String coupon;
private String discount;
private DiscountEnd discountEnd;
private Map extraParams;
private String promotionCode;
/** Finalize and obtain parameter instance from this builder. */
public InvoiceUpcomingLinesParams.Discount build() {
return new InvoiceUpcomingLinesParams.Discount(
this.coupon, this.discount, this.discountEnd, 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;
}
/** Details to determine how long the discount should be applied for. */
public Builder setDiscountEnd(InvoiceUpcomingLinesParams.Discount.DiscountEnd discountEnd) {
this.discountEnd = discountEnd;
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
* InvoiceUpcomingLinesParams.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 InvoiceUpcomingLinesParams.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 DiscountEnd {
/** Time span for the redeemed discount. */
@SerializedName("duration")
Duration duration;
/**
* 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;
/** A precise Unix timestamp for the discount to end. Must be in the future. */
@SerializedName("timestamp")
Long timestamp;
/**
* Required. The type of calculation made to determine when the discount
* ends.
*/
@SerializedName("type")
Type type;
private DiscountEnd(
Duration duration, Map extraParams, Long timestamp, Type type) {
this.duration = duration;
this.extraParams = extraParams;
this.timestamp = timestamp;
this.type = type;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Duration duration;
private Map extraParams;
private Long timestamp;
private Type type;
/** Finalize and obtain parameter instance from this builder. */
public InvoiceUpcomingLinesParams.Discount.DiscountEnd build() {
return new InvoiceUpcomingLinesParams.Discount.DiscountEnd(
this.duration, this.extraParams, this.timestamp, this.type);
}
/** Time span for the redeemed discount. */
public Builder setDuration(
InvoiceUpcomingLinesParams.Discount.DiscountEnd.Duration duration) {
this.duration = duration;
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 InvoiceUpcomingLinesParams.Discount.DiscountEnd#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 InvoiceUpcomingLinesParams.Discount.DiscountEnd#extraParams} for the
* field documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/** A precise Unix timestamp for the discount to end. Must be in the future. */
public Builder setTimestamp(Long timestamp) {
this.timestamp = timestamp;
return this;
}
/**
* Required. The type of calculation made to determine when the discount
* ends.
*/
public Builder setType(InvoiceUpcomingLinesParams.Discount.DiscountEnd.Type type) {
this.type = type;
return this;
}
}
@Getter
public static class Duration {
/**
* 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 a type of interval unit. Either {@code day}, {@code
* week}, {@code month} or {@code year}.
*/
@SerializedName("interval")
Interval interval;
/**
* Required. The number of intervals, as an whole number greater than 0.
* Stripe multiplies this by the interval type to get the overall duration.
*/
@SerializedName("interval_count")
Long intervalCount;
private Duration(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 InvoiceUpcomingLinesParams.Discount.DiscountEnd.Duration build() {
return new InvoiceUpcomingLinesParams.Discount.DiscountEnd.Duration(
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 InvoiceUpcomingLinesParams.Discount.DiscountEnd.Duration#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 InvoiceUpcomingLinesParams.Discount.DiscountEnd.Duration#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 a type of interval unit. Either {@code day},
* {@code week}, {@code month} or {@code year}.
*/
public Builder setInterval(
InvoiceUpcomingLinesParams.Discount.DiscountEnd.Duration.Interval interval) {
this.interval = interval;
return this;
}
/**
* Required. The number of intervals, as an whole number greater than 0.
* Stripe multiplies this by the interval type to get the overall duration.
*/
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 Type implements ApiRequestParams.EnumParam {
@SerializedName("duration")
DURATION("duration"),
@SerializedName("timestamp")
TIMESTAMP("timestamp");
@Getter(onMethod_ = {@Override})
private final String value;
Type(String value) {
this.value = value;
}
}
}
}
@Getter
public static class InvoiceItem {
/** The integer amount in cents (or local equivalent) of previewed invoice item. */
@SerializedName("amount")
Long amount;
/**
* Three-letter ISO currency
* code, in lowercase. Must be a supported
* currency. Only applicable to new invoice items.
*/
@SerializedName("currency")
String currency;
/**
* An arbitrary string which you can attach to the invoice item. The description is displayed in
* the invoice for easy tracking.
*/
@SerializedName("description")
String description;
/**
* Explicitly controls whether discounts apply to this invoice item. Defaults to true, except
* for negative invoice items.
*/
@SerializedName("discountable")
Boolean discountable;
/** The coupons to redeem into discounts for the invoice item in the preview. */
@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;
/**
* The ID of the invoice item to update in preview. If not specified, a new invoice item will be
* added to the preview of the upcoming invoice.
*/
@SerializedName("invoiceitem")
String invoiceitem;
/**
* 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;
/**
* The period associated with this invoice item. When set to different values, the period will
* be rendered on the invoice. If you have Stripe Revenue Recognition enabled,
* the period will be used to recognize and defer revenue. See the Revenue
* Recognition documentation for details.
*/
@SerializedName("period")
Period period;
/** 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;
/** Non-negative integer. The quantity of units for the invoice item. */
@SerializedName("quantity")
Long quantity;
/**
* 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 tax code ID. */
@SerializedName("tax_code")
Object taxCode;
/**
* The tax rates that apply to the item. When set, any {@code default_tax_rates} do not apply to
* this item.
*/
@SerializedName("tax_rates")
Object taxRates;
/**
* The integer unit amount in cents (or local equivalent) of the charge to be applied to the
* upcoming invoice. This unit_amount will be multiplied by the quantity to get the full amount.
* If you want to apply a credit to the customer's account, pass a negative unit_amount.
*/
@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 InvoiceItem(
Long amount,
String currency,
String description,
Boolean discountable,
Object discounts,
Map extraParams,
String invoiceitem,
Object metadata,
Period period,
String price,
PriceData priceData,
Long quantity,
TaxBehavior taxBehavior,
Object taxCode,
Object taxRates,
Long unitAmount,
BigDecimal unitAmountDecimal) {
this.amount = amount;
this.currency = currency;
this.description = description;
this.discountable = discountable;
this.discounts = discounts;
this.extraParams = extraParams;
this.invoiceitem = invoiceitem;
this.metadata = metadata;
this.period = period;
this.price = price;
this.priceData = priceData;
this.quantity = quantity;
this.taxBehavior = taxBehavior;
this.taxCode = taxCode;
this.taxRates = taxRates;
this.unitAmount = unitAmount;
this.unitAmountDecimal = unitAmountDecimal;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Long amount;
private String currency;
private String description;
private Boolean discountable;
private Object discounts;
private Map extraParams;
private String invoiceitem;
private Object metadata;
private Period period;
private String price;
private PriceData priceData;
private Long quantity;
private TaxBehavior taxBehavior;
private Object taxCode;
private Object taxRates;
private Long unitAmount;
private BigDecimal unitAmountDecimal;
/** Finalize and obtain parameter instance from this builder. */
public InvoiceUpcomingLinesParams.InvoiceItem build() {
return new InvoiceUpcomingLinesParams.InvoiceItem(
this.amount,
this.currency,
this.description,
this.discountable,
this.discounts,
this.extraParams,
this.invoiceitem,
this.metadata,
this.period,
this.price,
this.priceData,
this.quantity,
this.taxBehavior,
this.taxCode,
this.taxRates,
this.unitAmount,
this.unitAmountDecimal);
}
/** The integer amount in cents (or local equivalent) of previewed invoice item. */
public Builder setAmount(Long amount) {
this.amount = amount;
return this;
}
/**
* Three-letter ISO currency
* code, in lowercase. Must be a supported
* currency. Only applicable to new invoice items.
*/
public Builder setCurrency(String currency) {
this.currency = currency;
return this;
}
/**
* An arbitrary string which you can attach to the invoice item. The description is displayed
* in the invoice for easy tracking.
*/
public Builder setDescription(String description) {
this.description = description;
return this;
}
/**
* Explicitly controls whether discounts apply to this invoice item. Defaults to true, except
* for negative invoice items.
*/
public Builder setDiscountable(Boolean discountable) {
this.discountable = discountable;
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
* InvoiceUpcomingLinesParams.InvoiceItem#discounts} for the field documentation.
*/
@SuppressWarnings("unchecked")
public Builder addDiscount(InvoiceUpcomingLinesParams.InvoiceItem.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
* InvoiceUpcomingLinesParams.InvoiceItem#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 invoice item in the preview. */
public Builder setDiscounts(EmptyParam discounts) {
this.discounts = discounts;
return this;
}
/** The coupons to redeem into discounts for the invoice item in the preview. */
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
* InvoiceUpcomingLinesParams.InvoiceItem#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 InvoiceUpcomingLinesParams.InvoiceItem#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 invoice item to update in preview. If not specified, a new invoice item will
* be added to the preview of the upcoming invoice.
*/
public Builder setInvoiceitem(String invoiceitem) {
this.invoiceitem = invoiceitem;
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
* InvoiceUpcomingLinesParams.InvoiceItem#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 InvoiceUpcomingLinesParams.InvoiceItem#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;
}
/**
* The period associated with this invoice item. When set to different values, the period will
* be rendered on the invoice. If you have Stripe Revenue Recognition enabled,
* the period will be used to recognize and defer revenue. See the Revenue
* Recognition documentation for details.
*/
public Builder setPeriod(InvoiceUpcomingLinesParams.InvoiceItem.Period period) {
this.period = period;
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(InvoiceUpcomingLinesParams.InvoiceItem.PriceData priceData) {
this.priceData = priceData;
return this;
}
/** Non-negative integer. The quantity of units for the invoice item. */
public Builder setQuantity(Long quantity) {
this.quantity = quantity;
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(
InvoiceUpcomingLinesParams.InvoiceItem.TaxBehavior taxBehavior) {
this.taxBehavior = taxBehavior;
return this;
}
/** A tax code ID. */
public Builder setTaxCode(String taxCode) {
this.taxCode = taxCode;
return this;
}
/** A tax code ID. */
public Builder setTaxCode(EmptyParam taxCode) {
this.taxCode = taxCode;
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
* InvoiceUpcomingLinesParams.InvoiceItem#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
* InvoiceUpcomingLinesParams.InvoiceItem#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 that apply to the item. When set, any {@code default_tax_rates} do not apply
* to this item.
*/
public Builder setTaxRates(EmptyParam taxRates) {
this.taxRates = taxRates;
return this;
}
/**
* The tax rates that apply to the item. When set, any {@code default_tax_rates} do not apply
* to this item.
*/
public Builder setTaxRates(List taxRates) {
this.taxRates = taxRates;
return this;
}
/**
* The integer unit amount in cents (or local equivalent) of the charge to be applied to the
* upcoming invoice. This unit_amount will be multiplied by the quantity to get the full
* amount. If you want to apply a credit to the customer's account, pass a negative
* unit_amount.
*/
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 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;
/** Details to determine how long the discount should be applied for. */
@SerializedName("discount_end")
DiscountEnd discountEnd;
/**
* 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,
DiscountEnd discountEnd,
Map extraParams,
String promotionCode) {
this.coupon = coupon;
this.discount = discount;
this.discountEnd = discountEnd;
this.extraParams = extraParams;
this.promotionCode = promotionCode;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private String coupon;
private String discount;
private DiscountEnd discountEnd;
private Map extraParams;
private String promotionCode;
/** Finalize and obtain parameter instance from this builder. */
public InvoiceUpcomingLinesParams.InvoiceItem.Discount build() {
return new InvoiceUpcomingLinesParams.InvoiceItem.Discount(
this.coupon, this.discount, this.discountEnd, 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;
}
/** Details to determine how long the discount should be applied for. */
public Builder setDiscountEnd(
InvoiceUpcomingLinesParams.InvoiceItem.Discount.DiscountEnd discountEnd) {
this.discountEnd = discountEnd;
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 InvoiceUpcomingLinesParams.InvoiceItem.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 InvoiceUpcomingLinesParams.InvoiceItem.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 DiscountEnd {
/** Time span for the redeemed discount. */
@SerializedName("duration")
Duration duration;
/**
* 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;
/** A precise Unix timestamp for the discount to end. Must be in the future. */
@SerializedName("timestamp")
Long timestamp;
/**
* Required. The type of calculation made to determine when the discount
* ends.
*/
@SerializedName("type")
Type type;
private DiscountEnd(
Duration duration, Map extraParams, Long timestamp, Type type) {
this.duration = duration;
this.extraParams = extraParams;
this.timestamp = timestamp;
this.type = type;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Duration duration;
private Map extraParams;
private Long timestamp;
private Type type;
/** Finalize and obtain parameter instance from this builder. */
public InvoiceUpcomingLinesParams.InvoiceItem.Discount.DiscountEnd build() {
return new InvoiceUpcomingLinesParams.InvoiceItem.Discount.DiscountEnd(
this.duration, this.extraParams, this.timestamp, this.type);
}
/** Time span for the redeemed discount. */
public Builder setDuration(
InvoiceUpcomingLinesParams.InvoiceItem.Discount.DiscountEnd.Duration duration) {
this.duration = duration;
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
* InvoiceUpcomingLinesParams.InvoiceItem.Discount.DiscountEnd#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
* InvoiceUpcomingLinesParams.InvoiceItem.Discount.DiscountEnd#extraParams} for the field
* documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/** A precise Unix timestamp for the discount to end. Must be in the future. */
public Builder setTimestamp(Long timestamp) {
this.timestamp = timestamp;
return this;
}
/**
* Required. The type of calculation made to determine when the discount
* ends.
*/
public Builder setType(
InvoiceUpcomingLinesParams.InvoiceItem.Discount.DiscountEnd.Type type) {
this.type = type;
return this;
}
}
@Getter
public static class Duration {
/**
* 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 a type of interval unit. Either {@code day},
* {@code week}, {@code month} or {@code year}.
*/
@SerializedName("interval")
Interval interval;
/**
* Required. The number of intervals, as an whole number greater than 0.
* Stripe multiplies this by the interval type to get the overall duration.
*/
@SerializedName("interval_count")
Long intervalCount;
private Duration(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 InvoiceUpcomingLinesParams.InvoiceItem.Discount.DiscountEnd.Duration build() {
return new InvoiceUpcomingLinesParams.InvoiceItem.Discount.DiscountEnd.Duration(
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
* InvoiceUpcomingLinesParams.InvoiceItem.Discount.DiscountEnd.Duration#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
* InvoiceUpcomingLinesParams.InvoiceItem.Discount.DiscountEnd.Duration#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 a type of interval unit. Either {@code day},
* {@code week}, {@code month} or {@code year}.
*/
public Builder setInterval(
InvoiceUpcomingLinesParams.InvoiceItem.Discount.DiscountEnd.Duration.Interval
interval) {
this.interval = interval;
return this;
}
/**
* Required. The number of intervals, as an whole number greater than
* 0. Stripe multiplies this by the interval type to get the overall duration.
*/
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 Type implements ApiRequestParams.EnumParam {
@SerializedName("duration")
DURATION("duration"),
@SerializedName("timestamp")
TIMESTAMP("timestamp");
@Getter(onMethod_ = {@Override})
private final String value;
Type(String value) {
this.value = value;
}
}
}
}
@Getter
public static class Period {
/**
* Required. The end of the period, which must be greater than or equal to
* the start. This value is inclusive.
*/
@SerializedName("end")
Long end;
/**
* 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 start of the period. This value is inclusive. */
@SerializedName("start")
Long start;
private Period(Long end, Map extraParams, Long start) {
this.end = end;
this.extraParams = extraParams;
this.start = start;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Long end;
private Map extraParams;
private Long start;
/** Finalize and obtain parameter instance from this builder. */
public InvoiceUpcomingLinesParams.InvoiceItem.Period build() {
return new InvoiceUpcomingLinesParams.InvoiceItem.Period(
this.end, this.extraParams, this.start);
}
/**
* Required. The end of the period, which must be greater than or equal to
* the start. This value is inclusive.
*/
public Builder setEnd(Long end) {
this.end = end;
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 InvoiceUpcomingLinesParams.InvoiceItem.Period#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 InvoiceUpcomingLinesParams.InvoiceItem.Period#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 start of the period. This value is inclusive. */
public Builder setStart(Long start) {
this.start = start;
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.
*/
@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 InvoiceUpcomingLinesParams.InvoiceItem.PriceData build() {
return new InvoiceUpcomingLinesParams.InvoiceItem.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 InvoiceUpcomingLinesParams.InvoiceItem.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 InvoiceUpcomingLinesParams.InvoiceItem.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(
InvoiceUpcomingLinesParams.InvoiceItem.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;
}
}
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;
}
}
}
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 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 InvoiceUpcomingLinesParams.Issuer build() {
return new InvoiceUpcomingLinesParams.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
* InvoiceUpcomingLinesParams.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 InvoiceUpcomingLinesParams.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(InvoiceUpcomingLinesParams.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 ScheduleDetails {
/** Changes to apply to the phases of the subscription schedule, in the order provided. */
@SerializedName("amendments")
List amendments;
/**
* Configures when the subscription schedule generates prorations for phase transitions.
* Possible values are {@code prorate_on_next_phase} or {@code prorate_up_front} with the
* default being {@code prorate_on_next_phase}. {@code prorate_on_next_phase} will apply phase
* changes and generate prorations at transition time. {@code prorate_up_front} will bill for
* all phases within the current billing cycle up front.
*/
@SerializedName("billing_behavior")
BillingBehavior billingBehavior;
/**
* 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;
/**
* 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;
/**
* 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;
/** Provide any time periods to bill in advance. */
@SerializedName("prebilling")
Object prebilling;
/**
* In cases where the {@code schedule_details} params update the currently active phase,
* specifies if and how to prorate at the time of the request.
*/
@SerializedName("proration_behavior")
ProrationBehavior prorationBehavior;
private ScheduleDetails(
List amendments,
BillingBehavior billingBehavior,
EndBehavior endBehavior,
Map extraParams,
List phases,
Object prebilling,
ProrationBehavior prorationBehavior) {
this.amendments = amendments;
this.billingBehavior = billingBehavior;
this.endBehavior = endBehavior;
this.extraParams = extraParams;
this.phases = phases;
this.prebilling = prebilling;
this.prorationBehavior = prorationBehavior;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private List amendments;
private BillingBehavior billingBehavior;
private EndBehavior endBehavior;
private Map extraParams;
private List phases;
private Object prebilling;
private ProrationBehavior prorationBehavior;
/** Finalize and obtain parameter instance from this builder. */
public InvoiceUpcomingLinesParams.ScheduleDetails build() {
return new InvoiceUpcomingLinesParams.ScheduleDetails(
this.amendments,
this.billingBehavior,
this.endBehavior,
this.extraParams,
this.phases,
this.prebilling,
this.prorationBehavior);
}
/**
* Add an element to `amendments` list. A list is initialized for the first `add/addAll` call,
* and subsequent calls adds additional elements to the original list. See {@link
* InvoiceUpcomingLinesParams.ScheduleDetails#amendments} for the field documentation.
*/
public Builder addAmendment(InvoiceUpcomingLinesParams.ScheduleDetails.Amendment element) {
if (this.amendments == null) {
this.amendments = new ArrayList<>();
}
this.amendments.add(element);
return this;
}
/**
* Add all elements to `amendments` list. A list is initialized for the first `add/addAll`
* call, and subsequent calls adds additional elements to the original list. See {@link
* InvoiceUpcomingLinesParams.ScheduleDetails#amendments} for the field documentation.
*/
public Builder addAllAmendment(
List elements) {
if (this.amendments == null) {
this.amendments = new ArrayList<>();
}
this.amendments.addAll(elements);
return this;
}
/**
* Configures when the subscription schedule generates prorations for phase transitions.
* Possible values are {@code prorate_on_next_phase} or {@code prorate_up_front} with the
* default being {@code prorate_on_next_phase}. {@code prorate_on_next_phase} will apply phase
* changes and generate prorations at transition time. {@code prorate_up_front} will bill for
* all phases within the current billing cycle up front.
*/
public Builder setBillingBehavior(
InvoiceUpcomingLinesParams.ScheduleDetails.BillingBehavior billingBehavior) {
this.billingBehavior = billingBehavior;
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(
InvoiceUpcomingLinesParams.ScheduleDetails.EndBehavior endBehavior) {
this.endBehavior = endBehavior;
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
* InvoiceUpcomingLinesParams.ScheduleDetails#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 InvoiceUpcomingLinesParams.ScheduleDetails#extraParams} for the field
* documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/**
* Add an element to `phases` list. A list is initialized for the first `add/addAll` call, and
* subsequent calls adds additional elements to the original list. See {@link
* InvoiceUpcomingLinesParams.ScheduleDetails#phases} for the field documentation.
*/
public Builder addPhase(InvoiceUpcomingLinesParams.ScheduleDetails.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
* InvoiceUpcomingLinesParams.ScheduleDetails#phases} for the field documentation.
*/
public Builder addAllPhase(List elements) {
if (this.phases == null) {
this.phases = new ArrayList<>();
}
this.phases.addAll(elements);
return this;
}
/**
* Add an element to `prebilling` list. A list is initialized for the first `add/addAll` call,
* and subsequent calls adds additional elements to the original list. See {@link
* InvoiceUpcomingLinesParams.ScheduleDetails#prebilling} for the field documentation.
*/
@SuppressWarnings("unchecked")
public Builder addPrebilling(InvoiceUpcomingLinesParams.ScheduleDetails.Prebilling element) {
if (this.prebilling == null || this.prebilling instanceof EmptyParam) {
this.prebilling = new ArrayList();
}
((List) this.prebilling)
.add(element);
return this;
}
/**
* Add all elements to `prebilling` list. A list is initialized for the first `add/addAll`
* call, and subsequent calls adds additional elements to the original list. See {@link
* InvoiceUpcomingLinesParams.ScheduleDetails#prebilling} for the field documentation.
*/
@SuppressWarnings("unchecked")
public Builder addAllPrebilling(
List elements) {
if (this.prebilling == null || this.prebilling instanceof EmptyParam) {
this.prebilling = new ArrayList();
}
((List) this.prebilling)
.addAll(elements);
return this;
}
/** Provide any time periods to bill in advance. */
public Builder setPrebilling(EmptyParam prebilling) {
this.prebilling = prebilling;
return this;
}
/** Provide any time periods to bill in advance. */
public Builder setPrebilling(
List prebilling) {
this.prebilling = prebilling;
return this;
}
/**
* In cases where the {@code schedule_details} params update the currently active phase,
* specifies if and how to prorate at the time of the request.
*/
public Builder setProrationBehavior(
InvoiceUpcomingLinesParams.ScheduleDetails.ProrationBehavior prorationBehavior) {
this.prorationBehavior = prorationBehavior;
return this;
}
}
@Getter
public static class Amendment {
/**
* Details to identify the end of the time range modified by the proposed change. If not
* supplied, the amendment is considered a point-in-time operation that only affects the exact
* timestamp at {@code amendment_start}, and a restricted set of attributes is supported on
* the amendment.
*/
@SerializedName("amendment_end")
AmendmentEnd amendmentEnd;
/**
* Required. Details to identify the earliest timestamp where the proposed
* change should take effect.
*/
@SerializedName("amendment_start")
AmendmentStart amendmentStart;
/**
* For point-in-time amendments (having no {@code amendment_end}), this attribute lets you set
* or remove whether the subscription's billing cycle anchor is reset at the {@code
* amendment_start} timestamp.For time-span based amendments (having both {@code
* amendment_start} and {@code amendment_end}), the only value valid is {@code automatic},
* which removes any previously configured billing cycle anchor resets scheduled to occur
* during the window of time spanned by the amendment.
*/
@SerializedName("billing_cycle_anchor")
BillingCycleAnchor billingCycleAnchor;
/**
* Changes to the coupons being redeemed or discounts being applied during the amendment time
* span.
*/
@SerializedName("discount_actions")
List discountActions;
/**
* 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;
/** Changes to the subscription items during the amendment time span. */
@SerializedName("item_actions")
List itemActions;
/** Instructions for how to modify phase metadata. */
@SerializedName("metadata_actions")
List metadataActions;
/**
* Changes to how Stripe handles prorations during the amendment time span. Affects if and how
* prorations are created when a future phase starts. In cases where the amendment changes the
* currently active phase, it is used to determine whether or how to prorate now, at the time
* of the request. Also supported as a point-in-time operation when {@code amendment_end} is
* {@code null}.
*/
@SerializedName("proration_behavior")
ProrationBehavior prorationBehavior;
/**
* Defines how to pause collection for the underlying subscription throughout the duration of
* the amendment.
*/
@SerializedName("set_pause_collection")
SetPauseCollection setPauseCollection;
/**
* Ends the subscription schedule early as dictated by either the accompanying amendment's
* start or end.
*/
@SerializedName("set_schedule_end")
SetScheduleEnd setScheduleEnd;
/** Settings related to subscription trials. */
@SerializedName("trial_settings")
TrialSettings trialSettings;
private Amendment(
AmendmentEnd amendmentEnd,
AmendmentStart amendmentStart,
BillingCycleAnchor billingCycleAnchor,
List discountActions,
Map extraParams,
List itemActions,
List metadataActions,
ProrationBehavior prorationBehavior,
SetPauseCollection setPauseCollection,
SetScheduleEnd setScheduleEnd,
TrialSettings trialSettings) {
this.amendmentEnd = amendmentEnd;
this.amendmentStart = amendmentStart;
this.billingCycleAnchor = billingCycleAnchor;
this.discountActions = discountActions;
this.extraParams = extraParams;
this.itemActions = itemActions;
this.metadataActions = metadataActions;
this.prorationBehavior = prorationBehavior;
this.setPauseCollection = setPauseCollection;
this.setScheduleEnd = setScheduleEnd;
this.trialSettings = trialSettings;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private AmendmentEnd amendmentEnd;
private AmendmentStart amendmentStart;
private BillingCycleAnchor billingCycleAnchor;
private List
discountActions;
private Map extraParams;
private List itemActions;
private List
metadataActions;
private ProrationBehavior prorationBehavior;
private SetPauseCollection setPauseCollection;
private SetScheduleEnd setScheduleEnd;
private TrialSettings trialSettings;
/** Finalize and obtain parameter instance from this builder. */
public InvoiceUpcomingLinesParams.ScheduleDetails.Amendment build() {
return new InvoiceUpcomingLinesParams.ScheduleDetails.Amendment(
this.amendmentEnd,
this.amendmentStart,
this.billingCycleAnchor,
this.discountActions,
this.extraParams,
this.itemActions,
this.metadataActions,
this.prorationBehavior,
this.setPauseCollection,
this.setScheduleEnd,
this.trialSettings);
}
/**
* Details to identify the end of the time range modified by the proposed change. If not
* supplied, the amendment is considered a point-in-time operation that only affects the
* exact timestamp at {@code amendment_start}, and a restricted set of attributes is
* supported on the amendment.
*/
public Builder setAmendmentEnd(
InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.AmendmentEnd amendmentEnd) {
this.amendmentEnd = amendmentEnd;
return this;
}
/**
* Required. Details to identify the earliest timestamp where the proposed
* change should take effect.
*/
public Builder setAmendmentStart(
InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.AmendmentStart amendmentStart) {
this.amendmentStart = amendmentStart;
return this;
}
/**
* For point-in-time amendments (having no {@code amendment_end}), this attribute lets you
* set or remove whether the subscription's billing cycle anchor is reset at the {@code
* amendment_start} timestamp.For time-span based amendments (having both {@code
* amendment_start} and {@code amendment_end}), the only value valid is {@code automatic},
* which removes any previously configured billing cycle anchor resets scheduled to occur
* during the window of time spanned by the amendment.
*/
public Builder setBillingCycleAnchor(
InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.BillingCycleAnchor
billingCycleAnchor) {
this.billingCycleAnchor = billingCycleAnchor;
return this;
}
/**
* Add an element to `discountActions` list. A list is initialized for the first
* `add/addAll` call, and subsequent calls adds additional elements to the original list.
* See {@link InvoiceUpcomingLinesParams.ScheduleDetails.Amendment#discountActions} for the
* field documentation.
*/
public Builder addDiscountAction(
InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.DiscountAction element) {
if (this.discountActions == null) {
this.discountActions = new ArrayList<>();
}
this.discountActions.add(element);
return this;
}
/**
* Add all elements to `discountActions` list. A list is initialized for the first
* `add/addAll` call, and subsequent calls adds additional elements to the original list.
* See {@link InvoiceUpcomingLinesParams.ScheduleDetails.Amendment#discountActions} for the
* field documentation.
*/
public Builder addAllDiscountAction(
List elements) {
if (this.discountActions == null) {
this.discountActions = new ArrayList<>();
}
this.discountActions.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 InvoiceUpcomingLinesParams.ScheduleDetails.Amendment#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 InvoiceUpcomingLinesParams.ScheduleDetails.Amendment#extraParams} for the
* field documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/**
* Add an element to `itemActions` list. A list is initialized for the first `add/addAll`
* call, and subsequent calls adds additional elements to the original list. See {@link
* InvoiceUpcomingLinesParams.ScheduleDetails.Amendment#itemActions} for the field
* documentation.
*/
public Builder addItemAction(
InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.ItemAction element) {
if (this.itemActions == null) {
this.itemActions = new ArrayList<>();
}
this.itemActions.add(element);
return this;
}
/**
* Add all elements to `itemActions` list. A list is initialized for the first `add/addAll`
* call, and subsequent calls adds additional elements to the original list. See {@link
* InvoiceUpcomingLinesParams.ScheduleDetails.Amendment#itemActions} for the field
* documentation.
*/
public Builder addAllItemAction(
List elements) {
if (this.itemActions == null) {
this.itemActions = new ArrayList<>();
}
this.itemActions.addAll(elements);
return this;
}
/**
* Add an element to `metadataActions` list. A list is initialized for the first
* `add/addAll` call, and subsequent calls adds additional elements to the original list.
* See {@link InvoiceUpcomingLinesParams.ScheduleDetails.Amendment#metadataActions} for the
* field documentation.
*/
public Builder addMetadataAction(
InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.MetadataAction element) {
if (this.metadataActions == null) {
this.metadataActions = new ArrayList<>();
}
this.metadataActions.add(element);
return this;
}
/**
* Add all elements to `metadataActions` list. A list is initialized for the first
* `add/addAll` call, and subsequent calls adds additional elements to the original list.
* See {@link InvoiceUpcomingLinesParams.ScheduleDetails.Amendment#metadataActions} for the
* field documentation.
*/
public Builder addAllMetadataAction(
List elements) {
if (this.metadataActions == null) {
this.metadataActions = new ArrayList<>();
}
this.metadataActions.addAll(elements);
return this;
}
/**
* Changes to how Stripe handles prorations during the amendment time span. Affects if and
* how prorations are created when a future phase starts. In cases where the amendment
* changes the currently active phase, it is used to determine whether or how to prorate
* now, at the time of the request. Also supported as a point-in-time operation when {@code
* amendment_end} is {@code null}.
*/
public Builder setProrationBehavior(
InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.ProrationBehavior
prorationBehavior) {
this.prorationBehavior = prorationBehavior;
return this;
}
/**
* Defines how to pause collection for the underlying subscription throughout the duration
* of the amendment.
*/
public Builder setSetPauseCollection(
InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.SetPauseCollection
setPauseCollection) {
this.setPauseCollection = setPauseCollection;
return this;
}
/**
* Ends the subscription schedule early as dictated by either the accompanying amendment's
* start or end.
*/
public Builder setSetScheduleEnd(
InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.SetScheduleEnd setScheduleEnd) {
this.setScheduleEnd = setScheduleEnd;
return this;
}
/** Settings related to subscription trials. */
public Builder setTrialSettings(
InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.TrialSettings trialSettings) {
this.trialSettings = trialSettings;
return this;
}
}
@Getter
public static class AmendmentEnd {
/** Use the {@code end} time of a given discount. */
@SerializedName("discount_end")
DiscountEnd discountEnd;
/** Time span for the amendment starting from the {@code amendment_start}. */
@SerializedName("duration")
Duration duration;
/**
* 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;
/**
* A precise Unix timestamp for the amendment to end. Must be after the {@code
* amendment_start}.
*/
@SerializedName("timestamp")
Long timestamp;
/**
* Required. Select one of three ways to pass the {@code amendment_end}.
*/
@SerializedName("type")
Type type;
private AmendmentEnd(
DiscountEnd discountEnd,
Duration duration,
Map extraParams,
Long timestamp,
Type type) {
this.discountEnd = discountEnd;
this.duration = duration;
this.extraParams = extraParams;
this.timestamp = timestamp;
this.type = type;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private DiscountEnd discountEnd;
private Duration duration;
private Map extraParams;
private Long timestamp;
private Type type;
/** Finalize and obtain parameter instance from this builder. */
public InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.AmendmentEnd build() {
return new InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.AmendmentEnd(
this.discountEnd, this.duration, this.extraParams, this.timestamp, this.type);
}
/** Use the {@code end} time of a given discount. */
public Builder setDiscountEnd(
InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.AmendmentEnd.DiscountEnd
discountEnd) {
this.discountEnd = discountEnd;
return this;
}
/** Time span for the amendment starting from the {@code amendment_start}. */
public Builder setDuration(
InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.AmendmentEnd.Duration duration) {
this.duration = duration;
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
* InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.AmendmentEnd#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
* InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.AmendmentEnd#extraParams} for the
* field documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/**
* A precise Unix timestamp for the amendment to end. Must be after the {@code
* amendment_start}.
*/
public Builder setTimestamp(Long timestamp) {
this.timestamp = timestamp;
return this;
}
/**
* Required. Select one of three ways to pass the {@code amendment_end}.
*/
public Builder setType(
InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.AmendmentEnd.Type type) {
this.type = type;
return this;
}
}
@Getter
public static class DiscountEnd {
/** Required. The ID of a specific discount. */
@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;
private DiscountEnd(String discount, Map extraParams) {
this.discount = discount;
this.extraParams = extraParams;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private String discount;
private Map extraParams;
/** Finalize and obtain parameter instance from this builder. */
public InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.AmendmentEnd.DiscountEnd
build() {
return new InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.AmendmentEnd
.DiscountEnd(this.discount, this.extraParams);
}
/** Required. The ID of a specific discount. */
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
* InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.AmendmentEnd.DiscountEnd#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
* InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.AmendmentEnd.DiscountEnd#extraParams}
* for the field documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
}
}
@Getter
public static class Duration {
/**
* 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 a type of interval unit. Either {@code day},
* {@code week}, {@code month} or {@code year}.
*/
@SerializedName("interval")
Interval interval;
/**
* Required. The number of intervals, as an whole number greater than 0.
* Stripe multiplies this by the interval type to get the overall duration.
*/
@SerializedName("interval_count")
Long intervalCount;
private Duration(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 InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.AmendmentEnd.Duration
build() {
return new InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.AmendmentEnd.Duration(
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
* InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.AmendmentEnd.Duration#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
* InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.AmendmentEnd.Duration#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 a type of interval unit. Either {@code day},
* {@code week}, {@code month} or {@code year}.
*/
public Builder setInterval(
InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.AmendmentEnd.Duration.Interval
interval) {
this.interval = interval;
return this;
}
/**
* Required. The number of intervals, as an whole number greater than
* 0. Stripe multiplies this by the interval type to get the overall duration.
*/
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 Type implements ApiRequestParams.EnumParam {
@SerializedName("discount_end")
DISCOUNT_END("discount_end"),
@SerializedName("duration")
DURATION("duration"),
@SerializedName("schedule_end")
SCHEDULE_END("schedule_end"),
@SerializedName("timestamp")
TIMESTAMP("timestamp"),
@SerializedName("trial_end")
TRIAL_END("trial_end"),
@SerializedName("trial_start")
TRIAL_START("trial_start"),
@SerializedName("upcoming_invoice")
UPCOMING_INVOICE("upcoming_invoice");
@Getter(onMethod_ = {@Override})
private final String value;
Type(String value) {
this.value = value;
}
}
}
@Getter
public static class AmendmentStart {
/**
* Details of another amendment in the same array, immediately after which this amendment
* should begin.
*/
@SerializedName("amendment_end")
AmendmentEnd amendmentEnd;
/** Use the {@code end} time of a given discount. */
@SerializedName("discount_end")
DiscountEnd discountEnd;
/**
* 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;
/** A precise Unix timestamp for the amendment to start. */
@SerializedName("timestamp")
Long timestamp;
/**
* Required. Select one of three ways to pass the {@code amendment_start}.
*/
@SerializedName("type")
Type type;
private AmendmentStart(
AmendmentEnd amendmentEnd,
DiscountEnd discountEnd,
Map extraParams,
Long timestamp,
Type type) {
this.amendmentEnd = amendmentEnd;
this.discountEnd = discountEnd;
this.extraParams = extraParams;
this.timestamp = timestamp;
this.type = type;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private AmendmentEnd amendmentEnd;
private DiscountEnd discountEnd;
private Map extraParams;
private Long timestamp;
private Type type;
/** Finalize and obtain parameter instance from this builder. */
public InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.AmendmentStart build() {
return new InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.AmendmentStart(
this.amendmentEnd, this.discountEnd, this.extraParams, this.timestamp, this.type);
}
/**
* Details of another amendment in the same array, immediately after which this amendment
* should begin.
*/
public Builder setAmendmentEnd(
InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.AmendmentStart.AmendmentEnd
amendmentEnd) {
this.amendmentEnd = amendmentEnd;
return this;
}
/** Use the {@code end} time of a given discount. */
public Builder setDiscountEnd(
InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.AmendmentStart.DiscountEnd
discountEnd) {
this.discountEnd = discountEnd;
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
* InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.AmendmentStart#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
* InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.AmendmentStart#extraParams} for
* the field documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/** A precise Unix timestamp for the amendment to start. */
public Builder setTimestamp(Long timestamp) {
this.timestamp = timestamp;
return this;
}
/**
* Required. Select one of three ways to pass the {@code
* amendment_start}.
*/
public Builder setType(
InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.AmendmentStart.Type type) {
this.type = type;
return this;
}
}
@Getter
public static class AmendmentEnd {
/**
* 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 position of the previous amendment in the {@code
* amendments} array after which this amendment should begin. Indexes start from 0 and
* must be less than the index of the current amendment in the array.
*/
@SerializedName("index")
Long index;
private AmendmentEnd(Map extraParams, Long index) {
this.extraParams = extraParams;
this.index = index;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Map extraParams;
private Long index;
/** Finalize and obtain parameter instance from this builder. */
public InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.AmendmentStart.AmendmentEnd
build() {
return new InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.AmendmentStart
.AmendmentEnd(this.extraParams, this.index);
}
/**
* 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
* InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.AmendmentStart.AmendmentEnd#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
* InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.AmendmentStart.AmendmentEnd#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 position of the previous amendment in the {@code
* amendments} array after which this amendment should begin. Indexes start from 0 and
* must be less than the index of the current amendment in the array.
*/
public Builder setIndex(Long index) {
this.index = index;
return this;
}
}
}
@Getter
public static class DiscountEnd {
/** Required. The ID of a specific discount. */
@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;
private DiscountEnd(String discount, Map extraParams) {
this.discount = discount;
this.extraParams = extraParams;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private String discount;
private Map extraParams;
/** Finalize and obtain parameter instance from this builder. */
public InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.AmendmentStart.DiscountEnd
build() {
return new InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.AmendmentStart
.DiscountEnd(this.discount, this.extraParams);
}
/** Required. The ID of a specific discount. */
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
* InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.AmendmentStart.DiscountEnd#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
* InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.AmendmentStart.DiscountEnd#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 Type implements ApiRequestParams.EnumParam {
@SerializedName("amendment_end")
AMENDMENT_END("amendment_end"),
@SerializedName("discount_end")
DISCOUNT_END("discount_end"),
@SerializedName("now")
NOW("now"),
@SerializedName("schedule_end")
SCHEDULE_END("schedule_end"),
@SerializedName("timestamp")
TIMESTAMP("timestamp"),
@SerializedName("trial_end")
TRIAL_END("trial_end"),
@SerializedName("trial_start")
TRIAL_START("trial_start"),
@SerializedName("upcoming_invoice")
UPCOMING_INVOICE("upcoming_invoice");
@Getter(onMethod_ = {@Override})
private final String value;
Type(String value) {
this.value = value;
}
}
}
@Getter
public static class DiscountAction {
/** Details of the discount to add. */
@SerializedName("add")
Add add;
/**
* 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;
/** Details of the discount to remove. */
@SerializedName("remove")
Remove remove;
/** Details of the discount to replace the existing discounts with. */
@SerializedName("set")
Set set;
/** Required. Determines the type of discount action. */
@SerializedName("type")
Type type;
private DiscountAction(
Add add, Map extraParams, Remove remove, Set set, Type type) {
this.add = add;
this.extraParams = extraParams;
this.remove = remove;
this.set = set;
this.type = type;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Add add;
private Map extraParams;
private Remove remove;
private Set set;
private Type type;
/** Finalize and obtain parameter instance from this builder. */
public InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.DiscountAction build() {
return new InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.DiscountAction(
this.add, this.extraParams, this.remove, this.set, this.type);
}
/** Details of the discount to add. */
public Builder setAdd(
InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.DiscountAction.Add add) {
this.add = add;
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
* InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.DiscountAction#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
* InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.DiscountAction#extraParams} for
* the field documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/** Details of the discount to remove. */
public Builder setRemove(
InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.DiscountAction.Remove remove) {
this.remove = remove;
return this;
}
/** Details of the discount to replace the existing discounts with. */
public Builder setSet(
InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.DiscountAction.Set set) {
this.set = set;
return this;
}
/** Required. Determines the type of discount action. */
public Builder setType(
InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.DiscountAction.Type type) {
this.type = type;
return this;
}
}
@Getter
public static class Add {
/** The coupon code to redeem. */
@SerializedName("coupon")
String coupon;
/** An ID of an existing discount for a coupon that was already redeemed. */
@SerializedName("discount")
String discount;
/** Details to determine how long the discount should be applied for. */
@SerializedName("discount_end")
DiscountEnd discountEnd;
/**
* 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 index, starting at 0, at which to position the new discount. When not supplied,
* Stripe defaults to appending the discount to the end of the {@code discounts} array.
*/
@SerializedName("index")
Long index;
/** The promotion code to redeem. */
@SerializedName("promotion_code")
String promotionCode;
private Add(
String coupon,
String discount,
DiscountEnd discountEnd,
Map extraParams,
Long index,
String promotionCode) {
this.coupon = coupon;
this.discount = discount;
this.discountEnd = discountEnd;
this.extraParams = extraParams;
this.index = index;
this.promotionCode = promotionCode;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private String coupon;
private String discount;
private DiscountEnd discountEnd;
private Map extraParams;
private Long index;
private String promotionCode;
/** Finalize and obtain parameter instance from this builder. */
public InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.DiscountAction.Add build() {
return new InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.DiscountAction.Add(
this.coupon,
this.discount,
this.discountEnd,
this.extraParams,
this.index,
this.promotionCode);
}
/** The coupon code to redeem. */
public Builder setCoupon(String coupon) {
this.coupon = coupon;
return this;
}
/** An ID of an existing discount for a coupon that was already redeemed. */
public Builder setDiscount(String discount) {
this.discount = discount;
return this;
}
/** Details to determine how long the discount should be applied for. */
public Builder setDiscountEnd(
InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.DiscountAction.Add.DiscountEnd
discountEnd) {
this.discountEnd = discountEnd;
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
* InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.DiscountAction.Add#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
* InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.DiscountAction.Add#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 index, starting at 0, at which to position the new discount. When not supplied,
* Stripe defaults to appending the discount to the end of the {@code discounts} array.
*/
public Builder setIndex(Long index) {
this.index = index;
return this;
}
/** The promotion code to redeem. */
public Builder setPromotionCode(String promotionCode) {
this.promotionCode = promotionCode;
return this;
}
}
@Getter
public static class DiscountEnd {
/**
* 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 type of calculation made to determine when the
* discount ends.
*/
@SerializedName("type")
Type type;
private DiscountEnd(Map extraParams, Type type) {
this.extraParams = extraParams;
this.type = type;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Map extraParams;
private Type type;
/** Finalize and obtain parameter instance from this builder. */
public InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.DiscountAction.Add
.DiscountEnd
build() {
return new InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.DiscountAction.Add
.DiscountEnd(this.extraParams, this.type);
}
/**
* 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
* InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.DiscountAction.Add.DiscountEnd#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
* InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.DiscountAction.Add.DiscountEnd#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 type of calculation made to determine when the
* discount ends.
*/
public Builder setType(
InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.DiscountAction.Add
.DiscountEnd.Type
type) {
this.type = type;
return this;
}
}
public enum Type implements ApiRequestParams.EnumParam {
@SerializedName("amendment_end")
AMENDMENT_END("amendment_end");
@Getter(onMethod_ = {@Override})
private final String value;
Type(String value) {
this.value = value;
}
}
}
}
@Getter
public static class Remove {
/** The coupon code to remove from the {@code discounts} array. */
@SerializedName("coupon")
String coupon;
/** The ID of a discount to remove from the {@code discounts} array. */
@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;
/** The ID of a promotion code to remove from the {@code discounts} array. */
@SerializedName("promotion_code")
String promotionCode;
private Remove(
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 InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.DiscountAction.Remove
build() {
return new InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.DiscountAction.Remove(
this.coupon, this.discount, this.extraParams, this.promotionCode);
}
/** The coupon code to remove from the {@code discounts} array. */
public Builder setCoupon(String coupon) {
this.coupon = coupon;
return this;
}
/** The ID of a discount to remove from the {@code discounts} array. */
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
* InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.DiscountAction.Remove#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
* InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.DiscountAction.Remove#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 a promotion code to remove from the {@code discounts} array. */
public Builder setPromotionCode(String promotionCode) {
this.promotionCode = promotionCode;
return this;
}
}
}
@Getter
public static class Set {
/** The coupon code to replace the {@code discounts} array with. */
@SerializedName("coupon")
String coupon;
/** An ID of an existing discount to replace the {@code discounts} array with. */
@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;
/** An ID of an existing promotion code to replace the {@code discounts} array with. */
@SerializedName("promotion_code")
String promotionCode;
private Set(
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 InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.DiscountAction.Set build() {
return new InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.DiscountAction.Set(
this.coupon, this.discount, this.extraParams, this.promotionCode);
}
/** The coupon code to replace the {@code discounts} array with. */
public Builder setCoupon(String coupon) {
this.coupon = coupon;
return this;
}
/** An ID of an existing discount to replace the {@code discounts} array with. */
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
* InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.DiscountAction.Set#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
* InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.DiscountAction.Set#extraParams}
* for the field documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/** An ID of an existing promotion code to replace the {@code discounts} array with. */
public Builder setPromotionCode(String promotionCode) {
this.promotionCode = promotionCode;
return this;
}
}
}
public enum Type implements ApiRequestParams.EnumParam {
@SerializedName("add")
ADD("add"),
@SerializedName("remove")
REMOVE("remove"),
@SerializedName("set")
SET("set");
@Getter(onMethod_ = {@Override})
private final String value;
Type(String value) {
this.value = value;
}
}
}
@Getter
public static class ItemAction {
/**
* Details of the subscription item to add. If an item with the same {@code price} exists,
* it will be replaced by this new item. Otherwise, it adds the new item.
*/
@SerializedName("add")
Add add;
/**
* 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;
/** Details of the subscription item to remove. */
@SerializedName("remove")
Remove remove;
/**
* Details of the subscription item to replace the existing items with. If an item with the
* {@code set[price]} already exists, the {@code items} array is not cleared. Instead, all
* of the other {@code set} properties that are passed in this request will replace the
* existing values for the configuration item.
*/
@SerializedName("set")
Set set;
/** Required. Determines the type of item action. */
@SerializedName("type")
Type type;
private ItemAction(
Add add, Map extraParams, Remove remove, Set set, Type type) {
this.add = add;
this.extraParams = extraParams;
this.remove = remove;
this.set = set;
this.type = type;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Add add;
private Map extraParams;
private Remove remove;
private Set set;
private Type type;
/** Finalize and obtain parameter instance from this builder. */
public InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.ItemAction build() {
return new InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.ItemAction(
this.add, this.extraParams, this.remove, this.set, this.type);
}
/**
* Details of the subscription item to add. If an item with the same {@code price} exists,
* it will be replaced by this new item. Otherwise, it adds the new item.
*/
public Builder setAdd(
InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.ItemAction.Add add) {
this.add = add;
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
* InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.ItemAction#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
* InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.ItemAction#extraParams} for the
* field documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/** Details of the subscription item to remove. */
public Builder setRemove(
InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.ItemAction.Remove remove) {
this.remove = remove;
return this;
}
/**
* Details of the subscription item to replace the existing items with. If an item with
* the {@code set[price]} already exists, the {@code items} array is not cleared. Instead,
* all of the other {@code set} properties that are passed in this request will replace
* the existing values for the configuration item.
*/
public Builder setSet(
InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.ItemAction.Set set) {
this.set = set;
return this;
}
/** Required. Determines the type of item action. */
public Builder setType(
InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.ItemAction.Type type) {
this.type = type;
return this;
}
}
@Getter
public static class Add {
/**
* The discounts applied to the item. Subscription item discounts are applied before
* subscription discounts.
*/
@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;
/**
* 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")
Map metadata;
/** Required. The ID of the price object. */
@SerializedName("price")
String price;
/** Quantity for this item. */
@SerializedName("quantity")
Long quantity;
/**
* The tax rates that apply to this subscription item. When set, the {@code
* default_tax_rates} on the subscription do not apply to this {@code subscription_item}.
*/
@SerializedName("tax_rates")
List taxRates;
/** Options that configure the trial on the subscription item. */
@SerializedName("trial")
Trial trial;
private Add(
List
discounts,
Map extraParams,
Map metadata,
String price,
Long quantity,
List taxRates,
Trial trial) {
this.discounts = discounts;
this.extraParams = extraParams;
this.metadata = metadata;
this.price = price;
this.quantity = quantity;
this.taxRates = taxRates;
this.trial = trial;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private List<
InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.ItemAction.Add.Discount>
discounts;
private Map extraParams;
private Map metadata;
private String price;
private Long quantity;
private List taxRates;
private Trial trial;
/** Finalize and obtain parameter instance from this builder. */
public InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.ItemAction.Add build() {
return new InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.ItemAction.Add(
this.discounts,
this.extraParams,
this.metadata,
this.price,
this.quantity,
this.taxRates,
this.trial);
}
/**
* 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
* InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.ItemAction.Add#discounts} for
* the field documentation.
*/
public Builder addDiscount(
InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.ItemAction.Add.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
* InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.ItemAction.Add#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
* InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.ItemAction.Add#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
* InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.ItemAction.Add#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
* InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.ItemAction.Add#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
* InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.ItemAction.Add#metadata} for the
* field documentation.
*/
public Builder putAllMetadata(Map map) {
if (this.metadata == null) {
this.metadata = new HashMap<>();
}
this.metadata.putAll(map);
return this;
}
/** Required. The ID of the price object. */
public Builder setPrice(String price) {
this.price = price;
return this;
}
/** Quantity for this item. */
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
* InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.ItemAction.Add#taxRates} for the
* field documentation.
*/
public Builder addTaxRate(String element) {
if (this.taxRates == null) {
this.taxRates = new ArrayList<>();
}
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
* InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.ItemAction.Add#taxRates} for the
* field documentation.
*/
public Builder addAllTaxRate(List elements) {
if (this.taxRates == null) {
this.taxRates = new ArrayList<>();
}
this.taxRates.addAll(elements);
return this;
}
/** Options that configure the trial on the subscription item. */
public Builder setTrial(
InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.ItemAction.Add.Trial trial) {
this.trial = trial;
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;
/** Details to determine how long the discount should be applied for. */
@SerializedName("discount_end")
DiscountEnd discountEnd;
/**
* 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,
DiscountEnd discountEnd,
Map extraParams,
String promotionCode) {
this.coupon = coupon;
this.discount = discount;
this.discountEnd = discountEnd;
this.extraParams = extraParams;
this.promotionCode = promotionCode;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private String coupon;
private String discount;
private DiscountEnd discountEnd;
private Map extraParams;
private String promotionCode;
/** Finalize and obtain parameter instance from this builder. */
public InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.ItemAction.Add.Discount
build() {
return new InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.ItemAction.Add
.Discount(
this.coupon,
this.discount,
this.discountEnd,
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;
}
/** Details to determine how long the discount should be applied for. */
public Builder setDiscountEnd(
InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.ItemAction.Add.Discount
.DiscountEnd
discountEnd) {
this.discountEnd = discountEnd;
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
* InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.ItemAction.Add.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
* InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.ItemAction.Add.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 DiscountEnd {
/** Time span for the redeemed discount. */
@SerializedName("duration")
Duration duration;
/**
* 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;
/** A precise Unix timestamp for the discount to end. Must be in the future. */
@SerializedName("timestamp")
Long timestamp;
/**
* Required. The type of calculation made to determine when the
* discount ends.
*/
@SerializedName("type")
Type type;
private DiscountEnd(
Duration duration, Map extraParams, Long timestamp, Type type) {
this.duration = duration;
this.extraParams = extraParams;
this.timestamp = timestamp;
this.type = type;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Duration duration;
private Map extraParams;
private Long timestamp;
private Type type;
/** Finalize and obtain parameter instance from this builder. */
public InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.ItemAction.Add.Discount
.DiscountEnd
build() {
return new InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.ItemAction.Add
.Discount.DiscountEnd(
this.duration, this.extraParams, this.timestamp, this.type);
}
/** Time span for the redeemed discount. */
public Builder setDuration(
InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.ItemAction.Add.Discount
.DiscountEnd.Duration
duration) {
this.duration = duration;
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
* InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.ItemAction.Add.Discount.DiscountEnd#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
* InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.ItemAction.Add.Discount.DiscountEnd#extraParams}
* for the field documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/** A precise Unix timestamp for the discount to end. Must be in the future. */
public Builder setTimestamp(Long timestamp) {
this.timestamp = timestamp;
return this;
}
/**
* Required. The type of calculation made to determine when the
* discount ends.
*/
public Builder setType(
InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.ItemAction.Add.Discount
.DiscountEnd.Type
type) {
this.type = type;
return this;
}
}
@Getter
public static class Duration {
/**
* 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 a type of interval unit. Either {@code day},
* {@code week}, {@code month} or {@code year}.
*/
@SerializedName("interval")
Interval interval;
/**
* Required. The number of intervals, as an whole number greater
* than 0. Stripe multiplies this by the interval type to get the overall duration.
*/
@SerializedName("interval_count")
Long intervalCount;
private Duration(
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 InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.ItemAction.Add
.Discount.DiscountEnd.Duration
build() {
return new InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.ItemAction.Add
.Discount.DiscountEnd.Duration(
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
* InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.ItemAction.Add.Discount.DiscountEnd.Duration#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
* InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.ItemAction.Add.Discount.DiscountEnd.Duration#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 a type of interval unit. Either {@code
* day}, {@code week}, {@code month} or {@code year}.
*/
public Builder setInterval(
InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.ItemAction.Add.Discount
.DiscountEnd.Duration.Interval
interval) {
this.interval = interval;
return this;
}
/**
* Required. The number of intervals, as an whole number greater
* than 0. Stripe multiplies this by the interval type to get the overall
* duration.
*/
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 Type implements ApiRequestParams.EnumParam {
@SerializedName("duration")
DURATION("duration"),
@SerializedName("timestamp")
TIMESTAMP("timestamp");
@Getter(onMethod_ = {@Override})
private final String value;
Type(String value) {
this.value = value;
}
}
}
}
@Getter
public static class Trial {
/**
* List of price IDs which, if present on the subscription following a paid trial,
* constitute opting-in to the paid trial. Currently only supports at most 1 price ID.
*/
@SerializedName("converts_to")
List convertsTo;
/**
* 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. Determines the type of trial for this item. */
@SerializedName("type")
Type type;
private Trial(List convertsTo, Map extraParams, Type type) {
this.convertsTo = convertsTo;
this.extraParams = extraParams;
this.type = type;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private List convertsTo;
private Map extraParams;
private Type type;
/** Finalize and obtain parameter instance from this builder. */
public InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.ItemAction.Add.Trial
build() {
return new InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.ItemAction.Add
.Trial(this.convertsTo, this.extraParams, this.type);
}
/**
* Add an element to `convertsTo` list. A list is initialized for the first
* `add/addAll` call, and subsequent calls adds additional elements to the original
* list. See {@link
* InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.ItemAction.Add.Trial#convertsTo}
* for the field documentation.
*/
public Builder addConvertsTo(String element) {
if (this.convertsTo == null) {
this.convertsTo = new ArrayList<>();
}
this.convertsTo.add(element);
return this;
}
/**
* Add all elements to `convertsTo` list. A list is initialized for the first
* `add/addAll` call, and subsequent calls adds additional elements to the original
* list. See {@link
* InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.ItemAction.Add.Trial#convertsTo}
* for the field documentation.
*/
public Builder addAllConvertsTo(List elements) {
if (this.convertsTo == null) {
this.convertsTo = new ArrayList<>();
}
this.convertsTo.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
* InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.ItemAction.Add.Trial#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
* InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.ItemAction.Add.Trial#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. Determines the type of trial for this item. */
public Builder setType(
InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.ItemAction.Add.Trial.Type
type) {
this.type = type;
return this;
}
}
public enum Type implements ApiRequestParams.EnumParam {
@SerializedName("free")
FREE("free"),
@SerializedName("paid")
PAID("paid");
@Getter(onMethod_ = {@Override})
private final String value;
Type(String value) {
this.value = value;
}
}
}
}
@Getter
public static class Remove {
/**
* 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. ID of a price to remove. */
@SerializedName("price")
String price;
private Remove(Map extraParams, String price) {
this.extraParams = extraParams;
this.price = price;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Map extraParams;
private String price;
/** Finalize and obtain parameter instance from this builder. */
public InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.ItemAction.Remove build() {
return new InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.ItemAction.Remove(
this.extraParams, this.price);
}
/**
* 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
* InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.ItemAction.Remove#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
* InvoiceUpcomingLinesParams.ScheduleDetails.Amendment.ItemAction.Remove#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. ID of a price to remove. */
public Builder setPrice(String price) {
this.price = price;
return this;
}
}
}
@Getter
public static class Set {
/**
* If an item with the {@code price} already exists, passing this will override the {@code
* discounts} array on the subscription item that matches that price. Otherwise, the
* {@code items} array is cleared and a single new item is added with the supplied {@code
* discounts}.
*/
@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;
/**
* If an item with the {@code price} already exists, passing this will override the {@code
* metadata} on the subscription item that matches that price. Otherwise, the {@code
* items} array is cleared and a single new item is added with the supplied {@code
* metadata}.
*/
@SerializedName("metadata")
Map metadata;
/** Required. The ID of the price object. */
@SerializedName("price")
String price;
/**
* If an item with the {@code price} already exists, passing this will override the
* quantity on the subscription item that matches that price. Otherwise, the {@code items}
* array is cleared and a single new item is added with the supplied {@code quantity}.
*/
@SerializedName("quantity")
Long quantity;
/**
* If an item with the {@code price} already exists, passing this will override the {@code
* tax_rates} array on the subscription item that matches that price. Otherwise, the
* {@code items} array is cleared and a single new item is added with the supplied {@code
* tax_rates}.
*/
@SerializedName("tax_rates")
List taxRates;
/**
* If an item with the {@code price} already exists, passing this will override the {@code
* trial} configuration on the subscription item that matches that price. Otherwise, the
* {@code items} array is cleared and a single new item is added with the supplied {@code
* trial}.
*/
@SerializedName("trial")
Trial trial;
private Set(
List
discounts,
Map extraParams,
Map metadata,
String price,
Long quantity,
List
