public class SubscriptionScheduleCreateParams extends ApiRequestParams
Modifier and Type | Class and Description |
---|---|
static class |
SubscriptionScheduleCreateParams.BillingThresholds |
static class |
SubscriptionScheduleCreateParams.Builder |
static class |
SubscriptionScheduleCreateParams.CollectionMethod |
static class |
SubscriptionScheduleCreateParams.EndBehavior |
static class |
SubscriptionScheduleCreateParams.InvoiceSettings
Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached.
|
static class |
SubscriptionScheduleCreateParams.Phase
Add all map key/value pairs to `extraParams` map.
|
static class |
SubscriptionScheduleCreateParams.StartDate |
ApiRequestParams.EnumParam
EXTRA_PARAMS_KEY
Modifier and Type | Method and Description |
---|---|
static SubscriptionScheduleCreateParams.Builder |
builder() |
java.lang.Object |
getBillingThresholds()
Define thresholds at which an invoice will be sent, and the subscription advanced to a new
billing period.
|
SubscriptionScheduleCreateParams.CollectionMethod |
getCollectionMethod()
Either `charge_automatically`, or `send_invoice`.
|
java.lang.String |
getCustomer()
The identifier of the customer to create the subscription schedule for.
|
java.lang.String |
getDefaultPaymentMethod()
ID of the default payment method for the subscription schedule.
|
java.lang.String |
getDefaultSource()
ID of the default payment source for the subscription schedule.
|
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.
|
SubscriptionScheduleCreateParams.InvoiceSettings |
getInvoiceSettings()
All invoices will be billed using the specified settings.
|
java.util.Map<java.lang.String,java.lang.String> |
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()
The date at which the subscription schedule starts.
|
toMap
public static SubscriptionScheduleCreateParams.Builder builder()
public java.lang.Object getBillingThresholds()
public SubscriptionScheduleCreateParams.CollectionMethod getCollectionMethod()
public java.lang.String getCustomer()
public java.lang.String getDefaultPaymentMethod()
public java.lang.String getDefaultSource()
public SubscriptionScheduleCreateParams.EndBehavior getEndBehavior()
public java.util.List<java.lang.String> getExpand()
public java.util.Map<java.lang.String,java.lang.Object> getExtraParams()
@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.public java.lang.String getFromSubscription()
public SubscriptionScheduleCreateParams.InvoiceSettings getInvoiceSettings()
public java.util.Map<java.lang.String,java.lang.String> getMetadata()
public java.util.List<SubscriptionScheduleCreateParams.Phase> getPhases()
public java.lang.Object getStartDate()