Package com.stripe.param

Class InvoiceCreatePreviewParams.SubscriptionDetails.Builder

java.lang.Object

com.stripe.param.InvoiceCreatePreviewParams.SubscriptionDetails.Builder

Enclosing class:

InvoiceCreatePreviewParams.SubscriptionDetails

public static class InvoiceCreatePreviewParams.SubscriptionDetails.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
InvoiceCreatePreviewParams.SubscriptionDetails.Builder	addAllDefaultTaxRate(List<String> elements)	Add all elements to `defaultTaxRates` list.
InvoiceCreatePreviewParams.SubscriptionDetails.Builder	addAllItem(List<InvoiceCreatePreviewParams.SubscriptionDetails.Item> elements)	Add all elements to `items` list.
InvoiceCreatePreviewParams.SubscriptionDetails.Builder	addDefaultTaxRate(String element)	Add an element to `defaultTaxRates` list.
InvoiceCreatePreviewParams.SubscriptionDetails.Builder	addItem(InvoiceCreatePreviewParams.SubscriptionDetails.Item element)	Add an element to `items` list.
InvoiceCreatePreviewParams.SubscriptionDetails	build()	Finalize and obtain parameter instance from this builder.
InvoiceCreatePreviewParams.SubscriptionDetails.Builder	putAllExtraParam(Map<String,Object> map)	Add all map key/value pairs to `extraParams` map.
InvoiceCreatePreviewParams.SubscriptionDetails.Builder	putExtraParam(String key, Object value)	Add a key/value pair to `extraParams` map.
InvoiceCreatePreviewParams.SubscriptionDetails.Builder	setBillingCycleAnchor(InvoiceCreatePreviewParams.SubscriptionDetails.BillingCycleAnchor billingCycleAnchor)	For new subscriptions, a future timestamp to anchor the subscription's billing cycle.
InvoiceCreatePreviewParams.SubscriptionDetails.Builder	setBillingCycleAnchor(Long billingCycleAnchor)	For new subscriptions, a future timestamp to anchor the subscription's billing cycle.
InvoiceCreatePreviewParams.SubscriptionDetails.Builder	setCancelAt(EmptyParam cancelAt)	A timestamp at which the subscription should cancel.
InvoiceCreatePreviewParams.SubscriptionDetails.Builder	setCancelAt(Long cancelAt)	A timestamp at which the subscription should cancel.
InvoiceCreatePreviewParams.SubscriptionDetails.Builder	setCancelAtPeriodEnd(Boolean cancelAtPeriodEnd)	Indicate whether this subscription should cancel at the end of the current period ( current_period_end).
InvoiceCreatePreviewParams.SubscriptionDetails.Builder	setCancelNow(Boolean cancelNow)	This simulates the subscription being canceled or expired immediately.
InvoiceCreatePreviewParams.SubscriptionDetails.Builder	setDefaultTaxRates(EmptyParam defaultTaxRates)	If provided, the invoice returned will preview updating or creating a subscription with these default tax rates.
InvoiceCreatePreviewParams.SubscriptionDetails.Builder	setDefaultTaxRates(List<String> defaultTaxRates)	If provided, the invoice returned will preview updating or creating a subscription with these default tax rates.
InvoiceCreatePreviewParams.SubscriptionDetails.Builder	setProrationBehavior(InvoiceCreatePreviewParams.SubscriptionDetails.ProrationBehavior prorationBehavior)	Determines how to handle prorations when the billing cycle changes (e.g., when switching plans, resetting billing_cycle_anchor=now, or starting a trial), or if an item's quantity changes.
InvoiceCreatePreviewParams.SubscriptionDetails.Builder	setProrationDate(Long prorationDate)	If previewing an update to a subscription, and doing proration, subscription_details.proration_date forces the proration to be calculated as though the update was done at the specified time.
InvoiceCreatePreviewParams.SubscriptionDetails.Builder	setResumeAt(InvoiceCreatePreviewParams.SubscriptionDetails.ResumeAt resumeAt)	For paused subscriptions, setting subscription_details.resume_at to now will preview the invoice that will be generated if the subscription is resumed.
InvoiceCreatePreviewParams.SubscriptionDetails.Builder	setStartDate(Long startDate)	Date a subscription is intended to start (can be future or past).
InvoiceCreatePreviewParams.SubscriptionDetails.Builder	setTrialEnd(InvoiceCreatePreviewParams.SubscriptionDetails.TrialEnd trialEnd)	If provided, the invoice returned will preview updating or creating a subscription with that trial end.
InvoiceCreatePreviewParams.SubscriptionDetails.Builder	setTrialEnd(Long trialEnd)	If provided, the invoice returned will preview updating or creating a subscription with that trial end.

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 InvoiceCreatePreviewParams.SubscriptionDetails build()

Finalize and obtain parameter instance from this builder.

setBillingCycleAnchor

public InvoiceCreatePreviewParams.SubscriptionDetails.Builder setBillingCycleAnchor(InvoiceCreatePreviewParams.SubscriptionDetails.BillingCycleAnchor billingCycleAnchor)

For new subscriptions, a future timestamp to anchor the subscription's billing cycle. This is used to determine the date of the first full invoice, and, for plans with month or year intervals, the day of the month for subsequent invoices. For existing subscriptions, the value can only be set to now or unchanged.

setBillingCycleAnchor

