Skip to main content
POST
Create a fee product

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string

An idempotency key is an arbitrary unique value generated by client to detect subsequent retries of the same request. It is recommended that a UUID or a similar random identifier be used as an idempotency key. A different key must be used for each request, unless it is a retry.

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

Body

application/json

Fee product to create

name
string
required

Name of the fee product bundle.

Example:

"Premium Checking Fee Schedule"

description
string

Description of the fee product bundle.

Example:

"Fee schedule for premium checking accounts"

status
enum<string>
Available options:
active,
inactive
fee_config_ids
string<uuid>[]

Optional list of existing fee config IDs to associate with this product at creation time.

Example:

Response

Created fee product

creation_time
string<date-time>
required
read-only

Timestamp when the fee product was created.

Example:

"2024-01-15T10:00:00Z"

fee_config_ids
string<uuid>[]
required

IDs of fee configs associated with this product.

Example:
id
string<uuid>
required

Unique identifier for this fee product.

Example:

"7d943c51-e4ff-4e57-9558-08cab6b96312"

last_updated_time
string<date-time>
required
read-only

Timestamp when the fee product was last updated.

Example:

"2024-06-01T12:00:00Z"

tenant
string
required

The id of the tenant containing the resource.

Example:

"abcdef_ghijkl"

name
string
required

Name of the fee product bundle.

Example:

"Premium Checking Fee Schedule"

status
enum<string>
required
Available options:
active,
inactive
description
string

Description of the fee product bundle.

Example:

"Fee schedule for premium checking accounts"