Package com.stripe.param
Class InvoiceCreateParams
- java.lang.Object
-
- com.stripe.net.ApiRequestParams
-
- com.stripe.param.InvoiceCreateParams
-
public class InvoiceCreateParams extends ApiRequestParams
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
InvoiceCreateParams.AutomaticTax
static class
InvoiceCreateParams.Builder
static class
InvoiceCreateParams.CollectionMethod
Add all map key/value pairs to `extraParams` map.static class
InvoiceCreateParams.CustomField
Add all map key/value pairs to `extraParams` map.static class
InvoiceCreateParams.Discount
The value of the custom field.static class
InvoiceCreateParams.PaymentSettings
Add all map key/value pairs to `extraParams` map.static class
InvoiceCreateParams.TransferData
-
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
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static InvoiceCreateParams.Builder
builder()
java.lang.Object
getAccountTaxIds()
The account tax IDs associated with the invoice.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 of the invoice.InvoiceCreateParams.AutomaticTax
getAutomaticTax()
Settings for automatic tax lookup for this invoice.InvoiceCreateParams.CollectionMethod
getCollectionMethod()
Eithercharge_automatically
, orsend_invoice
.java.lang.String
getCustomer()
The ID of the customer who will be billed.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 when the invoice is created until it is due.java.lang.String
getDefaultPaymentMethod()
ID of the default payment method for the invoice.java.lang.String
getDefaultSource()
ID of the default payment source for the invoice.java.util.List<java.lang.String>
getDefaultTaxRates()
The tax rates that will apply to any line item that does not havetax_rates
set.java.lang.String
getDescription()
An arbitrary string attached to the object.java.lang.Object
getDiscounts()
The coupons to redeem into discounts for the invoice.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.String
getFooter()
Footer to be displayed on the invoice.java.lang.Object
getMetadata()
Set of key-value pairs that you can attach to an object.java.lang.String
getOnBehalfOf()
The account (if any) for which the funds of the invoice payment are intended.InvoiceCreateParams.PaymentSettings
getPaymentSettings()
Configuration settings for the PaymentIntent that is generated when the invoice is finalized.java.lang.String
getStatementDescriptor()
Extra information about a charge for the customer's credit card statement.java.lang.String
getSubscription()
The ID of the subscription to invoice, if any.InvoiceCreateParams.TransferData
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
-
-
-
-
Method Detail
-
builder
public static InvoiceCreateParams.Builder builder()
-
getAccountTaxIds
public java.lang.Object getAccountTaxIds()
The account tax IDs associated with the invoice. Only editable when the invoice is a draft.
-
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.
-
getAutoAdvance
public java.lang.Boolean getAutoAdvance()
Controls whether Stripe will perform automatic collection of the invoice. Whenfalse
, the invoice's state will not automatically advance without an explicit action.
-
getAutomaticTax
public InvoiceCreateParams.AutomaticTax getAutomaticTax()
Settings for automatic tax lookup for this invoice.
-
getCollectionMethod
public InvoiceCreateParams.CollectionMethod getCollectionMethod()
Eithercharge_automatically
, orsend_invoice
. When charging automatically, Stripe will attempt to pay this invoice using the default source attached to the customer. When sending an invoice, Stripe will email this invoice to the customer with payment instructions. Defaults tocharge_automatically
.
-
getCustomFields
public java.lang.Object getCustomFields()
A list of up to 4 custom fields to be displayed on the invoice.
-
getCustomer
public java.lang.String getCustomer()
The ID of the customer who will be billed.
-
getDaysUntilDue
public java.lang.Long getDaysUntilDue()
The number of days from when the invoice is created until it is due. Valid only for invoices wherecollection_method=send_invoice
.
-
getDefaultPaymentMethod
public java.lang.String 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.String 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.util.List<java.lang.String> getDefaultTaxRates()
The tax rates that will apply to any line item that does not havetax_rates
set.
-
getDescription
public java.lang.String getDescription()
An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard.
-
getDiscounts
public java.lang.Object getDiscounts()
The coupons to redeem into discounts for the invoice. If not specified, inherits the discount from the invoice's customer. Pass an empty string to avoid inheriting any discounts.
-
getDueDate
public java.lang.Long getDueDate()
The date on which payment for this invoice is due. Valid only for invoices wherecollection_method=send_invoice
.
-
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.String getFooter()
Footer to be displayed on the invoice.
-
getMetadata
public java.lang.Object getMetadata()
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 tometadata
.
-
getOnBehalfOf
public java.lang.String getOnBehalfOf()
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.
-
getPaymentSettings
public InvoiceCreateParams.PaymentSettings getPaymentSettings()
Configuration settings for the PaymentIntent that is generated when the invoice is finalized.
-
getStatementDescriptor
public java.lang.String 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 defaultstatement_descriptor
will be set to the first subscription item's product'sstatement_descriptor
.
-
getSubscription
public java.lang.String getSubscription()
The ID of the subscription to invoice, if any. If not set, the created invoice will include all pending invoice items for the customer. If set, the created invoice will only include pending invoice items for that subscription and pending invoice items not associated with any subscription. The subscription's billing cycle and regular subscription events won't be affected.
-
getTransferData
public InvoiceCreateParams.TransferData 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.
-
-