public InvoiceCreatePreviewParams.SubscriptionDetails.Builder setBillingCycleAnchor(Long billingCycleAnchor)

For new subscriptions, a future timestamp to anchor the subscription's billing cycle. This is used to determine the date of the first full invoice, and, for plans with month or year intervals, the day of the month for subsequent invoices. For existing subscriptions, the value can only be set to now or unchanged.

setCancelAt

public InvoiceCreatePreviewParams.SubscriptionDetails.Builder setCancelAt(Long cancelAt)

A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using proration_behavior. If set during a future period, this will always cause a proration for that period.

setCancelAt

public InvoiceCreatePreviewParams.SubscriptionDetails.Builder setCancelAt(EmptyParam cancelAt)

A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using proration_behavior. If set during a future period, this will always cause a proration for that period.

setCancelAtPeriodEnd

public InvoiceCreatePreviewParams.SubscriptionDetails.Builder setCancelAtPeriodEnd(Boolean cancelAtPeriodEnd)

Indicate whether this subscription should cancel at the end of the current period ( current_period_end). Defaults to false.

setCancelNow

public InvoiceCreatePreviewParams.SubscriptionDetails.Builder setCancelNow(Boolean cancelNow)

This simulates the subscription being canceled or expired immediately.

addDefaultTaxRate

public InvoiceCreatePreviewParams.SubscriptionDetails.Builder addDefaultTaxRate(String element)

Add an element to `defaultTaxRates` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See InvoiceCreatePreviewParams.SubscriptionDetails.defaultTaxRates for the field documentation.

addAllDefaultTaxRate

public InvoiceCreatePreviewParams.SubscriptionDetails.Builder addAllDefaultTaxRate(List<String> elements)

Add all elements to `defaultTaxRates` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See InvoiceCreatePreviewParams.SubscriptionDetails.defaultTaxRates for the field documentation.

setDefaultTaxRates

public InvoiceCreatePreviewParams.SubscriptionDetails.Builder setDefaultTaxRates(EmptyParam defaultTaxRates)

If provided, the invoice returned will preview updating or creating a subscription with these default tax rates. The default tax rates will apply to any line item that does not have tax_rates set.

setDefaultTaxRates

public InvoiceCreatePreviewParams.SubscriptionDetails.Builder setDefaultTaxRates(List<String> defaultTaxRates)

If provided, the invoice returned will preview updating or creating a subscription with these default tax rates. The default tax rates will apply to any line item that does not have tax_rates set.

putExtraParam

public InvoiceCreatePreviewParams.SubscriptionDetails.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 InvoiceCreatePreviewParams.SubscriptionDetails.extraParams for the field documentation.

putAllExtraParam

public InvoiceCreatePreviewParams.SubscriptionDetails.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 InvoiceCreatePreviewParams.SubscriptionDetails.extraParams for the field documentation.

addItem

public InvoiceCreatePreviewParams.SubscriptionDetails.Builder addItem(InvoiceCreatePreviewParams.SubscriptionDetails.Item element)

Add an element to `items` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See InvoiceCreatePreviewParams.SubscriptionDetails.items for the field documentation.

addAllItem

public InvoiceCreatePreviewParams.SubscriptionDetails.Builder addAllItem(List<InvoiceCreatePreviewParams.SubscriptionDetails.Item> elements)

Add all elements to `items` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See InvoiceCreatePreviewParams.SubscriptionDetails.items for the field documentation.

setProrationBehavior

public InvoiceCreatePreviewParams.SubscriptionDetails.Builder setProrationBehavior(InvoiceCreatePreviewParams.SubscriptionDetails.ProrationBehavior prorationBehavior)

Determines how to handle prorations when the billing cycle changes (e.g., when switching plans, resetting billing_cycle_anchor=now, or starting a trial), or if an item's quantity changes. The default value is create_prorations.

setProrationDate

public InvoiceCreatePreviewParams.SubscriptionDetails.Builder setProrationDate(Long prorationDate)

If previewing an update to a subscription, and doing proration, subscription_details.proration_date forces the proration to be calculated as though the update was done at the specified time. The time given must be within the current subscription period and within the current phase of the schedule backing this subscription, if the schedule exists. If set, subscription, and one of subscription_details.items, or subscription_details.trial_end are required. Also, subscription_details.proration_behavior cannot be set to 'none'.

setResumeAt

public InvoiceCreatePreviewParams.SubscriptionDetails.Builder setResumeAt(InvoiceCreatePreviewParams.SubscriptionDetails.ResumeAt resumeAt)

For paused subscriptions, setting subscription_details.resume_at to now will preview the invoice that will be generated if the subscription is resumed.

setStartDate

public InvoiceCreatePreviewParams.SubscriptionDetails.Builder setStartDate(Long startDate)

Date a subscription is intended to start (can be future or past).

setTrialEnd

public InvoiceCreatePreviewParams.SubscriptionDetails.Builder setTrialEnd(InvoiceCreatePreviewParams.SubscriptionDetails.TrialEnd trialEnd)

If provided, the invoice returned will preview updating or creating a subscription with that trial end. If set, one of subscription_details.items or subscription is required.

setTrialEnd

public InvoiceCreatePreviewParams.SubscriptionDetails.Builder setTrialEnd(Long trialEnd)

If provided, the invoice returned will preview updating or creating a subscription with that trial end. If set, one of subscription_details.items or subscription is required.