SubscriptionScheduleCreateParams.Builder (stripe-java 9.7.0 API)

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

Enclosing class:: SubscriptionScheduleCreateParams

public static class SubscriptionScheduleCreateParams.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
`SubscriptionScheduleCreateParams.Builder`	`addAllExpand(java.util.List<java.lang.String> elements)` Add all elements to `expand` list.
`SubscriptionScheduleCreateParams.Builder`	`addAllPhase(java.util.List<SubscriptionScheduleCreateParams.Phase> elements)` Add all elements to `phases` list.
`SubscriptionScheduleCreateParams.Builder`	`addExpand(java.lang.String element)` Add an element to `expand` list.
`SubscriptionScheduleCreateParams.Builder`	`addPhase(SubscriptionScheduleCreateParams.Phase element)` Add an element to `phases` list.
`SubscriptionScheduleCreateParams`	`build()` Finalize and obtain parameter instance from this builder.
`SubscriptionScheduleCreateParams.Builder`	`putAllMetadata(java.util.Map<java.lang.String,java.lang.String> map)` Add all map key/value pairs to `metadata` map.
`SubscriptionScheduleCreateParams.Builder`	`putMetadata(java.lang.String key, java.lang.String value)` Add a key/value pair to `metadata` map.
`SubscriptionScheduleCreateParams.Builder`	`setBilling(SubscriptionScheduleCreateParams.Billing billing)` Either `charge_automatically`, or `send_invoice`.
`SubscriptionScheduleCreateParams.Builder`	`setBillingThresholds(EmptyParam billingThresholds)` Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period.
`SubscriptionScheduleCreateParams.Builder`	`setBillingThresholds(SubscriptionScheduleCreateParams.BillingThresholds billingThresholds)` Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period.
`SubscriptionScheduleCreateParams.Builder`	`setCustomer(java.lang.String customer)` The identifier of the customer to create the subscription schedule for.
`SubscriptionScheduleCreateParams.Builder`	`setFromSubscription(java.lang.String fromSubscription)` Migrate an existing subscription to be managed by a subscription schedule.
`SubscriptionScheduleCreateParams.Builder`	`setInvoiceSettings(SubscriptionScheduleCreateParams.InvoiceSettings invoiceSettings)` All invoices will be billed using the specified settings.
`SubscriptionScheduleCreateParams.Builder`	`setRenewalBehavior(SubscriptionScheduleCreateParams.RenewalBehavior renewalBehavior)` Configures how the subscription schedule behaves when it ends.
`SubscriptionScheduleCreateParams.Builder`	`setRenewalInterval(SubscriptionScheduleCreateParams.RenewalInterval renewalInterval)` Configuration for renewing the subscription schedule when it ends.
`SubscriptionScheduleCreateParams.Builder`	`setStartDate(java.lang.Long startDate)` The date at which the subscription schedule starts.
`SubscriptionScheduleCreateParams.Builder`	`setStartDate(SubscriptionScheduleCreateParams.StartDate startDate)` The date at which the subscription schedule starts.

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 SubscriptionScheduleCreateParams build()
```
    Finalize and obtain parameter instance from this builder.
  - setBilling
```
public SubscriptionScheduleCreateParams.Builder setBilling(SubscriptionScheduleCreateParams.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 SubscriptionScheduleCreateParams.Builder setBillingThresholds(SubscriptionScheduleCreateParams.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 SubscriptionScheduleCreateParams.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.
  - setCustomer
```
public SubscriptionScheduleCreateParams.Builder setCustomer(java.lang.String customer)
```
    The identifier of the customer to create the subscription schedule for.
  - addExpand
```
public SubscriptionScheduleCreateParams.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 SubscriptionScheduleCreateParams.expand for the field documentation.
  - addAllExpand
```
public SubscriptionScheduleCreateParams.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 SubscriptionScheduleCreateParams.expand for the field documentation.
  - setFromSubscription
```
public SubscriptionScheduleCreateParams.Builder setFromSubscription(java.lang.String fromSubscription)
```
    Migrate an existing subscription to be managed by a subscription schedule. If this parameter is set, a subscription schedule will be created using the subscription's plan(s), set to auto-renew using the subscription's interval. Other parameters cannot be set since their values will be inferred from the subscription.
  - setInvoiceSettings
```
public SubscriptionScheduleCreateParams.Builder setInvoiceSettings(SubscriptionScheduleCreateParams.InvoiceSettings invoiceSettings)
```
    All invoices will be billed using the specified settings.
  - putMetadata
```
public SubscriptionScheduleCreateParams.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 SubscriptionScheduleCreateParams.metadata for the field documentation.
  - putAllMetadata
```
public SubscriptionScheduleCreateParams.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 SubscriptionScheduleCreateParams.metadata for the field documentation.
  - addPhase
```
public SubscriptionScheduleCreateParams.Builder addPhase(SubscriptionScheduleCreateParams.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 SubscriptionScheduleCreateParams.phases for the field documentation.
  - addAllPhase
```
public SubscriptionScheduleCreateParams.Builder addAllPhase(java.util.List<SubscriptionScheduleCreateParams.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 SubscriptionScheduleCreateParams.phases for the field documentation.
  - setRenewalBehavior
```
public SubscriptionScheduleCreateParams.Builder setRenewalBehavior(SubscriptionScheduleCreateParams.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 SubscriptionScheduleCreateParams.Builder setRenewalInterval(SubscriptionScheduleCreateParams.RenewalInterval renewalInterval)
```
    Configuration for renewing the subscription schedule when it ends. Must be set if `renewal_behavior` is `renew`. Otherwise, must not be set.
  - setStartDate
```
public SubscriptionScheduleCreateParams.Builder setStartDate(SubscriptionScheduleCreateParams.StartDate startDate)
```
    The date at which the subscription schedule starts.
  - setStartDate
```
public SubscriptionScheduleCreateParams.Builder setStartDate(java.lang.Long startDate)
```
    The date at which the subscription schedule starts.

Class SubscriptionScheduleCreateParams.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

build

setBilling

setBillingThresholds

setBillingThresholds

setCustomer

addExpand

addAllExpand

setFromSubscription

setInvoiceSettings

putMetadata

putAllMetadata

addPhase

addAllPhase

setRenewalBehavior

setRenewalInterval

setStartDate

setStartDate