com.stripe.param

Class SubscriptionScheduleUpdateParams.Builder

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()

Method Summary

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	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	setCollectionMethod(SubscriptionScheduleUpdateParams.CollectionMethod collectionMethod) Either `charge_automatically`, or `send_invoice`.
SubscriptionScheduleUpdateParams.Builder	setDefaultPaymentMethod(EmptyParam defaultPaymentMethod) ID of the default payment method for the subscription schedule.
SubscriptionScheduleUpdateParams.Builder	setDefaultPaymentMethod(java.lang.String defaultPaymentMethod) ID of the default payment method for the subscription schedule.
SubscriptionScheduleUpdateParams.Builder	setDefaultSource(EmptyParam defaultSource) ID of the default payment source for the subscription schedule.
SubscriptionScheduleUpdateParams.Builder	setDefaultSource(java.lang.String defaultSource) ID of the default payment source for the subscription schedule.
SubscriptionScheduleUpdateParams.Builder	setEndBehavior(SubscriptionScheduleUpdateParams.EndBehavior endBehavior) Configures how the subscription schedule behaves when it ends.
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	setRenewalInterval(SubscriptionScheduleUpdateParams.RenewalInterval renewalInterval) This parameter has been deprecated and will be removed in future API versions.

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.

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.

setCollectionMethod

public SubscriptionScheduleUpdateParams.Builder setCollectionMethod(SubscriptionScheduleUpdateParams.CollectionMethod collectionMethod)

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.

setDefaultPaymentMethod

public SubscriptionScheduleUpdateParams.Builder setDefaultPaymentMethod(java.lang.String defaultPaymentMethod)

ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.

setDefaultPaymentMethod

public SubscriptionScheduleUpdateParams.Builder setDefaultPaymentMethod(EmptyParam defaultPaymentMethod)

ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.

setDefaultSource

public SubscriptionScheduleUpdateParams.Builder setDefaultSource(java.lang.String defaultSource)

ID of the default payment source for the subscription schedule. It must belong to the customer associated with the subscription schedule and be in a chargeable state. If not set, defaults to the customer's default source.

setDefaultSource

public SubscriptionScheduleUpdateParams.Builder setDefaultSource(EmptyParam defaultSource)

ID of the default payment source for the subscription schedule. It must belong to the customer associated with the subscription schedule and be in a chargeable state. If not set, defaults to the customer's default source.

setEndBehavior

public SubscriptionScheduleUpdateParams.Builder setEndBehavior(SubscriptionScheduleUpdateParams.EndBehavior endBehavior)

Configures how the subscription schedule behaves when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running.`cancel` will end the subscription schedule and cancel the underlying subscription.

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`.

setRenewalInterval

public SubscriptionScheduleUpdateParams.Builder setRenewalInterval(SubscriptionScheduleUpdateParams.RenewalInterval renewalInterval)

This parameter has been deprecated and will be removed in future API versions. Configuration for renewing the subscription schedule when it ends. Must be set if `renewal_behavior` is `renew`. Otherwise, must not be set.