List fees plans

List all fee plans available for use by an account. This is intended to be used by an account when selecting a fee plan to apply to a connected account.

To access this endpoint using an access token you’ll need to specify the /accounts/{accountID}/profile.read scope.

GET

/accounts/{accountID}/fee-plans

200 401 403 429 500 504

The request completed successfully.

[
  {
    "billableFees": [
      {
        "billableEvent": "card-auth-volume",
        "billableFeeID": "9d957d33-1a9a-47aa-9460-fe1a90f003dd",
        "feeCategory": "card-acquiring",
        "feeConditions": {
          "transactionType": [
            "decline"
          ]
        },
        "feeModel": "fixed",
        "feeName": "Card decline fee",
        "feeProperties": {
          "fixedAmount": {
            "currency": "USD",
            "valueDecimal": "0.1"
          }
        }
      }
    ],
    "cardAcquiringModel": "cost-plus",
    "createdAt": "2019-08-24T14:15:22Z",
    "description": "string",
    "minimumCommitment": {
      "currency": "USD",
      "valueDecimal": "12.987654321"
    },
    "monthlyPlatformFee": {
      "currency": "USD",
      "valueDecimal": "12.987654321"
    },
    "name": "Fixed Rate Merchant Plan",
    "planID": "b3e38790-d1c0-4afb-b75c-aa44e99a6877"
  }
]

x-request-id


      string
      <uuid>

required

A unique identifier used to trace requests.

The request contained missing or expired authentication.

x-request-id


      string
      <uuid>

required

A unique identifier used to trace requests.

The user is not authorized to make the request.

x-request-id


      string
      <uuid>

required

A unique identifier used to trace requests.

Request was refused due to rate limiting.

x-request-id


      string
      <uuid>

required

A unique identifier used to trace requests.

The request failed due to an unexpected error.

x-request-id


      string
      <uuid>

required

A unique identifier used to trace requests.

The request failed because a downstream service failed to respond.

x-request-id


      string
      <uuid>

required

A unique identifier used to trace requests.

Headers

x-moov-version


      string

API version

Specify an API version.

API versioning follows the format vYYYY.QQ.BB, where

YYYY is the year
QQ is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10)
BB is the build number, starting at .01, for subsequent builds in the same quarter.
- For example, v2024.01.00 is the initial release of the first quarter of 2024.

The latest version represents the most recent development state. It may include breaking changes and should be treated as a beta release.

Default: v2024.01.00

Path parameters

accountID


      string
      <uuid>

required

Query parameters

planIDs


      array

A comma-separated list of plan IDs to filter the results by.

Response

application/json

billableFees


        array

Additional usage-based fees for this plan.

Show child attributes

billableEvent


        string

A unique code identifying a charge.

billableFeeID


        string<uuid>

feeCategory


        string<enum>

Possible values: ach, card-acquiring, card-other, card-pull, card-push, monthly-platform, network-passthrough, other, rtp

feeConditions


        object

Defines the specific conditions that must be met for the fee to be applied.

feeModel


        string<enum>

Specifies the pricing model used for the calculation of the final fee.

Possible values: fixed, blended, variable

feeName


        string

Specifies the name of the fee that will be billed.

feeProperties


        object

Defines the specific parameters used for fee calculation.

Show child attributes

fixedAmount


              object

A fixed fee that is applied to the amount of each transaction in the fixed and blended fee models.

Show child attributes

currency


        string

required

A 3-letter ISO 4217 currency code.

valueDecimal


        string

required

A decimal-formatted numerical string that represents up to 9 decimal place precision.

For example, $12.987654321 is ‘12.987654321’.

maxPerTransaction


              object

Specifies the maximum allowable spending for a single transaction, working as a transaction ceiling.

Show child attributes

currency


        string

required

A 3-letter ISO 4217 currency code.

valueDecimal


        string

required

A decimal-formatted numerical string that represents up to 9 decimal place precision.

For example, $12.987654321 is ‘12.987654321’.

minPerTransaction


              object

Specifies the minimum allowable spending for a single transaction, working as a transaction floor.

Show child attributes

currency


        string

required

A 3-letter ISO 4217 currency code.

valueDecimal


        string

required

A decimal-formatted numerical string that represents up to 9 decimal place precision.

For example, $12.987654321 is ‘12.987654321’.

variableRate


        string

A percentage fee that is applied to the amount of each transaction in the blended fee model, expressed as a decimal.

For example, 0.05% is ‘0.05’.

cardAcquiringModel


        string<enum>

Specifies the card processing pricing model

Possible values: cost-plus, flat-rate

createdAt


        string<date-time>

description


        string

A description of the fee plan.

minimumCommitment


        object

The minimum spending amount that must be met in the billing period. If actual usage is below the minimum amount, account is charged the difference.

Show child attributes

currency


        string

required

A 3-letter ISO 4217 currency code.

valueDecimal


        string

required

A decimal-formatted numerical string that represents up to 9 decimal place precision.

For example, $12.987654321 is ‘12.987654321’.

monthlyPlatformFee


        object

Fixed recurring amount paid in the billing period regardless of usage.

Show child attributes

currency


        string

required

A 3-letter ISO 4217 currency code.

valueDecimal


        string

required

A decimal-formatted numerical string that represents up to 9 decimal place precision.

For example, $12.987654321 is ‘12.987654321’.

name


        string

The name of the fee plan.

planID


        string<uuid>

200 401 403 429 500 504

The request completed successfully.

[
  {
    "billableFees": [
      {
        "billableEvent": "card-auth-volume",
        "billableFeeID": "9d957d33-1a9a-47aa-9460-fe1a90f003dd",
        "feeCategory": "card-acquiring",
        "feeConditions": {
          "transactionType": [
            "decline"
          ]
        },
        "feeModel": "fixed",
        "feeName": "Card decline fee",
        "feeProperties": {
          "fixedAmount": {
            "currency": "USD",
            "valueDecimal": "0.1"
          }
        }
      }
    ],
    "cardAcquiringModel": "cost-plus",
    "createdAt": "2019-08-24T14:15:22Z",
    "description": "string",
    "minimumCommitment": {
      "currency": "USD",
      "valueDecimal": "12.987654321"
    },
    "monthlyPlatformFee": {
      "currency": "USD",
      "valueDecimal": "12.987654321"
    },
    "name": "Fixed Rate Merchant Plan",
    "planID": "b3e38790-d1c0-4afb-b75c-aa44e99a6877"
  }
]

x-request-id


      string
      <uuid>

required

A unique identifier used to trace requests.

The request contained missing or expired authentication.

x-request-id


      string
      <uuid>

required

A unique identifier used to trace requests.

The user is not authorized to make the request.

x-request-id


      string
      <uuid>

required

A unique identifier used to trace requests.

Request was refused due to rate limiting.

x-request-id


      string
      <uuid>

required

A unique identifier used to trace requests.

The request failed due to an unexpected error.

x-request-id


      string
      <uuid>

required

A unique identifier used to trace requests.

The request failed because a downstream service failed to respond.

x-request-id


      string
      <uuid>

required

A unique identifier used to trace requests.