Update a Pricing Tier

Update a pricing tier given their pricingTierId.

caution

This endpoint has been deprecated and will be phased out at the end of 2023. Please update any existing usages of it to use the Update Object endpoint instead.

Endpoint

PUT /v1/pricing-tiers/:pricingTierId

Parameters

Parameter	Description	Type	Required
pricingTierId	The id of the pricing tier to update. Note that id cannot be changed.	URL param	yes
name	An optional, display-friendly name for the pricing tier.	JSON body	no
description	An optional description of the pricing tier. A useful description might include a summary of the functionality the pricing tier grants.	JSON body	no

Note: Optional fields that are omitted will clear existing values.

Request

cURL

curl "https://api.warrant.dev/v1/pricing-tiers/growth" \
    -X PUT \
    -H "Authorization: ApiKey YOUR_KEY" \
    --data-raw \
    '{ "name": "Growth Tier", description: "Grants a tenant access to all Growth plan features" }'

Go

updatedPricingTier, err := pricingtier.Update("growth", &pricingtier.PricingTierParams{
  Meta: map[string]interface{}{
    "name": "Growth Tier",
    "description": "Grants a tenant access to all Growth plan features",
  },
})

Java

Map<String, Object> tierMeta = new HashMap<String, Object>();
tierMeta.put("name", "Growth Tier");
tierMeta.put("description", "Grants a tenant access to all Growth plan features");
PricingTier updatedPricingTier = client.updatePricingTier("growth", new PricingTier("growth", tierMeta));

Node.js

const updatedPricingTier = await warrantClient.PricingTier.update("growth", {
  name: "Growth Tier",
  description: "Grants a tenant access to all Growth plan features",
});

Python

pricing_tier = warrant.PricingTier.get("growth")
pricing_tier.update({"name": "Growth Tier", "description": "Grants a tenant access to all Growth plan features"})

Ruby

# Class method
updated_pricing_tier = Warrant::PricingTier.update("growth", { name: "Growth Tier", description: "Grants a tenant access to all Growth plan features" })

# Instance method
pricing_tier = Warrant::PricingTier.get("growth")
pricing_tier.update({ name: "Growth Tier", description: "Grants a tenant access to all Growth plan features" })

PHP

Response

{
  "pricingTierId": "growth",
  "name": "Growth Tier",
  "description": "Grants a tenant access to all Growth plan features"
}