Package com.stripe.param
Class InvoiceUpcomingParams
java.lang.Object
com.stripe.net.ApiRequestParams
com.stripe.param.InvoiceUpcomingParams
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
static class
static class
Add all map key/value pairs to `extraParams` map.static class
static class
Add all map key/value pairs to `extraParams` map.static enum
The number of intervals between subscription billings.static class
static enum
static enum
static enum
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 TypeMethodDescriptionbuilder()
Settings for automatic tax lookup for this invoice preview.The code of the coupon to apply.The currency to preview this invoice in.The identifier of the customer whose upcoming invoice you'd like to retrieve.Details about the customer you want to invoice or overrides for an existing customer.The coupons to redeem into discounts for the invoice preview.Specifies which fields in the response should be expanded.Map of extra parameters for custom features not available in this client library.List of invoice items to add or update in the upcoming invoice preview.The identifier of the unstarted schedule whose upcoming invoice you'd like to retrieve.The identifier of the subscription for which you'd like to retrieve the upcoming invoice.For new subscriptions, a future timestamp to anchor the subscription's billing cycle.Timestamp indicating when the subscription should be scheduled to cancel.Boolean indicating whether this subscription should cancel at the end of the current period.This simulates the subscription being canceled or expired immediately.If provided, the invoice returned will preview updating or creating a subscription with these default tax rates.A list of up to 20 subscription items, each with an attached price.Determines how to handle prorations when the billing cycle changes (e.g., when switching plans, resettingbilling_cycle_anchor=now
, or starting a trial), or if an item'squantity
changes.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.For paused subscriptions, settingsubscription_resume_at
tonow
will preview the invoice that will be generated if the subscription is resumed.Date a subscription is intended to start (can be future or past).If provided, the invoice returned will preview updating or creating a subscription with that trial end.Indicates if a plan'strial_period_days
should be applied to the subscription.Methods inherited from class com.stripe.net.ApiRequestParams
toMap
-
Method Details
-
builder
-
getAutomaticTax
Settings for automatic tax lookup for this invoice preview. -
getCoupon
The code of the coupon to apply. Ifsubscription
orsubscription_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. -
getCurrency
The currency to preview this invoice in. Defaults to that ofcustomer
if not specified. -
getCustomer
The identifier of the customer whose upcoming invoice you'd like to retrieve. -
getCustomerDetails
Details about the customer you want to invoice or overrides for an existing customer. -
getDiscounts
The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the customer or subscription. This only works for coupons directly applied to the invoice. To apply a coupon to a subscription, you must use thecoupon
parameter instead. Pass an empty string to avoid inheriting any discounts. To preview the upcoming invoice for a subscription that hasn't been created, usecoupon
instead. -
getExpand
Specifies which fields in the response should be expanded. -
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
List of invoice items to add or update in the upcoming invoice preview. -
getSchedule
The identifier of the unstarted schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields. -
getSubscription
The identifier of the subscription for which you'd like to retrieve the upcoming invoice. If not provided, but asubscription_items
is provided, you will preview creating a subscription with those items. If neithersubscription
norsubscription_items
is provided, you will retrieve the next upcoming invoice from among the customer's subscriptions. -
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 withmonth
oryear
intervals, the day of the month for subsequent invoices. For existing subscriptions, the value can only be set tonow
orunchanged
. -
getSubscriptionCancelAt
Timestamp indicating when the subscription should be scheduled to cancel. Will prorate if within the current period and prorations have been enabled usingproration_behavior
. -
getSubscriptionCancelAtPeriodEnd
Boolean indicating whether this subscription should cancel at the end of the current period. -
getSubscriptionCancelNow
This simulates the subscription being canceled or expired immediately. -
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 havetax_rates
set. -
getSubscriptionItems
A list of up to 20 subscription items, each with an attached price. -
getSubscriptionProrationBehavior
Determines how to handle prorations when the billing cycle changes (e.g., when switching plans, resettingbilling_cycle_anchor=now
, or starting a trial), or if an item'squantity
changes. The default value iscreate_prorations
. -
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 within the current phase of the schedule backing this subscription, if the schedule exists. If set,subscription
, and one ofsubscription_items
, orsubscription_trial_end
are required. Also,subscription_proration_behavior
cannot be set to 'none'. -
getSubscriptionResumeAt
For paused subscriptions, settingsubscription_resume_at
tonow
will preview the invoice that will be generated if the subscription is resumed. -
getSubscriptionStartDate
Date a subscription is intended to start (can be future or past). -
getSubscriptionTrialEnd
If provided, the invoice returned will preview updating or creating a subscription with that trial end. If set, one ofsubscription_items
orsubscription
is required. -
getSubscriptionTrialFromPlan
Indicates if a plan'strial_period_days
should be applied to the subscription. Settingsubscription_trial_end
per subscription is preferred, and this defaults tofalse
. Setting this flag totrue
together withsubscription_trial_end
is not allowed. See Using trial periods on subscriptions to learn more.
-