Class: Stripe::V2::Billing::Cadence

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

Overview

A Cadence represents a billing schedule applied to a customer, defining when and how often to generate invoices, such as on monthly or annual billing cycle.

Defined Under Namespace

Classes: BillingCycle, Payer, Settings, SettingsData

Constant Summary collapse

OBJECT_NAME = 
"v2.billing.cadence"

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

#billing_cycle ⇒ Object (readonly)

The billing cycle is the object that defines future billing cycle dates.



643
644
645
 
# File 'lib/stripe/resources/v2/billing/cadence.rb', line 643

def billing_cycle
  @billing_cycle
end

#created ⇒ Object (readonly)

Timestamp of when the object was created.



645
646
647
 
# File 'lib/stripe/resources/v2/billing/cadence.rb', line 645

def created
  @created
end

#id ⇒ Object (readonly)

Unique identifier for the object.



647
648
649
 
# File 'lib/stripe/resources/v2/billing/cadence.rb', line 647

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.



649
650
651
 
# File 'lib/stripe/resources/v2/billing/cadence.rb', line 649

def livemode
  @livemode
end

#lookup_key ⇒ Object (readonly)

A lookup key used to retrieve cadences dynamically from a static string. Maximum length of 200 characters.



651
652
653
 
# File 'lib/stripe/resources/v2/billing/cadence.rb', line 651

def lookup_key
  @lookup_key
end

#metadata ⇒ Object (readonly)

Set of [key-value pairs](/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.



653
654
655
 
# File 'lib/stripe/resources/v2/billing/cadence.rb', line 653

def metadata
  @metadata
end

#next_billing_date ⇒ Object (readonly)

The date that the billing cadence will next bill. Null if the cadence is not active.



655
656
657
 
# File 'lib/stripe/resources/v2/billing/cadence.rb', line 655

def next_billing_date
  @next_billing_date
end

#object ⇒ Object (readonly)

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



657
658
659
 
# File 'lib/stripe/resources/v2/billing/cadence.rb', line 657

def object
  @object
end

#payer ⇒ Object (readonly)

The payer determines the entity financially responsible for the bill.



659
660
661
 
# File 'lib/stripe/resources/v2/billing/cadence.rb', line 659

def payer
  @payer
end

#settings ⇒ Object (readonly)

The settings associated with the cadence.



661
662
663
 
# File 'lib/stripe/resources/v2/billing/cadence.rb', line 661

def settings
  @settings
end

#settings_data ⇒ Object (readonly)

Settings data that contains expanded billing settings configuration with actual values.



663
664
665
 
# File 'lib/stripe/resources/v2/billing/cadence.rb', line 663

def settings_data
  @settings_data
end

#status ⇒ Object (readonly)

The current status of the cadence.



665
666
667
 
# File 'lib/stripe/resources/v2/billing/cadence.rb', line 665

def status
  @status
end

#test_clock ⇒ Object (readonly)

The ID of the Test Clock.



667
668
669
 
# File 'lib/stripe/resources/v2/billing/cadence.rb', line 667

def test_clock
  @test_clock
end

Class Method Details

.field_encodings ⇒ Object 



682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
 
# File 'lib/stripe/resources/v2/billing/cadence.rb', line 682

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

.field_remappings ⇒ Object 



678
679
680
 
# File 'lib/stripe/resources/v2/billing/cadence.rb', line 678

def self.field_remappings
  @field_remappings = {}
end

.inner_class_types ⇒ Object 



669
670
671
672
673
674
675
676
 
# File 'lib/stripe/resources/v2/billing/cadence.rb', line 669

def self.inner_class_types
  @inner_class_types = {
    billing_cycle: BillingCycle,
    payer: Payer,
    settings: Settings,
    settings_data: SettingsData,
  }
end

.object_name ⇒ Object 



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

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