Class: Stripe::ApplicationFeeRefundService

Inherits:
StripeService show all
Defined in:
lib/stripe/services/application_fee_refund_service.rb

Instance Method Summary collapse

Methods inherited from StripeService

#initialize, #request, #request_stream

Constructor Details

This class inherits a constructor from Stripe::StripeService

Instance Method Details

#create(id, params = {}, opts = {}) ⇒ Object

Refunds an application fee that has previously been collected but not yet refunded. Funds will be refunded to the Stripe account from which the fee was originally collected.

You can optionally refund only part of an application fee. You can do so multiple times, until the entire fee has been refunded.

Once entirely refunded, an application fee can’t be refunded again. This method will raise an error when called on an already-refunded application fee, or when trying to refund more money than is left on an application fee.



15
16
17
18
19
20
21
22
23
 
# File 'lib/stripe/services/application_fee_refund_service.rb', line 15

def create(id, params = {}, opts = {})
  request(
    method: :post,
    path: format("/v1/application_fees/%<id>s/refunds", { id: CGI.escape(id) }),
    params: params,
    opts: opts,
    base_address: :api
  )
end

#list(id, params = {}, opts = {}) ⇒ Object

You can see a list of the refunds belonging to a specific application fee. Note that the 10 most recent refunds are always available by default on the application fee object. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional refunds.



26
27
28
29
30
31
32
33
34
 
# File 'lib/stripe/services/application_fee_refund_service.rb', line 26

def list(id, params = {}, opts = {})
  request(
    method: :get,
    path: format("/v1/application_fees/%<id>s/refunds", { id: CGI.escape(id) }),
    params: params,
    opts: opts,
    base_address: :api
  )
end

#retrieve(fee, id, params = {}, opts = {}) ⇒ Object

By default, you can see the 10 most recent refunds stored directly on the application fee object, but you can also retrieve details about a specific refund stored on the application fee.



37
38
39
40
41
42
43
44
45
 
# File 'lib/stripe/services/application_fee_refund_service.rb', line 37

def retrieve(fee, id, params = {}, opts = {})
  request(
    method: :get,
    path: format("/v1/application_fees/%<fee>s/refunds/%<id>s", { fee: CGI.escape(fee), id: CGI.escape(id) }),
    params: params,
    opts: opts,
    base_address: :api
  )
end

#update(fee, id, params = {}, opts = {}) ⇒ Object

Updates the specified application fee refund by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

This request only accepts metadata as an argument.



50
51
52
53
54
55
56
57
58
 
# File 'lib/stripe/services/application_fee_refund_service.rb', line 50

def update(fee, id, params = {}, opts = {})
  request(
    method: :post,
    path: format("/v1/application_fees/%<fee>s/refunds/%<id>s", { fee: CGI.escape(fee), id: CGI.escape(id) }),
    params: params,
    opts: opts,
    base_address: :api
  )
end