Package com.stripe.param

Class QuoteUpdateParams.SubscriptionData.Builder

java.lang.Object

com.stripe.param.QuoteUpdateParams.SubscriptionData.Builder

Enclosing class:

QuoteUpdateParams.SubscriptionData

public static class QuoteUpdateParams.SubscriptionData.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
QuoteUpdateParams.SubscriptionData.Builder	addAllBillingSchedule(List<QuoteUpdateParams.SubscriptionData.BillingSchedule> elements)	Add all elements to `billingSchedules` list.
QuoteUpdateParams.SubscriptionData.Builder	addBillingSchedule(QuoteUpdateParams.SubscriptionData.BillingSchedule element)	Add an element to `billingSchedules` list.
QuoteUpdateParams.SubscriptionData	build()	Finalize and obtain parameter instance from this builder.
QuoteUpdateParams.SubscriptionData.Builder	putAllExtraParam(Map<String,Object> map)	Add all map key/value pairs to `extraParams` map.
QuoteUpdateParams.SubscriptionData.Builder	putAllMetadata(Map<String,String> map)	Add all map key/value pairs to `metadata` map.
QuoteUpdateParams.SubscriptionData.Builder	putExtraParam(String key, Object value)	Add a key/value pair to `extraParams` map.
QuoteUpdateParams.SubscriptionData.Builder	putMetadata(String key, String value)	Add a key/value pair to `metadata` map.
QuoteUpdateParams.SubscriptionData.Builder	setBillingBehavior(QuoteUpdateParams.SubscriptionData.BillingBehavior billingBehavior)	Configures when the subscription schedule generates prorations for phase transitions.
QuoteUpdateParams.SubscriptionData.Builder	setBillingCycleAnchor(EmptyParam billingCycleAnchor)	When specified as reset, the subscription will always start a new billing period when the quote is accepted.
QuoteUpdateParams.SubscriptionData.Builder	setBillingCycleAnchor(QuoteUpdateParams.SubscriptionData.BillingCycleAnchor billingCycleAnchor)	When specified as reset, the subscription will always start a new billing period when the quote is accepted.
QuoteUpdateParams.SubscriptionData.Builder	setBillingSchedules(EmptyParam billingSchedules)	Billing schedules that will be applied to the subscription or subscription schedule created when the quote is accepted.
QuoteUpdateParams.SubscriptionData.Builder	setBillingSchedules(List<QuoteUpdateParams.SubscriptionData.BillingSchedule> billingSchedules)	Billing schedules that will be applied to the subscription or subscription schedule created when the quote is accepted.
QuoteUpdateParams.SubscriptionData.Builder	setBillOnAcceptance(EmptyParam billOnAcceptance)	Describes the period to bill for upon accepting the quote.
QuoteUpdateParams.SubscriptionData.Builder	setBillOnAcceptance(QuoteUpdateParams.SubscriptionData.BillOnAcceptance billOnAcceptance)	Describes the period to bill for upon accepting the quote.
QuoteUpdateParams.SubscriptionData.Builder	setDescription(EmptyParam description)	The subscription's description, meant to be displayable to the customer.
QuoteUpdateParams.SubscriptionData.Builder	setDescription(String description)	The subscription's description, meant to be displayable to the customer.
QuoteUpdateParams.SubscriptionData.Builder	setEffectiveDate(EmptyParam effectiveDate)	When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted.
QuoteUpdateParams.SubscriptionData.Builder	setEffectiveDate(QuoteUpdateParams.SubscriptionData.EffectiveDate effectiveDate)	When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted.
QuoteUpdateParams.SubscriptionData.Builder	setEffectiveDate(Long effectiveDate)	When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted.
QuoteUpdateParams.SubscriptionData.Builder	setEndBehavior(QuoteUpdateParams.SubscriptionData.EndBehavior endBehavior)	Behavior of the subscription schedule and underlying subscription when it ends.
QuoteUpdateParams.SubscriptionData.Builder	setPhaseEffectiveAt(QuoteUpdateParams.SubscriptionData.PhaseEffectiveAt phaseEffectiveAt)	Configures how the subscription schedule handles billing for phase transitions when the quote is accepted.
QuoteUpdateParams.SubscriptionData.Builder	setPrebilling(EmptyParam prebilling)	If specified, the invoicing for the given billing cycle iterations will be processed when the quote is accepted.
QuoteUpdateParams.SubscriptionData.Builder	setPrebilling(QuoteUpdateParams.SubscriptionData.Prebilling prebilling)	If specified, the invoicing for the given billing cycle iterations will be processed when the quote is accepted.
QuoteUpdateParams.SubscriptionData.Builder	setProrationBehavior(QuoteUpdateParams.SubscriptionData.ProrationBehavior prorationBehavior)	Determines how to handle prorations.
QuoteUpdateParams.SubscriptionData.Builder	setTrialPeriodDays(EmptyParam trialPeriodDays)	Integer representing the number of trial period days before the customer is charged for the first time.
QuoteUpdateParams.SubscriptionData.Builder	setTrialPeriodDays(Long trialPeriodDays)	Integer representing the number of trial period days before the customer is charged for the first time.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

