Package com.stripe.param

Class QuoteCreateParams.Line.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • build

      public QuoteCreateParams.Line build()
      Finalize and obtain parameter instance from this builder.

    • addAction

      public QuoteCreateParams.Line.Builder addAction(QuoteCreateParams.Line.Action element)
      Add an element to `actions` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See QuoteCreateParams.Line.actions for the field documentation.

    • addAllAction

      public QuoteCreateParams.Line.Builder addAllAction(List<QuoteCreateParams.Line.Action> elements)
      Add all elements to `actions` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See QuoteCreateParams.Line.actions for the field documentation.

    • setAppliesTo

      public QuoteCreateParams.Line.Builder setAppliesTo(QuoteCreateParams.Line.AppliesTo appliesTo)
      Details to identify the subscription schedule the quote line applies to.

    • setBillingCycleAnchor

      public QuoteCreateParams.Line.Builder setBillingCycleAnchor(QuoteCreateParams.Line.BillingCycleAnchor billingCycleAnchor)
      For point-in-time quote lines (having no ends_at timestamp), this attribute lets you set or remove whether the subscription's billing cycle anchor is reset at the Quote Line starts_at timestamp.For time-span based quote lines (having both starts_at and ends_at), the only valid value is automatic, which removes any previously configured billing cycle anchor resets during the window of time spanning the quote line.

    • setCancelSubscriptionSchedule

      public QuoteCreateParams.Line.Builder setCancelSubscriptionSchedule(QuoteCreateParams.Line.CancelSubscriptionSchedule cancelSubscriptionSchedule)
      A point-in-time operation that cancels an existing subscription schedule at the line's starts_at timestamp. Currently only compatible with quote_acceptance_date for starts_at. When using cancel_subscription_schedule, the subscription schedule on the quote remains unalterable, except for modifications to the metadata, collection_method or invoice_settings.

    • setEndsAt

      public QuoteCreateParams.Line.Builder setEndsAt(QuoteCreateParams.Line.EndsAt endsAt)
      Details to identify the end of the time range modified by the proposed change. If not supplied, the quote line is considered a point-in-time operation that only affects the exact timestamp at starts_at, and a restricted set of attributes is supported on the quote line.

    • putExtraParam

      public QuoteCreateParams.Line.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 QuoteCreateParams.Line.extraParams for the field documentation.

    • putAllExtraParam

      public QuoteCreateParams.Line.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 QuoteCreateParams.Line.extraParams for the field documentation.

    • setProrationBehavior

      public QuoteCreateParams.Line.Builder setProrationBehavior(QuoteCreateParams.Line.ProrationBehavior prorationBehavior)
      Changes to how Stripe handles prorations during the quote line's time span. Affects if and how prorations are created when a future phase starts.

    • setSetPauseCollection

      public QuoteCreateParams.Line.Builder setSetPauseCollection(QuoteCreateParams.Line.SetPauseCollection setPauseCollection)
      Defines how to pause collection for the underlying subscription throughout the duration of the amendment.

    • setSetScheduleEnd

      public QuoteCreateParams.Line.Builder setSetScheduleEnd(QuoteCreateParams.Line.SetScheduleEnd setScheduleEnd)
      Timestamp helper to end the underlying schedule early, based on the acompanying line's start or end date.

    • setStartsAt

      public QuoteCreateParams.Line.Builder setStartsAt(QuoteCreateParams.Line.StartsAt startsAt)
      Details to identify the earliest timestamp where the proposed change should take effect.

    • setTrialSettings

      public QuoteCreateParams.Line.Builder setTrialSettings(QuoteCreateParams.Line.TrialSettings trialSettings)
      Settings related to subscription trials.