Class: Stripe::QuotePreviewSubscriptionSchedule::Phase

Inherits:
StripeObject
  • Object
show all
Defined in:
lib/stripe/resources/quote_preview_subscription_schedule.rb

Defined Under Namespace

Classes: AddInvoiceItem, AutomaticTax, BillingThresholds, Discount, InvoiceSettings, Item, PauseCollection, TransferData, TrialSettings

Constant Summary

Constants inherited from StripeObject

StripeObject::RESERVED_FIELD_NAMES

Instance Attribute Summary collapse

Attributes inherited from StripeObject

#last_response

Class Method Summary collapse

Methods inherited from StripeObject

#==, #[], #[]=, #_get_inner_class_type, additive_object_param, additive_object_param?, #as_json, construct_from, #deleted?, #dirty!, #each, #eql?, field_encodings, #hash, #initialize, #inspect, #keys, #marshal_dump, #marshal_load, protected_fields, #serialize_params, #to_hash, #to_json, #to_s, #update_attributes, #values

Constructor Details

This class inherits a constructor from Stripe::StripeObject

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Stripe::StripeObject

Instance Attribute Details

#add_invoice_items ⇒ Object (readonly)

A list of prices and quantities that will generate invoice items appended to the next invoice for this phase.



630
631
632
 
# File 'lib/stripe/resources/quote_preview_subscription_schedule.rb', line 630

def add_invoice_items
  @add_invoice_items
end

#application_fee_percent ⇒ Object (readonly)

A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account during this phase of the schedule.



632
633
634
 
# File 'lib/stripe/resources/quote_preview_subscription_schedule.rb', line 632

def application_fee_percent
  @application_fee_percent
end

#automatic_tax ⇒ Object (readonly)

Attribute for field automatic_tax



634
635
636
 
# File 'lib/stripe/resources/quote_preview_subscription_schedule.rb', line 634

def automatic_tax
  @automatic_tax
end

#billing_cycle_anchor ⇒ Object (readonly)

Possible values are phase_start or automatic. If phase_start then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If automatic then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle documentation.



636
637
638
 
# File 'lib/stripe/resources/quote_preview_subscription_schedule.rb', line 636

def billing_cycle_anchor
  @billing_cycle_anchor
end

#billing_thresholds ⇒ Object (readonly)

Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period



638
639
640
 
# File 'lib/stripe/resources/quote_preview_subscription_schedule.rb', line 638

def billing_thresholds
  @billing_thresholds
end

#collection_method ⇒ Object (readonly)

Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as active.



640
641
642
 
# File 'lib/stripe/resources/quote_preview_subscription_schedule.rb', line 640

def collection_method
  @collection_method
end

#currency ⇒ Object (readonly)

Three-letter ISO currency code, in lowercase. Must be a supported currency.



642
643
644
 
# File 'lib/stripe/resources/quote_preview_subscription_schedule.rb', line 642

def currency
  @currency
end

#default_payment_method ⇒ Object (readonly)

ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.



644
645
646
 
# File 'lib/stripe/resources/quote_preview_subscription_schedule.rb', line 644

def default_payment_method
  @default_payment_method
end

#default_tax_rates ⇒ Object (readonly)

The default tax rates to apply to the subscription during this phase of the subscription schedule.



646
647
648
 
# File 'lib/stripe/resources/quote_preview_subscription_schedule.rb', line 646

def default_tax_rates
  @default_tax_rates
end

#description ⇒ Object (readonly)

Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.



648
649
650
 
# File 'lib/stripe/resources/quote_preview_subscription_schedule.rb', line 648

def description
  @description
end

#discounts ⇒ Object (readonly)

The stackable discounts that will be applied to the subscription on this phase. Subscription item discounts are applied before subscription discounts.



650
651
652
 
# File 'lib/stripe/resources/quote_preview_subscription_schedule.rb', line 650

def discounts
  @discounts
end

#end_date ⇒ Object (readonly)

The end of this phase of the subscription schedule.



652
653
654
 
# File 'lib/stripe/resources/quote_preview_subscription_schedule.rb', line 652

