Class: Recurly::Requests::SubscriptionCreate

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

Returns:



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

define_attribute :account, :AccountCreate

#add_ons ⇒ Array[SubscriptionAddOnCreate]

Returns Add-ons.

Returns:



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

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

#auto_renew ⇒ Boolean

Returns Whether the subscription renews at the end of its term.

Returns:

  • (Boolean) —

    Whether the subscription renews at the end of its term.



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

define_attribute :auto_renew, :Boolean

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



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

define_attribute :billing_info_id, String

#bulk ⇒ Boolean

Returns Optional field to be used only when needing to bypass the 60 second limit on creating subscriptions. Should only be used when creating subscriptions in bulk from the API.

Returns:

  • (Boolean) —

    Optional field to be used only when needing to bypass the 60 second limit on creating subscriptions. Should only be used when creating subscriptions in bulk from the API.



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

define_attribute :bulk, :Boolean

#collection_method ⇒ String

Returns Collection method.

Returns:

  • (String) —

    Collection method



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

define_attribute :collection_method, String

#coupon_code ⇒ String

Returns Optional coupon code to redeem on the account and discount the subscription. Please note, the subscription request will fail if the coupon is invalid.

Returns:

  • (String) —

    Optional coupon code to redeem on the account and discount the subscription. Please note, the subscription request will fail if the coupon is invalid.



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

define_attribute :coupon_code, String

#credit_application_policy ⇒ CreditApplicationPolicy

Returns Controls whether credit invoices are automatically applied to new invoices. The mode field determines the application behavior. When mode is all, the optional allowed_origins array can restrict which credit invoice origins are applied. - all: All available credit invoices are applied (default) - none: No credit invoices are applied automatically.

Returns:

  • (CreditApplicationPolicy) —

    Controls whether credit invoices are automatically applied to new invoices. The mode field determines the application behavior. When mode is all, the optional allowed_origins array can restrict which credit invoice origins are applied. - all: All available credit invoices are applied (default) - none: No credit invoices are applied automatically



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

define_attribute :credit_application_policy, :CreditApplicationPolicy

#credit_customer_notes ⇒ String

Returns If there are pending credits on the account that will be invoiced during the subscription creation, these will be used as the Customer Notes on the credit invoice.

Returns:

  • (String) —

    If there are pending credits on the account that will be invoiced during the subscription creation, these will be used as the Customer Notes on the credit invoice.



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

define_attribute :credit_customer_notes, String

#currency ⇒ String

Returns 3-letter ISO 4217 currency code.

Returns:

  • (String) —

    3-letter ISO 4217 currency code.



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

define_attribute :currency, String

#custom_fields ⇒ Array[CustomField]

Returns The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.

Returns:

  • (Array[CustomField]) —

    The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.



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

define_attribute :custom_fields, Array, { :item_type => :CustomField }

#customer_notes ⇒ String

Returns This will default to the Customer Notes text specified on the Invoice Settings. Specify custom notes to add or override Customer Notes. Custom notes will stay with a subscription on all renewals.

Returns:

  • (String) —

    This will default to the Customer Notes text specified on the Invoice Settings. Specify custom notes to add or override Customer Notes. Custom notes will stay with a subscription on all renewals.



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

define_attribute :customer_notes, String

#net_terms ⇒ Integer

Returns Integer representing the number of days after an invoice's creation that the invoice will become past due. If an invoice's net terms are set to '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.

Returns:

  • (Integer) —

    Integer representing the number of days after an invoice's creation that the invoice will become past due. If an invoice's net terms are set to '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.



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

define_attribute :net_terms, Integer

#next_bill_date ⇒ DateTime

Returns If present, this sets the date the subscription's next billing period will start (current_period_ends_at). This can be used to align the subscription’s billing to a specific day of the month. The initial invoice will be prorated for the period between the subscription's activation date and the billing period end date. Subsequent periods will be based off the plan interval. For a subscription with a trial period, this will change when the trial expires.

Returns:

  • (DateTime) —

    If present, this sets the date the subscription's next billing period will start (current_period_ends_at). This can be used to align the subscription’s billing to a specific day of the month. The initial invoice will be prorated for the period between the subscription's activation date and the billing period end date. Subsequent periods will be based off the plan interval. For a subscription with a trial period, this will change when the trial expires.



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

define_attribute :next_bill_date, DateTime

#plan_code ⇒ String

Returns You must provide either a plan_code or plan_id. If both are provided the plan_id will be used.

Returns:

  • (String) —

    You must provide either a plan_code or plan_id. If both are provided the plan_id will be used.



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

define_attribute :plan_code, String

#plan_id ⇒ String

Returns You must provide either a plan_code or plan_id. If both are provided the plan_id will be used.

Returns:

  • (String) —

    You must provide either a plan_code or plan_id. If both are provided the plan_id will be used.



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

define_attribute :plan_id, 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.



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

define_attribute :po_number, String

#quantity ⇒ Integer

Returns Optionally override the default quantity of 1.

Returns:

  • (Integer) —

    Optionally override the default quantity of 1.



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

define_attribute :quantity, Integer

#ramp_intervals ⇒ Array[SubscriptionRampInterval]

Returns The new set of ramp intervals for the subscription.

