Commet
  • Pricing
Log InTry out
Add feature to plan POSTAdd price to plan POSTCreate plan POSTDelete plan price DELETEDelete plan DELETEDelete regional prices DELETEGet plan GETList plans GETRemove feature from plan DELETESet default price PUTSet plan regional pricing PUTSet plan visibility PUTUpdate plan feature PUTUpdate plan price PUTUpdate plan PUTUpsert regional prices PUT
DocumentationKnowledge BaseBuild with AIAPI ReferenceWebhooks

Set plan regional pricing

Configure a plan's regional pricing for one currency. Sending only currency and exchangeRate derives every regional value (base price, included balance, feature overage, intro offer) from the USD value at that rate. Optional per-price and per-feature overrides are stored as manual values.

Set default price PUT

Set a specific price as the default for its plan. Unsets previous default.

Set plan visibility PUT

Toggle a plan between public and private.

Authorization

ApiKeyAuth
x-api-key<token>

In: header

Path Parameters

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

PUT
/plans/{id}/regional

application/json

id*string
currency*string
Value in"ars" | "brl" | "clp" | "cop" | "pen" | "uyu" | "pyg" | "bob" | "mxn" | "cad" | "eur" | "jpy" | "cny" | "krw" | "hkd" | "sgd" | "twd" | "inr" | "thb"
exchangeRate*number
Range0 < value
prices?array<>
features?array<>
introOffers?array<>
curl -X PUT "https://commet.co/api/v1/plans/string/regional" \  -H "Content-Type: application/json" \  -d '{    "currency": "ars",    "exchangeRate": 0  }'

Configure a plan's regional pricing for one currency. Sending only currency and exchangeRate derives every regional value (base price, included balance, feature overage, intro offer) from the USD value at that rate. Optional per-price and per-feature overrides are stored as manual values.

{
  "success": true,
  "data": {
    "planId": "string",
    "currency": "string",
    "exchangeRate": 0,
    "pricesConfigured": -9007199254740991,
    "featuresConfigured": -9007199254740991,
    "object": "plan",
    "livemode": true
  }

{
  "success": false,
  "error": {
    "type": "string",
    "code": "string",
    "message": "string",
    "param": "string",
    "details": null,
    "doc_url": "string"
  }
}
{
  "success": false,
  "error": {
    "type": "string",
    "code": "string",
    "message": "string",
    "param": "string",
    "details": null,
    "doc_url": "string"
  }
}
{
  "success": false,
  "error": {
    "type": "string",
    "code": "string",
    "message": "string",
    "param": "string",
    "details": null,
    "doc_url": "string"
  }
}
{
  "success": false,
  "error": {
    "type": "string",
    "code": "string",
    "message": "string",
    "param": "string",
    "details": null,
    "doc_url": "string"
  }
}
}