Deprecated API Reference

This API Reference is being deprecated. Please use the New API Reference.

Fetch a Fee

List all the Fee resources you've created. For more information, see Subscription Billing Guide.

warning

This endpoint is deprecated and will be removed in a future release.

Make sure your requests use the latest version of Finix's API and endpoints. For more information, see Versioning.

Copy
Copied
curl 'https://finix.sandbox-payments-api.com/fees' \
-H 'Content-Type: application/json' \
-H 'Finix-Version:2022-02-01' \
-u USimz3zSq5R2PqiEBXY6rSiJ:8bacba32-9550-48ff-b567-fe7648947041

Example Response

Copy
Copied
{
  "_embedded" : {
    "fees" : [ {
      "id" : "FEfVmdhncr87berjP4VsAyHu",
      "created_at" : "2022-10-10T02:37:24.03Z",
      "updated_at" : "2022-10-10T02:37:24.03Z",
      "amount" : 1000,
      "currency" : "USD",
      "display_name" : "April_Performance_Analytics_Fees",
      "fee_subtype" : "CUSTOM",
      "fee_type" : "CUSTOM",
      "label" : "April_Performance_Analytics_Fees",
      "linked_id" : null,
      "linked_type" : null,
      "merchant" : "MUhQVWbSdd3Da68RKpfodqEV",
      "tags" : { },
      "_links" : {
        "self" : {
          "href" : "https://finix.sandbox-payments-api.com/fees/FEfVmdhncr87berjP4VsAyHu"
        },
        "merchant" : {
          "href" : "https://finix.sandbox-payments-api.com/merchants/MUhQVWbSdd3Da68RKpfodqEV"
        }
      }
    }, {
      "id" : "FEvmsxfv1a6ZmnA2geQCADmi",
      "created_at" : "2022-10-05T16:51:16.53Z",
      "updated_at" : "2022-10-05T16:51:16.53Z",
      "amount" : 54321,
      "currency" : "USD",
      "display_name" : "Merchant Software Fees",
      "fee_subtype" : "CUSTOM",
      "fee_type" : "CUSTOM",
      "label" : "Merchant Software Fees",
      "linked_id" : "SUBITEM_wi4T7ptTBbqV9pkT3YXY74",
      "linked_type" : "SUBSCRIPTION",
      "merchant" : "MUoT2LgUEMYN8zor6oooPehe",
      "tags" : { },
      "_links" : {
        "self" : {
          "href" : "https://finix.sandbox-payments-api.com/fees/FEvmsxfv1a6ZmnA2geQCADmi"
        },
        "merchant" : {
          "href" : "https://finix.sandbox-payments-api.com/merchants/MUoT2LgUEMYN8zor6oooPehe"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://finix.sandbox-payments-api.com/fees?offset=0&limit=20&sort=created_at,desc&sort=id,desc"
    },
    "next" : {
      "href" : "https://finix.sandbox-payments-api.com/fees?offset=20&limit=20&sort=created_at,desc&sort=id,desc"
    },
    "last" : {
      "href" : "https://finix.sandbox-payments-api.com/fees?offset=251500&limit=20&sort=created_at,desc&sort=id,desc"
    }
  },
  "page" : {
    "offset" : 0,
    "limit" : 20,
    "count" : 251502
  }
}

HTTP Request

GET https://finix.sandbox-payments-api.com/fees

Response

Field Type Description
id string ID of the Fee.
amount string The amount of the fee in cents.
currency string Three-letter ISO currency code in uppercase.
display_name string The name of the fee object that was passed in label.
fee_subtype string Subtype of the fee.
fee_type string The type of fee.
label string The display name of the Fee that can be used for filtering purposes.
linked_id string Entity id that the fee is linked to in our system. null by default.
linked_type string The type of entity the fee is linked to in our system. null by default.
merchant string The Finix Merchant ID that the fee is being debited from.(#step-1a-provision-a-merchant).
created_at string Timestamp of when the fee resource was created.
updated_at string Timestamp of when the fee was last updated.
tags string A custom value you can include to annotate the fee object's metadata (e.g. fee number).