Struct stripe::Sku

pub struct Sku {
    pub id: SkuId,
    pub active: bool,
    pub attributes: Option<Metadata>,
    pub created: Option<Timestamp>,
    pub currency: Option<Currency>,
    pub deleted: bool,
    pub image: Option<String>,
    pub inventory: Option<Inventory>,
    pub livemode: bool,
    pub metadata: Metadata,
    pub package_dimensions: Option<PackageDimensions>,
    pub price: Option<i64>,
    pub product: Option<Expandable<Product>>,
    pub updated: Option<Timestamp>,
}

The resource representing a Stripe "SKU".

For more details see https://stripe.com/docs/api/skus/object.

Fields

id: SkuId

Unique identifier for the object.

active: bool

Whether the SKU is available for purchase.

attributes: Option<Metadata>

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"}.

created: Option<Timestamp>

Time at which the object was created.

Measured in seconds since the Unix epoch.

currency: Option<Currency>

Three-letter ISO currency code, in lowercase.

Must be a supported currency.

deleted: bool

image: Option<String>

The URL of an image for this SKU, meant to be displayable to the customer.

inventory: Option<Inventory>

livemode: bool

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

metadata: 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.

package_dimensions: Option<PackageDimensions>

The dimensions of this SKU for shipping purposes.

price: Option<i64>

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

product: Option<Expandable<Product>>

The ID of the product this SKU is associated with.

The product must be currently active.

updated: Option<Timestamp>

Methods

impl Sku

pub fn list(client: &Client, params: ListSkus) -> Response<List<Sku>>

Returns a list of your SKUs.

The SKUs are returned sorted by creation date, with the most recently created SKUs appearing first.

pub fn create(client: &Client, params: CreateSku) -> Response<Sku>

Creates a new SKU associated with a product.

pub fn retrieve(client: &Client, id: &SkuId, expand: &[&str]) -> Response<Sku>

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.

pub fn update(client: &Client, id: &SkuId, params: UpdateSku) -> Response<Sku>

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.

pub fn delete(client: &Client, id: &SkuId) -> Response<Deleted<SkuId>>

Delete a SKU.

Deleting a SKU is only possible until it has been used in an order.

Trait Implementations

impl Object for Sku

type Id = SkuId

The canonical id type for this object.

fn id(&self) -> Self::Id

The id of the object.

fn object(&self) -> &'static str

The object's type, typically represented in wire format as the object property.

impl Clone for Sku

fn clone(&self) -> Sku

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Sku

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Serialize for Sku

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for Sku

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.