class Stripe::ApplicationFeesApi

Defined in:

stripe/api/application_fees_api.cr

Constant Summary

GET_APPLICATION_FEES_FEE_REFUNDS_ID_MAX_LENGTH_FOR_FEE = 5000
GET_APPLICATION_FEES_FEE_REFUNDS_ID_MAX_LENGTH_FOR_ID = 5000
GET_APPLICATION_FEES_ID_MAX_LENGTH_FOR_ID = 5000
GET_APPLICATION_FEES_ID_REFUNDS_MAX_LENGTH_FOR_ENDING_BEFORE = 5000
GET_APPLICATION_FEES_ID_REFUNDS_MAX_LENGTH_FOR_ID = 5000
GET_APPLICATION_FEES_ID_REFUNDS_MAX_LENGTH_FOR_STARTING_AFTER = 5000
GET_APPLICATION_FEES_MAX_LENGTH_FOR_CHARGE = 5000
GET_APPLICATION_FEES_MAX_LENGTH_FOR_ENDING_BEFORE = 5000
GET_APPLICATION_FEES_MAX_LENGTH_FOR_STARTING_AFTER = 5000
POST_APPLICATION_FEES_FEE_REFUNDS_ID_MAX_LENGTH_FOR_FEE = 5000
POST_APPLICATION_FEES_FEE_REFUNDS_ID_MAX_LENGTH_FOR_ID = 5000
POST_APPLICATION_FEES_ID_REFUNDS_MAX_LENGTH_FOR_ID = 5000

Constructors

Instance Method Summary

Constructor Detail

def self.new(api_client : Stripe::ApiClient = ApiClient.default) #

[View source]

Instance Method Detail

def api_client : ApiClient #

[View source]
def api_client=(api_client : ApiClient) #

