---
title: "Pull All Fee Schedules"
method: POST
path: "/v4/fee_schedules/search"
tags: ["Gateway Features", "Fee Schedule"]
---

# Pull All Fee Schedules

`POST /v4/fee_schedules/search`

## Request

- Base URL: `https://sandbox.nmi.com/api`
- URL: `https://sandbox.nmi.com/api/v4/fee_schedules/search`
- Auth: none required

<details>
<summary>Usage</summary>
This request will pull all fee schedules available on your account. 
</details>

## Headers

- `Content-Type` string, required
- `Authorization` string, required

## Request body

- PullAllFeeSchedulesRequest
  - `maxResults` string, required: Required. Value must be between 1-1000.
  - `includeCustomFeeSchedules` true | false: Determines whether to include custom fee schedules.
  - `parentAffiliateId` string: The ID of the affiliate directly above the merchant. Note: You can pass in parentAffiliateId to narrow down fee schedules to a specific affiliate's fee schedules. If parentAffiliateId is not specified, all fee schedules in the affiliate tree will be loaded.

## Response `200`

Success

- PullAllFeeSchedulesResponse
  - `objectType` string: The type of object that was returned as a result of the request.
  - `offset` number: The first N skipped results.
  - `maxResults` number: The max number results.
  - `totalResults` number: The total number of results.
  - `hasMore` boolean: If are there more results for the search.
  - `results` object[]: Results for the search.
    - `objectType` string: Type of the returned response object
    - `id` string: The ID for the row. You'll want the id value to assign to a merchant.
    - `name` string: The name of the fee schedule.
    - `costPlan` string: The numeric value associated with the cost plan.
    - `currency` string: Currency
    - `merchants` string[]: The merchants associated with the cost plan.
    - `affiliates` string[]: The affiliates associated with the cost plan.
    - `isDefault` string: Determination of whether or not the cost plan is default.
    - `isCustom` string: Determination of whether or not the cost plan is custom.

---

[API](https://skmtc.dev/nmi/apis/payments-api.md) - [All operations](https://skmtc.dev/nmi/apis/payments-api/llms.txt) - [OpenAPI document](https://skmtc.dev/nmi/apis/payments-api/revisions/c03727f27e27?raw)
