Cancel a filing

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.getpalm.com/v1/filing/{filing_id}/cancellation', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.getpalm.com/v1/filing/{filing_id}/cancellation"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "object": "filing",
  "mode": "live",
  "created_at": "2025-10-24T10:30:00Z",
  "updated_at": "2025-10-24T15:45:00Z",
  "metadata": {
    "external_id": "user_123_in_my_system",
    "customer_tier": "premium",
    "signup_source": "mobile_app"
  },
  "type": "formation",
  "status": "queued",
  "entity_type": "llc",
  "jurisdiction": "US-NC",
  "legal_name": "Acme Holdings LLC",
  "name": "Acme Holdings LLC",
  "expedited_tier": "same_day",
  "note": "The member holds name reservation 2026-123456 for this name.",
  "business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "result": {
    "registration_number": "NC-12345678",
    "formation_date": "2026-06-23"
  },
  "parent_filing_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "related_items": [
    {
      "object": "filing",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "formation",
      "status": "queued"
    }
  ],
  "documents": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "object": "document",
      "types": [
        "receipt",
        "filing_confirmation"
      ],
      "type": "articles_of_organization",
      "uploaded_at": "2023-11-07T05:31:56Z"
    }
  ],
  "fee": {
    "total": {
      "amount": 125,
      "currency": "USD"
    },
    "base": {
      "amount": 125,
      "currency": "USD"
    },
    "dynamic": {
      "amount": 125,
      "currency": "USD"
    },
    "late": {
      "amount": 125,
      "currency": "USD"
    },
    "credit_card": {
      "amount": 125,
      "currency": "USD"
    },
    "ach": {
      "amount": 125,
      "currency": "USD"
    },
    "items": [
      {
        "component_type": "dynamic",
        "name": "franchise_tax",
        "amount": 500,
        "currency": "USD"
      }
    ]
  },
  "status_reason": "<string>",
  "canceled_by": "<string>",
  "canceled_at": "2023-11-07T05:31:56Z",
  "cases": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "object": "case",
      "mode": "live",
      "created_at": "2025-10-24T10:30:00Z",
      "updated_at": "2025-10-24T15:45:00Z",
      "metadata": {
        "external_id": "user_123_in_my_system",
        "customer_tier": "premium",
        "signup_source": "mobile_app"
      },
      "parent_type": "filing",
      "parent_id": "4b2d9e17-8c35-4a6b-9f02-1e7d5a3c8b96",
      "kind": "missing_information",
      "status": "needs_response",
      "summary": "Additional information needed to complete your filing.",
      "opened_at": "2023-11-07T05:31:56Z",
      "details": "<string>",
      "request": {
        "fields": [
          {
            "name": "legal_name",
            "type": "string",
            "description": "Corrected legal name (state rejected \"Acme LLC\" — name already taken).",
            "required": true,
            "example": "Acme Holdings LLC",
            "document_types": [
              "other"
            ]
          }
        ],
        "documents": [
          "906f369f-a73b-46a2-8184-ccc5c2848abd"
        ]
      },
      "response": {
        "fields": {
          "legal_name": "Acme Holdings LLC",
          "signed_consent_letter": "906f369f-a73b-46a2-8184-ccc5c2848abd"
        },
        "documents": [
          "906f369f-a73b-46a2-8184-ccc5c2848abd"
        ]
      },
      "due_at": "2023-11-07T05:31:56Z",
      "resolved_at": "2023-11-07T05:31:56Z",
      "resolution_reason": "response_received"
    }
  ]
}

Filing

Cancel a filing

⚠️ Early access — This endpoint is in preview and may change in backwards-incompatible ways before it is marked stable. Avoid depending on it in production, and reach out before building on it.

Cancel a filing before processing begins.

When it succeeds. The filing must still be in a pre-processing status (queued or ready_to_file). It moves to the terminal canceled status, a filing.canceled webhook fires, and the response returns the filing with canceled_at and status_reason set.

When it fails. Once the filing has entered processing (or finished), cancellation returns a 409 filing_not_cancellable problem whose current_status member carries the filing status the decision was made against. There is no dry-run check — call cancel and read the response. A rejected attempt on an in-progress filing is still surfaced to the operations team working it, so they know you asked before anything is finalized with the state.

