Package com.stripe.model

Class AccountNotice

java.lang.Object
com.stripe.model.StripeObject
com.stripe.net.ApiResource
com.stripe.model.AccountNotice
All Implemented Interfaces:
HasId, MetadataStore<AccountNotice>, StripeActiveObject, StripeObjectInterface
public class AccountNotice extends ApiResource implements HasId, MetadataStore<AccountNotice>
A notice to a Connected account. Notice can be sent by Stripe on your behalf or you can opt to send the notices yourself.

See the guide to send notices to your connected accounts.

  • Constructor Details

    • AccountNotice

      public AccountNotice()

  • Method Details

    • list

      public static AccountNoticeCollection list(Map<String,Object> params) throws StripeException
      Retrieves a list of AccountNotice objects. The objects are sorted in descending order by creation date, with the most-recently-created object appearing first.
      Throws:
      StripeException

    • list

      public static AccountNoticeCollection list(Map<String,Object> params, RequestOptions options) throws StripeException
      Retrieves a list of AccountNotice objects. The objects are sorted in descending order by creation date, with the most-recently-created object appearing first.
      Throws:
      StripeException

    • list

      public static AccountNoticeCollection list(AccountNoticeListParams params) throws StripeException
      Retrieves a list of AccountNotice objects. The objects are sorted in descending order by creation date, with the most-recently-created object appearing first.
      Throws:
      StripeException

    • list

      public static AccountNoticeCollection list(AccountNoticeListParams params, RequestOptions options) throws StripeException
      Retrieves a list of AccountNotice objects. The objects are sorted in descending order by creation date, with the most-recently-created object appearing first.
      Throws:
      StripeException

    • retrieve

      public static AccountNotice retrieve(String accountNotice) throws StripeException
      Retrieves an AccountNotice object.
      Throws:
      StripeException

    • retrieve

      public static AccountNotice retrieve(String accountNotice, RequestOptions options) throws StripeException
      Retrieves an AccountNotice object.
      Throws:
      StripeException

    • retrieve

      public static AccountNotice retrieve(String accountNotice, Map<String,Object> params, RequestOptions options) throws StripeException
      Retrieves an AccountNotice object.
      Throws:
      StripeException

    • retrieve

      public static AccountNotice retrieve(String accountNotice, AccountNoticeRetrieveParams params, RequestOptions options) throws StripeException
      Retrieves an AccountNotice object.
      Throws:
      StripeException

    • update

      public AccountNotice update(Map<String,Object> params) throws StripeException
      Updates an AccountNotice object.
      Specified by:
      update in interface MetadataStore<AccountNotice>
      Throws:
      StripeException

    • update

      public AccountNotice update(Map<String,Object> params, RequestOptions options) throws StripeException
      Updates an AccountNotice object.
      Specified by:
      update in interface MetadataStore<AccountNotice>
      Throws:
      StripeException

    • update

      public AccountNotice update(AccountNoticeUpdateParams params) throws StripeException
      Updates an AccountNotice object.
      Throws:
      StripeException

    • update

      public AccountNotice update(AccountNoticeUpdateParams params, RequestOptions options) throws StripeException
      Updates an AccountNotice object.
      Throws:
      StripeException

    • setResponseGetter

      public void setResponseGetter(StripeResponseGetter responseGetter)
      Description copied from interface: StripeActiveObject
      Method is used by the containing object or StripeResponseGetter implementations to set the StripeResponseGetter instance used to make further requests.
      Specified by:
      setResponseGetter in interface StripeActiveObject
      Overrides:
      setResponseGetter in class ApiResource
      Parameters:
      responseGetter - the StripeResponseGetter instance to use for making further requests.

    • getCreated

      public Long getCreated()
      Time at which the object was created. Measured in seconds since the Unix epoch.

    • getDeadline

      public Long getDeadline()
      When present, the deadline for sending the notice to meet the relevant regulations.

    • getEmail

      public AccountNotice.Email getEmail()
      Information about the email when sent.

    • getLinkedObjects

      public AccountNotice.LinkedObjects getLinkedObjects()
      Information about objects related to the notice.

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

    • getObject

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

      Equal to account_notice.

    • getReason

      public String getReason()
      Reason the notice is being sent. The reason determines what copy the notice must contain. See the regulated customer notices guide. All reasons might not apply to your integration, and Stripe might add new reasons in the future, so we recommend an internal warning when you receive an unknown reason.

      One of issuing.account_closed_for_inactivity, issuing.account_closed_for_not_providing_business_model_clarification, issuing.account_closed_for_not_providing_url_clarification, issuing.account_closed_for_not_providing_use_case_clarification, issuing.account_closed_for_terms_of_service_violation, issuing.application_rejected_for_failure_to_verify, issuing.credit_application_rejected, issuing.credit_increase_application_rejected, issuing.credit_limit_decreased, issuing.credit_line_closed, issuing.dispute_lost, issuing.dispute_submitted, or issuing.dispute_won.

    • getSentAt

      public Long getSentAt()
      Date when the notice was sent. When absent, you must send the notice, update the content of the email and date when it was sent.

    • setCreated

      public void setCreated(Long created)
      Time at which the object was created. Measured in seconds since the Unix epoch.

    • setDeadline

      public void setDeadline(Long deadline)
      When present, the deadline for sending the notice to meet the relevant regulations.

    • setEmail

      public void setEmail(AccountNotice.Email email)
      Information about the email when sent.

    • setId

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

    • setLinkedObjects

      public void setLinkedObjects(AccountNotice.LinkedObjects linkedObjects)
      Information about objects related to the notice.

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

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

    • setObject

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

      Equal to account_notice.

    • setReason

      public void setReason(String reason)
      Reason the notice is being sent. The reason determines what copy the notice must contain. See the regulated customer notices guide. All reasons might not apply to your integration, and Stripe might add new reasons in the future, so we recommend an internal warning when you receive an unknown reason.

      One of issuing.account_closed_for_inactivity, issuing.account_closed_for_not_providing_business_model_clarification, issuing.account_closed_for_not_providing_url_clarification, issuing.account_closed_for_not_providing_use_case_clarification, issuing.account_closed_for_terms_of_service_violation, issuing.application_rejected_for_failure_to_verify, issuing.credit_application_rejected, issuing.credit_increase_application_rejected, issuing.credit_limit_decreased, issuing.credit_line_closed, issuing.dispute_lost, issuing.dispute_submitted, or issuing.dispute_won.

    • setSentAt

      public void setSentAt(Long sentAt)
      Date when the notice was sent. When absent, you must send the notice, update the content of the email and date when it was sent.

    • 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

    • 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.
      Specified by:
      getMetadata in interface MetadataStore<AccountNotice>