Struct stripe::Product[−][src]

pub struct Product {Show 16 fields
    pub id: ProductId,
    pub active: Option<Box<bool>>,
    pub created: Option<Timestamp>,
    pub deleted: bool,
    pub description: Option<Box<String>>,
    pub images: Option<Box<Vec<String>>>,
    pub livemode: Option<Box<bool>>,
    pub metadata: Metadata,
    pub name: Option<Box<String>>,
    pub package_dimensions: Option<Box<PackageDimensions>>,
    pub shippable: Option<Box<bool>>,
    pub statement_descriptor: Option<Box<String>>,
    pub tax_code: Option<Box<Expandable<TaxCode>>>,
    pub unit_label: Option<Box<String>>,
    pub updated: Option<Box<Timestamp>>,
    pub url: Option<Box<String>>,
}

Expand description

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<Box<bool>>

Whether the product is currently available for purchase.

created: Option<Timestamp>

Time at which the object was created.

Measured in seconds since the Unix epoch.

deleted: booldescription: Option<Box<String>>

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

Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.

images: Option<Box<Vec<String>>>

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

livemode: Option<Box<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<Box<String>>

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

Whenever this product is sold via a subscription, name will show up on associated invoice line item descriptions.

package_dimensions: Option<Box<PackageDimensions>>

The dimensions of this product for shipping purposes.

shippable: Option<Box<bool>>

Whether this product is shipped (i.e., physical goods).

statement_descriptor: Option<Box<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.

tax_code: Option<Box<Expandable<TaxCode>>>

A tax code ID.

unit_label: Option<Box<String>>

A label that represents units of this product in Stripe and on customers’ receipts and invoices.

When set, this will be included in associated invoice line item descriptions.

updated: Option<Box<Timestamp>>

Time at which the object was last updated.

Measured in seconds since the Unix epoch.

url: Option<Box<String>>

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

Implementations

[src]

impl Product

[src]

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.

[src]

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

Creates a new product object.

[src]

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.

[src]

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.

[src]

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

Delete a product.

Deleting a product is only possible if it has no prices associated with it. Additionally, deleting a product with type=good is only possible if it has no SKUs associated with it.