Struct stripe::OrderReturn

pub struct OrderReturn {
    pub id: OrderReturnId,
    pub amount: i64,
    pub created: Timestamp,
    pub currency: Currency,
    pub items: Vec<OrderItem>,
    pub livemode: bool,
    pub order: Option<Box<Expandable<Order>>>,
    pub refund: Option<Box<Expandable<Refund>>>,
}

The resource representing a Stripe “OrderReturn”.

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

Fields

id: OrderReturnId

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 returned line item.

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.

items: Vec<OrderItem>

The items included in this order return.

livemode: bool

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

order: Option<Box<Expandable<Order>>>

The order that this return includes items from.

refund: Option<Box<Expandable<Refund>>>

The ID of the refund issued for this return.

Implementations

impl OrderReturn

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

Returns a list of your order returns.

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

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

Retrieves the details of an existing order return.

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

Trait Implementations

impl Clone for OrderReturn

fn clone(&self) -> OrderReturn

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OrderReturn

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for OrderReturn

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

Deserialize this value from the given Serde deserializer.

impl Object for OrderReturn

type Id = OrderReturnId

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 OrderReturn

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

Serialize this value into the given Serde serializer.