Package com.stripe.model

Class Sku

java.lang.Object
com.stripe.model.StripeObject
com.stripe.net.ApiResource
com.stripe.model.Sku
All Implemented Interfaces:
HasId, MetadataStore<Sku>, StripeObjectInterface
public class Sku extends ApiResource implements HasId, MetadataStore<Sku>

  • Constructor Details

    • Sku

      public Sku()

  • Method Details

    • getProduct

      public String getProduct()
      Get ID of expandable product object.

    • setProduct

      public void setProduct(String id)

    • getProductObject

      public Product getProductObject()
      Get expanded product.

    • setProductObject

      public void setProductObject(Product expandableObject)

    • retrieve

      public static Sku retrieve(String id) throws StripeException
      Retrieves the details of an existing SKU. Supply the unique SKU identifier from either a SKU creation request or from the product, and Stripe will return the corresponding SKU information.
      Throws:
      StripeException

    • retrieve

      public static Sku retrieve(String id, RequestOptions options) throws StripeException
      Retrieves the details of an existing SKU. Supply the unique SKU identifier from either a SKU creation request or from the product, and Stripe will return the corresponding SKU information.
      Throws:
      StripeException

    • retrieve

      public static Sku retrieve(String id, Map<String,Object> params, RequestOptions options) throws StripeException
      Retrieves the details of an existing SKU. Supply the unique SKU identifier from either a SKU creation request or from the product, and Stripe will return the corresponding SKU information.
      Throws:
      StripeException

    • retrieve

      public static Sku retrieve(String id, SkuRetrieveParams params, RequestOptions options) throws StripeException
      Retrieves the details of an existing SKU. Supply the unique SKU identifier from either a SKU creation request or from the product, and Stripe will return the corresponding SKU information.
      Throws:
      StripeException

    • list

      public static SkuCollection list(Map<String,Object> params) throws StripeException
      Returns a list of your SKUs. The SKUs are returned sorted by creation date, with the most recently created SKUs appearing first.
      Throws:
      StripeException

    • list

      public static SkuCollection list(Map<String,Object> params, RequestOptions options) throws StripeException
      Returns a list of your SKUs. The SKUs are returned sorted by creation date, with the most recently created SKUs appearing first.
      Throws:
      StripeException

    • list

      public static SkuCollection list(SkuListParams params) throws StripeException
      Returns a list of your SKUs. The SKUs are returned sorted by creation date, with the most recently created SKUs appearing first.
      Throws:
      StripeException

    • list

      public static SkuCollection list(SkuListParams params, RequestOptions options) throws StripeException
      Returns a list of your SKUs. The SKUs are returned sorted by creation date, with the most recently created SKUs appearing first.
      Throws:
      StripeException

    • update

      public Sku update(Map<String,Object> params) throws StripeException
      Updates the specific SKU by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

      Note that a SKU’s attributes are not editable. Instead, you would need to deactivate the existing SKU and create a new one with the new attribute values.

      Specified by:
      update in interface MetadataStore<Sku>
      Throws:
      StripeException

    • update

      public Sku update(Map<String,Object> params, RequestOptions options) throws StripeException
      Updates the specific SKU by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

      Note that a SKU’s attributes are not editable. Instead, you would need to deactivate the existing SKU and create a new one with the new attribute values.

      Specified by:
      update in interface MetadataStore<Sku>
      Throws:
      StripeException

    • update

      public Sku update(SkuUpdateParams params) throws StripeException
      Updates the specific SKU by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

      Note that a SKU’s attributes are not editable. Instead, you would need to deactivate the existing SKU and create a new one with the new attribute values.

      Throws:
      StripeException

    • update

      public Sku update(SkuUpdateParams params, RequestOptions options) throws StripeException
      Updates the specific SKU by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

      Note that a SKU’s attributes are not editable. Instead, you would need to deactivate the existing SKU and create a new one with the new attribute values.

      Throws:
      StripeException

    • create

      public static Sku create(Map<String,Object> params) throws StripeException
      Creates a new SKU associated with a product.
      Throws:
      StripeException

    • create

      public static Sku create(Map<String,Object> params, RequestOptions options) throws StripeException
      Creates a new SKU associated with a product.
      Throws:
      StripeException

    • create

      public static Sku create(SkuCreateParams params) throws StripeException
      Creates a new SKU associated with a product.
      Throws:
      StripeException

    • create

      public static Sku create(SkuCreateParams params, RequestOptions options) throws StripeException
      Creates a new SKU associated with a product.
      Throws:
      StripeException

    • delete

      public Sku delete() throws StripeException
      Delete a SKU. Deleting a SKU is only possible until it has been used in an order.
      Throws:
      StripeException

    • delete

      public Sku delete(RequestOptions options) throws StripeException
      Delete a SKU. Deleting a SKU is only possible until it has been used in an order.
      Throws:
      StripeException

    • delete

      public Sku delete(Map<String,Object> params) throws StripeException
      Delete a SKU. Deleting a SKU is only possible until it has been used in an order.
      Throws:
      StripeException

    • delete

      public Sku delete(Map<String,Object> params, RequestOptions options) throws StripeException
      Delete a SKU. Deleting a SKU is only possible until it has been used in an order.
      Throws:
      StripeException

    • getActive

      public Boolean getActive()
      Whether the SKU is available for purchase.

    • getAttributes

      public Map<String,String> getAttributes()
      A dictionary of attributes and values for the attributes defined by the product. If, for example, a product's attributes are ["size", "gender"], a valid SKU has the following dictionary of attributes: {"size": "Medium", "gender": "Unisex"}.

    • getCreated

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

    • getCurrency

      public String getCurrency()
      Three-letter ISO currency code, in lowercase. Must be a supported currency.

    • getDeleted

      public Boolean getDeleted()
      Always true for a deleted object.

    • getImage

      public String getImage()
      The URL of an image for this SKU, meant to be displayable to the customer.

    • getInventory

      public Sku.Inventory getInventory()

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

    • getPackageDimensions

      public PackageDimensions getPackageDimensions()
      The dimensions of this SKU for shipping purposes.

    • getPrice

      public Long getPrice()
      The cost of the item as a positive integer in the smallest currency unit (that is, 100 cents to charge $1.00, or 100 to charge ¥100, Japanese Yen being a zero-decimal currency).

    • getUpdated

      public Long getUpdated()
      Time at which the object was last updated. Measured in seconds since the Unix epoch.

    • setActive

      public void setActive(Boolean active)
      Whether the SKU is available for purchase.

    • setAttributes

      public void setAttributes(Map<String,String> attributes)
      A dictionary of attributes and values for the attributes defined by the product. If, for example, a product's attributes are ["size", "gender"], a valid SKU has the following dictionary of attributes: {"size": "Medium", "gender": "Unisex"}.

    • setCreated

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

    • setCurrency

      public void setCurrency(String currency)
      Three-letter ISO currency code, in lowercase. Must be a supported currency.

    • setDeleted

      public void setDeleted(Boolean deleted)
      Always true for a deleted object.

    • setId

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

    • setImage

      public void setImage(String image)
      The URL of an image for this SKU, meant to be displayable to the customer.

    • setInventory

      public void setInventory(Sku.Inventory inventory)

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

    • setPackageDimensions

      public void setPackageDimensions(PackageDimensions packageDimensions)
      The dimensions of this SKU for shipping purposes.

    • setPrice

      public void setPrice(Long price)
      The cost of the item as a positive integer in the smallest currency unit (that is, 100 cents to charge $1.00, or 100 to charge ¥100, Japanese Yen being a zero-decimal currency).

    • setUpdated

      public void setUpdated(Long updated)
      Time at which the object was last updated. Measured in seconds since the Unix epoch.

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