Package com.stripe.model.v2.billing

Class Cadence

java.lang.Object
com.stripe.model.StripeObject
com.stripe.model.v2.billing.Cadence
All Implemented Interfaces:
HasId, StripeObjectInterface
public class Cadence extends StripeObject implements HasId

  • Constructor Details

    • Cadence

      public Cadence()

  • Method Details

    • getBillingCycle

      public Cadence.BillingCycle getBillingCycle()
      The billing cycle is the object that defines future billing cycle dates.

    • getCreated

      public Instant getCreated()
      Timestamp of when the object was created.

    • getInvoiceDiscountRules

      public List<Cadence.InvoiceDiscountRule> getInvoiceDiscountRules()
      The discount rules applied to all invoices for the cadence.

    • getLivemode

      public Boolean getLivemode()
      Has the value true if the object exists in live mode or the value false if the object exists in test mode.

    • getLookupKey

      public String getLookupKey()
      A lookup key used to retrieve cadences dynamically from a static string. Maximum length of 200 characters.

    • getMetadata

      public Map<String,String> getMetadata()
      Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

    • getNextBillingDate

      public Instant getNextBillingDate()
      The date that the billing cadence will next bill. Null if the cadence is not active.

    • getObject

      public String getObject()
      String representing the object's type. Objects of the same type share the same value of the object field.

      Equal to v2.billing.cadence.

    • getPayer

      public Cadence.Payer getPayer()
      The payer determines the entity financially responsible for the bill.

    • getSettings

      public Cadence.Settings getSettings()
      The settings associated with the cadence.

    • getSettingsData

      public Cadence.SettingsData getSettingsData()
      Settings data that contains expanded billing settings configuration with actual values.

    • getStatus

      public String getStatus()
      The current status of the cadence.

      One of active, or canceled.

    • getTestClock

      public String getTestClock()
      The ID of the Test Clock.

    • setBillingCycle

      public void setBillingCycle(Cadence.BillingCycle billingCycle)
      The billing cycle is the object that defines future billing cycle dates.

    • setCreated

      public void setCreated(Instant created)
      Timestamp of when the object was created.

    • setId

      public void setId(String id)
      Unique identifier for the object.

    • setInvoiceDiscountRules

      public void setInvoiceDiscountRules(List<Cadence.InvoiceDiscountRule> invoiceDiscountRules)
      The discount rules applied to all invoices for the cadence.

    • setLivemode

      public void setLivemode(Boolean livemode)
      Has the value true if the object exists in live mode or the value false if the object exists in test mode.

    • setLookupKey

      public void setLookupKey(String lookupKey)
      A lookup key used to retrieve cadences dynamically from a static string. Maximum length of 200 characters.

    • setMetadata

      public void setMetadata(Map<String,String> metadata)
      Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

    • setNextBillingDate

      public void setNextBillingDate(Instant nextBillingDate)
      The date that the billing cadence will next bill. Null if the cadence is not active.

    • setObject

      public void setObject(String object)
      String representing the object's type. Objects of the same type share the same value of the object field.

      Equal to v2.billing.cadence.

    • setPayer

      public void setPayer(Cadence.Payer payer)
      The payer determines the entity financially responsible for the bill.

    • setSettings

      public void setSettings(Cadence.Settings settings)
      The settings associated with the cadence.

    • setSettingsData

      public void setSettingsData(Cadence.SettingsData settingsData)
      Settings data that contains expanded billing settings configuration with actual values.

    • setStatus

      public void setStatus(String status)
      The current status of the cadence.

      One of active, or canceled.

    • setTestClock

      public void setTestClock(String testClock)
      The ID of the Test Clock.

    • 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

    • getId

      public String getId()
      Unique identifier for the object.
      Specified by:
      getId in interface HasId