com.stripe.param

Class PlanUpdateParams.Builder

java.lang.Object

com.stripe.param.PlanUpdateParams.Builder

Enclosing class:

PlanUpdateParams

public static class PlanUpdateParams.Builder
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
PlanUpdateParams.Builder	addAllExpand(java.util.List<java.lang.String> elements) Add all elements to `expand` list.
PlanUpdateParams.Builder	addExpand(java.lang.String element) Add an element to `expand` list.
PlanUpdateParams	build() Finalize and obtain parameter instance from this builder.
PlanUpdateParams.Builder	putAllMetadata(java.util.Map<java.lang.String,java.lang.String> map) Add all map key/value pairs to `metadata` map.
PlanUpdateParams.Builder	putMetadata(java.lang.String key, java.lang.String value) Add a key/value pair to `metadata` map.
PlanUpdateParams.Builder	setActive(java.lang.Boolean active) Whether the plan is currently available for new subscriptions.
PlanUpdateParams.Builder	setNickname(java.lang.String nickname) A brief description of the plan, hidden from customers.
PlanUpdateParams.Builder	setProduct(java.lang.String product) The product the plan belongs to.
PlanUpdateParams.Builder	setTrialPeriodDays(java.lang.Long trialPeriodDays) Default number of trial days when subscribing a customer to this plan using [`trial_from_plan=true`](https://stripe.com/docs/api#create_subscription-trial_from_plan).

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

build

public PlanUpdateParams build()

Finalize and obtain parameter instance from this builder.

setActive

public PlanUpdateParams.Builder setActive(java.lang.Boolean active)

Whether the plan is currently available for new subscriptions.

addExpand

public PlanUpdateParams.Builder addExpand(java.lang.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 PlanUpdateParams.expand for the field documentation.

addAllExpand

public PlanUpdateParams.Builder addAllExpand(java.util.List<java.lang.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 PlanUpdateParams.expand for the field documentation.

putMetadata

public PlanUpdateParams.Builder putMetadata(java.lang.String key,
                                            java.lang.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 PlanUpdateParams.metadata for the field documentation.

putAllMetadata

public PlanUpdateParams.Builder putAllMetadata(java.util.Map<java.lang.String,java.lang.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 PlanUpdateParams.metadata for the field documentation.

setNickname

public PlanUpdateParams.Builder setNickname(java.lang.String nickname)

A brief description of the plan, hidden from customers.

setProduct

public PlanUpdateParams.Builder setProduct(java.lang.String product)

The product the plan belongs to. Note that after updating, statement descriptors and line items of the plan in active subscriptions will be affected.

setTrialPeriodDays

public PlanUpdateParams.Builder setTrialPeriodDays(java.lang.Long trialPeriodDays)

Default number of trial days when subscribing a customer to this plan using [`trial_from_plan=true`](https://stripe.com/docs/api#create_subscription-trial_from_plan).