Class: Stripe::Order

Inherits:
APIResource show all
Extended by:
APIOperations::Create, APIOperations::List
Includes:
APIOperations::Save
Defined in:
lib/stripe/resources/order.rb

Overview

An Order describes a purchase being made by a customer, including the products & quantities being purchased, the order status, the payment information, and the billing/shipping details.

Related guide: [Orders overview](stripe.com/docs/orders)

Defined Under Namespace

Classes: AutomaticTax, BillingDetails, CancelParams, CreateParams, ListLineItemsParams, ListParams, Payment, ReopenParams, ShippingCost, ShippingDetails, SubmitParams, TaxDetails, TotalDetails, UpdateParams

Constant Summary collapse

OBJECT_NAME = 
"order"

Constants inherited from StripeObject

StripeObject::RESERVED_FIELD_NAMES

Instance Attribute Summary collapse

Attributes inherited from APIResource

#save_with_parent

Attributes inherited from StripeObject

#last_response

Class Method Summary collapse

Instance Method Summary collapse

Methods included from APIOperations::Create

create

Methods included from APIOperations::List

list

Methods included from APIOperations::Save

included, #save

Methods inherited from APIResource

class_name, custom_method, #refresh, #request_stripe_object, resource_url, #resource_url, retrieve, save_nested_resource

Methods included from APIOperations::Request

included

Methods inherited from StripeObject

#==, #[], #[]=, additive_object_param, additive_object_param?, #as_json, construct_from, #deleted?, #dirty!, #each, #eql?, #hash, #initialize, #inspect, #keys, #marshal_dump, #marshal_load, protected_fields, #serialize_params, #to_hash, #to_json, #to_s, #update_attributes, #values

Constructor Details

This class inherits a constructor from Stripe::StripeObject

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Stripe::StripeObject

Instance Attribute Details

#amount_subtotal ⇒ Object (readonly)

Order cost before any discounts or taxes are applied. A positive integer representing the subtotal of the order in the [smallest currency unit](stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency).



2808
2809
2810
 
# File 'lib/stripe/resources/order.rb', line 2808

def amount_subtotal
  @amount_subtotal
end

#amount_total ⇒ Object (readonly)

