SubscriptionUpdateParams.Builder (stripe-java 9.9.0 API)

java.lang.Object
- com.stripe.param.SubscriptionUpdateParams.Builder

Enclosing class:: SubscriptionUpdateParams

public static class SubscriptionUpdateParams.Builder
extends java.lang.Object

Constructor Summary

Constructors
Constructor and Description

Builder()

Constructors
Constructor and Description
`Builder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SubscriptionUpdateParams.Builder`	`addAllExpand(java.util.List<java.lang.String> elements)` Add all elements to `expand` list.
`SubscriptionUpdateParams.Builder`	`addAllItem(java.util.List<SubscriptionUpdateParams.Item> elements)` Add all elements to `items` list.
`SubscriptionUpdateParams.Builder`	`addExpand(java.lang.String element)` Add an element to `expand` list.
`SubscriptionUpdateParams.Builder`	`addItem(SubscriptionUpdateParams.Item element)` Add an element to `items` list.
`SubscriptionUpdateParams`	`build()` Finalize and obtain parameter instance from this builder.
`SubscriptionUpdateParams.Builder`	`putAllMetadata(java.util.Map<java.lang.String,java.lang.String> map)` Add all map key/value pairs to `metadata` map.
`SubscriptionUpdateParams.Builder`	`putMetadata(java.lang.String key, java.lang.String value)` Add a key/value pair to `metadata` map.
`SubscriptionUpdateParams.Builder`	`setApplicationFeePercent(java.math.BigDecimal applicationFeePercent)` A non-negative decimal between 0 and 100, with at most two decimal places.
`SubscriptionUpdateParams.Builder`	`setBilling(SubscriptionUpdateParams.Billing billing)` Either `charge_automatically`, or `send_invoice`.
`SubscriptionUpdateParams.Builder`	`setBillingCycleAnchor(SubscriptionUpdateParams.BillingCycleAnchor billingCycleAnchor)` Either `now` or `unchanged`.
`SubscriptionUpdateParams.Builder`	`setBillingThresholds(EmptyParam billingThresholds)` Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period.
`SubscriptionUpdateParams.Builder`	`setBillingThresholds(SubscriptionUpdateParams.BillingThresholds billingThresholds)` Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period.
`SubscriptionUpdateParams.Builder`	`setCancelAt(EmptyParam cancelAt)` A timestamp at which the subscription should cancel.
`SubscriptionUpdateParams.Builder`	`setCancelAt(java.lang.Long cancelAt)` A timestamp at which the subscription should cancel.
`SubscriptionUpdateParams.Builder`	`setCancelAtPeriodEnd(java.lang.Boolean cancelAtPeriodEnd)` Boolean indicating whether this subscription should cancel at the end of the current period.
`SubscriptionUpdateParams.Builder`	`setCoupon(java.lang.String coupon)` The code of the coupon to apply to this subscription.
`SubscriptionUpdateParams.Builder`	`setDaysUntilDue(java.lang.Long daysUntilDue)` Number of days a customer has to pay invoices generated by this subscription.
`SubscriptionUpdateParams.Builder`	`setDefaultPaymentMethod(java.lang.String defaultPaymentMethod)` ID of the default payment method for the subscription.
`SubscriptionUpdateParams.Builder`	`setDefaultSource(java.lang.String defaultSource)` ID of the default payment source for the subscription.
`SubscriptionUpdateParams.Builder`	`setDefaultTaxRates(EmptyParam defaultTaxRates)` The tax rates that will apply to any subscription item that does not have `tax_rates` set.
`SubscriptionUpdateParams.Builder`	`setDefaultTaxRates(java.util.List<java.lang.String> defaultTaxRates)` The tax rates that will apply to any subscription item that does not have `tax_rates` set.
`SubscriptionUpdateParams.Builder`	`setProrate(java.lang.Boolean prorate)` Boolean (defaults to `true`) telling us whether to [credit for unused time](https://stripe.com/docs/subscriptions/billing-cycle#prorations) when the billing cycle changes (e.g.
`SubscriptionUpdateParams.Builder`	`setProrationDate(java.lang.Long prorationDate)` If set, the proration will be calculated as though the subscription was updated at the given time.
`SubscriptionUpdateParams.Builder`	`setTaxPercent(java.math.BigDecimal taxPercent)` A non-negative decimal (with at most four decimal places) between 0 and 100.
`SubscriptionUpdateParams.Builder`	`setTaxPercent(EmptyParam taxPercent)` A non-negative decimal (with at most four decimal places) between 0 and 100.
`SubscriptionUpdateParams.Builder`	`setTransferData(EmptyParam transferData)` 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.
`SubscriptionUpdateParams.Builder`	`setTransferData(SubscriptionUpdateParams.TransferData transferData)` 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.
`SubscriptionUpdateParams.Builder`	`setTrialEnd(java.lang.Long trialEnd)` Unix timestamp representing the end of the trial period the customer will get before being charged for the first time.
`SubscriptionUpdateParams.Builder`	`setTrialEnd(SubscriptionUpdateParams.TrialEnd trialEnd)` Unix timestamp representing the end of the trial period the customer will get before being charged for the first time.
`SubscriptionUpdateParams.Builder`	`setTrialFromPlan(java.lang.Boolean trialFromPlan)` Indicates if a plan's `trial_period_days` should be applied to the subscription.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Builder
```
public Builder()
```
- Method Detail
  - build
```
public SubscriptionUpdateParams build()
```
    Finalize and obtain parameter instance from this builder.
  - setApplicationFeePercent
```
public SubscriptionUpdateParams.Builder setApplicationFeePercent(java.math.BigDecimal applicationFeePercent)
```
    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 with an OAuth key in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).
  - setBilling
