Skip to main content
POST
/
catalog
/
plans
/
{identifier}
/
publish
Publish a plan
curl --request POST \
  --url https://api.kelviq.com/api/v1/catalog/plans/{identifier}/publish/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "updateFeatures": false,
  "updatePricing": false
}
'
{
  "status": "published"
}

Authorizations

​
Authorization
string
header
required

The Server API Key obtained from the kelviq application. Pass as a Bearer token in the Authorization header. Example: 'Authorization: Bearer YOUR_API_KEY'

Path Parameters

​
identifier
string
required

Plan identifier.

Body

application/json

Publishes the most recent draft of a plan.

​
updateFeatures
boolean

If true, existing customers are migrated so their feature entitlements match the newly published plan.

Example:

false

​
updatePricing
boolean

If true, existing customers are migrated to the newly published plan's pricing.

Example:

false

Response

Plan published.

​
status
string
Example:

"published"