Total order cost after discounts and taxes are applied. A positive integer representing the cost of the order in the [smallest currency unit](stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). To submit an order, the total must be either 0 or at least $0.50 USD or [equivalent in charge currency](stripe.com/docs/currencies#minimum-and-maximum-charge-amounts).



2810
2811
2812
 
# File 'lib/stripe/resources/order.rb', line 2810

def amount_total
  @amount_total
end

#application ⇒ Object (readonly)

ID of the Connect application that created the Order, if any.



2812
2813
2814
 
# File 'lib/stripe/resources/order.rb', line 2812

def application
  @application
end

#automatic_tax ⇒ Object (readonly)

Attribute for field automatic_tax



2814
2815
2816
 
# File 'lib/stripe/resources/order.rb', line 2814

def automatic_tax
  @automatic_tax
end

#billing_details ⇒ Object (readonly)

Customer billing details associated with the order.



2816
2817
2818
 
# File 'lib/stripe/resources/order.rb', line 2816

def billing_details
  @billing_details
end

#client_secret ⇒ Object (readonly)

The client secret of this Order. Used for client-side retrieval using a publishable key.

The client secret can be used to complete a payment for an Order from your frontend. It should not be stored, logged, embedded in URLs, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret.

Refer to our docs for [creating and processing an order](stripe.com/docs/orders-beta/create-and-process) to learn about how client_secret should be handled.



2822
2823
2824
 
# File 'lib/stripe/resources/order.rb', line 2822

def client_secret
  @client_secret
end

#created ⇒ Object (readonly)

Time at which the object was created. Measured in seconds since the Unix epoch.



2824
2825
2826
 
# File 'lib/stripe/resources/order.rb', line 2824

def created
  @created
end

#currency ⇒ Object (readonly)

Three-letter [ISO currency code](www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](stripe.com/docs/currencies).



2826
2827
2828
 
# File 'lib/stripe/resources/order.rb', line 2826

def currency
  @currency
end

#customer ⇒ Object (readonly)

The customer which this orders belongs to.



2828
2829
2830
 
# File 'lib/stripe/resources/order.rb', line 2828

def customer
  @customer
end

#description ⇒ Object (readonly)

An arbitrary string attached to the object. Often useful for displaying to users.



2830
2831
2832
 
# File 'lib/stripe/resources/order.rb', line 2830

def description
  @description
end

#discounts ⇒ Object (readonly)

The discounts applied to the order. Use ‘expand[]=discounts` to expand each discount.



2832
2833
2834
 
# File 'lib/stripe/resources/order.rb', line 2832

def discounts
  @discounts
end

#id ⇒ Object (readonly)

Unique identifier for the object.



2834
2835
2836
 
# File 'lib/stripe/resources/order.rb', line 2834

def id
  @id
end

#ip_address ⇒ Object (readonly)

A recent IP address of the purchaser used for tax reporting and tax location inference.



2836
2837
2838
 
# File 'lib/stripe/resources/order.rb', line 2836

def ip_address
  @ip_address
end

#line_items ⇒ Object (readonly)

A list of line items the customer is ordering. Each line item includes information about the product, the quantity, and the resulting cost. There is a maximum of 100 line items.



2838
2839
2840
 
# File 'lib/stripe/resources/order.rb', line 2838

def line_items
  @line_items
end

#livemode ⇒ Object (readonly)

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



2840
2841
2842
 
# File 'lib/stripe/resources/order.rb', line 2840

def livemode
  @livemode
end

#metadata ⇒ Object (readonly)

Set of [key-value pairs](stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.



2842
2843
2844
 
# File 'lib/stripe/resources/order.rb', line 2842

def metadata
  @metadata
end

#object ⇒ Object (readonly)

String representing the object’s type. Objects of the same type share the same value.



2844
2845
2846
 
# File 'lib/stripe/resources/order.rb', line 2844

def object
  @object
end

#payment ⇒ Object (readonly)

Attribute for field payment



2846
2847
2848
 
# File 'lib/stripe/resources/order.rb', line 2846

def payment
  @payment
end

#shipping_cost ⇒ Object (readonly)

The details of the customer cost of shipping, including the customer chosen ShippingRate.



2848
2849
2850
 
# File 'lib/stripe/resources/order.rb', line 2848

def shipping_cost
  @shipping_cost
end

#shipping_details ⇒ Object (readonly)

Customer shipping information associated with the order.



2850
2851
2852
 
# File 'lib/stripe/resources/order.rb', line 2850

def shipping_details
  @shipping_details
end

#status ⇒ Object (readonly)

The overall status of the order.



2852
2853
2854
 
# File 'lib/stripe/resources/order.rb', line 2852

def status
  @status
end

#tax_details ⇒ Object (readonly)

Attribute for field tax_details



2854
2855
2856
 
# File 'lib/stripe/resources/order.rb', line 2854

def tax_details
  @tax_details
end

#total_details ⇒ Object (readonly)

Attribute for field total_details



2856
2857
2858
 
# File 'lib/stripe/resources/order.rb', line 2856

def total_details
  @total_details
end

Class Method Details

.cancel(id, params = {}, opts = {}) ⇒ Object

Cancels the order as well as the payment intent if one is attached.



2869
2870
2871
2872
2873
2874
2875
2876
 
# File 'lib/stripe/resources/order.rb', line 2869

def self.cancel(id, params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/orders/%<id>s/cancel", { id: CGI.escape(id) }),
    params: params,
    opts: opts
  )
end

.create(params = {}, opts = {}) ⇒ Object

Creates a new open order object.



2879
2880
2881
 
# File 'lib/stripe/resources/order.rb', line 2879

def self.create(params = {}, opts = {})
  request_stripe_object(method: :post, path: "/v1/orders", params: params, opts: opts)
end

.list(params = {}, opts = {}) ⇒ Object

Returns a list of your orders. The orders are returned sorted by creation date, with the most recently created orders appearing first.



2884
2885
2886
 
# File 'lib/stripe/resources/order.rb', line 2884

def self.list(params = {}, opts = {})
  request_stripe_object(method: :get, path: "/v1/orders", params: params, opts: opts)
end

.list_line_items(id, params = {}, opts = {}) ⇒ Object

When retrieving an order, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.



2899
2900
2901
2902
2903
2904
2905
2906
 
# File 'lib/stripe/resources/order.rb', line 2899

def self.list_line_items(id, params = {}, opts = {})
  request_stripe_object(
    method: :get,
    path: format("/v1/orders/%<id>s/line_items", { id: CGI.escape(id) }),
    params: params,
    opts: opts
  )
end

.object_name ⇒ Object 



16
17
18
 
# File 'lib/stripe/resources/order.rb', line 16

def self.object_name
  "order"
end

.reopen(id, params = {}, opts = {}) ⇒ Object

Reopens a submitted order.



2919
2920
2921
2922
2923
2924
2925
2926
 
# File 'lib/stripe/resources/order.rb', line 2919

def self.reopen(id, params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/orders/%<id>s/reopen", { id: CGI.escape(id) }),
    params: params,
    opts: opts
  )
end

.submit(id, params = {}, opts = {}) ⇒ Object

Submitting an Order transitions the status to processing and creates a PaymentIntent object so the order can be paid. If the Order has an amount_total of 0, no PaymentIntent object will be created. Once the order is submitted, its contents cannot be changed, unless the [reopen](docs.stripe.com/api#reopen_order) method is called.



2939
2940
2941
2942
2943
2944
2945
2946
 
# File 'lib/stripe/resources/order.rb', line 2939

def self.submit(id, params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/orders/%<id>s/submit", { id: CGI.escape(id) }),
    params: params,
    opts: opts
  )
end

.update(id, params = {}, opts = {}) ⇒ Object

Updates the specific order by setting the values of the parameters passed. Any parameters not provided will be left unchanged.



2949
2950
2951
2952
2953
2954
2955
2956
 
# File 'lib/stripe/resources/order.rb', line 2949

def self.update(id, params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/orders/%<id>s", { id: CGI.escape(id) }),
    params: params,
    opts: opts
  )
end

Instance Method Details

#cancel(params = {}, opts = {}) ⇒ Object

Cancels the order as well as the payment intent if one is attached.



2859
2860
2861
2862
2863
2864
2865
2866
 
# File 'lib/stripe/resources/order.rb', line 2859

def cancel(params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/orders/%<id>s/cancel", { id: CGI.escape(self["id"]) }),
    params: params,
    opts: opts
  )
end

#list_line_items(params = {}, opts = {}) ⇒ Object

When retrieving an order, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.



2889
2890
2891
2892
2893
2894
2895
2896
 
# File 'lib/stripe/resources/order.rb', line 2889

def list_line_items(params = {}, opts = {})
  request_stripe_object(
    method: :get,
    path: format("/v1/orders/%<id>s/line_items", { id: CGI.escape(self["id"]) }),
    params: params,
    opts: opts
  )
end

#reopen(params = {}, opts = {}) ⇒ Object

Reopens a submitted order.



2909
2910
2911
2912
2913
2914
2915
2916
 
# File 'lib/stripe/resources/order.rb', line 2909

def reopen(params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/orders/%<id>s/reopen", { id: CGI.escape(self["id"]) }),
    params: params,
    opts: opts
  )
end

#submit(params = {}, opts = {}) ⇒ Object

Submitting an Order transitions the status to processing and creates a PaymentIntent object so the order can be paid. If the Order has an amount_total of 0, no PaymentIntent object will be created. Once the order is submitted, its contents cannot be changed, unless the [reopen](docs.stripe.com/api#reopen_order) method is called.



2929
2930
2931
2932
2933
2934
2935
2936
 
# File 'lib/stripe/resources/order.rb', line 2929

def submit(params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/orders/%<id>s/submit", { id: CGI.escape(self["id"]) }),
    params: params,
    opts: opts
  )
end