Related filings. Each filing is evaluated on its own status. Canceling a formation that is still pre-processing also cancels its pre-processing related filings (an EIN cannot exist without the entity); each canceled filing sends its own filing.canceled webhook. A pending Palm registered agent on the formation is canceled with it: its status moves to canceled and a registered_agent.canceled webhook fires. The reverse never applies: a related EIN filing can be canceled independently — including after its formation has completed — without touching the formation.

Fees. Cancellation has no billing side effects. Palm fees are only charged on completion, and government fees ride on the filing that incurred them.

POST

filing

{filing_id}

cancellation

Cancel a filing

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.getpalm.com/v1/filing/{filing_id}/cancellation', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.getpalm.com/v1/filing/{filing_id}/cancellation"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "object": "filing",
  "mode": "live",
  "created_at": "2025-10-24T10:30:00Z",
  "updated_at": "2025-10-24T15:45:00Z",
  "metadata": {
    "external_id": "user_123_in_my_system",
    "customer_tier": "premium",
    "signup_source": "mobile_app"
  },
  "type": "formation",
  "status": "queued",
  "entity_type": "llc",
  "jurisdiction": "US-NC",
  "legal_name": "Acme Holdings LLC",
  "name": "Acme Holdings LLC",
  "expedited_tier": "same_day",
  "note": "The member holds name reservation 2026-123456 for this name.",
  "business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "result": {
    "registration_number": "NC-12345678",
    "formation_date": "2026-06-23"
  },
  "parent_filing_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "related_items": [
    {
      "object": "filing",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "formation",
      "status": "queued"
    }
  ],
  "documents": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "object": "document",
      "types": [
        "receipt",
        "filing_confirmation"
      ],
      "type": "articles_of_organization",
      "uploaded_at": "2023-11-07T05:31:56Z"
    }
  ],
  "fee": {
    "total": {
      "amount": 125,
      "currency": "USD"
    },
    "base": {
      "amount": 125,
      "currency": "USD"
    },
    "dynamic": {
      "amount": 125,
      "currency": "USD"
    },
    "late": {
      "amount": 125,
      "currency": "USD"
    },
    "credit_card": {
      "amount": 125,
      "currency": "USD"
    },
    "ach": {
      "amount": 125,
      "currency": "USD"
    },
    "items": [
      {
        "component_type": "dynamic",
        "name": "franchise_tax",
        "amount": 500,
        "currency": "USD"
      }
    ]
  },
  "status_reason": "<string>",
  "canceled_by": "<string>",
  "canceled_at": "2023-11-07T05:31:56Z",
  "cases": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "object": "case",
      "mode": "live",
      "created_at": "2025-10-24T10:30:00Z",
      "updated_at": "2025-10-24T15:45:00Z",
      "metadata": {
        "external_id": "user_123_in_my_system",
        "customer_tier": "premium",
        "signup_source": "mobile_app"
      },
      "parent_type": "filing",
      "parent_id": "4b2d9e17-8c35-4a6b-9f02-1e7d5a3c8b96",
      "kind": "missing_information",
      "status": "needs_response",
      "summary": "Additional information needed to complete your filing.",
      "opened_at": "2023-11-07T05:31:56Z",
      "details": "<string>",
      "request": {
        "fields": [
          {
            "name": "legal_name",
            "type": "string",
            "description": "Corrected legal name (state rejected \"Acme LLC\" — name already taken).",
            "required": true,
            "example": "Acme Holdings LLC",
            "document_types": [
              "other"
            ]
          }
        ],
        "documents": [
          "906f369f-a73b-46a2-8184-ccc5c2848abd"
        ]
      },
      "response": {
        "fields": {
          "legal_name": "Acme Holdings LLC",
          "signed_consent_letter": "906f369f-a73b-46a2-8184-ccc5c2848abd"
        },
        "documents": [
          "906f369f-a73b-46a2-8184-ccc5c2848abd"
        ]
      },
      "due_at": "2023-11-07T05:31:56Z",
      "resolved_at": "2023-11-07T05:31:56Z",
      "resolution_reason": "response_received"
    }
  ]
}

Authorizations

Authorization

string

header

required

