> For the complete documentation index, see [llms.txt](https://docs.atomyx.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.atomyx.io/atomyx-vault/products-and-subscriptions.md).

# Products and Subscriptions

## Overview

{% hint style="info" %}
Before using this guide, read the Atomyx Vault Overview for background on subscription management and the Identity & Subscription Layer.
{% endhint %}

Products in Atomyx Vault represent instances of Atomyx product types (such as Atomyx Manage, Atomyx Prepare, or Atomyx Layout) that have been added to a workspace. Each product instance has its own configuration, users, groups, and subscription.

Subscriptions are billing plans attached to products that determine the pricing tier, feature availability, and usage limits. Subscription management is powered by Chargebee, an external billing platform integrated with Atomyx Vault.

This document covers the management of products and subscriptions within a workspace.

## The Products List

The Products page is accessible from the workspace-level sidebar navigation. It displays all products that have been added to the current workspace in a table format.

<table><thead><tr><th width="209.234375">Type</th><th>Description</th></tr></thead><tbody><tr><td>Name</td><td>The display name of the product instance</td></tr><tr><td>Product</td><td>The Atomyx product type (e.g. Atomyx Manage, Atomyx Prepare)</td></tr><tr><td>Short name</td><td>The URL-friendly shortname for the product instance</td></tr><tr><td>Subscription</td><td>The current subscription plan name</td></tr><tr><td>Status</td><td>The product’s status (Active, Inactive)</td></tr><tr><td>Users</td><td>The number of users who have access to this product</td></tr><tr><td>My Role</td><td>The current user’s role within this product</td></tr><tr><td>Created on</td><td>The date the product was added to the workspace</td></tr></tbody></table>

Clicking a product row navigates to the product detail page, which provides access to all product configuration through a tabbed interface.

### Adding a Product

The “+ Add product” button initiates the product creation process. Adding a product to a workspace requires:

* Selecting the Atomyx product type from the available options
* Providing a product name - a descriptive display name for this product instance
* Setting a short nam - URL-friendly identifier for the product instance
* Optionally providing a product description

A workspace can have multiple products, including multiple instances of the same product type. This enables scenarios such as running separate Atomyx Manage instances for different departments or clients.

{% hint style="info" %}
After adding a product, it must be configured with a subscription, users, and optionally integrations before it is fully operational. The product appears as Inactive until a subscription is activated.
{% endhint %}

## Product Detail Page

The product detail page provides a comprehensive interface for managing all aspects of a product instance. It is organized into four tabs: Settings, Subscription, Users, and Integrations.

At the top of the product detail page, a banner displays the Atomyx product type (e.g. “Atomyx Manage”), providing quick identification of which product type this instance belongs to.

### Settings Tab

The Settings tab contains the core configuration for the product instance.

#### Product Name

The display name used throughout the Atomyx Vault interface to identify this product instance. This should be descriptive enough to distinguish it from other product instances, especially when multiple instances of the same product type exist in the workspace.

#### Short Name

A URL-friendly identifier used in product URLs and as a compact reference. The short name must be unique within the workspace.

#### Product Description

An optional description that provides context about the product instance’s purpose, configuration, or intended audience. This is useful for documentation purposes, especially in workspaces with multiple product instances.

### Subscription Tab

The Subscription tab manages the billing plan for the product instance. Subscriptions determine the pricing tier, feature availability, and usage limits for the product.

#### Choosing a Subscription

The “Choose subscription plan” button opens the subscription selection interface, which is powered by Chargebee. The available subscription plans depend on the Atomyx product type and may include:

* Free tier - limited functionality for evaluation or small-scale use
* Standard tier - full functionality with standard usage limits
* Professional tier - enhanced functionality with higher usage limits
* Enterprise tier - custom plans with negotiated terms and limits

{% hint style="info" %}
Subscription plans, pricing, and available tiers are managed in Chargebee and may vary by product type and region. The exact plans available will depend on the current Atomyx pricing structure.
{% endhint %}

#### Subscription Management

After a subscription is active, the Subscription tab displays the current plan details. Users with the Owner or Billing role can:

* View the current subscription plan and its terms
* Upgrade or downgrade the subscription plan
* View billing history and invoices
* Update payment information

Subscription changes may take effect immediately or at the next billing cycle, depending on the type of change and the plan terms.

### Users Tab

The Users tab manages which workspace members have access to this specific product and what role they have within it. The tab contains two sections: Product Users and Product Groups.

#### Product Users

The Product Users table displays individual users who have been granted access to the product. The table shows:

* Name - the user’s first name
* Surname - the user’s last name
* Email - the user’s email address
* Status - the user’s status (Active, Pending)
* Role - the user’s role within this product

Administrators can add workspace users to the product by selecting them from the workspace user list and assigning a product-level role. Only users who are already members of the workspace can be added to a product.

#### Product Groups

The Product Groups table displays workspace groups that have been granted access to the product. The table shows:

* Name - the group name
* Description - the group description
* Users - the number of users in the group
* Role - the product-level role assigned to the group

When a group is assigned to a product, all members of that group automatically receive access to the product with the specified role. This is the recommended approach for managing product access at scale.

{% hint style="info" %}
If a user has both an individual product role and a group-based product role, the effective role is determined by the most permissive assignment. For example, if a user is individually assigned a Member role but belongs to a group assigned the Admin role, the user will have Admin access.
{% endhint %}

### Integrations Tab

The Integrations tab manages connections between this product instance and external systems or services. Integrations extend the product’s functionality by connecting it to third-party platforms.

#### Product Integrations Table

The integrations table displays all configured integrations for the product instance, with the following columns:

* Name - the display name of the integration
* Description - a description of the integration’s purpose
* Role - the access level of the integration

#### Adding an Integration

The “+ Add integration” button initiates the integration setup process. The available integrations depend on the product type and may include connections to:

* E-commerce platforms
* Print MIS systems
* File storage services
* Communication tools
* Custom webhooks and APIs

Each integration may require specific configuration settings such as API keys, endpoint URLs, or authentication credentials. Refer to the specific Atomyx product documentation for details on available integrations and their configuration requirements.

## Terminology

The terminology used for products has evolved between the specification documents and the current user interface.

<table data-full-width="true"><thead><tr><th>Spec Term</th><th>Current UI Term</th><th>Notes</th></tr></thead><tbody><tr><td>Service Type</td><td>Product type</td><td>The specs use “service type” for the category of product (e.g. Atomyx Manage). The UI calls these “product types”.</td></tr><tr><td>Service</td><td>Product</td><td>The specs use “service” for an instance of a service type added to an account. The UI calls these “products”.</td></tr><tr><td>Account</td><td>Workspace</td><td>The specs use “account” for the organizational container. The UI calls this a “workspace”.</td></tr></tbody></table>

{% hint style="info" %}
This documentation uses the current UI terminology throughout. When referencing the specification documents, the equivalent spec terms are noted where relevant.
{% endhint %}

## Product Lifecycle

A product in Atomyx Vault follows a lifecycle from initial addition to the workspace through to potential removal.

### Adding

A product is added to a workspace through the “+ Add product” button on the Products page. At this stage, the product has no subscription, no users, and no integrations.

### Configuration

After adding, the product should be configured with:

1. A subscription plan to enable usage and determine feature availability
2. Users or groups to grant access to workspace members
3. Integrations to connect the product to external systems (if applicable)
4. Product settings including name, short name, and description

### Active Use

Once configured with a subscription and users, the product is fully operational. Users with product access can sign in to the product using their Atomyx account credentials, and Atomyx Vault handles the authentication and authorization.

### Subscription Changes

During the active use phase, subscription changes may be needed as requirements evolve. Subscription upgrades typically take effect immediately, while downgrades may take effect at the next billing cycle.

### Removal

Products can be removed from a workspace when they are no longer needed. Removal should be coordinated with:

* Users who have access to the product - they should be informed before removal
* Integrations that depend on the product - external system configurations may need to be updated
* Billing - ensure the subscription is properly cancelled before or during product removal

## Best Practices

### Product Management

* Use descriptive product names that clearly identify the instance, especially when running multiple instances of the same product type (e.g. “Atomyx Manage - Production”, “Atomyx Manage - Staging”)
* Set meaningful short names that are easy to remember and type in URLs
* Keep product descriptions up to date to help administrators understand each product’s purpose

### Subscription Management

* Start with the appropriate subscription tier for the expected usage level
* Monitor usage against subscription limits and upgrade proactively when approaching limits
* Assign the Billing role to finance team members who manage subscriptions
* Review subscriptions periodically and downgrade or remove products that are underutilized

### User Access

* Use groups rather than individual assignments to manage product access at scale
* Grant product access only to users who actively need the product
* Review product user lists periodically and remove access for users who no longer need it
* When onboarding new workspace members, add them to appropriate groups to automatically grant product access

### Integrations

* Document all integration configurations including API keys, endpoint URLs, and external system settings
* Test integrations in a non-production product instance before deploying to production
* Review integration configurations when external systems are updated or changed
* Remove integrations that are no longer in use to keep the product configuration clean

## Atomyx Submit Subscription Tiers

Atomyx Submit uses a credit-based subscription model where credits are consumed for each artwork submission processed. This section describes the available subscription tiers, credit allocation, and how to manage Atomyx Submit subscriptions.

### Atomyx Submit Subscription Model

Atomyx Submit operates on a credit system where each submission processed consumes credits from the workspace’s allocated pool. Credits are allocated monthly based on the chosen subscription tier. Once credits are consumed, behavior depends on configuration:

* Submissions queued - if configured, submissions are queued and processed when new credits become available in the next billing cycle
* Submissions rejected - if configured, submissions are rejected when credits are exhausted

Credit allocation is managed at the workspace level, meaning all Atomyx Submit product instances within a workspace share the same credit pool.

### Available Subscription Tiers

Atomyx Submit offers three primary subscription tiers:

<table data-full-width="true"><thead><tr><th>Tier</th><th>Monthly Credits</th><th>Preflight Included</th><th>Portal Customisation</th><th>Support</th></tr></thead><tbody><tr><td>Starter</td><td>100</td><td>Basic checks only</td><td>Logo + colours</td><td>Email</td></tr><tr><td>Professional</td><td>500</td><td>Full preflight suite</td><td>Full branding + custom CSS</td><td>Priority email</td></tr><tr><td>Enterprise</td><td>Unlimited</td><td>Full preflight + custom profiles</td><td>Full branding + custom domain</td><td>Dedicated support</td></tr></tbody></table>

#### Tier Features

Preflight Options:

* Basic checks - includes standard file validation and basic compliance checks
* Full preflight suite - includes advanced preflight checks, color profile validation, and compliance reporting
* Custom profiles - enterprise tier supports custom preflight profiles tailored to specific workflow requirements

Portal Customisation:

* Logo + colours - customize the submission portal with workspace logo and color scheme
* Full branding + custom CSS - full visual customization with custom CSS for complete design control
* Full branding + custom domain - enterprise tier supports custom domain URLs for the submission portal (e.g., submit.company.com)

Support Levels:

* Email - standard email support with typical response times
* Priority email - prioritized email support with faster response times
* Dedicated support - enterprise tier includes dedicated support contact with SLA guarantees

### Credit Allocation and Usage

Credits are allocated monthly based on the subscription tier and are tracked at the workspace level:

* Monthly allocation - credits are allocated on the subscription billing date each month
* Workspace-level pool - all Atomyx Submit product instances in the workspace share the same monthly credit allocation
* Usage monitoring - administrators can monitor credit usage from the Subscription tab on the Atomyx Submit product detail page
* Approaching limits - alerts are displayed when credit usage approaches the monthly allocation limit
* Credit exhaustion - when monthly credits are exhausted, submissions are either queued or rejected depending on configuration
* Rollover policy - unused credits do not roll over to the next month; the allocation resets on each billing date

### Managing Atomyx Submit Subscriptions

Atomyx Submit subscriptions are managed from the Subscription tab on the product detail page:

* View current tier - the Subscription tab displays the currently active subscription tier and its features
* Upgrade tier - users with the Owner or Billing role can upgrade to a higher tier for additional credits or features
* Downgrade tier - users with the Owner or Billing role can downgrade to a lower tier (typically effective at the next billing cycle)
* Monitor usage - the Subscription tab displays current credit usage against the monthly allocation
* Add credit packs - optional additional credits can be purchased mid-month if needed (availability depends on plan terms)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.atomyx.io/atomyx-vault/products-and-subscriptions.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.