Package com.stripe.model

Class QuotePreviewSubscriptionSchedule.DefaultSettings

java.lang.Object
com.stripe.model.StripeObject
com.stripe.model.QuotePreviewSubscriptionSchedule.DefaultSettings
All Implemented Interfaces:
StripeObjectInterface
Enclosing class:
QuotePreviewSubscriptionSchedule
public static class QuotePreviewSubscriptionSchedule.DefaultSettings extends StripeObject
For more details about DefaultSettings, please refer to the API Reference.

  • Constructor Details

    • DefaultSettings

      public DefaultSettings()

  • Method Details

    • getDefaultPaymentMethod

      public String getDefaultPaymentMethod()
      Get ID of expandable defaultPaymentMethod object.

    • setDefaultPaymentMethod

      public void setDefaultPaymentMethod(String id)

    • getDefaultPaymentMethodObject

      public PaymentMethod getDefaultPaymentMethodObject()
      Get expanded defaultPaymentMethod.

    • setDefaultPaymentMethodObject

      public void setDefaultPaymentMethodObject(PaymentMethod expandableObject)

    • getOnBehalfOf

      public String getOnBehalfOf()
      Get ID of expandable onBehalfOf object.

    • setOnBehalfOf

      public void setOnBehalfOf(String id)

    • getOnBehalfOfObject

      public Account getOnBehalfOfObject()
      Get expanded onBehalfOf.

    • setOnBehalfOfObject

      public void setOnBehalfOfObject(Account expandableObject)

    • getApplicationFeePercent

      public BigDecimal getApplicationFeePercent()
      A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account during this phase of the schedule.

    • getAutomaticTax

      public QuotePreviewSubscriptionSchedule.DefaultSettings.AutomaticTax getAutomaticTax()

    • getBillingCycleAnchor

      public String getBillingCycleAnchor()
      Possible values are phase_start or automatic. If phase_start then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If automatic then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle documentation.

      One of automatic, or phase_start.

    • getBillingThresholds

      public QuotePreviewSubscriptionSchedule.DefaultSettings.BillingThresholds getBillingThresholds()
      Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period.

    • getCollectionMethod

      public String getCollectionMethod()
      Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as active.

      One of charge_automatically, or send_invoice.

    • getDescription

      public String getDescription()
      Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.

    • getInvoiceSettings

      public QuotePreviewSubscriptionSchedule.DefaultSettings.InvoiceSettings getInvoiceSettings()

    • getPhaseEffectiveAt

      public String getPhaseEffectiveAt()
      Configures how the subscription schedule handles billing for phase transitions. Possible values are phase_start (default) or billing_period_start. phase_start bills based on the current state of the subscription, ignoring changes scheduled in future phases. billing_period_start bills predictively for upcoming phase transitions within the current billing cycle, including pricing changes and service period adjustments that will occur before the next invoice.

      One of billing_period_start, or phase_start.

    • getTransferData

      public QuotePreviewSubscriptionSchedule.DefaultSettings.TransferData getTransferData()
      The account (if any) the associated subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices.

    • setApplicationFeePercent

      public void setApplicationFeePercent(BigDecimal applicationFeePercent)
      A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account during this phase of the schedule.

    • setAutomaticTax

      public void setAutomaticTax(QuotePreviewSubscriptionSchedule.DefaultSettings.AutomaticTax automaticTax)

    • setBillingCycleAnchor

      public void setBillingCycleAnchor(String billingCycleAnchor)
      Possible values are phase_start or automatic. If phase_start then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If automatic then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle documentation.

      One of automatic, or phase_start.

    • setBillingThresholds

      public void setBillingThresholds(QuotePreviewSubscriptionSchedule.DefaultSettings.BillingThresholds billingThresholds)
      Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period.

    • setCollectionMethod

      public void setCollectionMethod(String collectionMethod)
      Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as active.

      One of charge_automatically, or send_invoice.

    • setDescription

      public void setDescription(String description)
      Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.

    • setInvoiceSettings

      public void setInvoiceSettings(QuotePreviewSubscriptionSchedule.DefaultSettings.InvoiceSettings invoiceSettings)

    • setPhaseEffectiveAt

      public void setPhaseEffectiveAt(String phaseEffectiveAt)
      Configures how the subscription schedule handles billing for phase transitions. Possible values are phase_start (default) or billing_period_start. phase_start bills based on the current state of the subscription, ignoring changes scheduled in future phases. billing_period_start bills predictively for upcoming phase transitions within the current billing cycle, including pricing changes and service period adjustments that will occur before the next invoice.

      One of billing_period_start, or phase_start.

    • setTransferData

      public void setTransferData(QuotePreviewSubscriptionSchedule.DefaultSettings.TransferData transferData)
      The account (if any) the associated subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object