Package com.stripe.param
Class SubscriptionScheduleCreateParams
- java.lang.Object
-
- com.stripe.net.ApiRequestParams
-
- com.stripe.param.SubscriptionScheduleCreateParams
-
public class SubscriptionScheduleCreateParams extends ApiRequestParams
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
SubscriptionScheduleCreateParams.Builder
static class
SubscriptionScheduleCreateParams.DefaultSettings
static class
SubscriptionScheduleCreateParams.EndBehavior
static class
SubscriptionScheduleCreateParams.Phase
static class
SubscriptionScheduleCreateParams.StartDate
-
Nested classes/interfaces inherited from class com.stripe.net.ApiRequestParams
ApiRequestParams.EnumParam
-
-
Field Summary
-
Fields inherited from class com.stripe.net.ApiRequestParams
EXTRA_PARAMS_KEY
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static SubscriptionScheduleCreateParams.Builder
builder()
java.lang.String
getCustomer()
The identifier of the customer to create the subscription schedule for.SubscriptionScheduleCreateParams.DefaultSettings
getDefaultSettings()
Object representing the subscription schedule's default settings.SubscriptionScheduleCreateParams.EndBehavior
getEndBehavior()
Configures how the subscription schedule behaves when it ends.java.util.List<java.lang.String>
getExpand()
Specifies which fields in the response should be expanded.java.util.Map<java.lang.String,java.lang.Object>
getExtraParams()
Map of extra parameters for custom features not available in this client library.java.lang.String
getFromSubscription()
Migrate an existing subscription to be managed by a subscription schedule.java.lang.Object
getMetadata()
Set of key-value pairs that you can attach to an object.java.util.List<SubscriptionScheduleCreateParams.Phase>
getPhases()
List representing phases of the subscription schedule.java.lang.Object
getStartDate()
When the subscription schedule starts.-
Methods inherited from class com.stripe.net.ApiRequestParams
toMap
-
-
-
-
Method Detail
-
builder
public static SubscriptionScheduleCreateParams.Builder builder()
-
getCustomer
public java.lang.String getCustomer()
The identifier of the customer to create the subscription schedule for.
-
getDefaultSettings
public SubscriptionScheduleCreateParams.DefaultSettings getDefaultSettings()
Object representing the subscription schedule's default settings.
-
getEndBehavior
public SubscriptionScheduleCreateParams.EndBehavior getEndBehavior()
Configures how the subscription schedule behaves when it ends. Possible values arerelease
orcancel
with the default beingrelease
.release
will end the subscription schedule and keep the underlying subscription running.cancel
will end the subscription schedule and cancel the underlying subscription.
-
getExpand
public java.util.List<java.lang.String> getExpand()
Specifies which fields in the response should be expanded.
-
getExtraParams
public java.util.Map<java.lang.String,java.lang.Object> getExtraParams()
Map of extra parameters for custom features not available in this client library. The content in this map is not serialized under this field's@SerializedName
value. Instead, each key/value pair is serialized as if the key is a root-level field (serialized) name in this param object. Effectively, this map is flattened to its parent instance.
-
getFromSubscription
public java.lang.String getFromSubscription()
Migrate an existing subscription to be managed by a subscription schedule. If this parameter is set, a subscription schedule will be created using the subscription's item(s), set to auto-renew using the subscription's interval. When using this parameter, other parameters (such as phase values) cannot be set. To create a subscription schedule with other modifications, we recommend making two separate API calls.
-
getMetadata
public java.lang.Object getMetadata()
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value tometadata
.
-
getPhases
public java.util.List<SubscriptionScheduleCreateParams.Phase> getPhases()
List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, theend_date
of one phase will always equal thestart_date
of the next phase.
-
getStartDate
public java.lang.Object getStartDate()
When the subscription schedule starts. We recommend usingnow
so that it starts the subscription immediately. You can also use a Unix timestamp to backdate the subscription so that it starts on a past date, or set a future date for the subscription to start on.
-
-