Package com.stripe.param

Class InvoiceUpcomingParams.Builder

java.lang.Object
com.stripe.param.InvoiceUpcomingParams.Builder
Enclosing class:
InvoiceUpcomingParams
public static class InvoiceUpcomingParams.Builder extends Object

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • build

      public InvoiceUpcomingParams build()
      Finalize and obtain parameter instance from this builder.

    • setAutomaticTax

      public InvoiceUpcomingParams.Builder setAutomaticTax(InvoiceUpcomingParams.AutomaticTax automaticTax)
      Settings for automatic tax lookup for this invoice preview.

    • setCoupon

      public InvoiceUpcomingParams.Builder setCoupon(String coupon)
      The ID of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use discounts instead.

    • setCurrency

      public InvoiceUpcomingParams.Builder setCurrency(String currency)
      The currency to preview this invoice in. Defaults to that of customer if not specified.

    • setCustomer

      public InvoiceUpcomingParams.Builder setCustomer(String customer)
      The identifier of the customer whose upcoming invoice you'd like to retrieve. If automatic_tax is enabled then one of customer, customer_details, subscription, or schedule must be set.

    • setCustomerDetails

      public InvoiceUpcomingParams.Builder setCustomerDetails(InvoiceUpcomingParams.CustomerDetails customerDetails)
      Details about the customer you want to invoice or overrides for an existing customer. If automatic_tax is enabled then one of customer, customer_details, subscription, or schedule must be set.

    • addDiscount

      public InvoiceUpcomingParams.Builder addDiscount(InvoiceUpcomingParams.Discount element)
      Add an element to `discounts` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See InvoiceUpcomingParams.discounts for the field documentation.

    • addAllDiscount

      public InvoiceUpcomingParams.Builder addAllDiscount(List<InvoiceUpcomingParams.Discount> elements)
      Add all elements to `discounts` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See InvoiceUpcomingParams.discounts for the field documentation.

    • setDiscounts

      public InvoiceUpcomingParams.Builder setDiscounts(EmptyParam discounts)
      The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the subscription or customer. This works for both coupons directly applied to an invoice and coupons applied to a subscription. Pass an empty string to avoid inheriting any discounts.

    • setDiscounts

      public InvoiceUpcomingParams.Builder setDiscounts(List<InvoiceUpcomingParams.Discount> discounts)
      The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the subscription or customer. This works for both coupons directly applied to an invoice and coupons applied to a subscription. Pass an empty string to avoid inheriting any discounts.

    • addExpand

      public InvoiceUpcomingParams.Builder addExpand(String element)
      Add an element to `expand` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See InvoiceUpcomingParams.expand for the field documentation.

    • addAllExpand

      public InvoiceUpcomingParams.Builder addAllExpand(List<String> elements)
      Add all elements to `expand` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See InvoiceUpcomingParams.expand for the field documentation.

    • putExtraParam

      public InvoiceUpcomingParams.Builder putExtraParam(String key, Object value)
      Add a key/value pair to `extraParams` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. See InvoiceUpcomingParams.extraParams for the field documentation.

    • putAllExtraParam

      public InvoiceUpcomingParams.Builder putAllExtraParam(Map<String,Object> map)
      Add all map key/value pairs to `extraParams` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. See InvoiceUpcomingParams.extraParams for the field documentation.

    • addInvoiceItem

      public InvoiceUpcomingParams.Builder addInvoiceItem(InvoiceUpcomingParams.InvoiceItem element)
      Add an element to `invoiceItems` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See InvoiceUpcomingParams.invoiceItems for the field documentation.

    • addAllInvoiceItem

      public InvoiceUpcomingParams.Builder addAllInvoiceItem(List<InvoiceUpcomingParams.InvoiceItem> elements)
      Add all elements to `invoiceItems` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See InvoiceUpcomingParams.invoiceItems for the field documentation.

    • setIssuer

      public InvoiceUpcomingParams.Builder setIssuer(InvoiceUpcomingParams.Issuer issuer)
      The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.

    • setOnBehalfOf

      public InvoiceUpcomingParams.Builder setOnBehalfOf(String onBehalfOf)
      The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the Invoices with Connect documentation for details.

    • setOnBehalfOf

      public InvoiceUpcomingParams.Builder setOnBehalfOf(EmptyParam onBehalfOf)
      The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the Invoices with Connect documentation for details.

    • setPreviewMode

      public InvoiceUpcomingParams.Builder setPreviewMode(InvoiceUpcomingParams.PreviewMode previewMode)
      Customizes the types of values to include when calculating the invoice. Defaults to next if unspecified.

    • setSchedule

      public InvoiceUpcomingParams.Builder setSchedule(String schedule)
      The identifier of the schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields.

    • setScheduleDetails

      public InvoiceUpcomingParams.Builder setScheduleDetails(InvoiceUpcomingParams.ScheduleDetails scheduleDetails)
      The schedule creation or modification params to apply as a preview. Cannot be used with subscription or subscription_ prefixed fields.

    • setSubscription

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

    • setSubscriptionBillingCycleAnchor

      public InvoiceUpcomingParams.Builder setSubscriptionBillingCycleAnchor(InvoiceUpcomingParams.SubscriptionBillingCycleAnchor subscriptionBillingCycleAnchor)
      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. This field has been deprecated and will be removed in a future API version. Use subscription_details.billing_cycle_anchor instead.

    • setSubscriptionBillingCycleAnchor

      public InvoiceUpcomingParams.Builder setSubscriptionBillingCycleAnchor(Long subscriptionBillingCycleAnchor)
      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. This field has been deprecated and will be removed in a future API version. Use subscription_details.billing_cycle_anchor instead.

    • setSubscriptionCancelAt

      public InvoiceUpcomingParams.Builder setSubscriptionCancelAt(Long subscriptionCancelAt)
      A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using proration_behavior. If set during a future period, this will always cause a proration for that period. This field has been deprecated and will be removed in a future API version. Use subscription_details.cancel_at instead.

    • setSubscriptionCancelAt

      public InvoiceUpcomingParams.Builder setSubscriptionCancelAt(EmptyParam subscriptionCancelAt)
      A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using proration_behavior. If set during a future period, this will always cause a proration for that period. This field has been deprecated and will be removed in a future API version. Use subscription_details.cancel_at instead.

    • setSubscriptionCancelAtPeriodEnd

      public InvoiceUpcomingParams.Builder setSubscriptionCancelAtPeriodEnd(Boolean subscriptionCancelAtPeriodEnd)
      Indicate whether this subscription should cancel at the end of the current period ( current_period_end). Defaults to false. This field has been deprecated and will be removed in a future API version. Use subscription_details.cancel_at_period_end instead.

    • setSubscriptionCancelNow

      public InvoiceUpcomingParams.Builder setSubscriptionCancelNow(Boolean subscriptionCancelNow)
      This simulates the subscription being canceled or expired immediately. This field has been deprecated and will be removed in a future API version. Use subscription_details.cancel_now instead.

    • addSubscriptionDefaultTaxRate

      public InvoiceUpcomingParams.Builder addSubscriptionDefaultTaxRate(String element)
      Add an element to `subscriptionDefaultTaxRates` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See InvoiceUpcomingParams.subscriptionDefaultTaxRates for the field documentation.

    • addAllSubscriptionDefaultTaxRate

      public InvoiceUpcomingParams.Builder addAllSubscriptionDefaultTaxRate(List<String> elements)
      Add all elements to `subscriptionDefaultTaxRates` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See InvoiceUpcomingParams.subscriptionDefaultTaxRates for the field documentation.

    • setSubscriptionDefaultTaxRates

      public InvoiceUpcomingParams.Builder setSubscriptionDefaultTaxRates(EmptyParam subscriptionDefaultTaxRates)
      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. This field has been deprecated and will be removed in a future API version. Use subscription_details.default_tax_rates instead.

    • setSubscriptionDefaultTaxRates

      public InvoiceUpcomingParams.Builder setSubscriptionDefaultTaxRates(List<String> subscriptionDefaultTaxRates)
      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. This field has been deprecated and will be removed in a future API version. Use subscription_details.default_tax_rates instead.

    • setSubscriptionDetails

      public InvoiceUpcomingParams.Builder setSubscriptionDetails(InvoiceUpcomingParams.SubscriptionDetails subscriptionDetails)
      The subscription creation or modification params to apply as a preview. Cannot be used with schedule or schedule_details fields.

    • addSubscriptionItem

      public InvoiceUpcomingParams.Builder addSubscriptionItem(InvoiceUpcomingParams.SubscriptionItem element)
      Add an element to `subscriptionItems` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See InvoiceUpcomingParams.subscriptionItems for the field documentation.

    • addAllSubscriptionItem

      public InvoiceUpcomingParams.Builder addAllSubscriptionItem(List<InvoiceUpcomingParams.SubscriptionItem> elements)
      Add all elements to `subscriptionItems` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See InvoiceUpcomingParams.subscriptionItems for the field documentation.

    • setSubscriptionProrationBehavior

      public InvoiceUpcomingParams.Builder setSubscriptionProrationBehavior(InvoiceUpcomingParams.SubscriptionProrationBehavior subscriptionProrationBehavior)
      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. The default value is create_prorations. This field has been deprecated and will be removed in a future API version. Use subscription_details.proration_behavior instead.

    • setSubscriptionProrationDate

      public InvoiceUpcomingParams.Builder setSubscriptionProrationDate(Long subscriptionProrationDate)
      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 of subscription_items, or subscription_trial_end are required. Also, subscription_proration_behavior cannot be set to 'none'. This field has been deprecated and will be removed in a future API version. Use subscription_details.proration_date instead.

    • setSubscriptionResumeAt

      public InvoiceUpcomingParams.Builder setSubscriptionResumeAt(InvoiceUpcomingParams.SubscriptionResumeAt subscriptionResumeAt)
      For paused subscriptions, setting subscription_resume_at to now will preview the invoice that will be generated if the subscription is resumed. This field has been deprecated and will be removed in a future API version. Use subscription_details.resume_at instead.

    • setSubscriptionStartDate

      public InvoiceUpcomingParams.Builder setSubscriptionStartDate(Long subscriptionStartDate)
      Date a subscription is intended to start (can be future or past). This field has been deprecated and will be removed in a future API version. Use subscription_details.start_date instead.

    • setSubscriptionTrialEnd

      public InvoiceUpcomingParams.Builder setSubscriptionTrialEnd(InvoiceUpcomingParams.SubscriptionTrialEnd subscriptionTrialEnd)
      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. This field has been deprecated and will be removed in a future API version. Use subscription_details.trial_end instead.

    • setSubscriptionTrialEnd

      public InvoiceUpcomingParams.Builder setSubscriptionTrialEnd(Long subscriptionTrialEnd)
      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. This field has been deprecated and will be removed in a future API version. Use subscription_details.trial_end instead.

    • setSubscriptionTrialFromPlan

      public InvoiceUpcomingParams.Builder setSubscriptionTrialFromPlan(Boolean subscriptionTrialFromPlan)
      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. See Using trial periods on subscriptions to learn more.