---
updatedAt: 2026-04-21T05:36:32.000Z
agentTools:
  projectIndex: https://developer.officernd.com/llms.txt
---

# Update and existing fee

Update and existing fee 

 Required scopes: `flex.community.fees.update`

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "paths": {
    "/api/v2/organizations/{orgSlug}/fees/{feeId}": {
      "put": {
        "description": "Update and existing fee \n\n Required scopes: `flex.community.fees.update`",
        "operationId": "FeesController_updateItem_api/v2",
        "parameters": [
          {
            "name": "shouldUseCoins",
            "required": false,
            "in": "query",
            "description": "Used to determine whether the fee you want to add should use coins valid for one-off fees. \n            In order for this to work the fee you're adding must have a plan selected.",
            "schema": {
              "example": false,
              "type": "boolean"
            }
          },
          {
            "name": "feeId",
            "required": true,
            "in": "path",
            "description": "fee id",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "orgSlug",
            "required": true,
            "in": "path",
            "description": "organization slug",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UpdateFeeDto"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FeeResultDto"
                }
              }
            }
          }
        },
        "security": [
          {
            "oauth2": [
              "flex.community.fees.update"
            ]
          }
        ],
        "summary": "Update and existing fee",
        "tags": [
          "Fees"
        ]
      }
    }
  },
  "info": {
    "title": "Community API",
    "description": "",
    "version": "2.0",
    "contact": {}
  },
  "servers": [
    {
      "url": "https://app.officernd.com"
    }
  ],
  "components": {
    "securitySchemes": {
      "oauth2": {
        "type": "oauth2",
        "flows": {
          "clientCredentials": {
            "tokenUrl": "https://identity.officernd.com/auth/token",
            "scopes": {}
          },
          "authorizationCode": {
            "authorizationUrl": "https://identity.officernd.com/auth/authorize",
            "tokenUrl": "https://identity.officernd.com/auth/token",
            "scopes": {}
          }
        }
      }
    },
    "schemas": {
      "PlanTargetType": {
        "type": "string",
        "enum": [
          "Plan",
          "ResourceRate"
        ],
        "description": "The type of the plan assigned to the fee."
      },
      "FeeStatus": {
        "type": "string",
        "enum": [
          "approved",
          "awaiting_approval"
        ],
        "description": "The status of the fee."
      },
      "FeeCoinResultDto": {
        "type": "object",
        "properties": {
          "_id": {
            "type": "string",
            "description": "The _id of the coin used for the fee.",
            "example": "603dfbc260f4054084125d36"
          },
          "count": {
            "type": "number",
            "description": "The count of the coins used for the fee.",
            "example": 2
          }
        }
      },
      "FeeInvoiceStatus": {
        "type": "string",
        "enum": [
          "not_paid",
          "invoiced",
          "paid",
          "refunded",
          "waived"
        ],
        "description": "The status of the fee in terms of billing."
      },
      "FeePaymentDto": {
        "type": "object",
        "properties": {
          "_id": {
            "type": "string",
            "description": "The _id of the payment associated with the fee. Appears, if a fee has been invoiced",
            "example": "603dfbc260f4054084125d30"
          },
          "status": {
            "description": "The status of the fee in terms of billing.",
            "example": "paid",
            "allOf": [
              {
                "$ref": "#/components/schemas/FeeInvoiceStatus"
              }
            ]
          },
          "creditNote": {
            "type": "string",
            "description": "The _id of the credit note associated with the fee. Appears, if a fee was credited.",
            "example": "603dfbc260f4054084125d30"
          }
        }
      },
      "FeeResultDto": {
        "type": "object",
        "properties": {
          "properties": {
            "type": "object",
            "description": "An object that contains all custom properties that can be applied to the item.",
            "example": {
              "customProperty1": "value1",
              "customProperty2": "value2"
            }
          },
          "_id": {
            "type": "string",
            "description": "The _id of the fee.",
            "example": "603dfbc260f4054084125d30"
          },
          "name": {
            "type": "string",
            "description": "The name of the fee.",
            "example": "Example Fee Name"
          },
          "price": {
            "type": "number",
            "description": "The unit price of the item described by the fee.",
            "example": 20
          },
          "quantity": {
            "type": "number",
            "description": "The quantity described by the one-off charge.",
            "example": 2
          },
          "company": {
            "type": "string",
            "description": "The _id of the company that the fee is associated with.",
            "example": "603dfbc260f4054084125d30"
          },
          "member": {
            "type": "string",
            "description": "The _id of the member that the fee is associated with.",
            "example": "603dfbc260f4054084125d30"
          },
          "location": {
            "type": "string",
            "description": "A reference to the location the fee is issued for.",
            "example": "603dfbc260f4054084125d30"
          },
          "plan": {
            "type": "string",
            "description": "A reference to the price plan assigned to the fee. \n            It is used to determine the sales account when generating an invoice.",
            "example": "603dfbc260f4054084125d30"
          },
          "planType": {
            "description": "The type of the plan assigned to the fee.",
            "example": "Plan",
            "allOf": [
              {
                "$ref": "#/components/schemas/PlanTargetType"
              }
            ]
          },
          "issueDate": {
            "type": "string",
            "description": "The date the fee was issued.",
            "example": "2025-03-03T00:00:00.000Z"
          },
          "status": {
            "description": "The status of the fee.",
            "example": "approved",
            "allOf": [
              {
                "$ref": "#/components/schemas/FeeStatus"
              }
            ]
          },
          "discount": {
            "type": "string",
            "description": "A reference to a discount definition.",
            "example": "603dfbc260f4054084125d33"
          },
          "discountAmount": {
            "type": "number",
            "description": "Manually granted discount for the specific fee.",
            "example": 5
          },
          "calculatedDiscountAmount": {
            "type": "number",
            "description": "The actual discount amount coming from a discount defintion or from a manually granted discount.",
            "example": 5
          },
          "discountedPrice": {
            "type": "number",
            "description": "The final fee unit price after granting the discount.",
            "example": 5
          },
          "isRefundable": {
            "type": "boolean",
            "description": "If true, the one-off charge is counted as deposit and can be refunded later on.",
            "example": true
          },
          "isPersonal": {
            "type": "boolean",
            "description": "If true, the one-off charge is billed to the assigned member and not to the company.",
            "example": true
          },
          "shouldBillInAdvance": {
            "type": "boolean",
            "description": "If true, the one-off charge is billed in advance (respecting its date). \n            By default one-off charges are not billed in advance.",
            "example": true
          },
          "shouldUseCoins": {
            "type": "boolean",
            "description": "In order for a fee to use coins you need to set this to true. \n            By default it's set to false.",
            "example": true
          },
          "coins": {
            "description": "The coins used for the fee.",
            "example": [
              {
                "_id": "594932ea518f3f150d306c89",
                "count": 2
              }
            ],
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/FeeCoinResultDto"
            }
          },
          "payment": {
            "description": "The invoice associated with the fee.",
            "example": {
              "_id": "603dfbc260f4054084125d30",
              "status": "paid",
              "creditNote": "603dfbc260f4054084125d30"
            },
            "allOf": [
              {
                "$ref": "#/components/schemas/FeePaymentDto"
              }
            ]
          },
          "source": {
            "type": "string",
            "description": "The source of the fee.",
            "example": "admin"
          },
          "createdAt": {
            "format": "date-time",
            "type": "string",
            "description": "The date when the fee has been created.",
            "example": "2024-04-12T00:00:00.000Z"
          },
          "createdBy": {
            "type": "string",
            "description": "The user that created the fee.",
            "example": "6080186f490fcf6e0537ec27"
          },
          "modifiedAt": {
            "format": "date-time",
            "type": "string",
            "description": "The user that did the last modification to the fee. If no update is made this field will match the \"createdBy\" field.",
            "example": "2024-05-12T00:00:00.000Z"
          },
          "modifiedBy": {
            "type": "string",
            "description": "The user that last updated the fee.",
            "example": "6080186f490fcf6e0537ec54"
          }
        }
      },
      "UpdateFeeDto": {
        "type": "object",
        "properties": {
          "properties": {
            "type": "object",
            "description": "An object that contains all custom properties that can be applied to the item.",
            "example": {
              "customProperty1": "value1",
              "customProperty2": "value2"
            }
          },
          "price": {
            "type": "number",
            "description": "The updated price of the fee.",
            "example": 20
          },
          "billToMember": {
            "type": "boolean",
            "description": "Alias of isPersonal. If true, the one-off charge is billed to the assigned member.",
            "example": true
          }
        }
      }
    }
  }
}
```