Class: Stripe::ChargeUpdateParams

Inherits:
RequestParams show all
Defined in:
lib/stripe/params/charge_update_params.rb

Defined Under Namespace

Classes: FraudDetails, PaymentDetails, Shipping

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

attr_accessor, coerce_params, coerce_value, field_encodings, new, #to_h

Constructor Details

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

Returns a new instance of ChargeUpdateParams.



1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
 
# File 'lib/stripe/params/charge_update_params.rb', line 1992

def initialize(
  customer: nil,
  description: nil,
  expand: nil,
  fraud_details: nil,
  metadata: nil,
  payment_details: nil,
  receipt_email: nil,
  shipping: nil,
  transfer_group: nil
)
  @customer = customer
  @description = description
  @expand = expand
  @fraud_details = fraud_details
  @metadata = metadata
  @payment_details = payment_details
  @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.



1974
1975
1976
 
# File 'lib/stripe/params/charge_update_params.rb', line 1974

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.



1976
1977
1978
 
# File 'lib/stripe/params/charge_update_params.rb', line 1976

def description
  @description
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



1978
1979
1980
 
# File 'lib/stripe/params/charge_update_params.rb', line 1978

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.



1980
1981
1982
 
# File 'lib/stripe/params/charge_update_params.rb', line 1980

def fraud_details
  @fraud_details
end

#metadata ⇒ Object

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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to ‘metadata`.



1982
1983
1984
 
# File 'lib/stripe/params/charge_update_params.rb', line 1982

def metadata
  @metadata
end

#payment_details ⇒ Object

Provides industry-specific information about the charge.



1984
1985
1986
 
# File 'lib/stripe/params/charge_update_params.rb', line 1984

def payment_details
  @payment_details
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.



1986
1987
1988
 
# File 'lib/stripe/params/charge_update_params.rb', line 1986

def receipt_email
  @receipt_email
end

#shipping ⇒ Object

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



1988
1989
1990
 
# File 'lib/stripe/params/charge_update_params.rb', line 1988

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](docs.stripe.com/connect/separate-charges-and-transfers#transfer-options) for details.



1990
1991
1992
 
# File 'lib/stripe/params/charge_update_params.rb', line 1990

def transfer_group
  @transfer_group
end