Returns:



83
 
# File 'lib/recurly/requests/subscription_create.rb', line 83

define_attribute :ramp_intervals, Array, { :item_type => :SubscriptionRampInterval }

#renewal_billing_cycles ⇒ Integer

Returns If auto_renew=true, when a term completes, total_billing_cycles takes this value as the length of subsequent terms. Defaults to the plan's total_billing_cycles.

Returns:

  • (Integer) —

    If auto_renew=true, when a term completes, total_billing_cycles takes this value as the length of subsequent terms. Defaults to the plan's total_billing_cycles.



87
 
# File 'lib/recurly/requests/subscription_create.rb', line 87

define_attribute :renewal_billing_cycles, Integer

#revenue_schedule_type ⇒ String

Returns Revenue schedule type.

Returns:

  • (String) —

    Revenue schedule type



91
 
# File 'lib/recurly/requests/subscription_create.rb', line 91

define_attribute :revenue_schedule_type, String

#shipping ⇒ SubscriptionShippingCreate

Returns Create a shipping address on the account and assign it to the subscription.

Returns:



95
 
# File 'lib/recurly/requests/subscription_create.rb', line 95

define_attribute :shipping, :SubscriptionShippingCreate

#starts_at ⇒ DateTime

Returns If set, the subscription will begin on this specified date. The subscription will apply the setup fee and trial period, unless the plan has no trial. Omit this field if the subscription should be started immediately.

Returns:

  • (DateTime) —

    If set, the subscription will begin on this specified date. The subscription will apply the setup fee and trial period, unless the plan has no trial. Omit this field if the subscription should be started immediately.



99
 
# File 'lib/recurly/requests/subscription_create.rb', line 99

define_attribute :starts_at, DateTime

#tax_inclusive ⇒ Boolean

Returns Determines whether or not tax is included in the unit amount. The Tax Inclusive Pricing feature (separate from the Mixed Tax Pricing feature) must be enabled to use this flag.

Returns:

  • (Boolean) —

    Determines whether or not tax is included in the unit amount. The Tax Inclusive Pricing feature (separate from the Mixed Tax Pricing feature) must be enabled to use this flag.



103
 
# File 'lib/recurly/requests/subscription_create.rb', line 103

define_attribute :tax_inclusive, :Boolean

#terms_and_conditions ⇒ String

Returns This will default to the Terms and Conditions text specified on the Invoice Settings page in your Recurly admin. Specify custom notes to add or override Terms and Conditions. Custom notes will stay with a subscription on all renewals.

Returns:

  • (String) —

    This will default to the Terms and Conditions text specified on the Invoice Settings page in your Recurly admin. Specify custom notes to add or override Terms and Conditions. Custom notes will stay with a subscription on all renewals.



107
 
# File 'lib/recurly/requests/subscription_create.rb', line 107

define_attribute :terms_and_conditions, String

#total_billing_cycles ⇒ Integer

Returns The number of cycles/billing periods in a term. When remaining_billing_cycles=0, if auto_renew=true the subscription will renew and a new term will begin, otherwise the subscription will expire.

Returns:

  • (Integer) —

    The number of cycles/billing periods in a term. When remaining_billing_cycles=0, if auto_renew=true the subscription will renew and a new term will begin, otherwise the subscription will expire.



111
 
# File 'lib/recurly/requests/subscription_create.rb', line 111

define_attribute :total_billing_cycles, Integer

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



115
 
# File 'lib/recurly/requests/subscription_create.rb', line 115

define_attribute :transaction_type, String

#trial_ends_at ⇒ DateTime

Returns IIf set, overrides the default trial behavior for the subscription. When the current date time or a past date time is provided the subscription will begin with no trial phase (overriding any plan default trial). When a future date time is provided the subscription will begin with a trial phase ending at the specified date time.

Returns:

  • (DateTime) —

    IIf set, overrides the default trial behavior for the subscription. When the current date time or a past date time is provided the subscription will begin with no trial phase (overriding any plan default trial). When a future date time is provided the subscription will begin with a trial phase ending at the specified date time.



119
 
# File 'lib/recurly/requests/subscription_create.rb', line 119

define_attribute :trial_ends_at, DateTime

#unit_amount ⇒ Float

Returns Override the unit amount of the subscription plan by setting this value. If not provided, the subscription will inherit the price from the subscription plan for the provided currency.

Returns:

  • (Float) —

    Override the unit amount of the subscription plan by setting this value. If not provided, the subscription will inherit the price from the subscription plan for the provided currency.



123
 
# File 'lib/recurly/requests/subscription_create.rb', line 123

define_attribute :unit_amount, Float

#vat_reverse_charge_notes ⇒ String

Returns This will default to the VAT reverse charge notes text specified on the Invoice Settings. Specify custom notes to add or override VAT reverse charge notes. Custom notes will stay with a subscription on all renewals.

Returns:

  • (String) —

    This will default to the VAT reverse charge notes text specified on the Invoice Settings. Specify custom notes to add or override VAT reverse charge notes. Custom notes will stay with a subscription on all renewals.



127
 
# File 'lib/recurly/requests/subscription_create.rb', line 127

define_attribute :vat_reverse_charge_notes, String