SubscriptionScheduleUpdateParams.Builder (stripe-java 10.0.1 API)

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

Enclosing class:: SubscriptionScheduleUpdateParams

public static class SubscriptionScheduleUpdateParams.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
`SubscriptionScheduleUpdateParams.Builder`	`addAllExpand(java.util.List<java.lang.String> elements)` Add all elements to `expand` list.
`SubscriptionScheduleUpdateParams.Builder`	`addAllPhase(java.util.List<SubscriptionScheduleUpdateParams.Phase> elements)` Add all elements to `phases` list.
`SubscriptionScheduleUpdateParams.Builder`	`addExpand(java.lang.String element)` Add an element to `expand` list.
`SubscriptionScheduleUpdateParams.Builder`	`addPhase(SubscriptionScheduleUpdateParams.Phase element)` Add an element to `phases` list.
`SubscriptionScheduleUpdateParams`	`build()` Finalize and obtain parameter instance from this builder.
`SubscriptionScheduleUpdateParams.Builder`	`putAllExtraParam(java.util.Map<java.lang.String,java.lang.Object> map)` Add all map key/value pairs to `extraParams` map.
`SubscriptionScheduleUpdateParams.Builder`	`putAllMetadata(java.util.Map<java.lang.String,java.lang.String> map)` Add all map key/value pairs to `metadata` map.
`SubscriptionScheduleUpdateParams.Builder`	`putExtraParam(java.lang.String key, java.lang.Object value)` Add a key/value pair to `extraParams` map.
`SubscriptionScheduleUpdateParams.Builder`	`putMetadata(java.lang.String key, java.lang.String value)` Add a key/value pair to `metadata` map.
`SubscriptionScheduleUpdateParams.Builder`	`setBilling(SubscriptionScheduleUpdateParams.Billing billing)` Either `charge_automatically`, or `send_invoice`.
`SubscriptionScheduleUpdateParams.Builder`	`setBillingThresholds(EmptyParam billingThresholds)` Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period.
`SubscriptionScheduleUpdateParams.Builder`	`setBillingThresholds(SubscriptionScheduleUpdateParams.BillingThresholds billingThresholds)` Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period.
`SubscriptionScheduleUpdateParams.Builder`	`setInvoiceSettings(SubscriptionScheduleUpdateParams.InvoiceSettings invoiceSettings)` All invoices will be billed using the specified settings.
`SubscriptionScheduleUpdateParams.Builder`	`setProrate(java.lang.Boolean prorate)` If the update changes the current phase, indicates if the changes should be prorated.
`SubscriptionScheduleUpdateParams.Builder`	`setRenewalBehavior(SubscriptionScheduleUpdateParams.RenewalBehavior renewalBehavior)` Configures how the subscription schedule behaves when it ends.
`SubscriptionScheduleUpdateParams.Builder`	`setRenewalInterval(SubscriptionScheduleUpdateParams.RenewalInterval renewalInterval)` Configuration for renewing the subscription schedule when it ends.

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 SubscriptionScheduleUpdateParams build()
```
    Finalize and obtain parameter instance from this builder.
  - setBilling
```
public SubscriptionScheduleUpdateParams.Builder setBilling(SubscriptionScheduleUpdateParams.Billing billing)
```
    Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing 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` on creation.
  - setBillingThresholds
```
public SubscriptionScheduleUpdateParams.Builder setBillingThresholds(SubscriptionScheduleUpdateParams.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 SubscriptionScheduleUpdateParams.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.
  - addExpand
```
public SubscriptionScheduleUpdateParams.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 SubscriptionScheduleUpdateParams.expand for the field documentation.
  - addAllExpand
```
public SubscriptionScheduleUpdateParams.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 SubscriptionScheduleUpdateParams.expand for the field documentation.
  - putExtraParam
```
public SubscriptionScheduleUpdateParams.Builder putExtraParam(java.lang.String key,
                                                              java.lang.Object value)
```
    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. See SubscriptionScheduleUpdateParams.extraParams for the field documentation.
  - putAllExtraParam
```
public SubscriptionScheduleUpdateParams.Builder putAllExtraParam(java.util.Map<java.lang.String,java.lang.Object> map)
```
    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. See SubscriptionScheduleUpdateParams.extraParams for the field documentation.
  - setInvoiceSettings
```
public SubscriptionScheduleUpdateParams.Builder setInvoiceSettings(SubscriptionScheduleUpdateParams.InvoiceSettings invoiceSettings)
```
    All invoices will be billed using the specified settings.
  - putMetadata
```
public SubscriptionScheduleUpdateParams.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 SubscriptionScheduleUpdateParams.metadata for the field documentation.
  - putAllMetadata
```
public SubscriptionScheduleUpdateParams.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 SubscriptionScheduleUpdateParams.metadata for the field documentation.
  - addPhase
```
public SubscriptionScheduleUpdateParams.Builder addPhase(SubscriptionScheduleUpdateParams.Phase element)
```
    Add an element to `phases` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See SubscriptionScheduleUpdateParams.phases for the field documentation.
  - addAllPhase
```
public SubscriptionScheduleUpdateParams.Builder addAllPhase(java.util.List<SubscriptionScheduleUpdateParams.Phase> elements)
```
    Add all elements to `phases` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See SubscriptionScheduleUpdateParams.phases for the field documentation.
  - setProrate
```
public SubscriptionScheduleUpdateParams.Builder setProrate(java.lang.Boolean prorate)
```
    If the update changes the current phase, indicates if the changes should be prorated. Defaults to `true`.
  - setRenewalBehavior
```
public SubscriptionScheduleUpdateParams.Builder setRenewalBehavior(SubscriptionScheduleUpdateParams.RenewalBehavior renewalBehavior)
```
    Configures how the subscription schedule behaves when it ends. Possible values are `none`, `renew`, or `release`. `renew` will create a new subscription schedule revision by adding a new phase using the most recent phase's `plans` applied to a duration set by `renewal_interval`. `none` will stop the subscription schedule and cancel the underlying subscription. `release` will stop the subscription schedule, but keep the underlying subscription running.
  - setRenewalInterval
```
public SubscriptionScheduleUpdateParams.Builder setRenewalInterval(SubscriptionScheduleUpdateParams.RenewalInterval renewalInterval)
```
    Configuration for renewing the subscription schedule when it ends. Must be set if `renewal_behavior` is `renew`. Otherwise, must not be set.

Class SubscriptionScheduleUpdateParams.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

build

setBilling

setBillingThresholds

setBillingThresholds

addExpand

addAllExpand

putExtraParam

putAllExtraParam

setInvoiceSettings

putMetadata

putAllMetadata

addPhase

addAllPhase

setProrate

setRenewalBehavior

setRenewalInterval