Package com.stripe.model.v2.billing

Class CollectionSetting

java.lang.Object
com.stripe.model.StripeObject
com.stripe.model.v2.billing.CollectionSetting
All Implemented Interfaces:
HasId, StripeObjectInterface
public class CollectionSetting extends StripeObject implements HasId
Settings that configure and manage the behavior of collecting payments.

  • Constructor Details

    • CollectionSetting

      public CollectionSetting()

  • Method Details

    • getCollectionMethod

      public String getCollectionMethod()
      Either automatic, or send_invoice. When charging automatically, Stripe will attempt to pay this bill at the end of the period using the payment method attached to the payer profile. When sending an invoice, Stripe will email your payer profile an invoice with payment instructions. Defaults to automatic.

      One of automatic, or send_invoice.

    • getCreated

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

    • getDisplayName

      public String getDisplayName()
      An optional field for adding a display name for the CollectionSetting object.

    • getEmailDelivery

      public CollectionSetting.EmailDelivery getEmailDelivery()
      Email delivery settings.

    • getLatestVersion

      public String getLatestVersion()
      The latest version of the current settings object. This will be Updated every time an attribute of the settings is updated.

    • getLiveVersion

      public String getLiveVersion()
      The current live version of the settings object. This can be different from latest_version if settings are updated without setting live_version='latest'.

    • 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 settings dynamically from a static string. This may be up to 200 characters.

    • 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.collection_setting.

    • getPaymentMethodConfiguration

      public String getPaymentMethodConfiguration()
      The ID of the PaymentMethodConfiguration object, which controls which payment methods are displayed to your customers.

    • getPaymentMethodOptions

      public CollectionSetting.PaymentMethodOptions getPaymentMethodOptions()
      Payment Method specific configuration stored on the object.

    • setCollectionMethod

      public void setCollectionMethod(String collectionMethod)
      Either automatic, or send_invoice. When charging automatically, Stripe will attempt to pay this bill at the end of the period using the payment method attached to the payer profile. When sending an invoice, Stripe will email your payer profile an invoice with payment instructions. Defaults to automatic.

      One of automatic, or send_invoice.

    • setCreated

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

    • setDisplayName

      public void setDisplayName(String displayName)
      An optional field for adding a display name for the CollectionSetting object.

    • setEmailDelivery

      public void setEmailDelivery(CollectionSetting.EmailDelivery emailDelivery)
      Email delivery settings.

    • setId

      public void setId(String id)
      The ID of the CollectionSetting.

    • setLatestVersion

      public void setLatestVersion(String latestVersion)
      The latest version of the current settings object. This will be Updated every time an attribute of the settings is updated.

    • setLiveVersion

      public void setLiveVersion(String liveVersion)
      The current live version of the settings object. This can be different from latest_version if settings are updated without setting live_version='latest'.

    • 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 settings dynamically from a static string. This may be up to 200 characters.

    • 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.collection_setting.

    • setPaymentMethodConfiguration

      public void setPaymentMethodConfiguration(String paymentMethodConfiguration)
      The ID of the PaymentMethodConfiguration object, which controls which payment methods are displayed to your customers.

    • setPaymentMethodOptions

      public void setPaymentMethodOptions(CollectionSetting.PaymentMethodOptions paymentMethodOptions)
      Payment Method specific configuration stored on the object.

    • 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()
      The ID of the CollectionSetting.
      Specified by:
      getId in interface HasId