Package com.stripe.model

Class Quote.SubscriptionData

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

  • Constructor Details

    • SubscriptionData

      public SubscriptionData()

  • Method Details

    • getFromSubscription

      public String getFromSubscription()
      Get ID of expandable fromSubscription object.

    • setFromSubscription

      public void setFromSubscription(String id)

    • getFromSubscriptionObject

      public Subscription getFromSubscriptionObject()
      Get expanded fromSubscription.

    • setFromSubscriptionObject

      public void setFromSubscriptionObject(Subscription expandableObject)

    • getBillOnAcceptance

      public Quote.SubscriptionData.BillOnAcceptance getBillOnAcceptance()
      Describes the period to bill for upon accepting the quote.

    • getBillingBehavior

      public String getBillingBehavior()
      Configures when the subscription schedule generates prorations for phase transitions. Possible values are prorate_on_next_phase or prorate_up_front with the default being prorate_on_next_phase. prorate_on_next_phase will apply phase changes and generate prorations at transition time. prorate_up_front will bill for all phases within the current billing cycle up front.

      One of prorate_on_next_phase, or prorate_up_front.

    • getBillingCycleAnchor

      public String getBillingCycleAnchor()
      Whether the subscription will always start a new billing period when the quote is accepted.

      Equal to reset.

    • getBillingMode

      public Quote.SubscriptionData.BillingMode getBillingMode()
      The billing mode of the quote.

    • getDescription

      public String getDescription()
      The subscription's 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.

    • getEffectiveDate

      public Long getEffectiveDate()
      When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted. This date is ignored if it is in the past when the quote is accepted. Measured in seconds since the Unix epoch.

    • getEndBehavior

      public String getEndBehavior()
      Behavior of the subscription schedule and underlying subscription when it ends.

      One of cancel, or release.

    • getMetadata

      public Map<String,String> getMetadata()
      Set of key-value pairs that will set metadata on the subscription or subscription schedule when the quote is accepted. If a recurring price is included in line_items, this field will be passed to the resulting subscription's metadata field. If subscription_data.effective_date is used, this field will be passed to the resulting subscription schedule's phases.metadata field. Unlike object-level metadata, this field is declarative. Updates will clear prior values.

    • getPrebilling

      public Quote.SubscriptionData.Prebilling getPrebilling()
      If specified, the invoicing for the given billing cycle iterations will be processed when the quote is accepted. Cannot be used with effective_date.

    • getProrationBehavior

      public String getProrationBehavior()
      Determines how to handle prorations when the quote is accepted.

      One of always_invoice, create_prorations, or none.

    • getTrialPeriodDays

      public Long getTrialPeriodDays()
      Integer representing the number of trial period days before the customer is charged for the first time.

    • setBillOnAcceptance

      public void setBillOnAcceptance(Quote.SubscriptionData.BillOnAcceptance billOnAcceptance)
      Describes the period to bill for upon accepting the quote.

    • setBillingBehavior

      public void setBillingBehavior(String billingBehavior)
      Configures when the subscription schedule generates prorations for phase transitions. Possible values are prorate_on_next_phase or prorate_up_front with the default being prorate_on_next_phase. prorate_on_next_phase will apply phase changes and generate prorations at transition time. prorate_up_front will bill for all phases within the current billing cycle up front.

      One of prorate_on_next_phase, or prorate_up_front.

    • setBillingCycleAnchor

      public void setBillingCycleAnchor(String billingCycleAnchor)
      Whether the subscription will always start a new billing period when the quote is accepted.

      Equal to reset.

    • setBillingMode

      public void setBillingMode(Quote.SubscriptionData.BillingMode billingMode)
      The billing mode of the quote.

    • setDescription

      public void setDescription(String description)
      The subscription's 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.

    • setEffectiveDate

      public void setEffectiveDate(Long effectiveDate)
      When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted. This date is ignored if it is in the past when the quote is accepted. Measured in seconds since the Unix epoch.

    • setEndBehavior

      public void setEndBehavior(String endBehavior)
      Behavior of the subscription schedule and underlying subscription when it ends.

      One of cancel, or release.

    • setMetadata

      public void setMetadata(Map<String,String> metadata)
      Set of key-value pairs that will set metadata on the subscription or subscription schedule when the quote is accepted. If a recurring price is included in line_items, this field will be passed to the resulting subscription's metadata field. If subscription_data.effective_date is used, this field will be passed to the resulting subscription schedule's phases.metadata field. Unlike object-level metadata, this field is declarative. Updates will clear prior values.

    • setPrebilling

      public void setPrebilling(Quote.SubscriptionData.Prebilling prebilling)
      If specified, the invoicing for the given billing cycle iterations will be processed when the quote is accepted. Cannot be used with effective_date.

    • setProrationBehavior

      public void setProrationBehavior(String prorationBehavior)
      Determines how to handle prorations when the quote is accepted.

      One of always_invoice, create_prorations, or none.

    • setTrialPeriodDays

      public void setTrialPeriodDays(Long trialPeriodDays)
      Integer representing the number of trial period days before the customer is charged for the first time.

    • 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