com.stripe.param

Class SubscriptionCreateParams

java.lang.Object

com.stripe.net.ApiRequestParams

com.stripe.param.SubscriptionCreateParams

public class SubscriptionCreateParams
extends ApiRequestParams

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SubscriptionCreateParams.BillingThresholds
static class	SubscriptionCreateParams.Builder
static class	SubscriptionCreateParams.CollectionMethod Add all map key/value pairs to `extraParams` map.
static class	SubscriptionCreateParams.InvoiceCustomerBalanceSettings Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached.
static class	SubscriptionCreateParams.Item Add all map key/value pairs to `extraParams` map.
static class	SubscriptionCreateParams.PaymentBehavior
static class	SubscriptionCreateParams.PendingInvoiceItemInterval Usage threshold that triggers the subscription to advance to a new billing period.
static class	SubscriptionCreateParams.TransferData
static class	SubscriptionCreateParams.TrialEnd

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

Modifier and Type	Method and Description
static SubscriptionCreateParams.Builder	builder()
java.math.BigDecimal	getApplicationFeePercent() A non-negative decimal between 0 and 100, with at most two decimal places.
java.lang.Long	getBackdateStartDate() For new subscriptions, a past timestamp to backdate the subscription's start date to.
java.lang.Long	getBillingCycleAnchor() A future timestamp to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle).
java.lang.Object	getBillingThresholds() Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period.
java.lang.Long	getCancelAt() A timestamp at which the subscription should cancel.
java.lang.Boolean	getCancelAtPeriodEnd() Boolean indicating whether this subscription should cancel at the end of the current period.
SubscriptionCreateParams.CollectionMethod	getCollectionMethod() Either `charge_automatically`, or `send_invoice`.
java.lang.String	getCoupon() The code of the coupon to apply to this subscription.
java.lang.String	getCustomer() The identifier of the customer to subscribe.
java.lang.Long	getDaysUntilDue() Number of days a customer has to pay invoices generated by this subscription.
java.lang.String	getDefaultPaymentMethod() ID of the default payment method for the subscription.
java.lang.String	getDefaultSource() ID of the default payment source for the subscription.
java.lang.Object	getDefaultTaxRates() The tax rates that will apply to any subscription item that does not have `tax_rates` set.
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.
SubscriptionCreateParams.InvoiceCustomerBalanceSettings	getInvoiceCustomerBalanceSettings() Controls whether a customer balance applied to an invoice should be consumed and not credited or debited back to the customer if voided by this subscription.
java.util.List<SubscriptionCreateParams.Item>	getItems() List of subscription items, each with an attached plan.
java.util.Map<java.lang.String,java.lang.String>	getMetadata() A set of key-value pairs that you can attach to a `Subscription` object.
java.lang.Boolean	getOffSession() Indicates if a customer is on or off-session while an invoice payment is attempted.
SubscriptionCreateParams.PaymentBehavior	getPaymentBehavior() Use `allow_incomplete` to create subscriptions with `status=incomplete` if its first invoice cannot be paid.
java.lang.Object	getPendingInvoiceItemInterval() Specifies an interval for how often to bill for any pending invoice items.
java.lang.Boolean	getProrate() Boolean (defaults to `true`) telling us whether to [credit for unused time](https://stripe.com/docs/subscriptions/billing-cycle#prorations) when the billing cycle changes (e.g.
java.lang.Object	getTaxPercent() A non-negative decimal (with at most four decimal places) between 0 and 100.
SubscriptionCreateParams.TransferData	getTransferData() If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges.
java.lang.Object	getTrialEnd() Unix timestamp representing the end of the trial period the customer will get before being charged for the first time.
java.lang.Boolean	getTrialFromPlan() Indicates if a plan's `trial_period_days` should be applied to the subscription.
java.lang.Long	getTrialPeriodDays() Integer representing the number of trial period days before the customer is charged for the first time.

Methods inherited from class com.stripe.net.ApiRequestParams

toMap

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static SubscriptionCreateParams.Builder builder()

getApplicationFeePercent

public java.math.BigDecimal getApplicationFeePercent()

A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).

