Introducing the Chargebee CLI

Release a business rule

Open in Postman

Releases the draft version of a business rule. The draft is promoted to the next version number and becomes the released version that Chargebee evaluates, so latest_version is incremented and released_at is set. Until you release it, the previously released version stays in effect.

Use this operation to promote a revision you staged with Update a business rule draft.

Prerequisites & Constraints

The rule must have a draft, created by Update a business rule draft.

Impacts

Business rule

The draft becomes the released version of the rule, latest_version is incremented, and released_at and released_by are set. The rule no longer has a draft, and Chargebee starts evaluating the newly released version in place of the previous one. Releasing does not change active, so a rule that has not been activated is still not evaluated.

Every release is a new version, and each business ruleset that contains the rule picks up the newly released version, because a ruleset always evaluates the latest released version of its member rules.

Implementation Notes

Review the version you are about to publish with Retrieve a business rule draft before calling this operation, because releasing cannot be undone and the change takes effect immediately for every ruleset that contains the rule.

Sample Request

Open in Postman

Sample Result[JSON]

URL Format

POST https://[site].chargebee.com/api/v2/business_rules/{business-rule-id}/release

Returns

Business rule object

The business rule after the release, with latest_version incremented and released_at and released_by set. The rule no longer has a draft, and active is unchanged.