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 is a Stripe sandbox that a user can claim into a new or existing Stripe account through an onboarding link. You can prefill it with an email address, sandbox name, and country. 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

    • getChannel

      public String getChannel()
      The distribution channel used to pre-install your Stripe App on the claimable sandbox. Use testing to install your app's external test version or public to install its published version.

      One of public, or testing.

    • getClaimedAt

      public Instant getClaimedAt()
      Time at which the sandbox was claimed. Set when the status is claimed or live. Represented as an RFC 3339 timestamp in UTC with millisecond precision, for example 2022-09-18T13:22:18.123Z.
    • getCreated

      public Instant getCreated()
      Time at which the sandbox was created. Represented as an RFC 3339 timestamp in UTC with millisecond precision, for example 2022-09-18T13:22:18.123Z.
    • getExpiresAt

      public Instant getExpiresAt()
      Time at which the unclaimed sandbox expires. Null when the status is claimed or live. Represented as an RFC 3339 timestamp in UTC with millisecond precision, for example 2022-09-18T13:22:18.123Z.
    • 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.

    • getOnboardingLinkDetails

      public ClaimableSandbox.OnboardingLinkDetails getOnboardingLinkDetails()
      Details about the onboarding link. Null when the sandbox status is live or expired.
    • getOwnerDetails

      public ClaimableSandbox.OwnerDetails getOwnerDetails()
      Details about the live mode owner account of the sandbox. This will be null until the sandbox is claimed.
    • 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 claimed, expired, live, or unclaimed.

    • setChannel

      public void setChannel(String channel)
      The distribution channel used to pre-install your Stripe App on the claimable sandbox. Use testing to install your app's external test version or public to install its published version.

      One of public, or testing.

    • setClaimedAt

      public void setClaimedAt(Instant claimedAt)
      Time at which the sandbox was claimed. Set when the status is claimed or live. Represented as an RFC 3339 timestamp in UTC with millisecond precision, for example 2022-09-18T13:22:18.123Z.
    • setCreated

      public void setCreated(Instant created)
      Time at which the sandbox was created. Represented as an RFC 3339 timestamp in UTC with millisecond precision, for example 2022-09-18T13:22:18.123Z.
    • setExpiresAt

      public void setExpiresAt(Instant expiresAt)
      Time at which the unclaimed sandbox expires. Null when the status is claimed or live. Represented as an RFC 3339 timestamp in UTC with millisecond precision, for example 2022-09-18T13:22:18.123Z.
    • 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.

    • setOnboardingLinkDetails

      public void setOnboardingLinkDetails(ClaimableSandbox.OnboardingLinkDetails onboardingLinkDetails)
      Details about the onboarding link. Null when the sandbox status is live or expired.
    • setOwnerDetails

      public void setOwnerDetails(ClaimableSandbox.OwnerDetails ownerDetails)
      Details about the live mode owner account of the sandbox. This will be null until the sandbox is claimed.
    • 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 claimed, expired, live, or unclaimed.

    • 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