Package com.stripe.param
Class SubscriptionItemUpdateParams.Builder
java.lang.Object
com.stripe.param.SubscriptionItemUpdateParams.Builder
- Enclosing class:
- SubscriptionItemUpdateParams
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionAdd all elements to `discounts` list.addAllExpand(List<String> elements) Add all elements to `expand` list.addAllTaxRate(List<String> elements) Add all elements to `taxRates` list.Add an element to `discounts` list.Add an element to `expand` list.addTaxRate(String element) Add an element to `taxRates` list.build()Finalize and obtain parameter instance from this builder.putAllExtraParam(Map<String, Object> map) Add all map key/value pairs to `extraParams` map.putAllMetadata(Map<String, String> map) Add all map key/value pairs to `metadata` map.putExtraParam(String key, Object value) Add a key/value pair to `extraParams` map.putMetadata(String key, String value) Add a key/value pair to `metadata` map.setBillingThresholds(EmptyParam billingThresholds) Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period.setBillingThresholds(SubscriptionItemUpdateParams.BillingThresholds billingThresholds) Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period.setDiscounts(EmptyParam discounts) The coupons to redeem into discounts for the subscription item.setDiscounts(List<SubscriptionItemUpdateParams.Discount> discounts) The coupons to redeem into discounts for the subscription item.setMetadata(EmptyParam metadata) Set of key-value pairs that you can attach to an object.setMetadata(Map<String, String> metadata) Set of key-value pairs that you can attach to an object.setOffSession(Boolean offSession) Indicates if a customer is on or off-session while an invoice payment is attempted.setPaymentBehavior(SubscriptionItemUpdateParams.PaymentBehavior paymentBehavior) Controls how Stripe handles payment when a subscription update requires payment andcollection_method=charge_automatically.setPlan(EmptyParam plan) The identifier of the new plan for this subscription item.The identifier of the new plan for this subscription item.setPrice(EmptyParam price) The ID of the price object.The ID of the price object.Data used to generate a new Price object inline.setProrationBehavior(SubscriptionItemUpdateParams.ProrationBehavior prorationBehavior) 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'squantitychanges.setProrationDate(Long prorationDate) If set, the proration will be calculated as though the subscription was updated at the given time.setQuantity(Long quantity) The quantity you'd like to apply to the subscription item you're creating.setTaxRates(EmptyParam taxRates) A list of Tax Rate ids.setTaxRates(List<String> taxRates) A list of Tax Rate ids.
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
build
Finalize and obtain parameter instance from this builder. -
setBillingThresholds
public SubscriptionItemUpdateParams.Builder setBillingThresholds(SubscriptionItemUpdateParams.BillingThresholds billingThresholds) 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. -
setBillingThresholds
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. -
addDiscount
public SubscriptionItemUpdateParams.Builder addDiscount(SubscriptionItemUpdateParams.Discount element) 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. SeeSubscriptionItemUpdateParams.discountsfor the field documentation. -
addAllDiscount
public SubscriptionItemUpdateParams.Builder addAllDiscount(List<SubscriptionItemUpdateParams.Discount> elements) 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. SeeSubscriptionItemUpdateParams.discountsfor the field documentation. -
setDiscounts
The coupons to redeem into discounts for the subscription item. -
setDiscounts
public SubscriptionItemUpdateParams.Builder setDiscounts(List<SubscriptionItemUpdateParams.Discount> discounts) The coupons to redeem into discounts for the subscription item. -
addExpand
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. SeeSubscriptionItemUpdateParams.expandfor the field documentation. -
addAllExpand
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. SeeSubscriptionItemUpdateParams.expandfor the field documentation. -
putExtraParam
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. SeeSubscriptionItemUpdateParams.extraParamsfor the field documentation. -
putAllExtraParam
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. SeeSubscriptionItemUpdateParams.extraParamsfor the field documentation. -
putMetadata
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. SeeSubscriptionItemUpdateParams.metadatafor the field documentation. -
putAllMetadata
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. SeeSubscriptionItemUpdateParams.metadatafor the field documentation. -
setMetadata
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. -
setMetadata
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. -
setOffSession
Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults tofalse(on-session). -
setPaymentBehavior
public SubscriptionItemUpdateParams.Builder setPaymentBehavior(SubscriptionItemUpdateParams.PaymentBehavior paymentBehavior) Controls how Stripe handles payment when a subscription update requires payment andcollection_method=charge_automatically. -
setPlan
The identifier of the new plan for this subscription item. -
setPlan
The identifier of the new plan for this subscription item. -
setPrice
The ID of the price object. One ofpriceorprice_datais required. When changing a subscription item's price,quantityis set to 1 unless aquantityparameter is provided. -
setPrice
The ID of the price object. One ofpriceorprice_datais required. When changing a subscription item's price,quantityis set to 1 unless aquantityparameter is provided. -
setPriceData
public SubscriptionItemUpdateParams.Builder setPriceData(SubscriptionItemUpdateParams.PriceData priceData) -
setProrationBehavior
public SubscriptionItemUpdateParams.Builder setProrationBehavior(SubscriptionItemUpdateParams.ProrationBehavior prorationBehavior) 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'squantitychanges. The default value iscreate_prorations. -
setProrationDate
If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the upcoming invoice endpoint. -
setQuantity
The quantity you'd like to apply to the subscription item you're creating. -
addTaxRate
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. SeeSubscriptionItemUpdateParams.taxRatesfor the field documentation. -
addAllTaxRate
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. SeeSubscriptionItemUpdateParams.taxRatesfor the field documentation. -
setTaxRates
A list of Tax Rate ids. These Tax Rates will override thedefault_tax_rateson the Subscription. When updating, pass an empty string to remove previously-defined tax rates. -
setTaxRates
A list of Tax Rate ids. These Tax Rates will override thedefault_tax_rateson the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
-