Struct stripe::Order

pub struct Order {

    pub id: OrderId,
    pub amount: i64,
    pub amount_returned: Option<i64>,
    pub application: Option<String>,
    pub application_fee: Option<i64>,
    pub charge: Option<Expandable<Charge>>,
    pub created: Timestamp,
    pub currency: Currency,
    pub customer: Option<Expandable<Customer>>,
    pub email: Option<String>,
    pub external_coupon_code: Option<String>,
    pub items: Vec<OrderItem>,
    pub livemode: bool,
    pub metadata: Metadata,
    pub returns: List<OrderReturn>,
    pub selected_shipping_method: Option<String>,
    pub shipping: Option<Shipping>,
    pub shipping_methods: Option<Vec<ShippingMethod>>,
    pub status: OrderStatus,
    pub status_transitions: Option<StatusTransitions>,
    pub updated: Option<Timestamp>,
    pub upstream_id: Option<String>,
}

The resource representing a Stripe “Order”.

Fields

id: OrderId

Unique identifier for the object.

amount: i64

A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount for the order.

amount_returned: Option<i64>

The total amount that was returned to the customer.

application: Option<String>

ID of the Connect Application that created the order.

application_fee: Option<i64>

A fee in cents that will be applied to the order and transferred to the application owner’s Stripe account.

The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees documentation.

charge: Option<Expandable<Charge>>

The ID of the payment used to pay for the order.

Present if the order status is paid, fulfilled, or refunded.

created: Timestamp

Time at which the object was created.

Measured in seconds since the Unix epoch.

currency: Currency

Three-letter ISO currency code, in lowercase.

Must be a supported currency.

customer: Option<Expandable<Customer>>

The customer used for the order.

email: Option<String>

The email address of the customer placing the order.

external_coupon_code: Option<String>

External coupon code to load for this order.

items: Vec<OrderItem>

List of items constituting the order.

An order can have up to 25 items.

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.

returns: List<OrderReturn>

A list of returns that have taken place for this order.

selected_shipping_method: Option<String>

The shipping method that is currently selected for this order, if any.

If present, it is equal to one of the ids of shipping methods in the shipping_methods array. At order creation time, if there are multiple shipping methods, Stripe will automatically selected the first method.

shipping: Option<Shipping>

The shipping address for the order.

Present if the order is for goods to be shipped.

shipping_methods: Option<Vec<ShippingMethod>>

A list of supported shipping methods for this order.

The desired shipping method can be specified either by updating the order, or when paying it.

status: OrderStatus

Current order status.

One of created, paid, canceled, fulfilled, or returned. More details in the Orders Guide.

status_transitions: Option<StatusTransitions>

The timestamps at which the order status was updated.

updated: Option<Timestamp>

Time at which the object was last updated.

Measured in seconds since the Unix epoch.

upstream_id: Option<String>

The user’s order ID if it is different from the Stripe order ID.

Implementations

impl Order

pub fn list(client: &Client, params: ListOrders<'_>) -> Response<List<Order>>

Returns a list of your orders.

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

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

Creates a new order object.

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

Retrieves the details of an existing order.

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

pub fn update(
    client: &Client,
    id: &OrderId,
    params: UpdateOrder<'_>
) -> Response<Order>

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

Any parameters not provided will be left unchanged.

Trait Implementations

impl Clone for Order

fn clone(&self) -> Order

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Order

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

Formats the value using the given formatter.

impl Default for Order

fn default() -> Order

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Order

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

Deserialize this value from the given Serde deserializer.

impl Object for Order

type Id = OrderId

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 Serialize for Order

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

Serialize this value into the given Serde serializer.