Class: Stripe::SubscriptionSchedule::Phase

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

Defined Under Namespace

Classes: AddInvoiceItem, AutomaticTax, 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

Method Summary

Methods inherited from Stripe::StripeObject

#==, #[], #[]=, 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.



171
172
173
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 171

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.



173
174
175
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 173

def application_fee_percent
  @application_fee_percent
end

#automatic_tax ⇒ Object (readonly)

Attribute for field automatic_tax



175
176
177
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 175

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



177
178
179
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 177

def billing_cycle_anchor
  @billing_cycle_anchor
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`.



179
180
181
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 179

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



181
182
183
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 181

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.



183
184
185
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 183

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.



185
186
187
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 185

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.



187
188
189
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 187

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.



189
190
191
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 189

def discounts
  @discounts
end

#end_date ⇒ Object (readonly)

The end of this phase of the subscription schedule.



191
192
193
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 191

def end_date
  @end_date
end

#invoice_settings ⇒ Object (readonly)

The invoice settings applicable during this phase.



193
194
195
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 193

def invoice_settings
  @invoice_settings
end

#items ⇒ Object (readonly)

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



195
196
197
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 195

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



197
198
199
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 197

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.



199
200
201
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 199

def on_behalf_of
  @on_behalf_of
end

#proration_behavior ⇒ Object (readonly)

If the subscription schedule will prorate when transitioning to this phase. Possible values are ‘create_prorations` and `none`.



201
202
203
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 201

def proration_behavior
  @proration_behavior
end

#start_date ⇒ Object (readonly)

The start of this phase of the subscription schedule.



203
204
205
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 203

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.



205
206
207
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 205

def transfer_data
  @transfer_data
end

#trial_end ⇒ Object (readonly)

When the trial ends within the phase.



207
208
209
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 207

def trial_end
  @trial_end
end