Package com.stripe.model.v2.core

Class ClaimableSandbox

java.lang.Object
com.stripe.model.StripeObject
com.stripe.model.v2.core.ClaimableSandbox
All Implemented Interfaces:
HasId, StripeObjectInterface
public class ClaimableSandbox extends StripeObject implements HasId
A claimable sandbox represents a Stripe sandbox that is anonymous. When it is created, it can be prefilled with specific metadata, such as email, name, or country. Claimable sandboxes can be claimed through a URL. When a user claims a sandbox through this URL, it will prompt them to create a new Stripe account. Or, it will allow them to claim this sandbox in their existing Stripe account. Claimable sandboxes have 60 days to be claimed. After this expiration time has passed, if the sandbox is not claimed, it will be deleted.

  • Constructor Details

    • ClaimableSandbox

      public ClaimableSandbox()

  • Method Details

    • getClaimUrl

      public String getClaimUrl()
      URL for user to claim sandbox into their existing Stripe account. The value will be null if the sandbox status is claimed or expired.

    • getClaimedAt

      public Instant getClaimedAt()
      The timestamp the sandbox was claimed. The value will be null if the sandbox status is not claimed.

    • getCreated

      public Instant getCreated()
      When the sandbox is created.

    • getExpiresAt

      public Instant getExpiresAt()
      The timestamp the sandbox will expire. The value will be null if the sandbox is claimed.

    • 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 of the object field.

      Equal to v2.core.claimable_sandbox.

    • getPrefill

      public ClaimableSandbox.Prefill getPrefill()
      Values prefilled during the creation of the sandbox. When a user claims the sandbox, they will be able to update these values.

    • getSandboxDetails

      public ClaimableSandbox.SandboxDetails getSandboxDetails()
      Data about the Stripe sandbox object.

    • getStatus

      public String getStatus()
      Status of the sandbox. One of unclaimed, expired, claimed.

    • setClaimUrl

      public void setClaimUrl(String claimUrl)
      URL for user to claim sandbox into their existing Stripe account. The value will be null if the sandbox status is claimed or expired.

    • setClaimedAt

      public void setClaimedAt(Instant claimedAt)
      The timestamp the sandbox was claimed. The value will be null if the sandbox status is not claimed.

    • setCreated

      public void setCreated(Instant created)
      When the sandbox is created.

    • setExpiresAt

      public void setExpiresAt(Instant expiresAt)
      The timestamp the sandbox will expire. The value will be null if the sandbox is claimed.

    • setId

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

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

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

    • setPrefill

      public void setPrefill(ClaimableSandbox.Prefill prefill)
      Values prefilled during the creation of the sandbox. When a user claims the sandbox, they will be able to update these values.

    • setSandboxDetails

      public void setSandboxDetails(ClaimableSandbox.SandboxDetails sandboxDetails)
      Data about the Stripe sandbox object.

    • setStatus

      public void setStatus(String status)
      Status of the sandbox. One of unclaimed, expired, claimed.

    • 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 Claimable sandbox.
      Specified by:
      getId in interface HasId