[View source]
def build_api_request_for_get_application_fees(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, charge : String | Nil = nil, created : Stripe::GetAccountsCreatedParameter | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_get_application_fees_fee_refunds_id(*, fee : String | Nil = nil, id : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_get_application_fees_id(*, id : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_get_application_fees_id_refunds(*, id : String | Nil = nil, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_post_application_fees_fee_refunds_id(*, fee : String | Nil = nil, id : String | Nil = nil, expand : Array(String) | Nil = nil, metadata : Stripe::PostAccountsRequestMetadata | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_post_application_fees_id_refunds(*, id : String | Nil = nil, amount : Int64 | Nil = nil, expand : Array(String) | Nil = nil, metadata : Hash(String, String) | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def client_side_validation?(*args, **options) #

[View source]
def client_side_validation?(*args, **options, &) #

[View source]
def debugging?(*args, **options) #

[View source]
def debugging?(*args, **options, &) #

[View source]
def get_application_fees(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, charge : String | Nil = nil, created : Stripe::GetAccountsCreatedParameter | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::PlatformEarningList #

Returns a list of application fees you’ve previously collected. The application fees are returned in sorted order, with the most recent fees appearing first.

@optional @param ending_before [String?] A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param charge [String?] Only return application fees for the charge specified by this charge ID. @optional @param created [Stripe::GetAccountsCreatedParameter?] Only return applications fees that were created during the given date interval. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::PlatformEarningList]

[View source]
def get_application_fees(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, charge : String | Nil = nil, created : Stripe::GetAccountsCreatedParameter | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : Nil #

<p>Returns a list of application fees you’ve previously collected. The application fees are returned in sorted order, with the most recent fees appearing first.</p> @optional @param ending_before [String?] A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param charge [String?] Only return application fees for the charge specified by this charge ID. @optional @param created [Stripe::GetAccountsCreatedParameter?] Only return applications fees that were created during the given date interval. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil


[View source]
def get_application_fees_fee_refunds_id(*, fee : String | Nil = nil, id : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::FeeRefund #

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.

@required @param fee [String?] @required @param id [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::FeeRefund]

[View source]
def get_application_fees_fee_refunds_id(*, fee : String | Nil = nil, id : String | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : Nil #

<p>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.</p> @required @param fee [String?] @required @param id [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil


[View source]
def get_application_fees_fee_refunds_id_with_http_info(*, fee : String | Nil = nil, id : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::FeeRefund, Int32, Hash(String, Array(String) | String)) #

<p>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.</p> @required @param fee [String?] @required @param id [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::FeeRefund, Integer, Hash)] Stripe::FeeRefund, response status code and response headers


[View source]
def get_application_fees_id(*, id : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::ApplicationFee #

Retrieves the details of an application fee that your account has collected. The same information is returned when refunding the application fee.

@required @param id [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::ApplicationFee]

[View source]
def get_application_fees_id(*, id : String | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : Nil #

<p>Retrieves the details of an application fee that your account has collected. The same information is returned when refunding the application fee.</p> @required @param id [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil


[View source]
def get_application_fees_id_refunds(*, id : String | Nil = nil, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::FeeRefundList #

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.

@required @param id [String?] @optional @param ending_before [String?] A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::FeeRefundList]

[View source]
def get_application_fees_id_refunds(*, id : String | Nil = nil, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : Nil #

<p>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 <code>limit</code> and <code>starting_after</code> parameters to page through additional refunds.</p> @required @param id [String?] @optional @param ending_before [String?] A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil


[View source]
def get_application_fees_id_refunds_with_http_info(*, id : String | Nil = nil, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::FeeRefundList, Int32, Hash(String, Array(String) | String)) #

<p>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 <code>limit</code> and <code>starting_after</code> parameters to page through additional refunds.</p> @required @param id [String?] @optional @param ending_before [String?] A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::FeeRefundList, Integer, Hash)] Stripe::FeeRefundList, response status code and response headers


[View source]
def get_application_fees_id_with_http_info(*, id : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::ApplicationFee, Int32, Hash(String, Array(String) | String)) #

<p>Retrieves the details of an application fee that your account has collected. The same information is returned when refunding the application fee.</p> @required @param id [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::ApplicationFee, Integer, Hash)] Stripe::ApplicationFee, response status code and response headers


[View source]
def get_application_fees_with_http_info(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, charge : String | Nil = nil, created : Stripe::GetAccountsCreatedParameter | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::PlatformEarningList, Int32, Hash(String, Array(String) | String)) #

<p>Returns a list of application fees you’ve previously collected. The application fees are returned in sorted order, with the most recent fees appearing first.</p> @optional @param ending_before [String?] A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param charge [String?] Only return application fees for the charge specified by this charge ID. @optional @param created [Stripe::GetAccountsCreatedParameter?] Only return applications fees that were created during the given date interval. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::PlatformEarningList, Integer, Hash)] Stripe::PlatformEarningList, response status code and response headers


[View source]
def post_application_fees_fee_refunds_id(*, fee : String | Nil = nil, id : String | Nil = nil, expand : Array(String) | Nil = nil, metadata : Stripe::PostAccountsRequestMetadata | Nil = nil) : Stripe::FeeRefund #

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.

@required @param fee [String?] @required @param id [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param metadata [Stripe::PostAccountsRequestMetadata?] @return [Stripe::FeeRefund]

[View source]
def post_application_fees_fee_refunds_id(*, fee : String | Nil = nil, id : String | Nil = nil, expand : Array(String) | Nil = nil, metadata : Stripe::PostAccountsRequestMetadata | Nil = nil, &block : Crest::Response -> ) : Nil #

<p>Updates the specified application fee refund by setting the values of the parameters passed. Any parameters not provided will be left unchanged.</p> <p>This request only accepts metadata as an argument.</p> @required @param fee [String?] @required @param id [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param metadata [Stripe::PostAccountsRequestMetadata?] @return nil


[View source]
def post_application_fees_fee_refunds_id_with_http_info(*, fee : String | Nil = nil, id : String | Nil = nil, expand : Array(String) | Nil = nil, metadata : Stripe::PostAccountsRequestMetadata | Nil = nil) : Tuple(Stripe::FeeRefund, Int32, Hash(String, Array(String) | String)) #

<p>Updates the specified application fee refund by setting the values of the parameters passed. Any parameters not provided will be left unchanged.</p> <p>This request only accepts metadata as an argument.</p> @required @param fee [String?] @required @param id [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param metadata [Stripe::PostAccountsRequestMetadata?] @return [Tuple(Stripe::FeeRefund, Integer, Hash)] Stripe::FeeRefund, response status code and response headers


[View source]
def post_application_fees_id_refunds(*, id : String | Nil = nil, amount : Int64 | Nil = nil, expand : Array(String) | Nil = nil, metadata : Hash(String, String) | Nil = nil) : Stripe::FeeRefund #

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.

@required @param id [String?] @optional @param amount [Int32?] A positive integer, in _cents (or local equivalent)_, representing how much of this fee to refund. Can refund only up to the remaining unrefunded amount of the fee. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param metadata [Hash(String, String)?] @return [Stripe::FeeRefund]

[View source]
def post_application_fees_id_refunds(*, id : String | Nil = nil, amount : Int64 | Nil = nil, expand : Array(String) | Nil = nil, metadata : Hash(String, String) | Nil = nil, &block : Crest::Response -> ) : Nil #

<p>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.</p> <p>You can optionally refund only part of an application fee. You can do so multiple times, until the entire fee has been refunded.</p> <p>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.</p> @required @param id [String?] @optional @param amount [Int32?] A positive integer, in cents (or local equivalent), representing how much of this fee to refund. Can refund only up to the remaining unrefunded amount of the fee. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param metadata [Hash(String, String)?] @return nil


[View source]
def post_application_fees_id_refunds_with_http_info(*, id : String | Nil = nil, amount : Int64 | Nil = nil, expand : Array(String) | Nil = nil, metadata : Hash(String, String) | Nil = nil) : Tuple(Stripe::FeeRefund, Int32, Hash(String, Array(String) | String)) #

<p>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.</p> <p>You can optionally refund only part of an application fee. You can do so multiple times, until the entire fee has been refunded.</p> <p>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.</p> @required @param id [String?] @optional @param amount [Int32?] A positive integer, in cents (or local equivalent), representing how much of this fee to refund. Can refund only up to the remaining unrefunded amount of the fee. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param metadata [Hash(String, String)?] @return [Tuple(Stripe::FeeRefund, Integer, Hash)] Stripe::FeeRefund, response status code and response headers


[View source]