For the complete documentation index, see llms.txt. This page is also available as Markdown.

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

Currency of the claimed amount.

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

Claimed USD cents from 0 through 900719925474 inclusive. Larger values are rejected with 422 validation_failed.

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

The requested track; omission uses the standard track with appeal retained.

queryOptional{"type":"string","enum":["ai_fast","ai_standard","ai_assisted_human"],"default":"ai_standard","example":"ai_standard"}

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"
        },
        "caseTrack": {
          "type": "string",
          "enum": [
            "ai_fast",
            "ai_standard",
            "ai_assisted_human"
          ]
        },
        "fixedComponent": {
          "$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})$"
            }
          }
        }
      },
      "required": [
        "claimAmount",
        "collectionMode",
        "tier",
        "rateBasisPoints",
        "percentComponent",
        "floor",
        "baseFee",
        "panelSurchargeRateBasisPoints",
        "panelSurcharge",
        "forumFee",
        "waived"
      ]
    },
    "requestId": {
      "type": "string"
    }
  }
}
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"
    },
    "details": {
      "description": "Account-readiness refusals include a value-free checklist and exact account-page link. Other error codes may provide different details.",
      "anyOf": [
        {
          "$ref": "#/components/schemas/AccountReadinessDetails",
          "type": "object",
          "additionalProperties": false,
          "required": [
            "ready",
            "accountSetupUrl",
            "missing"
          ],
          "properties": {
            "ready": {
              "type": "boolean"
            },
            "accountSetupUrl": {
              "type": "string",
              "format": "uri"
            },
            "missing": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/AccountReadinessRequirement",
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "label",
                  "section",
                  "accountUrl"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "label": {
                    "type": "string"
                  },
                  "section": {
                    "type": "string",
                    "enum": [
                      "email",
                      "identity",
                      "legal_documents"
                    ]
                  },
                  "accountUrl": {
                    "type": "string",
                    "format": "uri"
                  }
                }
              }
            }
          }
        },
        {
          "$ref": "#/components/schemas/LegalDocumentsRequiredDetails",
          "type": "object",
          "additionalProperties": false,
          "required": [
            "legalDocumentsUrl"
          ],
          "properties": {
            "legalDocumentsUrl": {
              "type": "string",
              "format": "uri",
              "description": "Absolute account-page URL where the person reviews and accepts the current Terms and Privacy Notice. Uses the configured public application origin. After accepting the documents, retry the original operation."
            },
            "ready": {
              "type": "boolean"
            },
            "accountSetupUrl": {
              "type": "string",
              "format": "uri"
            },
            "missing": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/AccountReadinessRequirement",
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "label",
                  "section",
                  "accountUrl"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "label": {
                    "type": "string"
                  },
                  "section": {
                    "type": "string",
                    "enum": [
                      "email",
                      "identity",
                      "legal_documents"
                    ]
                  },
                  "accountUrl": {
                    "type": "string",
                    "format": "uri"
                  }
                }
              }
            }
          }
        },
        {}
      ]
    }
  }
}

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.