Struct stripe::Product

pub struct Product {
    pub id: ProductId,
    pub active: Option<bool>,
    pub attributes: Option<Vec<String>>,
    pub caption: Option<String>,
    pub created: Option<Timestamp>,
    pub deactivate_on: Option<Vec<String>>,
    pub deleted: bool,
    pub description: Option<String>,
    pub images: Option<Vec<String>>,
    pub livemode: Option<bool>,
    pub metadata: Metadata,
    pub name: Option<String>,
    pub package_dimensions: Option<PackageDimensions>,
    pub shippable: Option<bool>,
    pub statement_descriptor: Option<String>,
    pub type_: Option<ProductType>,
    pub unit_label: Option<String>,
    pub updated: Option<Timestamp>,
    pub url: Option<String>,
}

The resource representing a Stripe "Product".

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

Fields

id: ProductId

Unique identifier for the object.

active: Option<bool>

Whether the product is currently available for purchase.

attributes: Option<Vec<String>>

A list of up to 5 attributes that each SKU can provide values for (e.g., ["color", "size"]).

Only applicable to products of type=good.

caption: Option<String>

A short one-line description of the product, meant to be displayable to the customer.

Only applicable to products of type=good.

created: Option<Timestamp>

Time at which the object was created.

Measured in seconds since the Unix epoch.

deactivate_on: Option<Vec<String>>

An array of connect application identifiers that cannot purchase this product.

Only applicable to products of type=good.

deleted: bool

description: Option<String>

The product's description, meant to be displayable to the customer.

Only applicable to products of type=good.

images: Option<Vec<String>>

A list of up to 8 URLs of images for this product, meant to be displayable to the customer.

Only applicable to products of type=good.

livemode: Option<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.

name: Option<String>

The product's name, meant to be displayable to the customer.

Applicable to both service and good types.

package_dimensions: Option<PackageDimensions>

The dimensions of this product for shipping purposes.

A SKU associated with this product can override this value by having its own package_dimensions. Only applicable to products of type=good.

shippable: Option<bool>

Whether this product is a shipped good.

Only applicable to products of type=good.

statement_descriptor: Option<String>

Extra information about a product which will appear on your customer's credit card statement.

In the case that multiple products are billed at once, the first statement descriptor will be used. Only available on products of type=service.

type_: Option<ProductType>

The type of the product.

The product is either of type good, which is eligible for use with Orders and SKUs, or service, which is eligible for use with Subscriptions and Plans.

unit_label: Option<String>

A label that represents units of this product, such as seat(s), in Stripe and on customers’ receipts and invoices.

Only available on products of type=service.

updated: Option<Timestamp>

url: Option<String>

A URL of a publicly-accessible webpage for this product.

Only applicable to products of type=good.

Methods

impl Product

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

Returns a list of your products.

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

pub fn create(client: &Client, params: CreateProduct) -> Response<Product>

Creates a new product object.

To create a product for use with subscriptions, see Subscriptions Products.

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

Retrieves the details of an existing product.

Supply the unique product ID from either a product creation request or the product list, and Stripe will return the corresponding product information.

pub fn update(
    client: &Client,
    id: &ProductId,
    params: UpdateProduct
) -> Response<Product>

Updates the specific product by setting the values of the parameters passed.

Any parameters not provided will be left unchanged. Note that a product’s attributes are not editable. Instead, you would need to deactivate the existing product and create a new one with the new attribute values.

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

Delete a product.

Deleting a product with type=good is only possible if it has no SKUs associated with it. Deleting a product with type=service is only possible if it has no plans associated with it.

Trait Implementations

impl Object for Product

type Id = ProductId

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 Product

fn clone(&self) -> Product

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Product

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

Formats the value using the given formatter.

impl Serialize for Product

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 Product

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

Deserialize this value from the given Serde deserializer.