Class: Stripe::Capital::FinancingOffer

Inherits:
APIResource show all
Extended by:
APIOperations::List
Defined in:
lib/stripe/resources/capital/financing_offer.rb

Overview

This is an object representing an offer of financing from Stripe Capital to a Connect subaccount.

Defined Under Namespace

Classes: AcceptedTerms, OfferedTerms

Constant Summary collapse

OBJECT_NAME = 
"capital.financing_offer"

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

Instance Method Summary collapse

Methods included from APIOperations::List

list

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?, field_encodings, #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

#accepted_terms ⇒ Object (readonly)

This is an object representing the terms of an offer of financing from Stripe Capital to a Connected account. This resource represents the terms accepted by the Connected account, which may differ from those offered.



67
68
69
 
# File 'lib/stripe/resources/capital/financing_offer.rb', line 67

def accepted_terms
  @accepted_terms
end

#account ⇒ Object (readonly)

The ID of the merchant associated with this financing object.



69
70
71
 
# File 'lib/stripe/resources/capital/financing_offer.rb', line 69

def 
  @account
end

#charged_off_at ⇒ Object (readonly)

The time at which this financing offer was charged off, if applicable. Given in seconds since unix epoch.



71
72
73
 
# File 'lib/stripe/resources/capital/financing_offer.rb', line 71

def charged_off_at
  @charged_off_at
end

#created ⇒ Object (readonly)

Time at which the offer was created. Given in seconds since unix epoch.



73
74
75
 
# File 'lib/stripe/resources/capital/financing_offer.rb', line 73

def created
  @created
end

#disclaimer_variant ⇒ Object (readonly)

The type of disclaimer to use for a financing offer in user-facing surfaces. The corresponding disclaimer text to use for each disclaimer_variant value can be found in the [marketing docs](docs.stripe.com/capital/marketing).



75
76
77
 
# File 'lib/stripe/resources/capital/financing_offer.rb', line 75

def disclaimer_variant
  @disclaimer_variant
end

#expires_after ⇒ Object (readonly)

Time at which the offer expires. Given in seconds since unix epoch.



77
78
79
 
# File 'lib/stripe/resources/capital/financing_offer.rb', line 77

def expires_after
  @expires_after
end

#financing_type ⇒ Object (readonly)

The type of financing being offered.



79
80
81
 
# File 'lib/stripe/resources/capital/financing_offer.rb', line 79

def financing_type
  @financing_type
end

#id ⇒ Object (readonly)

A unique identifier for the financing object.



81
82
83
 
# File 'lib/stripe/resources/capital/financing_offer.rb', line 81

def id
  @id
end

#livemode ⇒ Object (readonly)

If the object exists in live mode, the value is ‘true`. If the object exists in test mode, the value is `false`.



83
84
85
 
# File 'lib/stripe/resources/capital/financing_offer.rb', line 83

def livemode
  @livemode
end

#metadata ⇒ Object (readonly)

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



85
86
87
 
# File 'lib/stripe/resources/capital/financing_offer.rb', line 85

def metadata
  @metadata
end

#object ⇒ Object (readonly)

The object type: financing_offer.



87
88
89
 
# File 'lib/stripe/resources/capital/financing_offer.rb', line 87

def object
  @object
end

#offered_terms ⇒ Object (readonly)

This is an object representing the terms of an offer of financing from Stripe Capital to a Connected account. This resource represents both the terms offered to the Connected account.



91
92
93
 
# File 'lib/stripe/resources/capital/financing_offer.rb', line 91

def offered_terms
  @offered_terms
end

#product_type ⇒ Object (readonly)

Financing product identifier.



93
94
95
 
# File 'lib/stripe/resources/capital/financing_offer.rb', line 93

def product_type
  @product_type
end

#replacement ⇒ Object (readonly)

The ID of the financing offer that replaced this offer.



95
96
97
 
# File 'lib/stripe/resources/capital/financing_offer.rb', line 95

def replacement
  @replacement
end

#replacement_for ⇒ Object (readonly)

The ID of the financing offer that this offer is a replacement for.



97
98
99
 
# File 'lib/stripe/resources/capital/financing_offer.rb', line 97

def replacement_for
  @replacement_for
end

#status ⇒ Object (readonly)

The current status of the offer.



99
100
101
 
# File 'lib/stripe/resources/capital/financing_offer.rb', line 99

def status
  @status
end

#type ⇒ Object (readonly)

See [financing_type](docs.stripe.com/api/capital/connect_financing_object#financing_offer_object-financing_type).



101
102
103
 
# File 'lib/stripe/resources/capital/financing_offer.rb', line 101

def type
  @type
end

Class Method Details

.field_remappings ⇒ Object 



139
140
141
 
# File 'lib/stripe/resources/capital/financing_offer.rb', line 139

def self.field_remappings
  @field_remappings = {}
end

.inner_class_types ⇒ Object 



135
136
137
 
# File 'lib/stripe/resources/capital/financing_offer.rb', line 135

def self.inner_class_types
  @inner_class_types = { accepted_terms: AcceptedTerms, offered_terms: OfferedTerms }
end

.list(params = {}, opts = {}) ⇒ Object

Retrieves the financing offers available for Connected accounts that belong to your platform.



104
105
106
107
108
109
110
111
 
# File 'lib/stripe/resources/capital/financing_offer.rb', line 104

def self.list(params = {}, opts = {})
  request_stripe_object(
    method: :get,
    path: "/v1/capital/financing_offers",
    params: params,
    opts: opts
  )
end

.mark_delivered(financing_offer, params = {}, opts = {}) ⇒ Object

Acknowledges that platform has received and delivered the financing_offer to the intended merchant recipient.



126
127
128
129
130
131
132
133
 
# File 'lib/stripe/resources/capital/financing_offer.rb', line 126

def self.mark_delivered(financing_offer, params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/capital/financing_offers/%<financing_offer>s/mark_delivered", { financing_offer: CGI.escape(financing_offer) }),
    params: params,
    opts: opts
  )
end

.object_name ⇒ Object 



12
13
14
 
# File 'lib/stripe/resources/capital/financing_offer.rb', line 12

def self.object_name
  "capital.financing_offer"
end

Instance Method Details

#mark_delivered(params = {}, opts = {}) ⇒ Object

Acknowledges that platform has received and delivered the financing_offer to the intended merchant recipient.



115
116
117
118
119
120
121
122
 
# File 'lib/stripe/resources/capital/financing_offer.rb', line 115

def mark_delivered(params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/capital/financing_offers/%<financing_offer>s/mark_delivered", { financing_offer: CGI.escape(self["id"]) }),
    params: params,
    opts: opts
  )
end