Package com.stripe.param
Class SubscriptionScheduleUpdateParams.Builder
java.lang.Object
com.stripe.param.SubscriptionScheduleUpdateParams.Builder
- Enclosing class:
- SubscriptionScheduleUpdateParams
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionAdd all elements to `billingSchedules` list.addAllExpand(List<String> elements) Add all elements to `expand` list.Add all elements to `phases` list.Add an element to `billingSchedules` list.Add an element to `expand` list.Add an element to `phases` 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.setBillingBehavior(SubscriptionScheduleUpdateParams.BillingBehavior billingBehavior) Configures when the subscription schedule generates prorations for phase transitions.setBillingSchedules(EmptyParam billingSchedules) Sets the billing schedules for the subscription schedule.setBillingSchedules(List<SubscriptionScheduleUpdateParams.BillingSchedule> billingSchedules) Sets the billing schedules for the subscription schedule.setDefaultSettings(SubscriptionScheduleUpdateParams.DefaultSettings defaultSettings) Object representing the subscription schedule's default settings.Behavior of the subscription schedule and underlying subscription when it ends.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.If specified, the invoicing for the given billing cycle iterations will be processed now.setProrationBehavior(SubscriptionScheduleUpdateParams.ProrationBehavior prorationBehavior) If the update changes the billing configuration (item price, quantity, etc.) of the current phase, indicates how prorations from this change should be handled.
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
build
Finalize and obtain parameter instance from this builder. -
setBillingBehavior
public SubscriptionScheduleUpdateParams.Builder setBillingBehavior(SubscriptionScheduleUpdateParams.BillingBehavior billingBehavior) Configures when the subscription schedule generates prorations for phase transitions. Possible values areprorate_on_next_phaseorprorate_up_frontwith the default beingprorate_on_next_phase.prorate_on_next_phasewill apply phase changes and generate prorations at transition time.prorate_up_frontwill bill for all phases within the current billing cycle up front. -
addBillingSchedule
public SubscriptionScheduleUpdateParams.Builder addBillingSchedule(SubscriptionScheduleUpdateParams.BillingSchedule element) Add an element to `billingSchedules` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. SeeSubscriptionScheduleUpdateParams.billingSchedulesfor the field documentation. -
addAllBillingSchedule
public SubscriptionScheduleUpdateParams.Builder addAllBillingSchedule(List<SubscriptionScheduleUpdateParams.BillingSchedule> elements) Add all elements to `billingSchedules` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. SeeSubscriptionScheduleUpdateParams.billingSchedulesfor the field documentation. -
setBillingSchedules
Sets the billing schedules for the subscription schedule. -
setBillingSchedules
public SubscriptionScheduleUpdateParams.Builder setBillingSchedules(List<SubscriptionScheduleUpdateParams.BillingSchedule> billingSchedules) Sets the billing schedules for the subscription schedule. -
setDefaultSettings
public SubscriptionScheduleUpdateParams.Builder setDefaultSettings(SubscriptionScheduleUpdateParams.DefaultSettings defaultSettings) Object representing the subscription schedule's default settings. -
setEndBehavior
public SubscriptionScheduleUpdateParams.Builder setEndBehavior(SubscriptionScheduleUpdateParams.EndBehavior endBehavior) Behavior of the subscription schedule and underlying subscription when it ends. Possible values arereleaseorcancelwith the default beingrelease.releasewill end the subscription schedule and keep the underlying subscription running.cancelwill end the subscription schedule and cancel the underlying subscription. -
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. SeeSubscriptionScheduleUpdateParams.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. SeeSubscriptionScheduleUpdateParams.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. SeeSubscriptionScheduleUpdateParams.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. SeeSubscriptionScheduleUpdateParams.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. SeeSubscriptionScheduleUpdateParams.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. SeeSubscriptionScheduleUpdateParams.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. -
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. SeeSubscriptionScheduleUpdateParams.phasesfor the field documentation. -
addAllPhase
public SubscriptionScheduleUpdateParams.Builder addAllPhase(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. SeeSubscriptionScheduleUpdateParams.phasesfor the field documentation. -
setPrebilling
public SubscriptionScheduleUpdateParams.Builder setPrebilling(SubscriptionScheduleUpdateParams.Prebilling prebilling) If specified, the invoicing for the given billing cycle iterations will be processed now. -
setProrationBehavior
public SubscriptionScheduleUpdateParams.Builder setProrationBehavior(SubscriptionScheduleUpdateParams.ProrationBehavior prorationBehavior) If the update changes the billing configuration (item price, quantity, etc.) of the current phase, indicates how prorations from this change should be handled. The default value iscreate_prorations.
-