Function PlatformFeesApiAxiosParamCreator

Returns {
    getPlatformFee: ((tilled_account, id, options?) => Promise<RequestArgs>);
    listPlatformFees: ((tilled_account, created_at_gte?, created_at_lte?, charge_id?, offset?, limit?, options?) => Promise<RequestArgs>);
}

• getPlatformFee: ((tilled_account, id, options?) => Promise<RequestArgs>)

  • • (tilled_account, id, options?): Promise<RequestArgs>

    • Retrieves the details of a collected Platform Fee.

      Summary

      Get a Platform Fee

      Throws

      Parameters

      • tilled_account: string

        The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of.

      • id: string

      • Optional options: RawAxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

• listPlatformFees: ((tilled_account, created_at_gte?, created_at_lte?, charge_id?, offset?, limit?, options?) => Promise<RequestArgs>)

  • • (tilled_account, created_at_gte?, created_at_lte?, charge_id?, offset?, limit?, options?): Promise<RequestArgs>

    • Returns a list of Platform Fees. The Platform Fees are sorted with the most recently created appearing first.

      Summary

      List all Platform Fees

      Throws

      Parameters

      • tilled_account: string

        The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of.

      • Optional created_at_gte: string

        Minimum `created_at` value to filter by (inclusive).

      • Optional created_at_lte: string

        Maximum `created_at` value to filter by (inclusive).

      • Optional charge_id: string

        Only return application fees for the charge specified by this charge id.

      • Optional offset: number

        The (zero-based) offset of the first item in the collection to return.

      • Optional limit: number

        The maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used.

      • Optional options: RawAxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>