Class: Stripe::SubscriptionSchedule::DefaultSettings

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

Defined Under Namespace

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

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



141
142
143
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 141

def application_fee_percent
  @application_fee_percent
end

#automatic_tax ⇒ Object (readonly)

Attribute for field automatic_tax



143
144
145
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 143

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



145
146
147
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 145

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



147
148
149
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 147

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



149
150
151
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 149

def collection_method
  @collection_method
end

#default_payment_method ⇒ Object (readonly)

ID of the default payment method for the subscription schedule. If not set, invoices will use the default payment method in the customer’s invoice settings.



151
152
153
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 151

def default_payment_method
  @default_payment_method
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.



153
154
155
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 153

def description
  @description
end

#invoice_settings ⇒ Object (readonly)

Attribute for field invoice_settings



155
156
157
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 155

def invoice_settings
  @invoice_settings
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.



157
158
159
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 157

def on_behalf_of
  @on_behalf_of
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.



159
160
161
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 159

def transfer_data
  @transfer_data
end

Class Method Details

.field_remappings ⇒ Object 



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

def self.field_remappings
  @field_remappings = {}
end

.inner_class_types ⇒ Object 



161
162
163
164
165
166
167
168
 
# File 'lib/stripe/resources/subscription_schedule.rb', line 161

def self.inner_class_types
  @inner_class_types = {
    automatic_tax: AutomaticTax,
    billing_thresholds: BillingThresholds,
    invoice_settings: InvoiceSettings,
    transfer_data: TransferData,
  }
end