com.stripe.param

Class InvoiceUpcomingParams

java.lang.Object

com.stripe.net.ApiRequestParams

com.stripe.param.InvoiceUpcomingParams

public class InvoiceUpcomingParams
extends ApiRequestParams

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	InvoiceUpcomingParams.Builder
static class	InvoiceUpcomingParams.Discount
static class	InvoiceUpcomingParams.InvoiceItem Add all map key/value pairs to `extraParams` map.
static class	InvoiceUpcomingParams.SubscriptionBillingCycleAnchor The number of intervals between subscription billings.
static class	InvoiceUpcomingParams.SubscriptionItem Same as unit_amount, but accepts a decimal value with at most 12 decimal places.
static class	InvoiceUpcomingParams.SubscriptionProrationBehavior
static class	InvoiceUpcomingParams.SubscriptionTrialEnd

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 InvoiceUpcomingParams.Builder	builder()
java.lang.String	getCoupon() The code of the coupon to apply.
java.lang.String	getCustomer() The identifier of the customer whose upcoming invoice you'd like to retrieve.
java.lang.Object	getDiscounts()
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.util.List<InvoiceUpcomingParams.InvoiceItem>	getInvoiceItems() List of invoice items to add or update in the upcoming invoice preview.
java.lang.String	getSchedule() The identifier of the unstarted schedule whose upcoming invoice you'd like to retrieve.
java.lang.String	getSubscription() The identifier of the subscription for which you'd like to retrieve the upcoming invoice.
java.lang.Object	getSubscriptionBillingCycleAnchor() For new subscriptions, a future timestamp to anchor the subscription's billing cycle.
java.lang.Object	getSubscriptionCancelAt() Timestamp indicating when the subscription should be scheduled to cancel.
java.lang.Boolean	getSubscriptionCancelAtPeriodEnd() Boolean indicating whether this subscription should cancel at the end of the current period.
java.lang.Boolean	getSubscriptionCancelNow() This simulates the subscription being canceled or expired immediately.
java.lang.Object	getSubscriptionDefaultTaxRates() If provided, the invoice returned will preview updating or creating a subscription with these default tax rates.
java.util.List<InvoiceUpcomingParams.SubscriptionItem>	getSubscriptionItems() A list of up to 20 subscription items, each with an attached price.
java.lang.Boolean	getSubscriptionProrate() This field has been renamed to subscription_proration_behavior.
InvoiceUpcomingParams.SubscriptionProrationBehavior	getSubscriptionProrationBehavior() 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.
java.lang.Long	getSubscriptionProrationDate() If previewing an update to a subscription, and doing proration, subscription_proration_date forces the proration to be calculated as though the update was done at the specified time.
java.lang.Long	getSubscriptionStartDate() Date a subscription is intended to start (can be future or past).
java.math.BigDecimal	getSubscriptionTaxPercent() If provided, the invoice returned will preview updating or creating a subscription with that tax percent.
java.lang.Object	getSubscriptionTrialEnd() If provided, the invoice returned will preview updating or creating a subscription with that trial end.
java.lang.Boolean	getSubscriptionTrialFromPlan() Indicates if a plan's trial_period_days should be applied to the subscription.

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 InvoiceUpcomingParams.Builder builder()

getCoupon

public java.lang.String getCoupon()

The code of the coupon to apply. If subscription or subscription_items is provided, the invoice returned will preview updating or creating a subscription with that coupon. Otherwise, it will preview applying that coupon to the customer for the next upcoming invoice from among the customer's subscriptions. The invoice can be previewed without a coupon by passing this value as an empty string.

getCustomer

public java.lang.String getCustomer()

The identifier of the customer whose upcoming invoice you'd like to retrieve.

getDiscounts

public java.lang.Object getDiscounts()

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.

getInvoiceItems

public java.util.List<InvoiceUpcomingParams.InvoiceItem> getInvoiceItems()

List of invoice items to add or update in the upcoming invoice preview.

getSchedule

public java.lang.String getSchedule()

The identifier of the unstarted schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields.

getSubscription

public java.lang.String getSubscription()

The identifier of the subscription for which you'd like to retrieve the upcoming invoice. If not provided, but a subscription_items is provided, you will preview creating a subscription with those items. If neither subscription nor subscription_items is provided, you will retrieve the next upcoming invoice from among the customer's subscriptions.

getSubscriptionBillingCycleAnchor

public java.lang.Object getSubscriptionBillingCycleAnchor()

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.

getSubscriptionCancelAt

public java.lang.Object getSubscriptionCancelAt()

Timestamp indicating when the subscription should be scheduled to cancel. Will prorate if within the current period and prorations have been enabled using proration_behavior.

getSubscriptionCancelAtPeriodEnd

public java.lang.Boolean getSubscriptionCancelAtPeriodEnd()

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

getSubscriptionCancelNow

public java.lang.Boolean getSubscriptionCancelNow()

This simulates the subscription being canceled or expired immediately.

getSubscriptionDefaultTaxRates

public java.lang.Object getSubscriptionDefaultTaxRates()

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.

getSubscriptionItems

public java.util.List<InvoiceUpcomingParams.SubscriptionItem> getSubscriptionItems()

A list of up to 20 subscription items, each with an attached price.

getSubscriptionProrate

public java.lang.Boolean getSubscriptionProrate()

This field has been renamed to subscription_proration_behavior. subscription_prorate=true can be replaced with subscription_proration_behavior=create_prorations and subscription_prorate=false can be replaced with subscription_proration_behavior=none.

getSubscriptionProrationBehavior

public InvoiceUpcomingParams.SubscriptionProrationBehavior getSubscriptionProrationBehavior()

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. Valid values are create_prorations, none, or always_invoice.

Passing create_prorations will cause proration invoice items to be created when applicable. These proration items will only be invoiced immediately under certain conditions. In order to always invoice immediately for prorations, pass always_invoice.

Prorations can be disabled by passing none.

getSubscriptionProrationDate

public java.lang.Long getSubscriptionProrationDate()

If previewing an update to a subscription, and doing proration, subscription_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 cannot be before the subscription was on its current plan. If set, subscription, and one of subscription_items, or subscription_trial_end are required. Also, subscription_proration cannot be set to false.

getSubscriptionStartDate

public java.lang.Long getSubscriptionStartDate()

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

getSubscriptionTaxPercent

public java.math.BigDecimal getSubscriptionTaxPercent()

If provided, the invoice returned will preview updating or creating a subscription with that tax percent. If set, one of subscription_items or subscription is required. This field has been deprecated and will be removed in a future API version, for further information view the migration docs for tax_rates.

getSubscriptionTrialEnd

public java.lang.Object getSubscriptionTrialEnd()

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

getSubscriptionTrialFromPlan

public java.lang.Boolean getSubscriptionTrialFromPlan()

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