def end_date
  @end_date
end

#invoice_settings ⇒ Object (readonly)

The invoice settings applicable during this phase.



654
655
656
 
# File 'lib/stripe/resources/quote_preview_subscription_schedule.rb', line 654

def invoice_settings
  @invoice_settings
end

#items ⇒ Object (readonly)

Subscription items to configure the subscription to during this phase of the subscription schedule.



656
657
658
 
# File 'lib/stripe/resources/quote_preview_subscription_schedule.rb', line 656

def items
  @items
end

#metadata ⇒ Object (readonly)

Set of key-value pairs that you can attach to a phase. Metadata on a schedule's phase will update the underlying subscription's metadata when the phase is entered. Updating the underlying subscription's metadata directly will not affect the current phase's metadata.



658
659
660
 
# File 'lib/stripe/resources/quote_preview_subscription_schedule.rb', line 658

def metadata
  @metadata
end

#on_behalf_of ⇒ Object (readonly)

The account (if any) the charge was made on behalf of for charges associated with the schedule's subscription. See the Connect documentation for details.



660
661
662
 
# File 'lib/stripe/resources/quote_preview_subscription_schedule.rb', line 660

def on_behalf_of
  @on_behalf_of
end

#pause_collection ⇒ Object (readonly)

If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to paused. Learn more about pausing collection.



662
663
664
 
# File 'lib/stripe/resources/quote_preview_subscription_schedule.rb', line 662

def pause_collection
  @pause_collection
end

#proration_behavior ⇒ Object (readonly)

When transitioning phases, controls how prorations are handled (if any). Possible values are create_prorations, none, and always_invoice.



664
665
666
 
# File 'lib/stripe/resources/quote_preview_subscription_schedule.rb', line 664

def proration_behavior
  @proration_behavior
end

#start_date ⇒ Object (readonly)

The start of this phase of the subscription schedule.



666
667
668
 
# File 'lib/stripe/resources/quote_preview_subscription_schedule.rb', line 666

def start_date
  @start_date
end

#transfer_data ⇒ Object (readonly)

The account (if any) the associated subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices.



668
669
670
 
# File 'lib/stripe/resources/quote_preview_subscription_schedule.rb', line 668

def transfer_data
  @transfer_data
end

#trial ⇒ Object (readonly)

If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.



670
671
672
 
# File 'lib/stripe/resources/quote_preview_subscription_schedule.rb', line 670

def trial
  @trial
end

#trial_continuation ⇒ Object (readonly)

Specify behavior of the trial when crossing schedule phase boundaries



672
673
674
 
# File 'lib/stripe/resources/quote_preview_subscription_schedule.rb', line 672

def trial_continuation
  @trial_continuation
end

#trial_end ⇒ Object (readonly)

When the trial ends within the phase.



674
675
676
 
# File 'lib/stripe/resources/quote_preview_subscription_schedule.rb', line 674

def trial_end
  @trial_end
end

#trial_settings ⇒ Object (readonly)

Settings related to any trials on the subscription during this phase.



676
677
678
 
# File 'lib/stripe/resources/quote_preview_subscription_schedule.rb', line 676

def trial_settings
  @trial_settings
end

Class Method Details

.field_remappings ⇒ Object 



692
693
694
 
# File 'lib/stripe/resources/quote_preview_subscription_schedule.rb', line 692

def self.field_remappings
  @field_remappings = {}
end

.inner_class_types ⇒ Object 



678
679
680
681
682
683
684
685
686
687
688
689
690
 
# File 'lib/stripe/resources/quote_preview_subscription_schedule.rb', line 678

def self.inner_class_types
  @inner_class_types = {
    add_invoice_items: AddInvoiceItem,
    automatic_tax: AutomaticTax,
    billing_thresholds: BillingThresholds,
    discounts: Discount,
    invoice_settings: InvoiceSettings,
    items: Item,
    pause_collection: PauseCollection,
    transfer_data: TransferData,
    trial_settings: TrialSettings,
  }
end