Class: Stripe::ApplicationFeeRefund

Inherits:
APIResource show all
Includes:
Stripe::APIOperations::Save
Defined in:
lib/stripe/resources/application_fee_refund.rb

Overview

‘Application Fee Refund` objects allow you to refund an application fee that has previously been created but not yet refunded. Funds will be refunded to the Stripe account from which the fee was originally collected.

Related guide: [Refunding application fees](stripe.com/docs/connect/destination-charges#refunding-app-fee)

Constant Summary collapse

OBJECT_NAME =
"fee_refund"

Constants inherited from StripeObject

StripeObject::RESERVED_FIELD_NAMES

Instance Attribute Summary

Attributes inherited from APIResource

#save_with_parent

Attributes inherited from StripeObject

#last_response

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Stripe::APIOperations::Save

included, #save

Methods inherited from APIResource

class_name, custom_method, #refresh, #request_stripe_object, resource_url, save_nested_resource

Methods included from Stripe::APIOperations::Request

included

Methods inherited from StripeObject

#==, #[], #[]=, 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

Class Method Details

.object_nameObject



14
15
16
# File 'lib/stripe/resources/application_fee_refund.rb', line 14

def self.object_name
  "fee_refund"
end

.retrieve(_id, _api_key = nil) ⇒ Object

Raises:

  • (NotImplementedError)


31
32
33
34
35
36
# File 'lib/stripe/resources/application_fee_refund.rb', line 31

def self.retrieve(_id, _api_key = nil)
  raise NotImplementedError,
        "Application fee refunds cannot be retrieved without an " \
        "application fee ID. Retrieve an application fee refund using " \
        "`ApplicationFee.retrieve_refund('fee_id', 'refund_id')`"
end

.update(_id, _params = nil, _opts = nil) ⇒ Object

Raises:

  • (NotImplementedError)


23
24
25
26
27
28
29
# File 'lib/stripe/resources/application_fee_refund.rb', line 23

def self.update(_id, _params = nil, _opts = nil)
  raise NotImplementedError,
        "Application fee refunds cannot be updated without an " \
        "application fee ID. Update an application fee refund using " \
        "`ApplicationFee.update_refund('fee_id', 'refund_id', " \
        "update_params)`"
end

Instance Method Details

#resource_urlObject



18
19
20
21
# File 'lib/stripe/resources/application_fee_refund.rb', line 18

def resource_url
  "#{ApplicationFee.resource_url}/#{CGI.escape(fee)}/refunds" \
    "/#{CGI.escape(id)}"
end