Class: Stripe::V2::Billing::CollectionSettingVersion

Inherits:
APIResource show all
Defined in:
lib/stripe/resources/v2/billing/collection_setting_version.rb

Overview

A Collection Setting Version is a specific configuration of a CollectionSetting at a point in time. Collection Setting Versions enable you to track changes to payment collection settings over time and manage which version is active for new billing operations.

Defined Under Namespace

Classes: EmailDelivery, PaymentMethodOptions

Constant Summary collapse

OBJECT_NAME = 
"v2.billing.collection_setting_version"

Constants inherited from StripeObject

StripeObject::RESERVED_FIELD_NAMES

Instance Attribute Summary collapse

Attributes inherited from APIResource

#save_with_parent

Attributes inherited from StripeObject

#last_response

Class Method Summary collapse

Methods inherited from APIResource

class_name, custom_method, #refresh, #request_stripe_object, resource_url, #resource_url, retrieve, save_nested_resource

Methods included from APIOperations::Request

included

Methods inherited from 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

#collection_method ⇒ Object (readonly)

Either automatic, or send_invoice. When charging automatically, Stripe will attempt to pay this bill at the end of the period using the payment method attached to the payer profile. When sending an invoice, Stripe will email your payer profile an invoice with payment instructions. Defaults to automatic.



251
252
253
 
# File 'lib/stripe/resources/v2/billing/collection_setting_version.rb', line 251

def collection_method
  @collection_method
end

#created ⇒ Object (readonly)

Timestamp of when the object was created.



253
254
255
 
# File 'lib/stripe/resources/v2/billing/collection_setting_version.rb', line 253

def created
  @created
end

#email_delivery ⇒ Object (readonly)

Email delivery settings.



255
256
257
 
# File 'lib/stripe/resources/v2/billing/collection_setting_version.rb', line 255

def email_delivery
  @email_delivery
end

#id ⇒ Object (readonly)

The ID of the CollectionSettingVersion object.



257
258
259
 
# File 'lib/stripe/resources/v2/billing/collection_setting_version.rb', line 257

def id
  @id
end

#livemode ⇒ Object (readonly)

Has the value ‘true` if the object exists in live mode or the value `false` if the object exists in test mode.



259
260
261
 
# File 'lib/stripe/resources/v2/billing/collection_setting_version.rb', line 259

def livemode
  @livemode
end

#object ⇒ Object (readonly)

String representing the object’s type. Objects of the same type share the same value of the object field.



261
262
263
 
# File 'lib/stripe/resources/v2/billing/collection_setting_version.rb', line 261

def object
  @object
end

#payment_method_configuration ⇒ Object (readonly)

The ID of the PaymentMethodConfiguration object, which controls which payment methods are displayed to your customers.



263
264
265
 
# File 'lib/stripe/resources/v2/billing/collection_setting_version.rb', line 263

def payment_method_configuration
  @payment_method_configuration
end

#payment_method_options ⇒ Object (readonly)

Payment Method specific configuration stored on the object.



265
266
267
 
# File 'lib/stripe/resources/v2/billing/collection_setting_version.rb', line 265

def payment_method_options
  @payment_method_options
end

Class Method Details

.field_encodings ⇒ Object 



278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/stripe/resources/v2/billing/collection_setting_version.rb', line 278

def self.field_encodings
  @field_encodings = {
    payment_method_options: {
      kind: :object,
      fields: {
        card: {
          kind: :object,
          fields: { mandate_options: { kind: :object, fields: { amount: :int64_string } } },
        },
      },
    },
  }
end

.field_remappings ⇒ Object 



274
275
276
 
# File 'lib/stripe/resources/v2/billing/collection_setting_version.rb', line 274

def self.field_remappings
  @field_remappings = {}
end

.inner_class_types ⇒ Object 



267
268
269
270
271
272
 
# File 'lib/stripe/resources/v2/billing/collection_setting_version.rb', line 267

def self.inner_class_types
  @inner_class_types = {
    email_delivery: EmailDelivery,
    payment_method_options: PaymentMethodOptions,
  }
end

.object_name ⇒ Object 



10
11
12
 
# File 'lib/stripe/resources/v2/billing/collection_setting_version.rb', line 10

def self.object_name
  "v2.billing.collection_setting_version"
end