Enter your API key in the format: sk_test_xxxxx or sk_live_xxxxx

Path Parameters

filing_id

string<uuid>

required

Filing ID

Example:

"4b2d9e17-8c35-4a6b-9f02-1e7d5a3c8b96"

Response

Filing canceled

string<uuid>

required

Unique identifier for the resource

Example:

"123e4567-e89b-12d3-a456-426614174000"

object

enum<string>

required

Object type

Available options:

filing

Example:

"filing"

mode

enum<string>

required

Whether this resource was created with test or live credentials. Test and live data are fully isolated — a test resource never appears in live results and vice versa.

Available options:

test,

live

Example:

"live"

created_at

string<date-time>

required

ISO 8601 timestamp of when the resource was created

Example:

"2025-10-24T10:30:00Z"

updated_at

string<date-time>

required

ISO 8601 timestamp of when the resource was last updated

Example:

"2025-10-24T15:45:00Z"

metadata

object

required

Store up to 50 custom key-value pairs for application-specific data. Useful for storing references to external systems, feature flags, or other custom attributes.

Show child attributes

Example:

{
  "external_id": "user_123_in_my_system",
  "customer_tier": "premium",
  "signup_source": "mobile_app"
}

type

enum<string>

required

Filing type

Available options:

formation,

ein,

amendment,

scorp_election,

foreign_qualification

status

enum<string>

required

Current status

Available options:

queued,

ready_to_file,

processing,

filed,

completed,

canceled

entity_type

enum<string>

Entity type. Set on formations and foreign qualifications (derived from the referenced business).

Available options:

llc,

professional_llc,

corporation,

professional_corporation

jurisdiction

string

Jurisdiction the filing is made in (ISO 3166-2). For a foreign qualification this is the target state.

Example:

"US-NC"

legal_name

string

Business name the filing is being made under, as sent on the request. For a foreign qualification, the legal name being registered. Changes when a legal_name_change case resolves.

Example:

"Acme Holdings LLC"

name

string

deprecated

Deprecated: use legal_name. The same value.

Example:

"Acme Holdings LLC"

expedited_tier

string

Expedited processing tier requested for this filing, or null for standard processing. Only set on filings submitted with an expedited_tier.

Example:

"same_day"

note

string | null

Context the partner sent for Palm operations when creating this filing, or null when none was sent.

Example:

"The member holds name reservation 2026-123456 for this name."

business_id

string<uuid>

Linked business ID. For a foreign qualification this is the new business record created for the target-state registration, whose formation_jurisdiction and registration_jurisdiction say where the entity was formed and where it is registered.

result

object

Filing result — populated on completion, null until then. Shape depends on the filing type: formation → { registration_number, formation_date }; foreign qualification → { registration_number, registration_date, palm_id }; EIN → { ein_number, legal_name }. Other filing types have no result.

Option 1
Option 2
Option 3

Show child attributes

parent_filing_id

string<uuid>

Parent filing ID (for bundled EIN/RA)

Bundle of obligations tracked under this filing, each with its own object type and status: filings (state registration, EIN) and the registered agent (id is the business, resolvable at GET /business/:id/registered-agent).

Option 1
Option 2

Show child attributes

documents

object[]

Documents associated with this filing

Show child attributes

fee

object | null

Fee components keyed by type (base, dynamic, late, credit_card, ach), plus a convenience total grand total (assumes credit-card payment). Only present components are included. When items is set, it lists each evaluated rule for itemized rendering — the component-keyed values are the sums across those items.

Show child attributes

status_reason

string

Reason the filing was canceled (partner request, parent off-boarded, duplicate, etc.). Only present when status is canceled.

canceled_by

string

Role that initiated the cancellation. One of: partner, palm. Only present when status is canceled.

canceled_at

string<date-time>

Timestamp the filing was canceled

cases

object[]

Cases attached to this filing. One entry per partner-visible case, in chronological order. Each case carries a typed request payload describing what Palm needs and, once submitted, a typed response. Partners respond via POST /v1/case/:case_id/response. An entry with status=needs_response is an outstanding ask — its presence is the signal that the filing needs partner action.

Show child attributes

Palm Introduction

API Introduction

Endpoints

Cancel a filing

Authorizations

Path Parameters

Response