---
title: "Custom Fields"
description: "Your own fields on our records, defined per business so each book keeps its own vocabulary."
canonical_url: "https://twominutebilling.com/help/developers/api-reference/custom-fields"
---
# Custom Fields

> Your own fields on our records, defined per business so each book keeps its own vocabulary.

Your own fields on our records, defined per business so each book keeps its own vocabulary. A definition sets the label, the type and whether a value is required.

Values filter through the ordinary list grammar as `cf_<api_name>`, e.g. `?cf_plan_tier[is]=gold`, and are resolved per request from that business's definitions — which is why they cannot be listed as fixed query parameters on the list endpoints. Archiving a definition is soft and leaves existing values in place.

## Endpoints

<table>
<thead>
  <tr>
    <th>
      Method
    </th>
    
    <th>
      Endpoint
    </th>
    
    <th>
      Description
    </th>
  </tr>
</thead>

<tbody>
  <tr>
    <td>
      <code>
        GET
      </code>
    </td>
    
    <td>
      <a href="https://twominutebilling.com/help/developers/api-reference/custom-fields/list-custom-field-definitions">
        <code>
          /v1/businesses/{biz}/custom_field_definitions
        </code>
      </a>
    </td>
    
    <td>
      List custom-field definitions
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        POST
      </code>
    </td>
    
    <td>
      <a href="https://twominutebilling.com/help/developers/api-reference/custom-fields/define-a-custom-field">
        <code>
          /v1/businesses/{biz}/custom_field_definitions
        </code>
      </a>
    </td>
    
    <td>
      Define a custom field
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        GET
      </code>
    </td>
    
    <td>
      <a href="https://twominutebilling.com/help/developers/api-reference/custom-fields/get-a-custom-field-definition">
        <code>
          /v1/businesses/{biz}/custom_field_definitions/{id}
        </code>
      </a>
    </td>
    
    <td>
      Get a custom-field definition
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        PATCH
      </code>
    </td>
    
    <td>
      <a href="https://twominutebilling.com/help/developers/api-reference/custom-fields/edit-a-custom-field-definition">
        <code>
          /v1/businesses/{biz}/custom_field_definitions/{id}
        </code>
      </a>
    </td>
    
    <td>
      Edit a custom-field definition
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        DELETE
      </code>
    </td>
    
    <td>
      <a href="https://twominutebilling.com/help/developers/api-reference/custom-fields/archive-a-custom-field-definition">
        <code>
          /v1/businesses/{biz}/custom_field_definitions/{id}
        </code>
      </a>
    </td>
    
    <td>
      Archive a custom-field definition
    </td>
  </tr>
</tbody>
</table>


## Sitemap

See the full [sitemap](https://twominutebilling.com/sitemap.md) for all pages.