Class: Recurly::Requests::PurchaseCreate

Inherits:
Recurly::Request show all
Defined in:
lib/recurly/requests/purchase_create.rb

Instance Attribute Summary collapse

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

#account ⇒ AccountPurchase

Returns:



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

define_attribute :account, :AccountPurchase

#billing_info_id ⇒ String

Returns The `billing_info_id` is the value that represents a specific billing info for an end customer. When `billing_info_id` is used to assign billing info to the subscription, all future billing events for the subscription will bill to the specified billing info. `billing_info_id` can ONLY be used for sites utilizing the Wallet feature.

Returns:

  • (String) —

    The `billing_info_id` is the value that represents a specific billing info for an end customer. When `billing_info_id` is used to assign billing info to the subscription, all future billing events for the subscription will bill to the specified billing info. `billing_info_id` can ONLY be used for sites utilizing the Wallet feature.



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

define_attribute :billing_info_id, String

#collection_method ⇒ String

Returns Must be set to manual in order to preview a purchase for an Account that does not have payment information associated with the Billing Info.

Returns:

  • (String) —

    Must be set to manual in order to preview a purchase for an Account that does not have payment information associated with the Billing Info.



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

define_attribute :collection_method, String

#coupon_codes ⇒ Array[String]

Returns A list of coupon_codes to be redeemed on the subscription or account during the purchase.

Returns:

  • (Array[String]) —

    A list of coupon_codes to be redeemed on the subscription or account during the purchase.



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

define_attribute :coupon_codes, Array, { :item_type => String }

#credit_customer_notes ⇒ String

Returns Notes to be put on the credit invoice resulting from credits in the purchase, if any.

Returns:

  • (String) —

    Notes to be put on the credit invoice resulting from credits in the purchase, if any.



27
 
# File 'lib/recurly/requests/purchase_create.rb', line 27

define_attribute :credit_customer_notes, String

#currency ⇒ String

Returns 3-letter ISO 4217 currency code.

Returns:

  • (String) —

    3-letter ISO 4217 currency code.



31
 
# File 'lib/recurly/requests/purchase_create.rb', line 31

define_attribute :currency, String

#customer_notes ⇒ String

Returns Customer notes.

Returns:

  • (String) —

    Customer notes



35
 
# File 'lib/recurly/requests/purchase_create.rb', line 35

define_attribute :customer_notes, String

#gateway_code ⇒ String

Returns The default payment gateway identifier to be used for the purchase transaction. This will also be applied as the default for any subscriptions included in the purchase request.

Returns:

  • (String) —

    The default payment gateway identifier to be used for the purchase transaction. This will also be applied as the default for any subscriptions included in the purchase request.



39
 
# File 'lib/recurly/requests/purchase_create.rb', line 39

define_attribute :gateway_code, String

#gift_card_redemption_code ⇒ String

Returns A gift card redemption code to be redeemed on the purchase invoice.

Returns:

  • (String) —

    A gift card redemption code to be redeemed on the purchase invoice.



43
 
# File 'lib/recurly/requests/purchase_create.rb', line 43

define_attribute :gift_card_redemption_code, String

#line_items ⇒ Array[LineItemCreate]

Returns A list of one time charges or credits to be created with the purchase.

Returns:

  • (Array[LineItemCreate]) —

    A list of one time charges or credits to be created with the purchase.



47
 
# File 'lib/recurly/requests/purchase_create.rb', line 47

define_attribute :line_items, Array, { :item_type => :LineItemCreate }

#net_terms ⇒ Integer

Returns Integer paired with `Net Terms Type` and representing the number of days past the current date (for `net` Net Terms Type) or days after the last day of the current month (for `eom` Net Terms Type) that the invoice will become past due. For `manual` collection method, an additional 24 hours is added to ensure the customer has the entire last day to make payment before becoming past due. For example: If an invoice is due `net 0`, it is due 'On Receipt' and will become past due 24 hours after it's created. If an invoice is due `net 30`, it will become past due at 31 days exactly. If an invoice is due `eom 30`, it will become past due 31 days from the last day of the current month. For `automatic` collection method, the additional 24 hours is not added. For example, On-Receipt is due immediately, and `net 30` will become due exactly 30 days from invoice generation, at which point Recurly will attempt collection. When `eom` Net Terms Type is passed, the value for `Net Terms` is restricted to `0, 15, 30, 45, 60, or 90`. For more information on how net terms work with `manual` collection visit our docs page (docs.recurly.com/docs/manual-payments#section-collection-terms) or visit (docs.recurly.com/docs/automatic-invoicing-terms#section-collection-terms) for information about net terms using `automatic` collection.

