Package com.stripe.param

Class InvoiceUpcomingLinesParams.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • build

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

    • setAutomaticTax

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

    • setCoupon

      public InvoiceUpcomingLinesParams.Builder setCoupon(String coupon)
      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.

    • setCurrency

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

    • setCustomer

      public InvoiceUpcomingLinesParams.Builder setCustomer(String customer)
      The identifier of the customer whose upcoming invoice you'd like to retrieve.

    • setCustomerDetails

      public InvoiceUpcomingLinesParams.Builder setCustomerDetails(InvoiceUpcomingLinesParams.CustomerDetails customerDetails)
      Details about the customer you want to invoice or overrides for an existing customer.

    • addDiscount

      public InvoiceUpcomingLinesParams.Builder addDiscount(InvoiceUpcomingLinesParams.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 InvoiceUpcomingLinesParams.discounts for the field documentation.

    • addAllDiscount

      public InvoiceUpcomingLinesParams.Builder addAllDiscount(List<InvoiceUpcomingLinesParams.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 InvoiceUpcomingLinesParams.discounts for the field documentation.

    • setDiscounts

      public InvoiceUpcomingLinesParams.Builder setDiscounts(EmptyParam discounts)
      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 the coupon parameter instead. Pass an empty string to avoid inheriting any discounts. To preview the upcoming invoice for a subscription that hasn't been created, use coupon instead.

    • setDiscounts

      public InvoiceUpcomingLinesParams.Builder setDiscounts(List<InvoiceUpcomingLinesParams.Discount> discounts)
      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 the coupon parameter instead. Pass an empty string to avoid inheriting any discounts. To preview the upcoming invoice for a subscription that hasn't been created, use coupon instead.

    • setEndingBefore

      public InvoiceUpcomingLinesParams.Builder setEndingBefore(String endingBefore)
      A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.

    • addExpand

      public InvoiceUpcomingLinesParams.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 InvoiceUpcomingLinesParams.expand for the field documentation.

    • addAllExpand

      public InvoiceUpcomingLinesParams.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 InvoiceUpcomingLinesParams.expand for the field documentation.

    • putExtraParam

      public InvoiceUpcomingLinesParams.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 InvoiceUpcomingLinesParams.extraParams for the field documentation.

    • putAllExtraParam

      public InvoiceUpcomingLinesParams.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 InvoiceUpcomingLinesParams.extraParams for the field documentation.

    • addInvoiceItem

      public InvoiceUpcomingLinesParams.Builder addInvoiceItem(InvoiceUpcomingLinesParams.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 InvoiceUpcomingLinesParams.invoiceItems for the field documentation.

    • addAllInvoiceItem

      public InvoiceUpcomingLinesParams.Builder addAllInvoiceItem(List<InvoiceUpcomingLinesParams.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 InvoiceUpcomingLinesParams.invoiceItems for the field documentation.

    • setLimit

      public InvoiceUpcomingLinesParams.Builder setLimit(Long limit)
      A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

    • setSchedule

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

    • setStartingAfter

      public InvoiceUpcomingLinesParams.Builder setStartingAfter(String startingAfter)
      A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

    • setSubscription

      public InvoiceUpcomingLinesParams.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_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.

    • setSubscriptionBillingCycleAnchor

      public InvoiceUpcomingLinesParams.Builder setSubscriptionBillingCycleAnchor(InvoiceUpcomingLinesParams.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.

    • setSubscriptionBillingCycleAnchor

      public InvoiceUpcomingLinesParams.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.

    • setSubscriptionCancelAt

      public InvoiceUpcomingLinesParams.Builder setSubscriptionCancelAt(Long subscriptionCancelAt)
      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.

    • setSubscriptionCancelAt

      public InvoiceUpcomingLinesParams.Builder setSubscriptionCancelAt(EmptyParam subscriptionCancelAt)
      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.

    • setSubscriptionCancelAtPeriodEnd

      public InvoiceUpcomingLinesParams.Builder setSubscriptionCancelAtPeriodEnd(Boolean subscriptionCancelAtPeriodEnd)
      Boolean indicating whether this subscription should cancel at the end of the current period.

    • setSubscriptionCancelNow

      public InvoiceUpcomingLinesParams.Builder setSubscriptionCancelNow(Boolean subscriptionCancelNow)
      This simulates the subscription being canceled or expired immediately.

    • addSubscriptionDefaultTaxRate

      public InvoiceUpcomingLinesParams.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 InvoiceUpcomingLinesParams.subscriptionDefaultTaxRates for the field documentation.

    • addAllSubscriptionDefaultTaxRate

      public InvoiceUpcomingLinesParams.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 InvoiceUpcomingLinesParams.subscriptionDefaultTaxRates for the field documentation.

    • setSubscriptionDefaultTaxRates

      public InvoiceUpcomingLinesParams.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.

    • setSubscriptionDefaultTaxRates

      public InvoiceUpcomingLinesParams.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.

    • addSubscriptionItem

      public InvoiceUpcomingLinesParams.Builder addSubscriptionItem(InvoiceUpcomingLinesParams.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 InvoiceUpcomingLinesParams.subscriptionItems for the field documentation.

    • addAllSubscriptionItem

      public InvoiceUpcomingLinesParams.Builder addAllSubscriptionItem(List<InvoiceUpcomingLinesParams.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 InvoiceUpcomingLinesParams.subscriptionItems for the field documentation.

    • setSubscriptionPrebilling

      public InvoiceUpcomingLinesParams.Builder setSubscriptionPrebilling(InvoiceUpcomingLinesParams.SubscriptionPrebilling subscriptionPrebilling)
      The pre-billing to apply to the subscription as a preview.

    • setSubscriptionProrationBehavior

      public InvoiceUpcomingLinesParams.Builder setSubscriptionProrationBehavior(InvoiceUpcomingLinesParams.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.

    • setSubscriptionProrationDate

      public InvoiceUpcomingLinesParams.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'.

    • setSubscriptionResumeAt

      public InvoiceUpcomingLinesParams.Builder setSubscriptionResumeAt(InvoiceUpcomingLinesParams.SubscriptionResumeAt subscriptionResumeAt)
      For paused subscriptions, setting subscription_resume_at to now will preview the invoice that will be generated if the subscription is resumed.

    • setSubscriptionStartDate

      public InvoiceUpcomingLinesParams.Builder setSubscriptionStartDate(Long subscriptionStartDate)
      Date a subscription is intended to start (can be future or past).

    • setSubscriptionTrialEnd

      public InvoiceUpcomingLinesParams.Builder setSubscriptionTrialEnd(InvoiceUpcomingLinesParams.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.

    • setSubscriptionTrialEnd

      public InvoiceUpcomingLinesParams.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.

    • setSubscriptionTrialFromPlan

      public InvoiceUpcomingLinesParams.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.