GETpartial

Quote the current filing fee using exact USD minor units

Quote the current filing fee using exact USD minor units.

/api/fees/quotesquoteFilingFeeCanonical

Authentication and authority

No bearer credential is required.

Parameters

NameLocationRequirementSchema
currency

Required when the compatibility header is absent.

queryOptional{"type":"string","enum":["USD"]}
minorUnits

Required when the compatibility header is absent.

queryOptional{"type":"string","pattern":"^(0|[1-9][0-9]{0,77})$"}
declaratoryOnlyqueryOptional{"type":"boolean","default":false}
x-pc-compatibility

Bounded compatibility inputs on the canonical URL. Existing scoped credentials retain v1 responses; role-bound credentials use grant-checked typed operations. Preserves each contract’s original journals, consent and disclosure. See /openapi/partner-v1.json for scoped credentials.

headerOptional{"type":"string","enum":["v1"]}
amount

USD amount, required only with x-pc-compatibility: v1.

queryOptional{"type":"number","minimum":0}

Responses

200

Authorized operation result.

application/json

{
  "$ref": "#/components/schemas/CanonicalQuoteFilingFeeCanonicalResponse",
  "type": "object",
  "required": [
    "data",
    "requestId"
  ],
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "claimAmount": {
          "$ref": "#/components/schemas/FiatMoney",
          "type": "object",
          "additionalProperties": false,
          "required": [
            "currency",
            "minorUnits"
          ],
          "properties": {
            "currency": {
              "type": "string",
              "const": "USD"
            },
            "minorUnits": {
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,77})$"
            }
          }
        },
        "declaratoryOnly": {
          "type": "boolean"
        },
        "collectionMode": {
          "type": "string"
        },
        "tier": {
          "type": "string"
        },
        "rateBasisPoints": {
          "type": "string"
        },
        "percentComponent": {
          "$ref": "#/components/schemas/FiatMoney",
          "type": "object",
          "additionalProperties": false,
          "required": [
            "currency",
            "minorUnits"
          ],
          "properties": {
            "currency": {
              "type": "string",
              "const": "USD"
            },
            "minorUnits": {
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,77})$"
            }
          }
        },
        "floor": {
          "$ref": "#/components/schemas/FiatMoney",
          "type": "object",
          "additionalProperties": false,
          "required": [
            "currency",
            "minorUnits"
          ],
          "properties": {
            "currency": {
              "type": "string",
              "const": "USD"
            },
            "minorUnits": {
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,77})$"
            }
          }
        },
        "baseFee": {
          "$ref": "#/components/schemas/FiatMoney",
          "type": "object",
          "additionalProperties": false,
          "required": [
            "currency",
            "minorUnits"
          ],
          "properties": {
            "currency": {
              "type": "string",
              "const": "USD"
            },
            "minorUnits": {
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,77})$"
            }
          }
        },
        "panelSurchargeRateBasisPoints": {
          "type": "string"
        },
        "panelSurcharge": {
          "$ref": "#/components/schemas/FiatMoney",
          "type": "object",
          "additionalProperties": false,
          "required": [
            "currency",
            "minorUnits"
          ],
          "properties": {
            "currency": {
              "type": "string",
              "const": "USD"
            },
            "minorUnits": {
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,77})$"
            }
          }
        },
        "forumFee": {
          "$ref": "#/components/schemas/FiatMoney",
          "type": "object",
          "additionalProperties": false,
          "required": [
            "currency",
            "minorUnits"
          ],
          "properties": {
            "currency": {
              "type": "string",
              "const": "USD"
            },
            "minorUnits": {
              "type": "string",
              "pattern": "^(0|[1-9][0-9]{0,77})$"
            }
          }
        },
        "waived": {
          "type": "boolean"
        }
      },
      "required": [
        "claimAmount",
        "collectionMode",
        "tier",
        "rateBasisPoints",
        "percentComponent",
        "floor",
        "baseFee",
        "panelSurchargeRateBasisPoints",
        "panelSurcharge",
        "forumFee",
        "waived"
      ]
    },
    "requestId": {
      "type": "string"
    }
  },
  "x-code-source": "app/api/v2/fees/quote/route.ts"
}
default

RFC 9457 style problem response.

application/problem+json

{
  "$ref": "#/components/schemas/Problem",
  "type": "object",
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "requestId"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer"
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "requestId": {
      "type": "string"
    }
  }
}

Example response

Successful response

{
  "data": {
    "claimAmount": {
      "currency": "USD",
      "minorUnits": "12500"
    },
    "collectionMode": "collectionMode_test",
    "tier": "tier_test",
    "rateBasisPoints": "rateBasisPoints_test",
    "percentComponent": {
      "currency": "USD",
      "minorUnits": "12500"
    },
    "floor": {
      "currency": "USD",
      "minorUnits": "12500"
    },
    "baseFee": {
      "currency": "USD",
      "minorUnits": "12500"
    },
    "panelSurchargeRateBasisPoints": "panelSurchargeRateBasisPoints_test",
    "panelSurcharge": {
      "currency": "USD",
      "minorUnits": "12500"
    },
    "forumFee": {
      "currency": "USD",
      "minorUnits": "12500"
    },
    "waived": false
  },
  "requestId": "requestId_test"
}

Errors

Read the response status and stable error code. See errors and rate limits for recovery. Refresh the resource before resolving a state or digest conflict.

Idempotency and retries

  • For throttling, honor Retry-After when present. Back off on retryable server failures.