Skip to main content
Subscription products support recurring billing with configurable billing periods and multi-currency pricing. Products can be organized into groups for shared trial management and tiered pricing plans.

​
Billing Periods

​
Group Object

Product groups organize related subscription products (e.g., Free, Pro, Enterprise plans), enable shared trial management across products within a group, and scope which plans a customer may switch between. Each group exists per environment — one row for test and one for production.
Group IDs are in UUID format, not Short ID format. This is the only entity in the API that uses raw UUIDs.

​
Rules

Each key in rules is an independent switch. Both default to false.
Both switches are off unless you turn them on — including on groups that already exist. A key absent from a group’s stored rules reads back as false, so every group created before a switch existed has it off. If customer self-service plan changes are not working, check selfServicePlanChange on the group first.
update-group merges rules per field, it does not replace the object. Sending rules: { selfServicePlanChange: true } leaves sharedTrial at its stored value — you do not need to resend the switches you are not changing. This is the opposite of productIds, which replaces the whole list. Unrecognized keys are dropped rather than stored, and rules: null is treated the same as omitting the field.

​
Endpoints

Create Product

Create a subscription product with billing period and multi-currency pricing.

Update Product

Update a subscription product’s content. Creates a new immutable version if content changed.

Publish Product

Publish a subscription product from test to production (first-publish only).

Update Status

Activate or deactivate a subscription product.

Create Group

Create a product group to organize related subscription products.

Update Group

Update a product group’s name, description, rules, or product list.

Delete Group

Permanently delete a product group.

Publish Group

Publish a product group from test to production (supports repeated UPSERT).