Class: Stripe::Order::CreateParams

Inherits:

RequestParams

• Object
• RequestParams
• Stripe::Order::CreateParams

Defined in:

lib/stripe/resources/order.rb

Defined Under Namespace

Classes: AutomaticTax, BillingDetails, Discount, LineItem, Payment, ShippingCost, ShippingDetails, TaxDetails

Instance Attribute Summary

• #automatic_tax ⇒ Object

  Settings for automatic tax calculation for this order.

• #billing_details ⇒ Object

  Billing details for the customer.

• #currency ⇒ Object

  Three-letter [ISO currency code](www.iso.org/iso-4217-currency-codes.html), in lowercase.

• #customer ⇒ Object

  The customer associated with this order.

• #description ⇒ Object

  An arbitrary string attached to the object.

• #discounts ⇒ Object

  The coupons, promotion codes, and/or discounts to apply to the order.

• #expand ⇒ Object

  Specifies which fields in the response should be expanded.

• #ip_address ⇒ Object

  The IP address of the purchaser for this order.

• #line_items ⇒ Object

  A list of line items the customer is ordering.

• #metadata ⇒ Object

  Set of [key-value pairs](stripe.com/docs/api/metadata) that you can attach to an object.

• #payment ⇒ Object

  Payment information associated with the order, including payment settings.

• #shipping_cost ⇒ Object

  Settings for the customer cost of shipping for this order.

• #shipping_details ⇒ Object

  Shipping details for the order.

• #tax_details ⇒ Object

  Additional tax details about the purchaser to be used for this order.

Instance Method Summary

• #initialize(automatic_tax: nil, billing_details: nil, currency: nil, customer: nil, description: nil, discounts: nil, expand: nil, ip_address: nil, line_items: nil, metadata: nil, payment: nil, shipping_cost: nil, shipping_details: nil, tax_details: nil) ⇒ CreateParams constructor

  A new instance of CreateParams.

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(automatic_tax: nil, billing_details: nil, currency: nil, customer: nil, description: nil, discounts: nil, expand: nil, ip_address: nil, line_items: nil, metadata: nil, payment: nil, shipping_cost: nil, shipping_details: nil, tax_details: nil) ⇒ CreateParams

Returns a new instance of CreateParams.

# File 'lib/stripe/resources/order.rb', line 1935

def initialize(
  automatic_tax: nil,
  billing_details: nil,
  currency: nil,
  customer: nil,
  description: nil,
  discounts: nil,
  expand: nil,
  ip_address: nil,
  line_items: nil,
  metadata: nil,
  payment: nil,
  shipping_cost: nil,
  shipping_details: nil,
  tax_details: nil
)
  @automatic_tax = automatic_tax
  @billing_details = billing_details
  @currency = currency
  @customer = customer
  @description = description
  @discounts = discounts
  @expand = expand
  @ip_address = ip_address
  @line_items = line_items
  @metadata = metadata
  @payment = payment
  @shipping_cost = shipping_cost
  @shipping_details = shipping_details
  @tax_details = tax_details
end

Instance Attribute Details

#automatic_tax ⇒ Object

Settings for automatic tax calculation for this order.

# File 'lib/stripe/resources/order.rb', line 1907

def automatic_tax
  @automatic_tax
end

#billing_details ⇒ Object

Billing details for the customer. If a customer is provided, this will be automatically populated with values from that customer if override values are not provided.

# File 'lib/stripe/resources/order.rb', line 1909

def billing_details
  @billing_details
end

#currency ⇒ Object

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

# File 'lib/stripe/resources/order.rb', line 1911

def currency
  @currency
end

#customer ⇒ Object

The customer associated with this order.

# File 'lib/stripe/resources/order.rb', line 1913

def customer
  @customer
end

#description ⇒ Object

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

# File 'lib/stripe/resources/order.rb', line 1915

def description
  @description
end

#discounts ⇒ Object

The coupons, promotion codes, and/or discounts to apply to the order.

# File 'lib/stripe/resources/order.rb', line 1917

def discounts
  @discounts
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.

# File 'lib/stripe/resources/order.rb', line 1919

def expand
  @expand
end

#ip_address ⇒ Object

The IP address of the purchaser for this order.

# File 'lib/stripe/resources/order.rb', line 1921

def ip_address
  @ip_address
end

#line_items ⇒ Object

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

# File 'lib/stripe/resources/order.rb', line 1923

def line_items
  @line_items
end

#metadata ⇒ Object

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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to ‘metadata`.

# File 'lib/stripe/resources/order.rb', line 1925

def metadata
  @metadata
end

#payment ⇒ Object

Payment information associated with the order, including payment settings.

# File 'lib/stripe/resources/order.rb', line 1927

def payment
  @payment
end

#shipping_cost ⇒ Object

Settings for the customer cost of shipping for this order.

# File 'lib/stripe/resources/order.rb', line 1929

def shipping_cost
  @shipping_cost
end

#shipping_details ⇒ Object

Shipping details for the order.

# File 'lib/stripe/resources/order.rb', line 1931

def shipping_details
  @shipping_details
end

#tax_details ⇒ Object

Additional tax details about the purchaser to be used for this order.

# File 'lib/stripe/resources/order.rb', line 1933

def tax_details
  @tax_details
end