Class Manager
POST /v1/registration-fees/

Create Registration Fee

application/json

Body

Request for creating or updating a Registration Fee

  • name string Required

    Name

  • amount integer Required

    Amount

  • maxAmountPerFamily integer | null Required

    Maximum amount per family

  • repetitionInterval string Required

    Values are one-off, annual, or per-season.

  • dueDate string(date) | null

    Due date

  • proRated boolean Required

    Pro rated

  • taxRateId string | null Required

    Tax rate ID

Responses

  • 200 application/json

    successful operation

    Hide response attributes Show response attributes object
    • id string Required

      Registration fee ID

    • name string Required

      Name

    • amount integer Required

      Amount

    • maxAmountPerFamily integer | null Required

      Max Amount Per Family

    • repetitionInterval string Required

      Values are one-off, annual, or per-season.

    • dueDate string(date) | null Required

      Due Date

    • proRated boolean

      Whether the registration fee can be pro-rated

    • taxRate object Required

      Tax Rate schema

      Hide taxRate attributes Show taxRate attributes object
      • id string Required

        id

      • rate number(float) Required

        Tax Rate (percent) with 3 decimal places

      • label string Required

        Label

      • isDefault boolean Required

        Is Default

    • archivedAt string(date-time) | null Required

      Archived At
  • 403 application/json

    Not authorized

    Hide response attributes Show response attributes object

    Error schema

    • statusCode number Required

      Status Code

    • messages array[string] Required

      List of error messages

    • exception object

      Exception
  • 422 application/json

    Validation error

    Hide response attributes Show response attributes object
    • statusCode number Required

      Status Code

    • messages array[string] Required

      List of error messages

    • exception object

      Exception
POST /v1/registration-fees/ 
curl \
 --request POST 'https://localhost/v1/registration-fees/' \
 --header "Content-Type: application/json" \
 --data '{"name":"My Registration Fee","amount":100,"maxAmountPerFamily":100,"repetitionInterval":"one-off","dueDate":"2023-12-05","proRated":false,"taxRateId":"tax_xxxxxxxxxxxxxxxxxxxxxxxxxx"}'
Request examples 
{
  "name": "My Registration Fee",
  "amount": 100,
  "maxAmountPerFamily": 100,
  "repetitionInterval": "one-off",
  "dueDate": "2023-12-05",
  "proRated": false,
  "taxRateId": "tax_xxxxxxxxxxxxxxxxxxxxxxxxxx"
}
Response examples (200) 
{
  "id": "reg_xxxxxxxxxxxxxxxxxxxxxxxxxx",
  "name": "Registration Fee",
  "amount": 100,
  "maxAmountPerFamily": 100,
  "repetitionInterval": "one-off",
  "dueDate": "2023-12-05",
  "proRated": true,
  "taxRate": {
    "id": "tax_xxxxxxxxxxxxxxxxxxxxxxxxxx",
    "rate": "20.000",
    "label": "VAT (20%)",
    "isDefault": true
  },
  "archivedAt": "2024-06-12T09:39:49.000000Z"
}
Response examples (403) 
{
  "statusCode": 42.0,
  "messages": [
    "string"
  ],
  "exception": {}
}
Response examples (422) 
{
  "statusCode": 42.0,
  "messages": [
    "string"
  ],
  "exception": {}
}