Service Design Specification - Object Design for companySubscription

workforceos-subscriptionmanagement-service documentation

Document Overview

This document outlines the object design for the companySubscription model in our application. It includes details about the model’s attributes, relationships, and any specific validation or business logic that applies.

companySubscription Data Object

Object Overview

Description: Represents a company's active or inactive subscription record for feature gating (AI, analytics, etc.). Used to track activation/expiry, status, available features, and audit trail of renewals. 1 per company; used for entitlement checking.

This object represents a core data structure within the service and acts as the blueprint for database interaction, API generation, and business logic enforcement. It is defined using the ObjectSettings pattern, which governs its behavior, access control, caching strategy, and integration points with other systems such as Stripe and Redis.

Core Configuration

Composite Indexes

The index also defines a conflict resolution strategy for duplicate key violations.

When a new record would violate this composite index, the following action will be taken:

On Duplicate: throwError

An error will be thrown, preventing the insertion of conflicting data.

Stripe Integration

This data object is configured to integrate with Stripe for order management of AI Subscription. It is designed to handle payment processing and order tracking. To manage payments, Mindbricks will design additional Business API routes arround this data object, which will be used checkout orders and charge customers.

if an error occurs during the checkout process, the API will continue to execute, allowing for custom error handling. In this case, the payment error will ve recorded as a status update. To make a retry a new checkout, a new order will be created with the same data as the original order.

Properties Schema

Property Type Required Description
activationDate Date Yes Start date/time when subscription is (re)activated.
expiryDate Date Yes Planned end date/time of subscription validity (inclusive).
status Enum Yes Subscription status: active, inactive, pending, or expired.
subscribedFeatures String[] (array) No Array of enabled feature flags for this company's subscription (e.g., aiAnalytics, reporting, notifications).
lastRenewedBy ID No ID of user (admin/mod) who last renewed or updated the subscription record; for audit.
currency String No ISO currency code for the subscription payment. Defaults to usd.
paymentStatus Enum Yes Stripe payment status: pending (awaiting payment), paid (success), failed, canceled.
paymentStatusUpdatedAt Date No Timestamp of the last payment status change from Stripe.
ownerId ID Yes The user who initiated the subscription purchase. Used for Stripe payment ownership.
stripeSubscriptionId String No Stripe subscription ID for recurring billing management. Set after successful payment.
amount Integer Yes Subscription price in cents (e.g. 4999 = $49.99). Used by Stripe payment flow.
companyId ID Yes An ID value to represent the tenant id of the company
paymentConfirmation Enum Yes An automatic property that is used to check the confirmed status of the payment set by webhooks.

Array Properties

subscribedFeatures

Array properties can hold multiple values and are indicated by the [] suffix in their type. Avoid using arrays in properties that are used for relations, as they will not work correctly. Note that using connection objects instead of arrays is recommended for relations, as they provide better performance and flexibility.

Default Values

Default values are automatically assigned to properties when a new object is created, if no value is provided in the request body. Since default values are applied on db level, they should be literal values, not expressions.If you want to use expressions, you can use transposed parameters in any business API to set default values dynamically.

Constant Properties

currency ownerId amount companyId

Constant properties are defined to be immutable after creation, meaning they cannot be updated or changed once set. They are typically used for properties that should remain constant throughout the object’s lifecycle. A property is set to be constant if the Allow Update option is set to false.

Auto Update Properties

activationDate expiryDate status subscribedFeatures lastRenewedBy currency paymentStatus paymentStatusUpdatedAt ownerId stripeSubscriptionId amount

An update crud API created with the option Auto Params enabled will automatically update these properties with the provided values in the request body. If you want to update any property in your own business logic not by user input, you can set the Allow Auto Update option to false. These properties will be added to the update API’s body parameters and can be updated by the user if any value is provided in the request body.

Enum Properties

Enum properties are defined with a set of allowed values, ensuring that only valid options can be assigned to them. The enum options value will be stored as strings in the database, but when a data object is created an addtional property with the same name plus an idx suffix will be created, which will hold the index of the selected enum option. You can use the index property to sort by the enum value or when your enum options represent a sequence of values.

Elastic Search Indexing

activationDate expiryDate status subscribedFeatures lastRenewedBy paymentStatus paymentStatusUpdatedAt ownerId stripeSubscriptionId amount companyId paymentConfirmation

Properties that are indexed in Elastic Search will be searchable via the Elastic Search API. While all properties are stored in the elastic search index of the data object, only those marked for Elastic Search indexing will be available for search queries.

Database Indexing

activationDate expiryDate status paymentStatus ownerId stripeSubscriptionId companyId paymentConfirmation

Properties that are indexed in the database will be optimized for query performance, allowing for faster data retrieval. Make a property indexed in the database if you want to use it frequently in query filters or sorting.

Secondary Key Properties

companyId paymentConfirmation

Secondary key properties are used to create an additional indexed identifiers for the data object, allowing for alternative access patterns. Different than normal indexed properties, secondary keys will act as primary keys and Mindbricks will provide automatic secondary key db utility functions to access the data object by the secondary key.

Relation Properties

lastRenewedBy ownerId

Mindbricks supports relations between data objects, allowing you to define how objects are linked together. You can define relations in the data object properties, which will be used to create foreign key constraints in the database. For complex joins operations, Mindbricks supportsa BFF pattern, where you can view dynamic and static views based on Elastic Search Indexes. Use db level relations for simple one-to-one or one-to-many relationships, and use BFF views for complex joins that require multiple data objects to be joined together.

The target object is a sibling object, meaning that the relation is a many-to-one or one-to-one relationship from this object to the target.

On Delete: Set Null Required: No

The target object is a sibling object, meaning that the relation is a many-to-one or one-to-one relationship from this object to the target.

On Delete: Set Null Required: Yes

CustomData-sourced Properties

paymentStatus amount paymentConfirmation

These properties have source: 'customData' — every create/update API on this data object declares the value via apiOptions.dataClauseSettings.customData[]. Refer to the per-API documentation for the concrete value each API writes.

Filter Properties

activationDate expiryDate status paymentStatus companyId paymentConfirmation

Filter properties are used to define parameters that can be used in query filters, allowing for dynamic data retrieval based on user input or predefined criteria. These properties are automatically mapped as API parameters in the listing API’s that have “Auto Params” enabled.