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' \
-u USimz3zSq5R2PqiEBXY6rSiJ:8bacba32-9550-48ff-b567-fe7648947041

Example Response

Copy
Copied
{
  "_embedded" : {
    "fees" : [ {
      "id" : "FEwMMgN9Xc92bw3VWux9kySC",
      "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",
      "created_at" : "2022-03-30T00:25:59.84Z",
      "updated_at" : "2022-03-30T00:25:59.84Z",
      "tags" : { },
      "_links" : {
        "self" : {
          "href" : "https://finix.sandbox-payments-api.com/fees/FEwMMgN9Xc92bw3VWux9kySC"
        },
        "merchant" : {
          "href" : "https://finix.sandbox-payments-api.com/merchants/MUhQVWbSdd3Da68RKpfodqEV"
        }
      }
    }, {
      "id" : "FEfFVX4b5hbwXCu2wibw7YBG",
      "amount" : 54321,
      "currency" : "USD",
      "display_name" : null,
      "fee_subtype" : "CUSTOM",
      "fee_type" : "CUSTOM",
      "label" : null,
      "linked_id" : "SUBITEM_s7DeekZZcqaQ6ENx9NaqT6",
      "linked_type" : "SUBSCRIPTION",
      "merchant" : "MUrJZVYwgsemFPZBmrAD15eR",
      "created_at" : "2022-03-05T16:51:12.58Z",
      "updated_at" : "2022-03-05T16:51:12.58Z",
      "tags" : { },
      "_links" : {
        "self" : {
          "href" : "https://finix.sandbox-payments-api.com/fees/FEfFVX4b5hbwXCu2wibw7YBG"
        },
        "merchant" : {
          "href" : "https://finix.sandbox-payments-api.com/merchants/MUrJZVYwgsemFPZBmrAD15eR"
        }
      }
    } ]
  },
  "_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=250520&limit=20&sort=created_at,desc&sort=id,desc"
    }
  },
  "page" : {
    "offset" : 0,
    "limit" : 20,
    "count" : 250523
  }
}

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).