Class: Recurly::Requests::LineItemRefund

Inherits:

Recurly::Request

• Object
• Recurly::Request
• Recurly::Requests::LineItemRefund

Defined in:

lib/recurly/requests/line_item_refund.rb

Instance Attribute Summary

• #id ⇒ String

  Line item ID.

• #prorate ⇒ Boolean

  Set to `true` if the line item should be prorated; set to `false` if not.

• #quantity ⇒ Integer

  Line item quantity to be refunded.

• #quantity_decimal ⇒ String

  A floating-point alternative to Quantity.

Attributes inherited from Recurly::Request

#attributes

Method Summary

Methods inherited from Recurly::Request

#==, #to_s

Methods included from Schema::SchemaFactory

#schema

Methods included from Schema::RequestCaster

#cast_request

Methods included from Schema::ResourceCaster

#cast

Methods included from Schema::SchemaValidator

#get_did_you_mean, #validate!, #validate_attribute!

Instance Attribute Details

#id ⇒ String

Returns Line item ID.

Returns:

• (String) —

  Line item ID

# File 'lib/recurly/requests/line_item_refund.rb', line 11

define_attribute :id, String

#prorate ⇒ Boolean

Returns Set to `true` if the line item should be prorated; set to `false` if not. This can only be used on line items that have a start and end date.

Returns:

• (Boolean) —

  Set to `true` if the line item should be prorated; set to `false` if not. This can only be used on line items that have a start and end date.

# File 'lib/recurly/requests/line_item_refund.rb', line 15

define_attribute :prorate, :Boolean

#quantity ⇒ Integer

Returns Line item quantity to be refunded.

Returns:

• (Integer) —

  Line item quantity to be refunded.

# File 'lib/recurly/requests/line_item_refund.rb', line 19

define_attribute :quantity, Integer

#quantity_decimal ⇒ String

Returns A floating-point alternative to Quantity. If this value is present, it will be used in place of Quantity for calculations, and Quantity will be the rounded integer value of this number. This field supports up to 9 decimal places. The Decimal Quantity feature must be enabled to utilize this field.

Returns:

• (String) —

  A floating-point alternative to Quantity. If this value is present, it will be used in place of Quantity for calculations, and Quantity will be the rounded integer value of this number. This field supports up to 9 decimal places. The Decimal Quantity feature must be enabled to utilize this field.

# File 'lib/recurly/requests/line_item_refund.rb', line 23

define_attribute :quantity_decimal, String