Create a One-time Fee

Create a one-time custom Fee resource. 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 \
-d '{
	"amount" : 1000,
	"currency" : "USD",
	"fee_type" : "CUSTOM",
	"fee_subtype" : "CUSTOM",
	"merchant_id" : "MUhQVWbSdd3Da68RKpfodqEV",
  "label" : "April_Performance_Analytics_Fees",
	"settlement_delay_days" : 3
}'

Example Response

Copy

Copied

{
    "id": "FErHfqKicPqY4oijrSswBn7n",
    "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-29T20:57:15.44Z",
    "updated_at": "2022-03-29T20:57:15.44Z",
    "tags": {},
    "_links": {
        "self": {
            "href": "https://finix.sandbox-payments-api.com/fees/FErHfqKicPqY4oijrSswBn7n"
        },
        "merchant": {
            "href": "https://finix.sandbox-payments-api.com/merchants/MUhQVWbSdd3Da68RKpfodqEV"
        }
    }
}

HTTP Request

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

Request Arguments

Field	Type	Description
`amount`	string, required	The amount of the fee in cents.
`currency`	string, required	Three-letter ISO currency code in uppercase. Only USD is available.
`fee_type`	string, required	The type of fee. Set to CUSTOM.
`fee_subtype`	string, required	Subtype of the fee. Set to CUSTOM.
`merchant_id`	string, required	The Finix Merchant ID that you want to debit the fee from.
`label`	string, optional	The display name of the `Fee` that can be used for filtering purposes.
`settlement_delay_days`	string, optional	Delays in days, when the fee will be submitted for settlement.

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