com.stripe.param

Class InvoiceUpdateParams

java.lang.Object

com.stripe.net.ApiRequestParams

com.stripe.param.InvoiceUpdateParams

public class InvoiceUpdateParams
extends ApiRequestParams

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	InvoiceUpdateParams.Builder
static class	InvoiceUpdateParams.CollectionMethod Add all map key/value pairs to `extraParams` map.
static class	InvoiceUpdateParams.CustomField
static class	InvoiceUpdateParams.TransferData The value of the custom field.

Nested classes/interfaces inherited from class com.stripe.net.ApiRequestParams

ApiRequestParams.EnumParam

Field Summary

Fields inherited from class com.stripe.net.ApiRequestParams

EXTRA_PARAMS_KEY

Method Summary

Modifier and Type	Method and Description
static InvoiceUpdateParams.Builder	builder()
java.lang.Long	getApplicationFeeAmount() A fee in %s that will be applied to the invoice and transferred to the application owner's Stripe account.
java.lang.Boolean	getAutoAdvance() Controls whether Stripe will perform [automatic collection](https://stripe.com/docs/billing/invoices/workflow/#auto_advance) of the invoice.
InvoiceUpdateParams.CollectionMethod	getCollectionMethod() Either `charge_automatically` or `send_invoice`.
java.lang.Object	getCustomFields() A list of up to 4 custom fields to be displayed on the invoice.
java.lang.Long	getDaysUntilDue() The number of days from which the invoice is created until it is due.
java.lang.Object	getDefaultPaymentMethod() ID of the default payment method for the invoice.
java.lang.Object	getDefaultSource() ID of the default payment source for the invoice.
java.lang.Object	getDefaultTaxRates() The tax rates that will apply to any line item that does not have `tax_rates` set.
java.lang.Object	getDescription()
java.lang.Long	getDueDate() The date on which payment for this invoice is due.
java.util.List<java.lang.String>	getExpand() Specifies which fields in the response should be expanded.
java.util.Map<java.lang.String,java.lang.Object>	getExtraParams() Map of extra parameters for custom features not available in this client library.
java.lang.Object	getFooter() Footer to be displayed on the invoice.
java.util.Map<java.lang.String,java.lang.String>	getMetadata()
java.lang.Object	getStatementDescriptor() Extra information about a charge for the customer's credit card statement.
java.lang.Object	getTaxPercent() 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.
java.lang.Object	getTransferData() 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.

Methods inherited from class com.stripe.net.ApiRequestParams

toMap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static InvoiceUpdateParams.Builder builder()

getApplicationFeeAmount

public java.lang.Long getApplicationFeeAmount()

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](https://stripe.com/docs/connect/subscriptions#invoices).

getAutoAdvance

public java.lang.Boolean getAutoAdvance()

Controls whether Stripe will perform [automatic collection](https://stripe.com/docs/billing/invoices/workflow/#auto_advance) of the invoice.

getCollectionMethod

public InvoiceUpdateParams.CollectionMethod getCollectionMethod()

Either `charge_automatically` or `send_invoice`. This field can be updated only on `draft` invoices.

getCustomFields

public java.lang.Object getCustomFields()

A list of up to 4 custom fields to be displayed on the invoice. If a value for `custom_fields` is specified, the list specified will replace the existing custom field list on this invoice.

getDaysUntilDue

public java.lang.Long getDaysUntilDue()

The number of days from which the invoice is created until it is due. Only valid for invoices where `collection_method=send_invoice`. This field can only be updated on `draft` invoices.

getDefaultPaymentMethod

public java.lang.Object getDefaultPaymentMethod()

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.

getDefaultSource

public java.lang.Object getDefaultSource()

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.

getDefaultTaxRates

public java.lang.Object getDefaultTaxRates()

The tax rates that will apply to any line item that does not have `tax_rates` set. Pass an empty string to remove previously-set default tax rates.

getDescription

public java.lang.Object getDescription()

getDueDate

public java.lang.Long getDueDate()

The date on which payment for this invoice is due. Only valid for invoices where `collection_method=send_invoice`. This field can only be updated on `draft` invoices.

getExpand

public java.util.List<java.lang.String> getExpand()

Specifies which fields in the response should be expanded.

getExtraParams

public java.util.Map<java.lang.String,java.lang.Object> getExtraParams()

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

getFooter

public java.lang.Object getFooter()

Footer to be displayed on the invoice.

getMetadata

public java.util.Map<java.lang.String,java.lang.String> getMetadata()

getStatementDescriptor

public java.lang.Object getStatementDescriptor()

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 `statement_descriptor` will be set to the first subscription item's product's `statement_descriptor`.

getTaxPercent

public java.lang.Object getTaxPercent()

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 `draft` invoices. This field has been deprecated and will be removed in a future API version, for further information view the [migration docs](https://stripe.com/docs/billing/migration/taxes) for `tax_rates`.

getTransferData

public java.lang.Object getTransferData()

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.