Update a rate card

curl --request POST \
  --url https://api.metronome.com/v1/contract-pricing/rate-cards/update \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "rate_card_id": "d7abd0cd-4ae9-4db7-8676-e986a4ebd8dc",
  "name": "My Updated Rate Card",
  "description": "My Updated Rate Card Description"
}
'

import requests

url = "https://api.metronome.com/v1/contract-pricing/rate-cards/update"

payload = {
    "rate_card_id": "d7abd0cd-4ae9-4db7-8676-e986a4ebd8dc",
    "name": "My Updated Rate Card",
    "description": "My Updated Rate Card Description"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    rate_card_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
    name: 'My Updated Rate Card',
    description: 'My Updated Rate Card Description'
  })
};

fetch('https://api.metronome.com/v1/contract-pricing/rate-cards/update', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.metronome.com/v1/contract-pricing/rate-cards/update",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'rate_card_id' => 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
    'name' => 'My Updated Rate Card',
    'description' => 'My Updated Rate Card Description'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.metronome.com/v1/contract-pricing/rate-cards/update"

	payload := strings.NewReader("{\n  \"rate_card_id\": \"d7abd0cd-4ae9-4db7-8676-e986a4ebd8dc\",\n  \"name\": \"My Updated Rate Card\",\n  \"description\": \"My Updated Rate Card Description\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.metronome.com/v1/contract-pricing/rate-cards/update")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"rate_card_id\": \"d7abd0cd-4ae9-4db7-8676-e986a4ebd8dc\",\n  \"name\": \"My Updated Rate Card\",\n  \"description\": \"My Updated Rate Card Description\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.metronome.com/v1/contract-pricing/rate-cards/update")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"rate_card_id\": \"d7abd0cd-4ae9-4db7-8676-e986a4ebd8dc\",\n  \"name\": \"My Updated Rate Card\",\n  \"description\": \"My Updated Rate Card Description\"\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "d7abd0cd-4ae9-4db7-8676-e986a4ebd8dc"
  }
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

Rate cards

Update a rate card

Update a rate card’s name, description, aliases, and credit type conversion rates. This endpoint does not affect underlying pricing rates or schedules.

Use this endpoint to:

Rename rate cards: Update display names or descriptions for organizational clarity
Manage aliases: Add, modify, or schedule alias transitions for seamless and code-free rate card migrations
Update documentation: Keep rate card descriptions current with business context
Configure custom pricing units: Add credit type conversions to enable rates with different pricing units

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_alias instead of direct rate_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_at timestamp
Automatic cutover: Starting at the scheduled time, new contracts created in your PLG workflow using that alias will automatically reference the new rate card

POST

contract-pricing

rate-cards

update

Update a rate card

curl --request POST \
  --url https://api.metronome.com/v1/contract-pricing/rate-cards/update \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "rate_card_id": "d7abd0cd-4ae9-4db7-8676-e986a4ebd8dc",
  "name": "My Updated Rate Card",
  "description": "My Updated Rate Card Description"
}
'

import requests

url = "https://api.metronome.com/v1/contract-pricing/rate-cards/update"

payload = {
    "rate_card_id": "d7abd0cd-4ae9-4db7-8676-e986a4ebd8dc",
    "name": "My Updated Rate Card",
    "description": "My Updated Rate Card Description"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    rate_card_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
    name: 'My Updated Rate Card',
    description: 'My Updated Rate Card Description'
  })
};

fetch('https://api.metronome.com/v1/contract-pricing/rate-cards/update', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.metronome.com/v1/contract-pricing/rate-cards/update",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'rate_card_id' => 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
    'name' => 'My Updated Rate Card',
    'description' => 'My Updated Rate Card Description'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.metronome.com/v1/contract-pricing/rate-cards/update"

	payload := strings.NewReader("{\n  \"rate_card_id\": \"d7abd0cd-4ae9-4db7-8676-e986a4ebd8dc\",\n  \"name\": \"My Updated Rate Card\",\n  \"description\": \"My Updated Rate Card Description\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.metronome.com/v1/contract-pricing/rate-cards/update")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"rate_card_id\": \"d7abd0cd-4ae9-4db7-8676-e986a4ebd8dc\",\n  \"name\": \"My Updated Rate Card\",\n  \"description\": \"My Updated Rate Card Description\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.metronome.com/v1/contract-pricing/rate-cards/update")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"rate_card_id\": \"d7abd0cd-4ae9-4db7-8676-e986a4ebd8dc\",\n  \"name\": \"My Updated Rate Card\",\n  \"description\": \"My Updated Rate Card Description\"\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "d7abd0cd-4ae9-4db7-8676-e986a4ebd8dc"
  }
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

Authorizations

Authorization

string

header

required

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

Body

application/json

Update a rate card. Must provide at least one of name, description, aliases, or addCreditTypeConversions.

rate_card_id

string<uuid>

required

ID of the rate card to update

name

string

Used only in UI/API. It is not exposed to end customers.

description

string

aliases

object[]

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.

Show child attributes

add_credit_type_conversions

object[]

Add credit type conversions for using custom pricing units in rates. Existing conversions cannot be modified.

Show child attributes

Response

Success

data

object

required

Show child attributes

⌘I

GET STARTED

ESSENTIALS

ENDPOINTS

Update a rate card

Use this endpoint to:

Active contract impact:

Grandfathering existing PLG customer pricing:

How scheduled aliases work for PLG grandfathering:

Grandfathering process:

Authorizations

Body

Response