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, TransferData

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.



436
437
438
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 436

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.



438
439
440
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 438

def application_fee_percent
  @application_fee_percent
end

#automatic_tax ⇒ Object (readonly)

Attribute for field automatic_tax



440
441
442
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 440

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



442
443
444
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 442

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



444
445
446
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 444

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



446
447
448
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 446

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



448
449
450
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 448

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.



450
451
452
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 450

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.



452
453
454
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 452

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.



454
455
456
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 454

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.



456
457
458
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 456

def discounts
  @discounts
end

#end_date ⇒ Object (readonly)

The end of this phase of the subscription schedule.



458
459
460
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 458

def end_date
  @end_date
end

#invoice_settings ⇒ Object (readonly)

The invoice settings applicable during this phase.



460
461
462
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 460

def invoice_settings
  @invoice_settings
end

#items ⇒ Object (readonly)

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



462
463
464
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 462

def items
  @items
end

#metadata ⇒ Object (readonly)

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



464
465
466
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 464

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.



466
467
468
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 466

def on_behalf_of
  @on_behalf_of
end

#proration_behavior ⇒ Object (readonly)

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



468
469
470
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 468

def proration_behavior
  @proration_behavior
end

#start_date ⇒ Object (readonly)

The start of this phase of the subscription schedule.



470
471
472
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 470

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.



472
473
474
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 472

def transfer_data
  @transfer_data
end

#trial_end ⇒ Object (readonly)

When the trial ends within the phase.



474
475
476
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 474

def trial_end
  @trial_end
end

Class Method Details

.field_remappings ⇒ Object 



488
489
490
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 488

def self.field_remappings
  @field_remappings = {}
end

.inner_class_types ⇒ Object 



476
477
478
479
480
481
482
483
484
485
486
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 476

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,
    transfer_data: TransferData,
  }
end