Package com.stripe.param

Class SubscriptionScheduleUpdateParams.Builder

java.lang.Object
com.stripe.param.SubscriptionScheduleUpdateParams.Builder
Enclosing class:
SubscriptionScheduleUpdateParams
public static class SubscriptionScheduleUpdateParams.Builder extends Object

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • build

      public SubscriptionScheduleUpdateParams 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 are prorate_on_next_phase or prorate_up_front with the default being prorate_on_next_phase. prorate_on_next_phase will apply phase changes and generate prorations at transition time. prorate_up_front will bill for all phases within the current billing cycle up front.

    • 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 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(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(List<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(String key, 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(Map<String,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.

    • putMetadata

      public SubscriptionScheduleUpdateParams.Builder putMetadata(String key, 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(Map<String,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.

    • setMetadata

      public SubscriptionScheduleUpdateParams.Builder setMetadata(EmptyParam metadata)
      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 to metadata.

    • setMetadata

      public SubscriptionScheduleUpdateParams.Builder setMetadata(Map<String,String> metadata)
      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 to metadata.

    • 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(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.

    • 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 is create_prorations.