Package com.stripe.param

Class InvoiceCreatePreviewParams

java.lang.Object
com.stripe.net.ApiRequestParams
com.stripe.param.InvoiceCreatePreviewParams
public class InvoiceCreatePreviewParams extends ApiRequestParams

  • Method Details

    • builder

      public static InvoiceCreatePreviewParams.Builder builder()

    • getAutomaticTax

      public InvoiceCreatePreviewParams.AutomaticTax getAutomaticTax()
      Settings for automatic tax lookup for this invoice preview.

    • getCoupon

      public String getCoupon()
      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.

    • getCurrency

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

    • getCustomer

      public String getCustomer()
      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.

    • getCustomerDetails

      public InvoiceCreatePreviewParams.CustomerDetails getCustomerDetails()
      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.

    • getDiscounts

      public Object getDiscounts()
      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.

    • getExpand

      public List<String> getExpand()
      Specifies which fields in the response should be expanded.

    • getExtraParams

      public Map<String,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 List<InvoiceCreatePreviewParams.InvoiceItem> getInvoiceItems()
      List of invoice items to add or update in the upcoming invoice preview.

    • getIssuer

      public InvoiceCreatePreviewParams.Issuer getIssuer()
      The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.

    • getOnBehalfOf

      public Object getOnBehalfOf()
      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.

    • getPreviewMode

      public InvoiceCreatePreviewParams.PreviewMode getPreviewMode()
      Customizes the types of values to include when calculating the invoice. Defaults to next if unspecified.

    • getSchedule

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

    • getScheduleDetails

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

    • getSubscription

      public String getSubscription()
      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.

    • getSubscriptionDetails

      public InvoiceCreatePreviewParams.SubscriptionDetails getSubscriptionDetails()
      The subscription creation or modification params to apply as a preview. Cannot be used with schedule or schedule_details fields.