Ask Moov Beta
Generative AI is experimental and can make mistakes.
Guides Dashboard Use cases API Changelog
  1. API reference
  2. Moov accounts
  3. Fee plans

Create fee plan agreement

Creates the subscription of a fee plan to a merchant account. Merchants are required to accept the fee plan terms prior to activation.

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

POST
/accounts/{accountID}/fee-plan-agreements
Java PHP Python TypeScript 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

package hello.world;

import io.moov.sdk.Moov;
import io.moov.sdk.models.components.CreateFeePlanAgreement;
import io.moov.sdk.models.components.Security;
import io.moov.sdk.models.errors.FeePlanAgreementError;
import io.moov.sdk.models.errors.GenericError;
import io.moov.sdk.models.operations.CreateFeePlanAgreementsResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws GenericError, FeePlanAgreementError, Exception {

        Moov sdk = Moov.builder()
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        CreateFeePlanAgreementsResponse res = sdk.feePlans().createFeePlanAgreements()
                .accountID("19962eb8-00cd-44e5-8a66-a1ebaf88c2fe")
                .createFeePlanAgreement(CreateFeePlanAgreement.builder()
                    .planID("b97c2d59-80c5-49ac-b1fc-40e3a81d8daf")
                    .build())
                .call();

        if (res.feePlanAgreement().isPresent()) {
            // handle response
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

declare(strict_types=1);

require 'vendor/autoload.php';

use Moov\MoovPhp;
use Moov\MoovPhp\Models\Components;

$sdk = MoovPhp\Moov::builder()
    ->setSecurity(
        new Components\Security(
            username: '',
            password: '',
        )
    )
    ->build();

$createFeePlanAgreement = new Components\CreateFeePlanAgreement(
    planID: 'b700714f-83b3-45f6-91b3-1f9081d9e23c',
);

$response = $sdk->feePlans->createAgreements(
    accountID: 'a39319c8-13f2-4af4-9f8c-e0ce6779fd54',
    createFeePlanAgreement: $createFeePlanAgreement,
    xMoovVersion: 'v2024.01.00'

);

if ($response->feePlanAgreement !== null) {
    // handle response
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15

from moovio_sdk import Moov
from moovio_sdk.models import components


with Moov(
    security=components.Security(
        username="",
        password="",
    ),
) as moov:

    res = moov.fee_plans.create_fee_plan_agreements(account_id="19962eb8-00cd-44e5-8a66-a1ebaf88c2fe", plan_id="b97c2d59-80c5-49ac-b1fc-40e3a81d8daf")

    # Handle response
    print(res)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22

import { Moov } from "@moovio/sdk";

const moov = new Moov({
  security: {
    username: "",
    password: "",
  },
});

async function run() {
  const result = await moov.feePlans.createFeePlanAgreements({
    accountID: "19962eb8-00cd-44e5-8a66-a1ebaf88c2fe",
    createFeePlanAgreement: {
      planID: "b97c2d59-80c5-49ac-b1fc-40e3a81d8daf",
    },
  });

  // Handle the result
  console.log(result);
}

run();
201 400 401 403 404 409 422 429 500 504
The resource was successfully created.
schema
{
  "properties": {
    "acceptedOn": {
      "format": "date-time",
      "type": "string"
    },
    "accountID": {
      "format": "uuid",
      "type": "string"
    },
    "agreementID": {
      "format": "uuid",
      "type": "string"
    },
    "billableFees": {
      "items": {
        "example": {
          "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"
            }
          }
        },
        "properties": {
          "billableEvent": {
            "description": "A unique code identifying a charge.",
            "type": "string"
          },
          "billableFeeID": {
            "format": "uuid",
            "type": "string"
          },
          "feeCategory": {
            "enum": [
              "ach",
              "card-acquiring",
              "card-other",
              "card-pull",
              "card-push",
              "monthly-platform",
              "network-passthrough",
              "other",
              "rtp"
            ],
            "type": "string"
          },
          "feeConditions": {
            "additionalProperties": {},
            "description": "Defines the specific conditions that must be met for the fee to be applied.",
            "example": {
              "cardBrand": [
                "visa"
              ]
            },
            "type": "object"
          },
          "feeModel": {
            "description": "Specifies the pricing model used for the calculation of the final fee.",
            "enum": [
              "fixed",
              "blended",
              "variable"
            ],
            "type": "string"
          },
          "feeName": {
            "description": "Specifies the name of the fee that will be billed.",
            "type": "string"
          },
          "feeProperties": {
            "description": "Defines the specific parameters used for fee calculation.",
            "example": {
              "fixedAmount": {
                "currency": "USD",
                "valueDecimal": "0.0195"
              },
              "maxPerTransaction": {
                "currency": "USD",
                "valueDecimal": "0.035"
              },
              "minPerTransaction": {
                "currency": "USD",
                "valueDecimal": "0.0195"
              },
              "variableRate": "0.15"
            },
            "properties": {
              "fixedAmount": {
                "allOf": [
                  {
                    "properties": {
                      "currency": {
                        "description": "A 3-letter ISO 4217 currency code.",
                        "example": "USD",
                        "pattern": "^[A-Za-z]{3}$",
                        "type": "string"
                      },
                      "valueDecimal": {
                        "description": "A decimal-formatted numerical string that represents up to 9 decimal place precision. \n\nFor example, $12.987654321 is '12.987654321'.",
                        "example": "12.987654321",
                        "pattern": "^\\d+\\.\\d{1,9}$",
                        "type": "string"
                      }
                    },
                    "required": [
                      "currency",
                      "valueDecimal"
                    ],
                    "type": "object"
                  }
                ],
                "description": "A fixed fee that is applied to the amount of each transaction in the `fixed` and `blended` fee models."
              },
              "maxPerTransaction": {
                "allOf": [
                  {
                    "properties": {
                      "currency": {
                        "description": "A 3-letter ISO 4217 currency code.",
                        "example": "USD",
                        "pattern": "^[A-Za-z]{3}$",
                        "type": "string"
                      },
                      "valueDecimal": {
                        "description": "A decimal-formatted numerical string that represents up to 9 decimal place precision. \n\nFor example, $12.987654321 is '12.987654321'.",
                        "example": "12.987654321",
                        "pattern": "^\\d+\\.\\d{1,9}$",
                        "type": "string"
                      }
                    },
                    "required": [
                      "currency",
                      "valueDecimal"
                    ],
                    "type": "object"
                  }
                ],
                "description": "Specifies the maximum allowable spending for a single transaction, working as a transaction ceiling."
              },
              "minPerTransaction": {
                "allOf": [
                  {
                    "properties": {
                      "currency": {
                        "description": "A 3-letter ISO 4217 currency code.",
                        "example": "USD",
                        "pattern": "^[A-Za-z]{3}$",
                        "type": "string"
                      },
                      "valueDecimal": {
                        "description": "A decimal-formatted numerical string that represents up to 9 decimal place precision. \n\nFor example, $12.987654321 is '12.987654321'.",
                        "example": "12.987654321",
                        "pattern": "^\\d+\\.\\d{1,9}$",
                        "type": "string"
                      }
                    },
                    "required": [
                      "currency",
                      "valueDecimal"
                    ],
                    "type": "object"
                  }
                ],
                "description": "Specifies the minimum allowable spending for a single transaction, working as a transaction floor."
              },
              "variableRate": {
                "description": "A percentage fee that is applied to the amount of each transaction in the `blended` fee model, expressed as a decimal. \n\nFor example, 0.05% is '0.05'.",
                "example": "0.05",
                "pattern": "^[0-9]+.?[0-9]*$",
                "type": "string"
              }
            },
            "type": "object"
          }
        },
        "required": [
          "feeModel",
          "feeCategory"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "cardAcquiringModel": {
      "description": "Specifies the card processing pricing model",
      "enum": [
        "cost-plus",
        "flat-rate"
      ],
      "type": "string"
    },
    "description": {
      "description": "The description of the agreement.",
      "type": "string"
    },
    "minimumCommitment": {
      "allOf": [
        {
          "properties": {
            "currency": {
              "description": "A 3-letter ISO 4217 currency code.",
              "example": "USD",
              "pattern": "^[A-Za-z]{3}$",
              "type": "string"
            },
            "valueDecimal": {
              "description": "A decimal-formatted numerical string that represents up to 9 decimal place precision. \n\nFor example, $12.987654321 is '12.987654321'.",
              "example": "12.987654321",
              "pattern": "^\\d+\\.\\d{1,9}$",
              "type": "string"
            }
          },
          "required": [
            "currency",
            "valueDecimal"
          ],
          "type": "object"
        }
      ],
      "description": "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.",
      "type": "object"
    },
    "monthlyPlatformFee": {
      "allOf": [
        {
          "properties": {
            "currency": {
              "description": "A 3-letter ISO 4217 currency code.",
              "example": "USD",
              "pattern": "^[A-Za-z]{3}$",
              "type": "string"
            },
            "valueDecimal": {
              "description": "A decimal-formatted numerical string that represents up to 9 decimal place precision. \n\nFor example, $12.987654321 is '12.987654321'.",
              "example": "12.987654321",
              "pattern": "^\\d+\\.\\d{1,9}$",
              "type": "string"
            }
          },
          "required": [
            "currency",
            "valueDecimal"
          ],
          "type": "object"
        }
      ],
      "description": "Fixed recurring amount paid in the billing period regardless of usage.",
      "type": "object"
    },
    "name": {
      "description": "The name of the agreement.",
      "type": "string"
    },
    "planID": {
      "format": "uuid",
      "type": "string"
    },
    "status": {
      "enum": [
        "active",
        "terminated"
      ],
      "type": "string"
    }
  },
  "required": [
    "agreementID",
    "planID",
    "name",
    "acceptedOn",
    "status",
    "cardAcquiringModel",
    "billableFees",
    "minimumCommitment",
    "monthlyPlatformFee"
  ],
  "type": "object"
}

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The server could not understand the request due to invalid syntax.
schema
{
  "properties": {
    "error": {
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object"
}

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The request contained missing or expired authentication.

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The user is not authorized to make the request.

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The requested resource was not found.

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The request conflicted with the current state of the target resource.
schema
{
  "properties": {
    "error": {
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object"
}

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The request was well-formed, but the contents failed validation. Check the request for missing or invalid fields.
schema
{
  "properties": {
    "planID": {
      "type": "string"
    }
  },
  "type": "object"
}

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.
Request was refused due to rate limiting.

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The request failed due to an unexpected error.

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The request failed because a downstream service failed to respond.

Response headers

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

Body

application/json

planID

string<uuid> required

Response

application/json

acceptedOn

string<date-time> required

agreementID

string<uuid> required

billableFees

array required
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 Pattern
A 3-letter ISO 4217 currency code.

valueDecimal

string required Pattern

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 Pattern
A 3-letter ISO 4217 currency code.

valueDecimal

string required Pattern

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 Pattern
A 3-letter ISO 4217 currency code.

valueDecimal

string required Pattern

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

For example, $12.987654321 is '12.987654321'.

variableRate

string Pattern

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> required
Specifies the card processing pricing model
Possible values: cost-plus, flat-rate

minimumCommitment

object required
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 Pattern
A 3-letter ISO 4217 currency code.

valueDecimal

string required Pattern

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

For example, $12.987654321 is '12.987654321'.

monthlyPlatformFee

object required
Fixed recurring amount paid in the billing period regardless of usage.
Show child attributes

currency

string required Pattern
A 3-letter ISO 4217 currency code.

valueDecimal

string required Pattern

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

For example, $12.987654321 is '12.987654321'.

name

string required
The name of the agreement.

planID

string<uuid> required

status

string<enum> required
Possible values: active, terminated

accountID

string<uuid>

description

string
The description of the agreement.