Returns:

  • (Integer) —

    Integer paired with `Net Terms Type` and representing the number of days past the current date (for `net` Net Terms Type) or days after the last day of the current month (for `eom` Net Terms Type) that the invoice will become past due. For `manual` collection method, an additional 24 hours is added to ensure the customer has the entire last day to make payment before becoming past due. For example: If an invoice is due `net 0`, it is due 'On Receipt' and will become past due 24 hours after it's created. If an invoice is due `net 30`, it will become past due at 31 days exactly. If an invoice is due `eom 30`, it will become past due 31 days from the last day of the current month. For `automatic` collection method, the additional 24 hours is not added. For example, On-Receipt is due immediately, and `net 30` will become due exactly 30 days from invoice generation, at which point Recurly will attempt collection. When `eom` Net Terms Type is passed, the value for `Net Terms` is restricted to `0, 15, 30, 45, 60, or 90`. For more information on how net terms work with `manual` collection visit our docs page (docs.recurly.com/docs/manual-payments#section-collection-terms) or visit (docs.recurly.com/docs/automatic-invoicing-terms#section-collection-terms) for information about net terms using `automatic` collection.



51
 
# File 'lib/recurly/requests/purchase_create.rb', line 51

define_attribute :net_terms, Integer

#net_terms_type ⇒ String

Returns Optionally supplied string that may be either `net` or `eom` (end-of-month). When `net`, an invoice becomes past due the specified number of `Net Terms` days from the current date. When `eom` an invoice becomes past due the specified number of `Net Terms` days from the last day of the current month.

Returns:

  • (String) —

    Optionally supplied string that may be either `net` or `eom` (end-of-month). When `net`, an invoice becomes past due the specified number of `Net Terms` days from the current date. When `eom` an invoice becomes past due the specified number of `Net Terms` days from the last day of the current month.



55
 
# File 'lib/recurly/requests/purchase_create.rb', line 55

define_attribute :net_terms_type, String

#po_number ⇒ String

Returns For manual invoicing, this identifies the PO number associated with the subscription.

Returns:

  • (String) —

    For manual invoicing, this identifies the PO number associated with the subscription.



59
 
# File 'lib/recurly/requests/purchase_create.rb', line 59

define_attribute :po_number, String

#shipping ⇒ ShippingPurchase

Returns:



63
 
# File 'lib/recurly/requests/purchase_create.rb', line 63

define_attribute :shipping, :ShippingPurchase

#subscriptions ⇒ Array[SubscriptionPurchase]

Returns A list of subscriptions to be created with the purchase.

Returns:



67
 
# File 'lib/recurly/requests/purchase_create.rb', line 67

define_attribute :subscriptions, Array, { :item_type => :SubscriptionPurchase }

#terms_and_conditions ⇒ String

Returns Terms and conditions to be put on the purchase invoice.

Returns:

  • (String) —

    Terms and conditions to be put on the purchase invoice.



71
 
# File 'lib/recurly/requests/purchase_create.rb', line 71

define_attribute :terms_and_conditions, String

#transaction_type ⇒ String

Returns An optional type designation for the payment gateway transaction created by this request. Supports 'moto' value, which is the acronym for mail order and telephone transactions.

Returns:

  • (String) —

    An optional type designation for the payment gateway transaction created by this request. Supports 'moto' value, which is the acronym for mail order and telephone transactions.



75
 
# File 'lib/recurly/requests/purchase_create.rb', line 75

define_attribute :transaction_type, String

#vat_reverse_charge_notes ⇒ String

Returns VAT reverse charge notes for cross border European tax settlement.

Returns:

  • (String) —

    VAT reverse charge notes for cross border European tax settlement.



79
 
# File 'lib/recurly/requests/purchase_create.rb', line 79

define_attribute :vat_reverse_charge_notes, String