build

public QuoteUpdateParams.SubscriptionData build()

Finalize and obtain parameter instance from this builder.

setBillOnAcceptance

public QuoteUpdateParams.SubscriptionData.Builder setBillOnAcceptance(QuoteUpdateParams.SubscriptionData.BillOnAcceptance billOnAcceptance)

Describes the period to bill for upon accepting the quote.

setBillOnAcceptance

public QuoteUpdateParams.SubscriptionData.Builder setBillOnAcceptance(EmptyParam billOnAcceptance)

Describes the period to bill for upon accepting the quote.

setBillingBehavior

public QuoteUpdateParams.SubscriptionData.Builder setBillingBehavior(QuoteUpdateParams.SubscriptionData.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.

setBillingCycleAnchor

public QuoteUpdateParams.SubscriptionData.Builder setBillingCycleAnchor(QuoteUpdateParams.SubscriptionData.BillingCycleAnchor billingCycleAnchor)

When specified as reset, the subscription will always start a new billing period when the quote is accepted.

setBillingCycleAnchor

public QuoteUpdateParams.SubscriptionData.Builder setBillingCycleAnchor(EmptyParam billingCycleAnchor)

When specified as reset, the subscription will always start a new billing period when the quote is accepted.

addBillingSchedule

public QuoteUpdateParams.SubscriptionData.Builder addBillingSchedule(QuoteUpdateParams.SubscriptionData.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. See QuoteUpdateParams.SubscriptionData.billingSchedules for the field documentation.

addAllBillingSchedule

public QuoteUpdateParams.SubscriptionData.Builder addAllBillingSchedule(List<QuoteUpdateParams.SubscriptionData.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. See QuoteUpdateParams.SubscriptionData.billingSchedules for the field documentation.

setBillingSchedules

public QuoteUpdateParams.SubscriptionData.Builder setBillingSchedules(EmptyParam billingSchedules)

Billing schedules that will be applied to the subscription or subscription schedule created when the quote is accepted.

setBillingSchedules

public QuoteUpdateParams.SubscriptionData.Builder setBillingSchedules(List<QuoteUpdateParams.SubscriptionData.BillingSchedule> billingSchedules)

Billing schedules that will be applied to the subscription or subscription schedule created when the quote is accepted.

setDescription

public QuoteUpdateParams.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.

setDescription

public QuoteUpdateParams.SubscriptionData.Builder setDescription(EmptyParam 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 QuoteUpdateParams.SubscriptionData.Builder setEffectiveDate(QuoteUpdateParams.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 QuoteUpdateParams.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 QuoteUpdateParams.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.

setEndBehavior

public QuoteUpdateParams.SubscriptionData.Builder setEndBehavior(QuoteUpdateParams.SubscriptionData.EndBehavior endBehavior)

Behavior of the subscription schedule and underlying subscription when it ends.

putExtraParam

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

putAllExtraParam

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

putMetadata

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

putAllMetadata

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

setPhaseEffectiveAt

public QuoteUpdateParams.SubscriptionData.Builder setPhaseEffectiveAt(QuoteUpdateParams.SubscriptionData.PhaseEffectiveAt phaseEffectiveAt)

Configures how the subscription schedule handles billing for phase transitions when the quote is accepted.

setPrebilling

public QuoteUpdateParams.SubscriptionData.Builder setPrebilling(QuoteUpdateParams.SubscriptionData.Prebilling prebilling)

If specified, the invoicing for the given billing cycle iterations will be processed when the quote is accepted. Cannot be used with effective_date.

setPrebilling

public QuoteUpdateParams.SubscriptionData.Builder setPrebilling(EmptyParam prebilling)

If specified, the invoicing for the given billing cycle iterations will be processed when the quote is accepted. Cannot be used with effective_date.

setProrationBehavior

public QuoteUpdateParams.SubscriptionData.Builder setProrationBehavior(QuoteUpdateParams.SubscriptionData.ProrationBehavior prorationBehavior)

Determines how to handle prorations. When creating a subscription, valid values are create_prorations or none.

When updating a subscription, valid values are create_prorations, none, or always_invoice.

Passing create_prorations will cause proration invoice items to be created when applicable. These proration items will only be invoiced immediately under certain conditions. In order to always invoice immediately for prorations, pass always_invoice.

Prorations can be disabled by passing none.

setTrialPeriodDays

public QuoteUpdateParams.SubscriptionData.Builder setTrialPeriodDays(Long trialPeriodDays)

Integer representing the number of trial period days before the customer is charged for the first time.

setTrialPeriodDays

public QuoteUpdateParams.SubscriptionData.Builder setTrialPeriodDays(EmptyParam trialPeriodDays)

Integer representing the number of trial period days before the customer is charged for the first time.