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

#==, #[], #[]=, #_get_inner_class_type, 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).



3140
3141
3142
 
# File 'lib/stripe/resources/order.rb', line 3140

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).



3142
3143
3144
 
# File 'lib/stripe/resources/order.rb', line 3142

def amount_total
  @amount_total
end

#application ⇒ Object (readonly)

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



3144
3145
3146
 
# File 'lib/stripe/resources/order.rb', line 3144

def application
  @application
end

#automatic_tax ⇒ Object (readonly)

Attribute for field automatic_tax



3146
3147
3148
 
# File 'lib/stripe/resources/order.rb', line 3146

def automatic_tax
  @automatic_tax
end

#billing_details ⇒ Object (readonly)

Customer billing details associated with the order.



3148
3149
3150
 
# File 'lib/stripe/resources/order.rb', line 3148

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.



3154
3155
3156
 
# File 'lib/stripe/resources/order.rb', line 3154

def client_secret
  @client_secret
end

#created ⇒ Object (readonly)

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



3156
3157
3158
 
# File 'lib/stripe/resources/order.rb', line 3156

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).



3158
3159
3160
 
# File 'lib/stripe/resources/order.rb', line 3158

def currency
  @currency
end

#customer ⇒ Object (readonly)

The customer which this orders belongs to.



3160
3161
3162
 
# File 'lib/stripe/resources/order.rb', line 3160

def customer
  @customer
end

#description ⇒ Object (readonly)

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



3162
3163
3164
 
# File 'lib/stripe/resources/order.rb', line 3162

def description
  @description
end

#discounts ⇒ Object (readonly)

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



3164
3165
3166
 
# File 'lib/stripe/resources/order.rb', line 3164

def discounts
  @discounts
end

#id ⇒ Object (readonly)

Unique identifier for the object.



3166
3167
3168
 
# File 'lib/stripe/resources/order.rb', line 3166

def id
  @id
end

#ip_address ⇒ Object (readonly)

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



3168
3169
3170
 
# File 'lib/stripe/resources/order.rb', line 3168

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.



3170
3171
3172
 
# File 'lib/stripe/resources/order.rb', line 3170

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.



3172
3173
3174
 
# File 'lib/stripe/resources/order.rb', line 3172

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.



3174
3175
3176
 
# File 'lib/stripe/resources/order.rb', line 3174

def metadata
  @metadata
end

#object ⇒ Object (readonly)

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



3176
3177
3178
 
# File 'lib/stripe/resources/order.rb', line 3176

def object
  @object
end

#payment ⇒ Object (readonly)

Attribute for field payment



3178
3179
3180
 
# File 'lib/stripe/resources/order.rb', line 3178

def payment
  @payment
end

#shipping_cost ⇒ Object (readonly)

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



3180
3181
3182
 
# File 'lib/stripe/resources/order.rb', line 3180

def shipping_cost
  @shipping_cost
end

#shipping_details ⇒ Object (readonly)

Customer shipping information associated with the order.



3182
3183
3184
 
# File 'lib/stripe/resources/order.rb', line 3182

def shipping_details
  @shipping_details
end

#status ⇒ Object (readonly)

The overall status of the order.



3184
3185
3186
 
# File 'lib/stripe/resources/order.rb', line 3184

def status
  @status
end

#tax_details ⇒ Object (readonly)

Attribute for field tax_details



3186
3187
3188
 
# File 'lib/stripe/resources/order.rb', line 3186

def tax_details
  @tax_details
end

#total_details ⇒ Object (readonly)

Attribute for field total_details



3188
3189
3190
 
# File 'lib/stripe/resources/order.rb', line 3188

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.



3201
3202
3203
3204
3205
3206
3207
3208
 
# File 'lib/stripe/resources/order.rb', line 3201

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.



3211
3212
3213
 
# File 'lib/stripe/resources/order.rb', line 3211

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

.field_remappings ⇒ Object 



3302
3303
3304
 
# File 'lib/stripe/resources/order.rb', line 3302

def self.field_remappings
  @field_remappings = {}
end

.inner_class_types ⇒ Object 



3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
 
# File 'lib/stripe/resources/order.rb', line 3290

def self.inner_class_types
  @inner_class_types = {
    automatic_tax: AutomaticTax,
    billing_details: BillingDetails,
    payment: Payment,
    shipping_cost: ShippingCost,
    shipping_details: ShippingDetails,
    tax_details: TaxDetails,
    total_details: TotalDetails,
  }
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.



3216
3217
3218
 
# File 'lib/stripe/resources/order.rb', line 3216

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.



3231
3232
3233
3234
3235
3236
3237
3238
 
# File 'lib/stripe/resources/order.rb', line 3231

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.



3251
3252
3253
3254
3255
3256
3257
3258
 
# File 'lib/stripe/resources/order.rb', line 3251

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.



3271
3272
3273
3274
3275
3276
3277
3278
 
# File 'lib/stripe/resources/order.rb', line 3271

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.



3281
3282
3283
3284
3285
3286
3287
3288
 
# File 'lib/stripe/resources/order.rb', line 3281

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.



3191
3192
3193
3194
3195
3196
3197
3198
 
# File 'lib/stripe/resources/order.rb', line 3191

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.



3221
3222
3223
3224
3225
3226
3227
3228
 
# File 'lib/stripe/resources/order.rb', line 3221

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.



3241
3242
3243
3244
3245
3246
3247
3248
 
# File 'lib/stripe/resources/order.rb', line 3241

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.



3261
3262
3263
3264
3265
3266
3267
3268
 
# File 'lib/stripe/resources/order.rb', line 3261

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