Class: Stripe::ChargeUpdateParams

Inherits:
RequestParams show all
Defined in:
lib/stripe/params/charge_update_params.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) ⇒ ChargeUpdateParams

Returns a new instance of ChargeUpdateParams.



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/stripe/params/charge_update_params.rb', line 82

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.



66
67
68
 
# File 'lib/stripe/params/charge_update_params.rb', line 66

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.



68
69
70
 
# File 'lib/stripe/params/charge_update_params.rb', line 68

def description
  @description
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



70
71
72
 
# File 'lib/stripe/params/charge_update_params.rb', line 70

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.



72
73
74
 
# File 'lib/stripe/params/charge_update_params.rb', line 72

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



74
75
76
 
# File 'lib/stripe/params/charge_update_params.rb', line 74

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.



76
77
78
 
# File 'lib/stripe/params/charge_update_params.rb', line 76

def receipt_email
  @receipt_email
end

#shipping ⇒ Object

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



78
79
80
 
# File 'lib/stripe/params/charge_update_params.rb', line 78

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.



80
81
82
 
# File 'lib/stripe/params/charge_update_params.rb', line 80

def transfer_group
  @transfer_group
end