getBackdateStartDate

public java.lang.Long getBackdateStartDate()

For new subscriptions, a past timestamp to backdate the subscription's start date to. If set, the first invoice will contain a proration for the timespan between the start date and the current time. Can be combined with trials and the billing cycle anchor.

getBillingCycleAnchor

public java.lang.Long getBillingCycleAnchor()

A future timestamp to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/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.

getBillingThresholds

public java.lang.Object getBillingThresholds()

Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds.

getCancelAt

public java.lang.Long getCancelAt()

A timestamp at which the subscription should cancel. If set to a date before the current period ends this will cause a proration if `prorate=true`.

getCancelAtPeriodEnd

public java.lang.Boolean getCancelAtPeriodEnd()

Boolean indicating whether this subscription should cancel at the end of the current period.

getCollectionMethod

public SubscriptionCreateParams.CollectionMethod getCollectionMethod()

Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions. Defaults to `charge_automatically`.

getCoupon

public java.lang.String getCoupon()

The code of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription.

getCustomer

public java.lang.String getCustomer()

The identifier of the customer to subscribe.

getDaysUntilDue

public java.lang.Long getDaysUntilDue()

Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`.

getDefaultPaymentMethod

public java.lang.String getDefaultPaymentMethod()

ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. If not set, invoices will use the default payment method in the customer's invoice settings.

getDefaultSource

public java.lang.String getDefaultSource()

ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If not set, defaults to the customer's default source.

getDefaultTaxRates

public java.lang.Object getDefaultTaxRates()

The tax rates that will apply to any subscription item that does not have `tax_rates` set. Invoices created will have their `default_tax_rates` populated from the 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.

getInvoiceCustomerBalanceSettings

public SubscriptionCreateParams.InvoiceCustomerBalanceSettings getInvoiceCustomerBalanceSettings()

Controls whether a customer balance applied to an invoice should be consumed and not credited or debited back to the customer if voided by this subscription.

getItems

public java.util.List<SubscriptionCreateParams.Item> getItems()

List of subscription items, each with an attached plan.

getMetadata

public java.util.Map<java.lang.String,java.lang.String> getMetadata()

A set of key-value pairs that you can attach to a `Subscription` object. It can be useful for storing additional information about the subscription in a structured format.

getOffSession

public java.lang.Boolean getOffSession()

Indicates if a customer is on or off-session while an invoice payment is attempted.

getPaymentBehavior

public SubscriptionCreateParams.PaymentBehavior getPaymentBehavior()

Use `allow_incomplete` to create subscriptions with `status=incomplete` if its first invoice cannot be paid. Creating subscriptions with this status allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior.

Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's first invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not create a subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more.

getPendingInvoiceItemInterval

public java.lang.Object getPendingInvoiceItemInterval()

Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given subscription at the specified interval.

getProrate

public java.lang.Boolean getProrate()

Boolean (defaults to `true`) telling us whether to [credit for unused time](https://stripe.com/docs/subscriptions/billing-cycle#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. If `false`, the anchor period will be free (similar to a trial) and no proration adjustments will be created.

getTaxPercent

public java.lang.Object getTaxPercent()

A non-negative decimal (with at most four decimal places) between 0 and 100. This represents the percentage of the subscription invoice subtotal that will be calculated and added as tax to the final amount in each billing period. For example, a plan which charges $10/month with a `tax_percent` of `20.0` will charge $12 per invoice. To unset a previously-set value, pass an empty string. This field has been deprecated and will be removed in a future API version, for further information view the [migration docs](https://stripe.com/docs/billing/migration/taxes) for `tax_rates`.

getTransferData

public SubscriptionCreateParams.TransferData getTransferData()

If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges. This will be unset if you POST an empty value.

getTrialEnd

public java.lang.Object getTrialEnd()

Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`.

getTrialFromPlan

public java.lang.Boolean getTrialFromPlan()

Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed.

getTrialPeriodDays

public java.lang.Long getTrialPeriodDays()

Integer representing the number of trial period days before the customer is charged for the first time. This will always overwrite any trials that might apply via a subscribed plan.