Package com.stripe.param

Class QuoteCreateParams.SubscriptionData.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • build

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

    • setDescription

      public QuoteCreateParams.SubscriptionData.Builder setDescription(String description)
      The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.

    • setEffectiveDate

      public QuoteCreateParams.SubscriptionData.Builder setEffectiveDate(QuoteCreateParams.SubscriptionData.EffectiveDate effectiveDate)
      When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted. When updating a subscription, the date of which the subscription will be updated using a subscription schedule. The special value current_period_end can be provided to update a subscription at the end of its current period. The effective_date is ignored if it is in the past when the quote is accepted.

    • setEffectiveDate

      public QuoteCreateParams.SubscriptionData.Builder setEffectiveDate(Long effectiveDate)
      When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted. When updating a subscription, the date of which the subscription will be updated using a subscription schedule. The special value current_period_end can be provided to update a subscription at the end of its current period. The effective_date is ignored if it is in the past when the quote is accepted.

    • setEffectiveDate

      public QuoteCreateParams.SubscriptionData.Builder setEffectiveDate(EmptyParam effectiveDate)
      When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted. When updating a subscription, the date of which the subscription will be updated using a subscription schedule. The special value current_period_end can be provided to update a subscription at the end of its current period. The effective_date is ignored if it is in the past when the quote is accepted.

    • putExtraParam

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

    • putAllExtraParam

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

    • putMetadata

      public QuoteCreateParams.SubscriptionData.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 QuoteCreateParams.SubscriptionData.metadata for the field documentation.

    • putAllMetadata

      public QuoteCreateParams.SubscriptionData.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 QuoteCreateParams.SubscriptionData.metadata for the field documentation.

    • setTrialPeriodDays

      public QuoteCreateParams.SubscriptionData.Builder setTrialPeriodDays(Long trialPeriodDays)
      Integer representing the number of trial period days before the customer is charged for the first time.

    • setTrialPeriodDays

      public QuoteCreateParams.SubscriptionData.Builder setTrialPeriodDays(EmptyParam trialPeriodDays)
      Integer representing the number of trial period days before the customer is charged for the first time.