Class: Stripe::ChargeService::UpdateParams

Inherits:
RequestParams show all
Defined in:
lib/stripe/services/charge_service.rb

Defined Under Namespace

Classes: FraudDetails, Shipping

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(customer: nil, description: nil, expand: nil, fraud_details: nil, metadata: nil, receipt_email: nil, shipping: nil, transfer_group: nil) ⇒ UpdateParams

Returns a new instance of UpdateParams.



316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/stripe/services/charge_service.rb', line 316

def initialize(
  customer: nil,
  description: nil,
  expand: nil,
  fraud_details: nil,
  metadata: nil,
  receipt_email: nil,
  shipping: nil,
  transfer_group: nil
)
  @customer = customer
  @description = description
  @expand = expand
  @fraud_details = fraud_details
  @metadata = metadata
  @receipt_email = receipt_email
  @shipping = shipping
  @transfer_group = transfer_group
end

Instance Attribute Details

#customer ⇒ Object

The ID of an existing customer that will be associated with this request. This field may only be updated if there is no existing associated customer with this charge.



300
301
302
 
# File 'lib/stripe/services/charge_service.rb', line 300

def customer
  @customer
end

#description ⇒ Object

An arbitrary string which you can attach to a charge object. It is displayed when in the web interface alongside the charge. Note that if you use Stripe to send automatic email receipts to your customers, your receipt emails will include the ‘description` of the charge(s) that they are describing.



302
303
304
 
# File 'lib/stripe/services/charge_service.rb', line 302

def description
  @description
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



304
305
306
 
# File 'lib/stripe/services/charge_service.rb', line 304

def expand
  @expand
end

#fraud_details ⇒ Object

A set of key-value pairs you can attach to a charge giving information about its riskiness. If you believe a charge is fraudulent, include a ‘user_report` key with a value of `fraudulent`. If you believe a charge is safe, include a `user_report` key with a value of `safe`. Stripe will use the information you send to improve our fraud detection algorithms.



306
307
308
 
# File 'lib/stripe/services/charge_service.rb', line 306

def fraud_details
  @fraud_details
end

#metadata ⇒ Object

Set of [key-value pairs](stripe.com/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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to ‘metadata`.



308
309
310
 
# File 'lib/stripe/services/charge_service.rb', line 308

def metadata
  @metadata
end

#receipt_email ⇒ Object

This is the email address that the receipt for this charge will be sent to. If this field is updated, then a new email receipt will be sent to the updated address.



310
311
312
 
# File 'lib/stripe/services/charge_service.rb', line 310

def receipt_email
  @receipt_email
end

#shipping ⇒ Object

Shipping information for the charge. Helps prevent fraud on charges for physical goods.



312
313
314
 
# File 'lib/stripe/services/charge_service.rb', line 312

def shipping
  @shipping
end

#transfer_group ⇒ Object

A string that identifies this transaction as part of a group. ‘transfer_group` may only be provided if it has not been set. See the [Connect documentation](stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details.



314
315
316
 
# File 'lib/stripe/services/charge_service.rb', line 314

def transfer_group
  @transfer_group
end