API ReferencePricing Groups

Create Pricing Group

Create a new pricing group with rate tiers. Pricing groups allow institutions to manage interest rates at scale by defining reusable rate structures that can be assigned to multiple accounts. When a pricing group's rates are updated, all assigned accounts receive the new rates automatically.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
namestringRequired<=128 characters

Name of the pricing group (e.g., ‘Retail Checking’, ‘Accounts 2025’)

interest_rate_tierslist of objectsRequired
Rate tiers for the pricing group. At least one tier is required.
descriptionstring or nullOptional<=256 characters
Optional description providing additional context about this pricing group
effective_atstringOptionalformat: "date-time"
When these rates become effective. Defaults to now if not provided.
account_idslist of strings or nullOptional
Optional list of account IDs to assign to this pricing group upon creation. If provided, the pricing group rates will be applied to these accounts immediately.
submitted_bystring or nullOptional<=128 characters

Response

Successful Response
idstring
institution_idstring
namestring
descriptionstring or null
account_countinteger
Number of accounts currently assigned to this pricing group
interest_rate_tierslist of objects
created_atstring
updated_atstring
accountslist of objects
List of accounts assigned to this pricing group

Errors