Update a rate card
Update the metadata properties of an existing rate card, including its name, description, and aliases. This endpoint is designed for managing rate card identity and reference aliases rather than modifying pricing rates.
Modifies the descriptive properties and alias configuration of a rate card without affecting the underlying pricing rates or schedules. This allows you to update how a rate card is identified and referenced throughout your system.
Use this endpoint to:
- Rate card renaming: Update display names or descriptions for organizational clarity
- Alias management: Add, modify, or schedule alias transitions for seamless rate card migrations
- Documentation updates: Keep rate card descriptions current with business context
- Self-serve provisioning setup: Configure aliases to enable code-free rate card transitions
Active contract impact:
- Alias changes: Already-created contracts continue using their originally assigned rate cards.
- Other changes made using this endpoint will only impact the Metronome UI.
Grandfathering existing PLG customer pricing:
- Rate card aliases support scheduled transitions, enabling seamless rate card migrations for new customers, allowing existing customers to be grandfathered into their existing prices without code. Note that there are multiple mechanisms to support grandfathering in Metronome.
How scheduled aliases work for PLG grandfathering:
Initial setup:
- Add alias to current rate card: Assign a stable alias (e.g., “standard-pricing”) to your active rate card
- Reference alias during contract creation: Configure your self-serve workflow to create contracts using
rate_card_aliasinstead of directrate_card_id - Automatic resolution: New contracts referencing the alias automatically resolve to the rate card associated with the alias at the point in time of provisioning
Grandfathering process:
- Create new rate card: Build your new rate card with updated pricing structure
- Schedule alias transition: Add the same alias to the new rate card with a
starting_attimestamp - Automatic cutover: Starting at the scheduled time, new contracts created in your PLG workflow using that alias will automatically reference the new rate card
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
Update a rate card. Must provide at least one of name or description.
ID of the rate card to update
Used only in UI/API. It is not exposed to end customers.
Reference this alias when creating a contract. If the same alias is assigned to multiple rate cards, it will reference the rate card to which it was most recently assigned. It is not exposed to end customers.
Response
Success