Class: Recurly::Requests::PlanCreate

Inherits:
Recurly::Request show all
Defined in:
lib/recurly/requests/plan_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::ResourceCaster

#cast

Methods included from Schema::RequestCaster

#cast_request

Methods included from Schema::SchemaFactory

#schema

Methods included from Schema::SchemaValidator

#get_did_you_mean, #validate!, #validate_attribute!

Instance Attribute Details

#accounting_codeString

Returns Accounting code for invoice line items for the plan. If no value is provided, it defaults to plan's code.

Returns:

  • (String)

    Accounting code for invoice line items for the plan. If no value is provided, it defaults to plan's code.


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

define_attribute :accounting_code, String

#add_onsArray[AddOnCreate]

Returns Add Ons.

Returns:


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

define_attribute :add_ons, Array, { :item_type => :AddOnCreate }

#auto_renewBoolean

Returns Subscriptions will automatically inherit this value once they are active. If `auto_renew` is `true`, then a subscription will automatically renew its term at renewal. If `auto_renew` is `false`, then a subscription will expire at the end of its term. `auto_renew` can be overridden on the subscription record itself.

Returns:

  • (Boolean)

    Subscriptions will automatically inherit this value once they are active. If `auto_renew` is `true`, then a subscription will automatically renew its term at renewal. If `auto_renew` is `false`, then a subscription will expire at the end of its term. `auto_renew` can be overridden on the subscription record itself.


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

define_attribute :auto_renew, :Boolean

#codeString

Returns Unique code to identify the plan. This is used in Hosted Payment Page URLs and in the invoice exports.

Returns:

  • (String)

    Unique code to identify the plan. This is used in Hosted Payment Page URLs and in the invoice exports.


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

define_attribute :code, String

#currenciesArray[PlanPricing]

Returns Pricing.

Returns:


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

define_attribute :currencies, Array, { :item_type => :PlanPricing }

#descriptionString

Returns Optional description, not displayed.

Returns:

  • (String)

    Optional description, not displayed.


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

define_attribute :description, String

#hosted_pagesPlanHostedPages

Returns Hosted pages settings.

Returns:


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

define_attribute :hosted_pages, :PlanHostedPages

#interval_lengthInteger

Returns Length of the plan's billing interval in `interval_unit`.

Returns:

  • (Integer)

    Length of the plan's billing interval in `interval_unit`.


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

define_attribute :interval_length, Integer

#interval_unitString

Returns Unit for the plan's billing interval.

Returns:

  • (String)

    Unit for the plan's billing interval.


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

define_attribute :interval_unit, String

#nameString

Returns This name describes your plan and will appear on the Hosted Payment Page and the subscriber's invoice.

Returns:

  • (String)

    This name describes your plan and will appear on the Hosted Payment Page and the subscriber's invoice.


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

define_attribute :name, String

#setup_fee_accounting_codeString

Returns Accounting code for invoice line items for the plan's setup fee. If no value is provided, it defaults to plan's accounting code.

Returns:

  • (String)

    Accounting code for invoice line items for the plan's setup fee. If no value is provided, it defaults to plan's accounting code.


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

define_attribute :setup_fee_accounting_code, String

#tax_codeString

Returns Optional field used by Avalara, Vertex, and Recurly's EU VAT tax feature to determine taxation rules. If you have your own AvaTax or Vertex account configured, use their tax codes to assign specific tax rules. If you are using Recurly's EU VAT feature, you can use values of `unknown`, `physical`, or `digital`.

Returns:

  • (String)

    Optional field used by Avalara, Vertex, and Recurly's EU VAT tax feature to determine taxation rules. If you have your own AvaTax or Vertex account configured, use their tax codes to assign specific tax rules. If you are using Recurly's EU VAT feature, you can use values of `unknown`, `physical`, or `digital`.


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

define_attribute :tax_code, String

#tax_exemptBoolean

Returns `true` exempts tax on the plan, `false` applies tax on the plan.

Returns:

  • (Boolean)

    `true` exempts tax on the plan, `false` applies tax on the plan.


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

define_attribute :tax_exempt, :Boolean

#total_billing_cyclesInteger

Returns Automatically terminate plans after a defined number of billing cycles.

Returns:

  • (Integer)

    Automatically terminate plans after a defined number of billing cycles.


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

define_attribute :total_billing_cycles, Integer

#trial_lengthInteger

Returns Length of plan's trial period in `trial_units`. `0` means `no trial`.

Returns:

  • (Integer)

    Length of plan's trial period in `trial_units`. `0` means `no trial`.


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

define_attribute :trial_length, Integer

#trial_unitString

Returns Units for the plan's trial period.

Returns:

  • (String)

    Units for the plan's trial period.


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

define_attribute :trial_unit, String