```
public SubscriptionUpdateParams.Builder setBilling(SubscriptionUpdateParams.Billing billing)
```
    Either `charge_automatically`, or `send_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 to `charge_automatically`.
  - setBillingCycleAnchor
```
public SubscriptionUpdateParams.Builder setBillingCycleAnchor(SubscriptionUpdateParams.BillingCycleAnchor billingCycleAnchor)
```
    Either `now` or `unchanged`. Setting the value to `now` resets the subscription's billing cycle anchor to the current time. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).
  - setBillingThresholds
```
public SubscriptionUpdateParams.Builder setBillingThresholds(SubscriptionUpdateParams.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
```
public SubscriptionUpdateParams.Builder setBillingThresholds(EmptyParam 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.
  - setCancelAt
```
public SubscriptionUpdateParams.Builder setCancelAt(EmptyParam cancelAt)
```
    A timestamp at which the subscription should cancel. If set to a date before the current period ends this will cause a proration if `prorate=true`.
  - setCancelAt
```
public SubscriptionUpdateParams.Builder setCancelAt(java.lang.Long cancelAt)
```
    A timestamp at which the subscription should cancel. If set to a date before the current period ends this will cause a proration if `prorate=true`.
  - setCancelAtPeriodEnd
```
public SubscriptionUpdateParams.Builder setCancelAtPeriodEnd(java.lang.Boolean cancelAtPeriodEnd)
```
    Boolean indicating whether this subscription should cancel at the end of the current period.
  - setCoupon
```
public SubscriptionUpdateParams.Builder setCoupon(java.lang.String coupon)
```
    The code of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription.
  - setDaysUntilDue
```
public SubscriptionUpdateParams.Builder setDaysUntilDue(java.lang.Long daysUntilDue)
```
    Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `billing` is set to `send_invoice`.
  - setDefaultPaymentMethod
```
public SubscriptionUpdateParams.Builder setDefaultPaymentMethod(java.lang.String defaultPaymentMethod)
```
    ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. If not set, invoices will use the default payment method in the customer's invoice settings.
  - setDefaultSource
```
public SubscriptionUpdateParams.Builder setDefaultSource(java.lang.String defaultSource)
```
    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. If not set, defaults to the customer's default source.
  - setDefaultTaxRates
```
public SubscriptionUpdateParams.Builder setDefaultTaxRates(EmptyParam defaultTaxRates)
```
    The tax rates that will apply to any subscription item that does not have `tax_rates` set. Invoices created will have their `default_tax_rates` populated from the subscription.
  - setDefaultTaxRates
```
public SubscriptionUpdateParams.Builder setDefaultTaxRates(java.util.List<java.lang.String> defaultTaxRates)
```
    The tax rates that will apply to any subscription item that does not have `tax_rates` set. Invoices created will have their `default_tax_rates` populated from the subscription.
  - addExpand
```
public SubscriptionUpdateParams.Builder addExpand(java.lang.String element)
```
    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 SubscriptionUpdateParams.expand for the field documentation.
  - addAllExpand
```
public SubscriptionUpdateParams.Builder addAllExpand(java.util.List<java.lang.String> elements)
```
    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 SubscriptionUpdateParams.expand for the field documentation.
  - addItem
```
public SubscriptionUpdateParams.Builder addItem(SubscriptionUpdateParams.Item element)
```
    Add an element to `items` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See SubscriptionUpdateParams.items for the field documentation.
  - addAllItem
```
public SubscriptionUpdateParams.Builder addAllItem(java.util.List<SubscriptionUpdateParams.Item> elements)
```
    Add all elements to `items` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See SubscriptionUpdateParams.items for the field documentation.
  - putMetadata
```
public SubscriptionUpdateParams.Builder putMetadata(java.lang.String key,
                                                    java.lang.String value)
```
    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 SubscriptionUpdateParams.metadata for the field documentation.
  - putAllMetadata
```
public SubscriptionUpdateParams.Builder putAllMetadata(java.util.Map<java.lang.String,java.lang.String> map)
```
    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 SubscriptionUpdateParams.metadata for the field documentation.
  - setProrate
```
public SubscriptionUpdateParams.Builder setProrate(java.lang.Boolean prorate)
```
    Boolean (defaults to `true`) telling us whether to [credit for unused time](https://stripe.com/docs/subscriptions/billing-cycle#prorations) when the billing cycle changes (e.g. when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. If `false`, the anchor period will be free (similar to a trial) and no proration adjustments will be created.
  - setProrationDate
```
public SubscriptionUpdateParams.Builder setProrationDate(java.lang.Long prorationDate)
```
    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](#retrieve_customer_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.
  - setTaxPercent
```
public SubscriptionUpdateParams.Builder setTaxPercent(EmptyParam taxPercent)
```
    A non-negative decimal (with at most four decimal places) between 0 and 100. This represents the percentage of the subscription invoice subtotal that will be calculated and added as tax to the final amount in each billing period. For example, a plan which charges $10/month with a `tax_percent` of `20.0` will charge $12 per invoice. To unset a previously-set value, pass an empty string. 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) to `tax_rates`
  - setTaxPercent
```
public SubscriptionUpdateParams.Builder setTaxPercent(java.math.BigDecimal taxPercent)
```
    A non-negative decimal (with at most four decimal places) between 0 and 100. This represents the percentage of the subscription invoice subtotal that will be calculated and added as tax to the final amount in each billing period. For example, a plan which charges $10/month with a `tax_percent` of `20.0` will charge $12 per invoice. To unset a previously-set value, pass an empty string. 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) to `tax_rates`
  - setTransferData
```
public SubscriptionUpdateParams.Builder setTransferData(SubscriptionUpdateParams.TransferData transferData)
```
    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.
  - setTransferData
```
public SubscriptionUpdateParams.Builder setTransferData(EmptyParam transferData)
```
    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.
  - setTrialEnd
```
public SubscriptionUpdateParams.Builder setTrialEnd(SubscriptionUpdateParams.TrialEnd trialEnd)
```
    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 value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`.
  - setTrialEnd
```
public SubscriptionUpdateParams.Builder setTrialEnd(java.lang.Long trialEnd)
```
    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 value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`.
  - setTrialFromPlan
```
public SubscriptionUpdateParams.Builder setTrialFromPlan(java.lang.Boolean trialFromPlan)
```
    Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed.

Class SubscriptionUpdateParams.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

build

setApplicationFeePercent

setBilling

setBillingCycleAnchor

setBillingThresholds

setBillingThresholds

setCancelAt

setCancelAt

setCancelAtPeriodEnd

setCoupon

setDaysUntilDue

setDefaultPaymentMethod

setDefaultSource

setDefaultTaxRates

setDefaultTaxRates

addExpand

addAllExpand

addItem

addAllItem

putMetadata

putAllMetadata

setProrate

setProrationDate

setTaxPercent

setTaxPercent

setTransferData

setTransferData

setTrialEnd

setTrialEnd

setTrialFromPlan