com.stripe.param.InvoiceUpdateParams Maven / Gradle / Ivy
// Generated by delombok at Wed Jun 10 17:29:55 PDT 2020
package com.stripe.param;
import com.google.gson.annotations.SerializedName;
import com.stripe.net.ApiRequestParams;
import com.stripe.param.common.EmptyParam;
import java.math.BigDecimal;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
public class InvoiceUpdateParams extends ApiRequestParams {
/**
* A fee in %s that will be applied to the invoice and transferred to the application owner's
* Stripe account. The request must be made with an OAuth key or the Stripe-Account header in
* order to take an application fee. For more information, see the application fees documentation.
*/
@SerializedName("application_fee_amount")
Long applicationFeeAmount;
/**
* Controls whether Stripe will perform automatic collection
* of the invoice.
*/
@SerializedName("auto_advance")
Boolean autoAdvance;
/**
* Either {@code charge_automatically} or {@code send_invoice}. This field can be updated only on
* {@code draft} invoices.
*/
@SerializedName("collection_method")
CollectionMethod collectionMethod;
/**
* A list of up to 4 custom fields to be displayed on the invoice. If a value for {@code
* custom_fields} is specified, the list specified will replace the existing custom field list on
* this invoice. Pass an empty string to remove previously-defined fields.
*/
@SerializedName("custom_fields")
Object customFields;
/**
* The number of days from which the invoice is created until it is due. Only valid for invoices
* where {@code collection_method=send_invoice}. This field can only be updated on {@code draft}
* invoices.
*/
@SerializedName("days_until_due")
Long daysUntilDue;
/**
* ID of the default payment method for the invoice. It must belong to the customer associated
* with the invoice. If not set, defaults to the subscription's default payment method, if any, or
* to the default payment method in the customer's invoice settings.
*/
@SerializedName("default_payment_method")
Object defaultPaymentMethod;
/**
* ID of the default payment source for the invoice. It must belong to the customer associated
* with the invoice and be in a chargeable state. If not set, defaults to the subscription's
* default source, if any, or to the customer's default source.
*/
@SerializedName("default_source")
Object defaultSource;
/**
* The tax rates that will apply to any line item that does not have {@code tax_rates} set. Pass
* an empty string to remove previously-defined tax rates.
*/
@SerializedName("default_tax_rates")
Object defaultTaxRates;
/**
* An arbitrary string attached to the object. Often useful for displaying to users. Referenced as
* 'memo' in the Dashboard.
*/
@SerializedName("description")
Object description;
/**
* The date on which payment for this invoice is due. Only valid for invoices where {@code
* collection_method=send_invoice}. This field can only be updated on {@code draft} invoices.
*/
@SerializedName("due_date")
Long dueDate;
/**
* 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;
/**
* Footer to be displayed on the invoice.
*/
@SerializedName("footer")
Object footer;
/**
* 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;
/**
* Extra information about a charge for the customer's credit card statement. It must contain at
* least one letter. If not specified and this invoice is part of a subscription, the default
* {@code statement_descriptor} will be set to the first subscription item's product's {@code
* statement_descriptor}.
*/
@SerializedName("statement_descriptor")
Object statementDescriptor;
/**
* The percent tax rate applied to the invoice, represented as a non-negative decimal number (with
* at most four decimal places) between 0 and 100. To unset a previously-set value, pass an empty
* string. This field can be updated only on {@code draft} invoices. This field has been
* deprecated and will be removed in a future API version, for further information view the migration docs for {@code
* tax_rates}.
*/
@SerializedName("tax_percent")
Object taxPercent;
/**
* If specified, the funds from the invoice will be transferred to the destination and the ID of
* the resulting transfer will be found on the invoice's charge. This will be unset if you POST an
* empty value.
*/
@SerializedName("transfer_data")
Object transferData;
private InvoiceUpdateParams(Long applicationFeeAmount, Boolean autoAdvance, CollectionMethod collectionMethod, Object customFields, Long daysUntilDue, Object defaultPaymentMethod, Object defaultSource, Object defaultTaxRates, Object description, Long dueDate, List expand, Map extraParams, Object footer, Object metadata, Object statementDescriptor, Object taxPercent, Object transferData) {
this.applicationFeeAmount = applicationFeeAmount;
this.autoAdvance = autoAdvance;
this.collectionMethod = collectionMethod;
this.customFields = customFields;
this.daysUntilDue = daysUntilDue;
this.defaultPaymentMethod = defaultPaymentMethod;
this.defaultSource = defaultSource;
this.defaultTaxRates = defaultTaxRates;
this.description = description;
this.dueDate = dueDate;
this.expand = expand;
this.extraParams = extraParams;
this.footer = footer;
this.metadata = metadata;
this.statementDescriptor = statementDescriptor;
this.taxPercent = taxPercent;
this.transferData = transferData;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Long applicationFeeAmount;
private Boolean autoAdvance;
private CollectionMethod collectionMethod;
private Object customFields;
private Long daysUntilDue;
private Object defaultPaymentMethod;
private Object defaultSource;
private Object defaultTaxRates;
private Object description;
private Long dueDate;
private List expand;
private Map extraParams;
private Object footer;
private Object metadata;
private Object statementDescriptor;
private Object taxPercent;
private Object transferData;
/**
* Finalize and obtain parameter instance from this builder.
*/
public InvoiceUpdateParams build() {
return new InvoiceUpdateParams(this.applicationFeeAmount, this.autoAdvance, this.collectionMethod, this.customFields, this.daysUntilDue, this.defaultPaymentMethod, this.defaultSource, this.defaultTaxRates, this.description, this.dueDate, this.expand, this.extraParams, this.footer, this.metadata, this.statementDescriptor, this.taxPercent, this.transferData);
}
/**
* A fee in %s that will be applied to the invoice and transferred to the application owner's
* Stripe account. The request must be made with an OAuth key or the Stripe-Account header in
* order to take an application fee. For more information, see the application fees documentation.
*/
public Builder setApplicationFeeAmount(Long applicationFeeAmount) {
this.applicationFeeAmount = applicationFeeAmount;
return this;
}
/**
* Controls whether Stripe will perform automatic
* collection of the invoice.
*/
public Builder setAutoAdvance(Boolean autoAdvance) {
this.autoAdvance = autoAdvance;
return this;
}
/**
* Either {@code charge_automatically} or {@code send_invoice}. This field can be updated only
* on {@code draft} invoices.
*/
public Builder setCollectionMethod(CollectionMethod collectionMethod) {
this.collectionMethod = collectionMethod;
return this;
}
/**
* Add an element to `customFields` list. A list is initialized for the first `add/addAll` call,
* and subsequent calls adds additional elements to the original list. See {@link
* InvoiceUpdateParams#customFields} for the field documentation.
*/
@SuppressWarnings("unchecked")
public Builder addCustomField(CustomField element) {
if (this.customFields == null || this.customFields instanceof EmptyParam) {
this.customFields = new ArrayList();
}
((List) this.customFields).add(element);
return this;
}
/**
* Add all elements to `customFields` list. A list is initialized for the first `add/addAll`
* call, and subsequent calls adds additional elements to the original list. See {@link
* InvoiceUpdateParams#customFields} for the field documentation.
*/
@SuppressWarnings("unchecked")
public Builder addAllCustomField(List elements) {
if (this.customFields == null || this.customFields instanceof EmptyParam) {
this.customFields = new ArrayList();
}
((List) this.customFields).addAll(elements);
return this;
}
/**
* A list of up to 4 custom fields to be displayed on the invoice. If a value for {@code
* custom_fields} is specified, the list specified will replace the existing custom field list
* on this invoice. Pass an empty string to remove previously-defined fields.
*/
public Builder setCustomFields(EmptyParam customFields) {
this.customFields = customFields;
return this;
}
/**
* A list of up to 4 custom fields to be displayed on the invoice. If a value for {@code
* custom_fields} is specified, the list specified will replace the existing custom field list
* on this invoice. Pass an empty string to remove previously-defined fields.
*/
public Builder setCustomFields(List customFields) {
this.customFields = customFields;
return this;
}
/**
* The number of days from which the invoice is created until it is due. Only valid for invoices
* where {@code collection_method=send_invoice}. This field can only be updated on {@code draft}
* invoices.
*/
public Builder setDaysUntilDue(Long daysUntilDue) {
this.daysUntilDue = daysUntilDue;
return this;
}
/**
* ID of the default payment method for the invoice. It must belong to the customer associated
* with the invoice. If not set, defaults to the subscription's default payment method, if any,
* or to the default payment method in the customer's invoice settings.
*/
public Builder setDefaultPaymentMethod(String defaultPaymentMethod) {
this.defaultPaymentMethod = defaultPaymentMethod;
return this;
}
/**
* ID of the default payment method for the invoice. It must belong to the customer associated
* with the invoice. If not set, defaults to the subscription's default payment method, if any,
* or to the default payment method in the customer's invoice settings.
*/
public Builder setDefaultPaymentMethod(EmptyParam defaultPaymentMethod) {
this.defaultPaymentMethod = defaultPaymentMethod;
return this;
}
/**
* ID of the default payment source for the invoice. It must belong to the customer associated
* with the invoice and be in a chargeable state. If not set, defaults to the subscription's
* default source, if any, or to the customer's default source.
*/
public Builder setDefaultSource(String defaultSource) {
this.defaultSource = defaultSource;
return this;
}
/**
* ID of the default payment source for the invoice. It must belong to the customer associated
* with the invoice and be in a chargeable state. If not set, defaults to the subscription's
* default source, if any, or to the customer's default source.
*/
public Builder setDefaultSource(EmptyParam defaultSource) {
this.defaultSource = defaultSource;
return this;
}
/**
* Add an element to `defaultTaxRates` list. A list is initialized for the first `add/addAll`
* call, and subsequent calls adds additional elements to the original list. See {@link
* InvoiceUpdateParams#defaultTaxRates} for the field documentation.
*/
@SuppressWarnings("unchecked")
public Builder addDefaultTaxRate(String element) {
if (this.defaultTaxRates == null || this.defaultTaxRates instanceof EmptyParam) {
this.defaultTaxRates = new ArrayList();
}
((List) this.defaultTaxRates).add(element);
return this;
}
/**
* Add all elements to `defaultTaxRates` list. A list is initialized for the first `add/addAll`
* call, and subsequent calls adds additional elements to the original list. See {@link
* InvoiceUpdateParams#defaultTaxRates} for the field documentation.
*/
@SuppressWarnings("unchecked")
public Builder addAllDefaultTaxRate(List elements) {
if (this.defaultTaxRates == null || this.defaultTaxRates instanceof EmptyParam) {
this.defaultTaxRates = new ArrayList();
}
((List) this.defaultTaxRates).addAll(elements);
return this;
}
/**
* The tax rates that will apply to any line item that does not have {@code tax_rates} set. Pass
* an empty string to remove previously-defined tax rates.
*/
public Builder setDefaultTaxRates(EmptyParam defaultTaxRates) {
this.defaultTaxRates = defaultTaxRates;
return this;
}
/**
* The tax rates that will apply to any line item that does not have {@code tax_rates} set. Pass
* an empty string to remove previously-defined tax rates.
*/
public Builder setDefaultTaxRates(List defaultTaxRates) {
this.defaultTaxRates = defaultTaxRates;
return this;
}
/**
* An arbitrary string attached to the object. Often useful for displaying to users. Referenced
* as 'memo' in the Dashboard.
*/
public Builder setDescription(String description) {
this.description = description;
return this;
}
/**
* An arbitrary string attached to the object. Often useful for displaying to users. Referenced
* as 'memo' in the Dashboard.
*/
public Builder setDescription(EmptyParam description) {
this.description = description;
return this;
}
/**
* The date on which payment for this invoice is due. Only valid for invoices where {@code
* collection_method=send_invoice}. This field can only be updated on {@code draft} invoices.
*/
public Builder setDueDate(Long dueDate) {
this.dueDate = dueDate;
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
* InvoiceUpdateParams#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
* InvoiceUpdateParams#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
* InvoiceUpdateParams#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 InvoiceUpdateParams#extraParams} for the field documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/**
* Footer to be displayed on the invoice.
*/
public Builder setFooter(String footer) {
this.footer = footer;
return this;
}
/**
* Footer to be displayed on the invoice.
*/
public Builder setFooter(EmptyParam footer) {
this.footer = footer;
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
* InvoiceUpdateParams#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 InvoiceUpdateParams#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;
}
/**
* Extra information about a charge for the customer's credit card statement. It must contain at
* least one letter. If not specified and this invoice is part of a subscription, the default
* {@code statement_descriptor} will be set to the first subscription item's product's {@code
* statement_descriptor}.
*/
public Builder setStatementDescriptor(String statementDescriptor) {
this.statementDescriptor = statementDescriptor;
return this;
}
/**
* Extra information about a charge for the customer's credit card statement. It must contain at
* least one letter. If not specified and this invoice is part of a subscription, the default
* {@code statement_descriptor} will be set to the first subscription item's product's {@code
* statement_descriptor}.
*/
public Builder setStatementDescriptor(EmptyParam statementDescriptor) {
this.statementDescriptor = statementDescriptor;
return this;
}
/**
* The percent tax rate applied to the invoice, represented as a non-negative decimal number
* (with at most four decimal places) between 0 and 100. To unset a previously-set value, pass
* an empty string. This field can be updated only on {@code draft} invoices. This field has
* been deprecated and will be removed in a future API version, for further information view the
* migration docs for {@code
* tax_rates}.
*/
public Builder setTaxPercent(BigDecimal taxPercent) {
this.taxPercent = taxPercent;
return this;
}
/**
* The percent tax rate applied to the invoice, represented as a non-negative decimal number
* (with at most four decimal places) between 0 and 100. To unset a previously-set value, pass
* an empty string. This field can be updated only on {@code draft} invoices. This field has
* been deprecated and will be removed in a future API version, for further information view the
* migration docs for {@code
* tax_rates}.
*/
public Builder setTaxPercent(EmptyParam taxPercent) {
this.taxPercent = taxPercent;
return this;
}
/**
* If specified, the funds from the invoice will be transferred to the destination and the ID of
* the resulting transfer will be found on the invoice's charge. This will be unset if you POST
* an empty value.
*/
public Builder setTransferData(TransferData transferData) {
this.transferData = transferData;
return this;
}
/**
* If specified, the funds from the invoice will be transferred to the destination and the ID of
* the resulting transfer will be found on the invoice's charge. This will be unset if you POST
* an empty value.
*/
public Builder setTransferData(EmptyParam transferData) {
this.transferData = transferData;
return this;
}
}
public static class CustomField {
/**
* 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 name of the custom field. This may be up to 30 characters.
*/
@SerializedName("name")
Object name;
/**
* The value of the custom field. This may be up to 30 characters.
*/
@SerializedName("value")
Object value;
private CustomField(Map extraParams, Object name, Object value) {
this.extraParams = extraParams;
this.name = name;
this.value = value;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Map extraParams;
private Object name;
private Object value;
/** Finalize and obtain parameter instance from this builder. */
public CustomField build() {
return new CustomField(this.extraParams, this.name, 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
* InvoiceUpdateParams.CustomField#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 InvoiceUpdateParams.CustomField#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 name of the custom field. This may be up to 30 characters. */
public Builder setName(String name) {
this.name = name;
return this;
}
/** The name of the custom field. This may be up to 30 characters. */
public Builder setName(EmptyParam name) {
this.name = name;
return this;
}
/** The value of the custom field. This may be up to 30 characters. */
public Builder setValue(String value) {
this.value = value;
return this;
}
public Builder setValue(EmptyParam value) {
this.value = value;
return this;
}
}
/**
* Map of extra parameters for custom features not available in this client library. The content
* in this map is not serialized under this field's {@code @SerializedName} value. Instead, each
* key/value pair is serialized as if the key is a root-level field (serialized) name in this
* param object. Effectively, this map is flattened to its parent instance.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Map getExtraParams() {
return this.extraParams;
}
/**
* The name of the custom field. This may be up to 30 characters.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Object getName() {
return this.name;
}
/**
* The value of the custom field. This may be up to 30 characters.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Object getValue() {
return this.value;
}
}
/**
* The value of the custom field. This may be up to 30 characters.
*/
public static class TransferData {
/**
* The amount that will be transferred automatically when the invoice is paid. If no amount is
* set, the full amount is transferred.
*/
@SerializedName("amount")
Long amount;
/**
* ID of an existing, connected Stripe account.
*/
@SerializedName("destination")
Object destination;
/**
* Map of extra parameters for custom features not available in this client library. The content
* in this map is not serialized under this field's {@code @SerializedName} value. Instead, each
* key/value pair is serialized as if the key is a root-level field (serialized) name in this
* param object. Effectively, this map is flattened to its parent instance.
*/
@SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY)
Map extraParams;
private TransferData(Long amount, Object destination, Map extraParams) {
this.amount = amount;
this.destination = destination;
this.extraParams = extraParams;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Long amount;
private Object destination;
private Map extraParams;
/** Finalize and obtain parameter instance from this builder. */
public TransferData build() {
return new TransferData(this.amount, this.destination, this.extraParams);
}
/**
* The amount that will be transferred automatically when the invoice is paid. If no amount is
* set, the full amount is transferred.
*/
public Builder setAmount(Long amount) {
this.amount = amount;
return this;
}
/** ID of an existing, connected Stripe account. */
public Builder setDestination(String destination) {
this.destination = destination;
return this;
}
/** ID of an existing, connected Stripe account. */
public Builder setDestination(EmptyParam destination) {
this.destination = destination;
return this;
}
/**
* Add a key/value pair to `extraParams` map. A map is initialized for the first `put/putAll`
* call, and subsequent calls add additional key/value pairs to the original map. See {@link
* InvoiceUpdateParams.TransferData#extraParams} for the field documentation.
*/
public Builder putExtraParam(String key, Object value) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.put(key, value);
return this;
}
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
}
/**
* The amount that will be transferred automatically when the invoice is paid. If no amount is
* set, the full amount is transferred.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Long getAmount() {
return this.amount;
}
/**
* ID of an existing, connected Stripe account.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Object getDestination() {
return this.destination;
}
/**
* Map of extra parameters for custom features not available in this client library. The content
* in this map is not serialized under this field's {@code @SerializedName} value. Instead, each
* key/value pair is serialized as if the key is a root-level field (serialized) name in this
* param object. Effectively, this map is flattened to its parent instance.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Map getExtraParams() {
return this.extraParams;
}
}
/**
* 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 InvoiceUpdateParams.TransferData#extraParams} for the field documentation.
*/
public enum CollectionMethod implements ApiRequestParams.EnumParam {
@SerializedName("charge_automatically")
CHARGE_AUTOMATICALLY("charge_automatically"), @SerializedName("send_invoice")
SEND_INVOICE("send_invoice");
private final String value;
CollectionMethod(String value) {
this.value = value;
}
@Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getValue() {
return this.value;
}
}
/**
* A fee in %s that will be applied to the invoice and transferred to the application owner's
* Stripe account. The request must be made with an OAuth key or the Stripe-Account header in
* order to take an application fee. For more information, see the application fees documentation.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Long getApplicationFeeAmount() {
return this.applicationFeeAmount;
}
/**
* Controls whether Stripe will perform automatic collection
* of the invoice.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Boolean getAutoAdvance() {
return this.autoAdvance;
}
/**
* Either {@code charge_automatically} or {@code send_invoice}. This field can be updated only on
* {@code draft} invoices.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public CollectionMethod getCollectionMethod() {
return this.collectionMethod;
}
/**
* A list of up to 4 custom fields to be displayed on the invoice. If a value for {@code
* custom_fields} is specified, the list specified will replace the existing custom field list on
* this invoice. Pass an empty string to remove previously-defined fields.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Object getCustomFields() {
return this.customFields;
}
/**
* The number of days from which the invoice is created until it is due. Only valid for invoices
* where {@code collection_method=send_invoice}. This field can only be updated on {@code draft}
* invoices.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Long getDaysUntilDue() {
return this.daysUntilDue;
}
/**
* ID of the default payment method for the invoice. It must belong to the customer associated
* with the invoice. If not set, defaults to the subscription's default payment method, if any, or
* to the default payment method in the customer's invoice settings.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Object getDefaultPaymentMethod() {
return this.defaultPaymentMethod;
}
/**
* ID of the default payment source for the invoice. It must belong to the customer associated
* with the invoice and be in a chargeable state. If not set, defaults to the subscription's
* default source, if any, or to the customer's default source.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Object getDefaultSource() {
return this.defaultSource;
}
/**
* The tax rates that will apply to any line item that does not have {@code tax_rates} set. Pass
* an empty string to remove previously-defined tax rates.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Object getDefaultTaxRates() {
return this.defaultTaxRates;
}
/**
* An arbitrary string attached to the object. Often useful for displaying to users. Referenced as
* 'memo' in the Dashboard.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Object getDescription() {
return this.description;
}
/**
* The date on which payment for this invoice is due. Only valid for invoices where {@code
* collection_method=send_invoice}. This field can only be updated on {@code draft} invoices.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Long getDueDate() {
return this.dueDate;
}
/**
* Specifies which fields in the response should be expanded.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public List getExpand() {
return this.expand;
}
/**
* Map of extra parameters for custom features not available in this client library. The content
* in this map is not serialized under this field's {@code @SerializedName} value. Instead, each
* key/value pair is serialized as if the key is a root-level field (serialized) name in this
* param object. Effectively, this map is flattened to its parent instance.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Map getExtraParams() {
return this.extraParams;
}
/**
* Footer to be displayed on the invoice.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Object getFooter() {
return this.footer;
}
/**
* Set of key-value pairs that you can attach to an object. This can be useful for storing
* additional information about the object in a structured format. Individual keys can be unset by
* posting an empty value to them. All keys can be unset by posting an empty value to {@code
* metadata}.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Object getMetadata() {
return this.metadata;
}
/**
* Extra information about a charge for the customer's credit card statement. It must contain at
* least one letter. If not specified and this invoice is part of a subscription, the default
* {@code statement_descriptor} will be set to the first subscription item's product's {@code
* statement_descriptor}.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Object getStatementDescriptor() {
return this.statementDescriptor;
}
/**
* The percent tax rate applied to the invoice, represented as a non-negative decimal number (with
* at most four decimal places) between 0 and 100. To unset a previously-set value, pass an empty
* string. This field can be updated only on {@code draft} invoices. This field has been
* deprecated and will be removed in a future API version, for further information view the migration docs for {@code
* tax_rates}.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Object getTaxPercent() {
return this.taxPercent;
}
/**
* If specified, the funds from the invoice will be transferred to the destination and the ID of
* the resulting transfer will be found on the invoice's charge. This will be unset if you POST an
* empty value.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Object getTransferData() {
return this.transferData;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy