Class: Stripe::SubscriptionSchedule::Phase

Inherits:
Stripe::StripeObject show all
Defined in:
lib/stripe/resources/subscription_schedule.rb

Defined Under Namespace

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

Constant Summary

Constants inherited from Stripe::StripeObject

Stripe::StripeObject::RESERVED_FIELD_NAMES

Instance Attribute Summary collapse

Attributes inherited from Stripe::StripeObject

#last_response

Class Method Summary collapse

Methods inherited from Stripe::StripeObject

#==, #[], #[]=, #_get_inner_class_type, additive_object_param, additive_object_param?, #as_json, construct_from, #deleted?, #dirty!, #each, #eql?, #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.



661
662
663
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 661

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.



663
664
665
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 663

def application_fee_percent
  @application_fee_percent
end

#automatic_tax ⇒ Object (readonly)

Attribute for field automatic_tax



665
666
667
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 665

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](docs.stripe.com/billing/subscriptions/billing-cycle).



667
668
669
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 667

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



669
670
671
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 669

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



671
672
673
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 671

def collection_method
  @collection_method
end

#currency ⇒ Object (readonly)

Three-letter [ISO currency code](www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](stripe.com/docs/currencies).



673
674
675
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 673

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.



675
676
677
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 675

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.



677
678
679
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 677

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.



679
680
681
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 679

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.



681
682
683
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 681

def discounts
  @discounts
end

#effective_at ⇒ Object (readonly)

Configures how the subscription schedule handles billing for phase transitions. Possible values are ‘phase_start` (default) or `billing_period_start`. `phase_start` bills based on the current state of the subscription, ignoring changes scheduled in future phases. `billing_period_start` bills predictively for upcoming phase transitions within the current billing cycle, including pricing changes and service period adjustments that will occur before the next invoice.



683
684
685
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 683

def effective_at
  @effective_at
end

#end_date ⇒ Object (readonly)

The end of this phase of the subscription schedule.



685
686
687
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 685

def end_date
  @end_date
end

#invoice_settings ⇒ Object (readonly)

The invoice settings applicable during this phase.



687
688
689
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 687

def invoice_settings
  @invoice_settings
end

#items ⇒ Object (readonly)

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



689
690
691
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 689

def items
  @items
end

#metadata ⇒ Object (readonly)

Set of [key-value pairs](docs.stripe.com/api/metadata) 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`.



691
692
693
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 691

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.



693
694
695
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 693

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](docs.stripe.com/billing/subscriptions/pause-payment).



695
696
697
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 695

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



697
698
699
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 697

def proration_behavior
  @proration_behavior
end

#start_date ⇒ Object (readonly)

The start of this phase of the subscription schedule.



699
700
701
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 699

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.



701
702
703
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 701

def transfer_data
  @transfer_data
end

#trial_continuation ⇒ Object (readonly)

Specify behavior of the trial when crossing schedule phase boundaries



703
704
705
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 703

def trial_continuation
  @trial_continuation
end

#trial_end ⇒ Object (readonly)

When the trial ends within the phase.



705
706
707
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 705

def trial_end
  @trial_end
end

#trial_settings ⇒ Object (readonly)

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



707
708
709
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 707

def trial_settings
  @trial_settings
end

Class Method Details

.field_remappings ⇒ Object 



723
724
725
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 723

def self.field_remappings
  @field_remappings = {}
end

.inner_class_types ⇒ Object 



709
710
711
712
713
714
715
716
717
718
719
720
721
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 709

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