Class SubscriptionUpdateParams
- java.lang.Object
-
- com.stripe.net.ApiRequestParams
-
- com.stripe.param.SubscriptionUpdateParams
-
public class SubscriptionUpdateParams extends ApiRequestParams
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
SubscriptionUpdateParams.AddInvoiceItem
static class
SubscriptionUpdateParams.AutomaticTax
Same asunit_amount
, but accepts a decimal value in %s with at most 12 decimal places.static class
SubscriptionUpdateParams.BillingCycleAnchor
Add all map key/value pairs to `extraParams` map.static class
SubscriptionUpdateParams.BillingThresholds
Add all map key/value pairs to `extraParams` map.static class
SubscriptionUpdateParams.Builder
static class
SubscriptionUpdateParams.CollectionMethod
static class
SubscriptionUpdateParams.Item
Indicates if thebilling_cycle_anchor
should be reset when a threshold is reached.static class
SubscriptionUpdateParams.PauseCollection
The number of intervals between subscription billings.static class
SubscriptionUpdateParams.PaymentBehavior
static class
SubscriptionUpdateParams.PaymentSettings
static class
SubscriptionUpdateParams.PendingInvoiceItemInterval
static class
SubscriptionUpdateParams.ProrationBehavior
static class
SubscriptionUpdateParams.TransferData
static class
SubscriptionUpdateParams.TrialEnd
-
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 SubscriptionUpdateParams.Builder
builder()
java.util.List<SubscriptionUpdateParams.AddInvoiceItem>
getAddInvoiceItems()
A list of prices and quantities that will generate invoice items appended to the first invoice for this subscription.java.math.BigDecimal
getApplicationFeePercent()
A non-negative decimal between 0 and 100, with at most two decimal places.SubscriptionUpdateParams.AutomaticTax
getAutomaticTax()
Automatic tax settings for this subscription.SubscriptionUpdateParams.BillingCycleAnchor
getBillingCycleAnchor()
Eithernow
orunchanged
.java.lang.Object
getBillingThresholds()
Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period.java.lang.Object
getCancelAt()
A timestamp at which the subscription should cancel.java.lang.Boolean
getCancelAtPeriodEnd()
Boolean indicating whether this subscription should cancel at the end of the current period.SubscriptionUpdateParams.CollectionMethod
getCollectionMethod()
Eithercharge_automatically
, orsend_invoice
.java.lang.Object
getCoupon()
The ID of the coupon to apply to this subscription.java.lang.Long
getDaysUntilDue()
Number of days a customer has to pay invoices generated by this subscription.java.lang.Object
getDefaultPaymentMethod()
ID of the default payment method for the subscription.java.lang.Object
getDefaultSource()
ID of the default payment source for the subscription.java.lang.Object
getDefaultTaxRates()
The tax rates that will apply to any subscription item that does not havetax_rates
set.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.util.List<SubscriptionUpdateParams.Item>
getItems()
A list of up to 20 subscription items, each with an attached price.java.lang.Object
getMetadata()
Set of key-value pairs that you can attach to an object.java.lang.Boolean
getOffSession()
Indicates if a customer is on or off-session while an invoice payment is attempted.java.lang.Object
getPauseCollection()
If specified, payment collection for this subscription will be paused.SubscriptionUpdateParams.PaymentBehavior
getPaymentBehavior()
Useallow_incomplete
to transition the subscription tostatus=past_due
if a payment is required but cannot be paid.SubscriptionUpdateParams.PaymentSettings
getPaymentSettings()
Payment settings to pass to invoices created by the subscription.java.lang.Object
getPendingInvoiceItemInterval()
Specifies an interval for how often to bill for any pending invoice items.java.lang.Object
getPromotionCode()
The promotion code to apply to this subscription.SubscriptionUpdateParams.ProrationBehavior
getProrationBehavior()
Determines how to handle prorations when the billing cycle changes (e.g., when switching plans, resettingbilling_cycle_anchor=now
, or starting a trial), or if an item'squantity
changes.java.lang.Long
getProrationDate()
If set, the proration will be calculated as though the subscription was updated at the given time.java.lang.Object
getTransferData()
If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges.java.lang.Object
getTrialEnd()
Unix timestamp representing the end of the trial period the customer will get before being charged for the first time.java.lang.Boolean
getTrialFromPlan()
Indicates if a plan'strial_period_days
should be applied to the subscription.-
Methods inherited from class com.stripe.net.ApiRequestParams
toMap
-
-
-
-
Method Detail
-
builder
public static SubscriptionUpdateParams.Builder builder()
-
getAddInvoiceItems
public java.util.List<SubscriptionUpdateParams.AddInvoiceItem> getAddInvoiceItems()
A list of prices and quantities that will generate invoice items appended to the first invoice for this subscription. You may pass up to 20 items.
-
getApplicationFeePercent
public java.math.BigDecimal getApplicationFeePercent()
A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees documentation.
-
getAutomaticTax
public SubscriptionUpdateParams.AutomaticTax getAutomaticTax()
Automatic tax settings for this subscription.
-
getBillingCycleAnchor
public SubscriptionUpdateParams.BillingCycleAnchor getBillingCycleAnchor()
Eithernow
orunchanged
. Setting the value tonow
resets the subscription's billing cycle anchor to the current time. For more information, see the billing cycle documentation.
-
getBillingThresholds
public java.lang.Object getBillingThresholds()
Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds.
-
getCancelAt
public java.lang.Object getCancelAt()
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 usingproration_behavior
. If set during a future period, this will always cause a proration for that period.
-
getCancelAtPeriodEnd
public java.lang.Boolean getCancelAtPeriodEnd()
Boolean indicating whether this subscription should cancel at the end of the current period.
-
getCollectionMethod
public SubscriptionUpdateParams.CollectionMethod getCollectionMethod()
Eithercharge_automatically
, orsend_invoice
. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions. Defaults tocharge_automatically
.
-
getCoupon
public java.lang.Object getCoupon()
The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription.
-
getDaysUntilDue
public java.lang.Long getDaysUntilDue()
Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions wherecollection_method
is set tosend_invoice
.
-
getDefaultPaymentMethod
public java.lang.Object getDefaultPaymentMethod()
ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence overdefault_source
. If neither are set, invoices will use the customer's invoice_settings.default_payment_method or default_source.
-
getDefaultSource
public java.lang.Object getDefaultSource()
ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. Ifdefault_payment_method
is also set,default_payment_method
will take precedence. If neither are set, invoices will use the customer's invoice_settings.default_payment_method or default_source.
-
getDefaultTaxRates
public java.lang.Object getDefaultTaxRates()
The tax rates that will apply to any subscription item that does not havetax_rates
set. Invoices created will have theirdefault_tax_rates
populated from the subscription. Pass an empty string to remove previously-defined tax rates.
-
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.
-
getItems
public java.util.List<SubscriptionUpdateParams.Item> getItems()
A list of up to 20 subscription items, each with an attached price.
-
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
.
-
getOffSession
public java.lang.Boolean getOffSession()
Indicates if a customer is on or off-session while an invoice payment is attempted.
-
getPauseCollection
public java.lang.Object getPauseCollection()
If specified, payment collection for this subscription will be paused.
-
getPaymentBehavior
public SubscriptionUpdateParams.PaymentBehavior getPaymentBehavior()
Useallow_incomplete
to transition the subscription tostatus=past_due
if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the SCA Migration Guide for Billing to learn more. This is the default behavior.Use
default_incomplete
to transition the subscription tostatus=past_due
when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, SCA regulation, or collecting a mandate for a bank debit payment method.Use
pending_if_incomplete
to update the subscription using pending updates. When you usepending_if_incomplete
you can only pass the parameters supported by pending updates.Use
error_if_incomplete
if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the changelog to learn more.
-
getPaymentSettings
public SubscriptionUpdateParams.PaymentSettings getPaymentSettings()
Payment settings to pass to invoices created by the subscription.
-
getPendingInvoiceItemInterval
public java.lang.Object getPendingInvoiceItemInterval()
Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling Create an invoice for the given subscription at the specified interval.
-
getPromotionCode
public java.lang.Object getPromotionCode()
The promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription.
-
getProrationBehavior
public SubscriptionUpdateParams.ProrationBehavior getProrationBehavior()
Determines how to handle prorations when the billing cycle changes (e.g., when switching plans, resettingbilling_cycle_anchor=now
, or starting a trial), or if an item'squantity
changes. Valid values arecreate_prorations
,none
, oralways_invoice
.Passing
create_prorations
will cause proration invoice items to be created when applicable. These proration items will only be invoiced immediately under certain conditions. In order to always invoice immediately for prorations, passalways_invoice
.Prorations can be disabled by passing
none
.
-
getProrationDate
public java.lang.Long getProrationDate()
If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply exactly the same proration that was previewed with upcoming invoice endpoint. It can also be used to implement custom proration logic, such as prorating by day instead of by second, by providing the time that you wish to use for proration calculations.
-
getTransferData
public java.lang.Object getTransferData()
If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges. This will be unset if you POST an empty value.
-
getTrialEnd
public java.lang.Object getTrialEnd()
Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special valuenow
can be provided to end the customer's trial immediately. Can be at most two years frombilling_cycle_anchor
.
-
getTrialFromPlan
public java.lang.Boolean getTrialFromPlan()
Indicates if a plan'strial_period_days
should be applied to the subscription. Settingtrial_end
per subscription is preferred, and this defaults tofalse
. Setting this flag totrue
together withtrial_end
is not allowed. See Using trial periods on subscriptions to learn more.
-
-