# REST API GUIDE 
## aifitapp-subscription-service
**Version:** `1.0.24`

Manages the single premium subscription plan lifecycle including activation, status tracking, cancellation, and admin-configurable pricing. Provides subscription status validation endpoints for other services to gate access to AI-powered featuresa.z

## Architectural Design Credit and Contact Information

The architectural design of this microservice is credited to . 
For inquiries, feedback, or further information regarding the architecture, please direct your communication to:

Email: 

We encourage open communication and welcome any questions or discussions related to the architectural aspects of this microservice.

## Documentation Scope

Welcome to the official documentation for the Subscription Service's REST API. This document is designed to provide a comprehensive guide to interfacing with our Subscription Service exclusively through RESTful API endpoints.

**Intended Audience**

This documentation is intended for developers and integrators who are looking to interact with the Subscription Service via HTTP requests for purposes such as creating, updating, deleting and querying Subscription objects.

**Overview**

Within these pages, you will find detailed information on how to effectively utilize the REST API, including authentication methods, request and response formats, endpoint descriptions, and examples of common use cases.

Beyond REST
It's important to note that the Subscription Service also supports alternative methods of interaction, such as gRPC and messaging via a Message Broker. These communication methods are beyond the scope of this document. For information regarding these protocols, please refer to their respective documentation.

## Authentication And Authorization

To ensure secure access to the Subscription service's protected endpoints, a project-wide access token is required. This token serves as the primary method for authenticating requests to our service. However, it's important to note that access control varies across different routes:

**Protected API**: 
Certain API (routes) require specific authorization levels. Access to these routes is contingent upon the possession of a valid access token that meets the route-specific authorization criteria. Unauthorized requests to these routes will be rejected.

**Public API **: 
The service also includes public API (routes) that are accessible without authentication. These public endpoints are designed for open access and do not require an access token.

### Token Locations
When including your access token in a request, ensure it is placed in one of the following specified locations. The service will sequentially search these locations for the token, utilizing the first one it encounters.

| Location               | Token Name / Param Name      |
| ---------------------- | ---------------------------- |
| Query                  | access_token                 |
| Authorization Header   | Bearer                       |
| Header                 | appaili-access-token|
| Cookie                 | appaili-access-token|


Please ensure the token is correctly placed in one of these locations, using the appropriate label as indicated. The service prioritizes these locations in the order listed, processing the first token it successfully identifies.


## Api Definitions
This section outlines the API endpoints available within the Subscription service. Each endpoint can receive parameters through various methods, meticulously described in the following definitions. It's important to understand the flexibility in how parameters can be included in requests to effectively interact with the Subscription service.

This service is configured to listen for HTTP requests on port `3001`, 
serving both the main API interface and default administrative endpoints.

The following routes are available by default:

* **API Test Interface (API Face):** `/`
* **Swagger Documentation:** `/swagger`
* **Postman Collection Download:** `/getPostmanCollection`
* **Health Checks:** `/health` and `/admin/health`
* **Current Session Info:** `/currentuser`
* **Favicon:** `/favicon.ico`

This service is accessible via the following environment-specific URLs:

* **Preview:** `https://appaili.prw.mindbricks.com/subscription-api`
* **Staging:** `https://appaili-stage.mindbricks.co/subscription-api`
* **Production:** `https://appaili.mindbricks.co/subscription-api`

**Parameter Inclusion Methods:**
Parameters can be incorporated into API requests in several ways, each with its designated location. Understanding these methods is crucial for correctly constructing your requests:

**Query Parameters:** Included directly in the URL's query string.

**Path Parameters:** Embedded within the URL's path.

**Body Parameters:** Sent within the JSON body of the request.

**Session Parameters:** Automatically read from the session object. This method is used for parameters that are intrinsic to the user's session, such as userId. When using an API that involves session parameters, you can omit these from your request. The service will automatically bind them to the API layer, provided that a session is associated with your request.

**Note on Session Parameters:**
Session parameters represent a unique method of parameter inclusion, relying on the context of the user's session. A common example of a session parameter is userId, which the service automatically associates with your request when a session exists. This feature ensures seamless integration of user-specific data without manual input for each request.

By adhering to the specified parameter inclusion methods, you can effectively utilize the Subscription service's API endpoints. For detailed information on each endpoint, including required parameters and their accepted locations, refer to the individual API definitions below.

### Common Parameters

The `Subscription` service's business API support several common parameters designed to modify and enhance the behavior of API requests. These parameters are not individually listed in the API route definitions to avoid repetition. Instead, refer to this section to understand how to leverage these common behaviors across different routes. Note that all common parameters should be included in the query part of the URL.

### Supported Common Parameters:

- **getJoins (BOOLEAN)**: Controls whether to retrieve associated objects along with the main object. By default, `getJoins` is assumed to be `true`. Set it to `false` if you prefer to receive only the main fields of an object, excluding its associations.

- **excludeCQRS (BOOLEAN)**: Applicable only when `getJoins` is `true`. By default, `excludeCQRS` is set to `false`. Enabling this parameter (`true`) omits non-local associations, which are typically more resource-intensive as they require querying external services like ElasticSearch for additional information. Use this to optimize response times and resource usage.

- **requestId (String)**: Identifies a request to enable tracking through the service's log chain. A random hex string of 32 characters is assigned by default. If you wish to use a custom `requestId`, simply include it in your query parameters.

- **caching (BOOLEAN)**: Determines the use of caching for query API. By default, caching is enabled (`true`). To ensure the freshest data directly from the database, set this parameter to `false`, bypassing the cache.

- **cacheTTL (Integer)**: Specifies the Time-To-Live (TTL) for query caching, in seconds. This is particularly useful for adjusting the default caching duration (5 minutes) for `get list` queries. Setting a custom `cacheTTL` allows you to fine-tune the cache lifespan to meet your needs.

- **pageNumber (Integer)**: For paginated `get list` API's, this parameter selects which page of results to retrieve. The default is `1`, indicating the first page. To disable pagination and retrieve all results, set `pageNumber` to `0`.

- **pageRowCount (Integer)**: In conjunction with paginated API's, this parameter defines the number of records per page. The default value is `25`. Adjusting `pageRowCount` allows you to control the volume of data returned in a single request.

By utilizing these common parameters, you can tailor the behavior of API requests to suit your specific requirements, ensuring optimal performance and usability of the `Subscription` service.


### Error Response

If a request encounters an issue, whether due to a logical fault or a technical problem, the service responds with a standardized JSON error structure. The HTTP status code within this response indicates the nature of the error, utilizing commonly recognized codes for clarity:

- **400 Bad Request**: The request was improperly formatted or contained invalid parameters, preventing the server from processing it.
- **401 Unauthorized**: The request lacked valid authentication credentials or the credentials provided do not grant access to the requested resource.
- **404 Not Found**: The requested resource was not found on the server.
- **500 Internal Server Error**: The server encountered an unexpected condition that prevented it from fulfilling the request.

Each error response is structured to provide meaningful insight into the problem, assisting in diagnosing and resolving issues efficiently.

```js
{
  "result": "ERR",
  "status": 400,
  "message": "errMsg_organizationIdisNotAValidID",
  "errCode": 400,
  "date": "2024-03-19T12:13:54.124Z",
  "detail": "String"
}
```` 

### Object Structure of a Successfull Response

When the `Subscription` service processes requests successfully, it wraps the requested resource(s) within a JSON envelope. This envelope not only contains the data but also includes essential metadata, such as configuration details and pagination information, to enrich the response and provide context to the client.

**Key Characteristics of the Response Envelope:**

- **Data Presentation**: Depending on the nature of the request, the service returns either a single data object or an array of objects encapsulated within the JSON envelope.
  - **Creation and Update API**: These API routes return the unmodified (pure) form of the data object(s), without any associations to other data objects.
  - **Delete API**: Even though the data is removed from the database, the last known state of the data object(s) is returned in its pure form.
  - **Get Requests**: A single data object is returned in JSON format.
  - **Get List Requests**: An array of data objects is provided, reflecting a collection of resources.

- **Data Structure and Joins**: The complexity of the data structure in the response can vary based on the API's architectural design and the join options specified in the request. The architecture might inherently limit join operations, or they might be dynamically controlled through query parameters.
  - **Pure Data Forms**: In some cases, the response mirrors the exact structure found in the primary data table, without extensions.
  - **Extended Data Forms**: Alternatively, responses might include data extended through joins with tables within the same service or aggregated from external sources, such as ElasticSearch indices related to other services.
  - **Join Varieties**: The extensions might involve one-to-one joins, resulting in single object associations, or one-to-many joins, leading to an array of objects. In certain instances, the data might even feature nested inclusions from other data objects.

**Design Considerations**: The structure of a API's response data is meticulously crafted during the service's architectural planning. This design ensures that responses adequately reflect the intended data relationships and service logic, providing clients with rich and meaningful information.

**Brief Data**: Certain API's return a condensed version of the object data, intentionally selecting only specific fields deemed useful for that request. In such instances, the API documentation will detail the properties included in the response, guiding developers on what to expect.

### API Response Structure

The API utilizes a standardized JSON envelope to encapsulate responses. This envelope is designed to consistently deliver both the requested data and essential metadata, ensuring that clients can efficiently interpret and utilize the response.

**HTTP Status Codes:**

- **200 OK**: This status code is returned for successful GET, LIST, UPDATE, or DELETE operations, indicating that the request has been processed successfully.
- **201 Created**: This status code is specific to CREATE operations, signifying that the requested resource has been successfully created.

**Success Response Format:**

For successful operations, the response includes a `"status": "OK"` property, signaling the successful execution of the request. The structure of a successful response is outlined below:

```json
{
  "status":"OK",
  "statusCode": 200,   
  "elapsedMs":126,
  "ssoTime":120,
  "source": "db",
  "cacheKey": "hexCode",
  "userId": "ID",
  "sessionId": "ID",
  "requestId": "ID",
  "dataName":"products",
  "method":"GET",
  "action":"list",
  "appVersion":"Version",
  "rowCount":3
  "products":[{},{},{}],
  "paging": {
    "pageNumber":1, 
    "pageRowCount":25, 
    "totalRowCount":3,
    "pageCount":1
  },
  "filters": [],
  "uiPermissions": []
}
````

- **`products`**: In this example, this key contains the actual response content, which may be a single object or an array of objects depending on the operation performed.

**Handling Errors:**

For details on handling error scenarios and understanding the structure of error responses, please refer to the "Error Response" section provided earlier in this documentation. It outlines how error conditions are communicated, including the use of HTTP status codes and standardized JSON structures for error messages.

## Resources 
Subscription service provides the following resources which are stored in its own database as a data object. Note that a resource for an api access is a data object for the service.

### PricingConfig resource

*Resource Definition* : Stores the current premium subscription pricing configuration. Admin-managed, single system-wide record.
*PricingConfig Resource Properties* 
| Name | Type | Required | Default | Definition | 
| ---- | ---- | -------- | ------- | ---------- |
| **currency** | String |  |  | *Currency code for pricing (e.g., usd).* |
| **description** | Text |  |  | *Human-readable description of the subscription plan.* |
| **price** | Integer |  |  | *Current subscription price in cents (e.g., 999 = $9.99).* |
| **type** | Enum |  |  | ** |
#### Enum Properties
Enum properties are represented as strings in the database. The values are mapped to their corresponding names in the application layer.
##### type Enum Property
*Enum Options*
| Name | Value | Index | 
| ---- | ----- | ----- |
| **subscription** | `"subscription""` | 0 | 
| **quota** | `"quota""` | 1 | 
### Subscription resource

*Resource Definition* : Represents a user's premium subscription record, serving as the Stripe payment object. Tracks payment status, price paid, and subscription lifecycle dates.
*Subscription Resource Properties* 
| Name | Type | Required | Default | Definition | 
| ---- | ---- | -------- | ------- | ---------- |
| **activatedAt** | Date |  |  | *Timestamp when the subscription was activated after successful payment.* |
| **cancelledAt** | Date |  |  | *Timestamp when the subscription was cancelled by the user.* |
| **currency** | String |  |  | *Currency code for the payment (e.g., usd).* |
| **pricePaid** | Integer |  |  | *Amount paid in cents at the time of subscription activation.* |
| **status** | Enum |  |  | *Current subscription status managed by Stripe payment flow.* |
| **statusUpdatedAt** | Date |  |  | *Timestamp of the last status update, auto-managed by Stripe payment flow.* |
| **userId** | ID |  |  | *Reference to the user who owns this subscription.* |
| **paymentConfirmation** | Enum |  |  | *An automatic property that is used to check the confirmed status of the payment set by webhooks.* |
#### Enum Properties
Enum properties are represented as strings in the database. The values are mapped to their corresponding names in the application layer.
##### status Enum Property
*Property Definition* : Current subscription status managed by Stripe payment flow.*Enum Options*
| Name | Value | Index | 
| ---- | ----- | ----- |
| **pending** | `"pending""` | 0 | 
| **active** | `"active""` | 1 | 
| **cancelled** | `"cancelled""` | 2 | 
| **expired** | `"expired""` | 3 | 
| **failed** | `"failed""` | 4 | 
##### paymentConfirmation Enum Property
*Property Definition* : An automatic property that is used to check the confirmed status of the payment set by webhooks.*Enum Options*
| Name | Value | Index | 
| ---- | ----- | ----- |
| **pending** | `"pending""` | 0 | 
| **processing** | `"processing""` | 1 | 
| **paid** | `"paid""` | 2 | 
| **canceled** | `"canceled""` | 3 | 
### Sys_subscriptionPayment resource

*Resource Definition* : A payment storage object to store the payment life cyle of orders based on subscription object. It is autocreated based on the source object's checkout config
*Sys_subscriptionPayment Resource Properties* 
| Name | Type | Required | Default | Definition | 
| ---- | ---- | -------- | ------- | ---------- |
| **ownerId** | ID |  |  | * An ID value to represent owner user who created the order* |
| **orderId** | ID |  |  | *an ID value to represent the orderId which is the ID parameter of the source subscription object* |
| **paymentId** | String |  |  | *A String value to represent the paymentId which is generated on the Stripe gateway. This id may represent different objects due to the payment gateway and the chosen flow type* |
| **paymentStatus** | String |  |  | *A string value to represent the payment status which belongs to the lifecyle of a Stripe payment.* |
| **statusLiteral** | String |  |  | *A string value to represent the logical payment status which belongs to the application lifecycle itself.* |
| **redirectUrl** | String |  |  | *A string value to represent return page of the frontend to show the result of the payment, this is used when the callback is made to server not the client.* |
### Sys_paymentCustomer resource

*Resource Definition* : A payment storage object to store the customer values of the payment platform
*Sys_paymentCustomer Resource Properties* 
| Name | Type | Required | Default | Definition | 
| ---- | ---- | -------- | ------- | ---------- |
| **userId** | ID |  |  | * An ID value to represent the user who is created as a stripe customer* |
| **customerId** | String |  |  | *A string value to represent the customer id which is generated on the Stripe gateway. This id is used to represent the customer in the Stripe gateway* |
| **platform** | String |  |  | *A String value to represent payment platform which is used to make the payment. It is stripe as default. It will be used to distinguesh the payment gateways in the future.* |
### Sys_paymentMethod resource

*Resource Definition* : A payment storage object to store the payment methods of the platform customers
*Sys_paymentMethod Resource Properties* 
| Name | Type | Required | Default | Definition | 
| ---- | ---- | -------- | ------- | ---------- |
| **paymentMethodId** | String |  |  | *A string value to represent the id of the payment method on the payment platform.* |
| **userId** | ID |  |  | * An ID value to represent the user who owns the payment method* |
| **customerId** | String |  |  | *A string value to represent the customer id which is generated on the payment gateway.* |
| **cardHolderName** | String |  |  | *A string value to represent the name of the card holder. It can be different than the registered customer.* |
| **cardHolderZip** | String |  |  | *A string value to represent the zip code of the card holder. It is used for address verification in specific countries.* |
| **platform** | String |  |  | *A String value to represent payment platform which teh paymentMethod belongs. It is stripe as default. It will be used to distinguesh the payment gateways in the future.* |
| **cardInfo** | Object |  |  | *A Json value to store the card details of the payment method.* |
## Business Api
### `Cancel Subscription` API
Cancel the authenticated user's active subscription. Sets the subscription status to cancelled and records the cancellation timestamp.

**API Frontend Description By The Backend Architect**

Call this endpoint when the user confirms they want to cancel their subscription. After successful cancellation, inform the user that they will lose access to AI features. The response contains the updated subscription record with status 'cancelled'.

**Rest Route**

The `cancelSubscription` API REST controller can be triggered via the following route:

`/v1/subscriptions/:subscriptionId/cancel`


**Rest Request Parameters**


The `cancelSubscription` api has got 1 regular request parameter  

| Parameter              | Type                   | Required | Population                   |
| ---------------------- | ---------------------- | -------- | ---------------------------- |
| subscriptionId  | ID  | true | request.params?.["subscriptionId"] |
**subscriptionId** : This id paremeter is used to select the required data object that will be updated



**REST Request**
To access the api you can use the **REST** controller with the path **POST  /v1/subscriptions/:subscriptionId/cancel**
```js
  axios({
    method: 'POST',
    url: `/v1/subscriptions/${subscriptionId}/cancel`,
    data: {
    
    },
    params: {
    
        }
  });
```   
**REST Response**


```json
{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "subscription",
	"method": "POST",
	"action": "update",
	"appVersion": "Version",
	"rowCount": 1,
	"subscription": {
		"id": "ID",
		"activatedAt": "Date",
		"cancelledAt": "Date",
		"currency": "String",
		"pricePaid": "Integer",
		"status": "Enum",
		"status_idx": "Integer",
		"statusUpdatedAt": "Date",
		"userId": "ID",
		"paymentConfirmation": "Enum",
		"paymentConfirmation_idx": "Integer",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}
```


### `Check Subscriptionstatus` API
Machine-to-machine endpoint for other services to validate if a user has an active subscription. Returns the active subscription record if one exists, or an empty list if not.


**Rest Route**

The `checkSubscriptionStatus` API REST controller can be triggered via the following route:

`/v1/check-status`


**Rest Request Parameters**


The `checkSubscriptionStatus` api has got 1 regular request parameter  

| Parameter              | Type                   | Required | Population                   |
| ---------------------- | ---------------------- | -------- | ---------------------------- |
| userId  | ID  | true | request.body?.["userId"] |
**userId** : The user ID to check subscription status for.



**REST Request**
To access the api you can use the **REST** controller with the path **POST  /v1/check-status**
```js
  axios({
    method: 'POST',
    url: '/v1/check-status',
    data: {
            userId:"ID",  
    
    },
    params: {
    
        }
  });
```   
**REST Response**

This route's response is constrained to a select list of properties, and therefore does not encompass all attributes of the resource.

```json
{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "subscriptions",
	"method": "POST",
	"action": "list",
	"appVersion": "Version",
	"rowCount": "\"Number\"",
	"subscriptions": [
		{
			"isActive": true
		},
		{},
		{}
	],
	"paging": {
		"pageNumber": "Number",
		"pageRowCount": "NUmber",
		"totalRowCount": "Number",
		"pageCount": "Number"
	},
	"filters": [],
	"uiPermissions": []
}
```


### `Create Pricingconfig` API
**[Default create API]** — This is the designated default `create` API for the `pricingConfig` data object. Frontend generators and AI agents should use this API for standard CRUD operations.
Create a new pricing configuration record. Admin-only operation for setting up subscription pricing.


**Rest Route**

The `createPricingConfig` API REST controller can be triggered via the following route:

`/v1/pricingconfigs`


**Rest Request Parameters**


The `createPricingConfig` api has got 4 regular request parameters  

| Parameter              | Type                   | Required | Population                   |
| ---------------------- | ---------------------- | -------- | ---------------------------- |
| currency  | String  | true | request.body?.["currency"] |
| description  | Text  | false | request.body?.["description"] |
| price  | Integer  | true | request.body?.["price"] |
| type  | Enum  | true | request.body?.["type"] |
**currency** : Currency code for pricing (e.g., usd).
**description** : Human-readable description of the subscription plan.
**price** : Current subscription price in cents (e.g., 999 = $9.99).
**type** : 



**REST Request**
To access the api you can use the **REST** controller with the path **POST  /v1/pricingconfigs**
```js
  axios({
    method: 'POST',
    url: '/v1/pricingconfigs',
    data: {
            currency:"String",  
            description:"Text",  
            price:"Integer",  
            type:"Enum",  
    
    },
    params: {
    
        }
  });
```   
**REST Response**


```json
{
	"status": "OK",
	"statusCode": "201",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "pricingConfig",
	"method": "POST",
	"action": "create",
	"appVersion": "Version",
	"rowCount": 1,
	"pricingConfig": {
		"id": "ID",
		"currency": "String",
		"description": "Text",
		"price": "Integer",
		"type": "Enum",
		"type_idx": "Integer",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}
```


### `Delete Pricingconfig` API
**[Default delete API]** — This is the designated default `delete` API for the `pricingConfig` data object. Frontend generators and AI agents should use this API for standard CRUD operations.
Delete a pricing configuration record. Admin-only operation.


**Rest Route**

The `deletePricingConfig` API REST controller can be triggered via the following route:

`/v1/pricingconfigs/:pricingConfigId`


**Rest Request Parameters**


The `deletePricingConfig` api has got 1 regular request parameter  

| Parameter              | Type                   | Required | Population                   |
| ---------------------- | ---------------------- | -------- | ---------------------------- |
| pricingConfigId  | ID  | true | request.params?.["pricingConfigId"] |
**pricingConfigId** : This id paremeter is used to select the required data object that will be deleted



**REST Request**
To access the api you can use the **REST** controller with the path **DELETE  /v1/pricingconfigs/:pricingConfigId**
```js
  axios({
    method: 'DELETE',
    url: `/v1/pricingconfigs/${pricingConfigId}`,
    data: {
    
    },
    params: {
    
        }
  });
```   
**REST Response**


```json
{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "pricingConfig",
	"method": "DELETE",
	"action": "delete",
	"appVersion": "Version",
	"rowCount": 1,
	"pricingConfig": {
		"id": "ID",
		"currency": "String",
		"description": "Text",
		"price": "Integer",
		"type": "Enum",
		"type_idx": "Integer",
		"isActive": false,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}
```


### `Get Mysubscription` API
Retrieve the currently authenticated user's active subscription. Returns the active subscription if one exists.

**API Frontend Description By The Backend Architect**

Use this endpoint to check if the current user has an active subscription before allowing access to AI features. If a 404 is returned, the user does not have an active subscription and should be prompted to subscribe.

**Rest Route**

The `getMySubscription` API REST controller can be triggered via the following route:

`/v1/my-subscription`


**Rest Request Parameters**
The `getMySubscription` api has got no request parameters.    




**REST Request**
To access the api you can use the **REST** controller with the path **GET  /v1/my-subscription**
```js
  axios({
    method: 'GET',
    url: '/v1/my-subscription',
    data: {
    
    },
    params: {
    
        }
  });
```   
**REST Response**


```json
{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "subscription",
	"method": "GET",
	"action": "get",
	"appVersion": "Version",
	"rowCount": 1,
	"subscription": {
		"id": "ID",
		"activatedAt": "Date",
		"cancelledAt": "Date",
		"currency": "String",
		"pricePaid": "Integer",
		"status": "Enum",
		"status_idx": "Integer",
		"statusUpdatedAt": "Date",
		"userId": "ID",
		"paymentConfirmation": "Enum",
		"paymentConfirmation_idx": "Integer",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}
```


### `Get Pricingconfig` API
**[Default get API]** — This is the designated default `get` API for the `pricingConfig` data object. Frontend generators and AI agents should use this API for standard CRUD operations.
Retrieve a pricing configuration record. Accessible to all authenticated users to view current subscription pricing.

**API Frontend Description By The Backend Architect**

Use this endpoint to display the current subscription price to users before they initiate payment.

**Rest Route**

The `getPricingConfig` API REST controller can be triggered via the following route:

`/v1/pricingconfigs/:pricingConfigId`


**Rest Request Parameters**


The `getPricingConfig` api has got 1 regular request parameter  

| Parameter              | Type                   | Required | Population                   |
| ---------------------- | ---------------------- | -------- | ---------------------------- |
| pricingConfigId  | ID  | true | request.params?.["pricingConfigId"] |
**pricingConfigId** : This id paremeter is used to query the required data object.



**REST Request**
To access the api you can use the **REST** controller with the path **GET  /v1/pricingconfigs/:pricingConfigId**
```js
  axios({
    method: 'GET',
    url: `/v1/pricingconfigs/${pricingConfigId}`,
    data: {
    
    },
    params: {
    
        }
  });
```   
**REST Response**


```json
{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "pricingConfig",
	"method": "GET",
	"action": "get",
	"appVersion": "Version",
	"rowCount": 1,
	"pricingConfig": {
		"id": "ID",
		"currency": "String",
		"description": "Text",
		"price": "Integer",
		"type": "Enum",
		"type_idx": "Integer",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}
```


### `Get Subscription` API
**[Default get API]** — This is the designated default `get` API for the `subscription` data object. Frontend generators and AI agents should use this API for standard CRUD operations.
Retrieve a subscription record by its ID. Owners can view their own subscriptions; admins can view any.


**Rest Route**

The `getSubscription` API REST controller can be triggered via the following route:

`/v1/subscriptions/:subscriptionId`


**Rest Request Parameters**


The `getSubscription` api has got 1 regular request parameter  

| Parameter              | Type                   | Required | Population                   |
| ---------------------- | ---------------------- | -------- | ---------------------------- |
| subscriptionId  | ID  | true | request.params?.["subscriptionId"] |
**subscriptionId** : This id paremeter is used to query the required data object.



**REST Request**
To access the api you can use the **REST** controller with the path **GET  /v1/subscriptions/:subscriptionId**
```js
  axios({
    method: 'GET',
    url: `/v1/subscriptions/${subscriptionId}`,
    data: {
    
    },
    params: {
    
        }
  });
```   
**REST Response**


```json
{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "subscription",
	"method": "GET",
	"action": "get",
	"appVersion": "Version",
	"rowCount": 1,
	"subscription": {
		"id": "ID",
		"activatedAt": "Date",
		"cancelledAt": "Date",
		"currency": "String",
		"pricePaid": "Integer",
		"status": "Enum",
		"status_idx": "Integer",
		"statusUpdatedAt": "Date",
		"userId": "ID",
		"paymentConfirmation": "Enum",
		"paymentConfirmation_idx": "Integer",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}
```


### `List Pricingconfigs` API
**[Default list API]** — This is the designated default `list` API for the `pricingConfig` data object. Frontend generators and AI agents should use this API for standard CRUD operations.
List all pricing configuration records. Accessible to authenticated users.


**Rest Route**

The `listPricingConfigs` API REST controller can be triggered via the following route:

`/v1/pricingconfigs`


**Rest Request Parameters**
The `listPricingConfigs` api has got no request parameters.    




**REST Request**
To access the api you can use the **REST** controller with the path **GET  /v1/pricingconfigs**
```js
  axios({
    method: 'GET',
    url: '/v1/pricingconfigs',
    data: {
    
    },
    params: {
    
        }
  });
```   
**REST Response**


```json
{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "pricingConfigs",
	"method": "GET",
	"action": "list",
	"appVersion": "Version",
	"rowCount": "\"Number\"",
	"pricingConfigs": [
		{
			"id": "ID",
			"currency": "String",
			"description": "Text",
			"price": "Integer",
			"type": "Enum",
			"type_idx": "Integer",
			"isActive": true,
			"recordVersion": "Integer",
			"createdAt": "Date",
			"updatedAt": "Date",
			"_owner": "ID"
		},
		{},
		{}
	],
	"paging": {
		"pageNumber": "Number",
		"pageRowCount": "NUmber",
		"totalRowCount": "Number",
		"pageCount": "Number"
	},
	"filters": [],
	"uiPermissions": []
}
```


### `List Subscriptions` API
**[Default list API]** — This is the designated default `list` API for the `subscription` data object. Frontend generators and AI agents should use this API for standard CRUD operations.
List all subscriptions. Admin-only endpoint for monitoring subscription records.


**Rest Route**

The `listSubscriptions` API REST controller can be triggered via the following route:

`/v1/subscriptions`


**Rest Request Parameters**



**Filter Parameters**

The `listSubscriptions` api supports 3 optional filter parameters for filtering list results:

**status** (`Enum`): Current subscription status managed by Stripe payment flow.

- Single: `?status=<value>` (case-insensitive)
- Multiple: `?status=<value1>&status=<value2>`
- Null: `?status=null`


**userId** (`ID`): Reference to the user who owns this subscription.

- Single: `?userId=<value>`
- Multiple: `?userId=<value1>&userId=<value2>`
- Null: `?userId=null`


**paymentConfirmation** (`Enum`): An automatic property that is used to check the confirmed status of the payment set by webhooks.

- Single: `?paymentConfirmation=<value>` (case-insensitive)
- Multiple: `?paymentConfirmation=<value1>&paymentConfirmation=<value2>`
- Null: `?paymentConfirmation=null`



**REST Request**
To access the api you can use the **REST** controller with the path **GET  /v1/subscriptions**
```js
  axios({
    method: 'GET',
    url: '/v1/subscriptions',
    data: {
    
    },
    params: {
    
        // Filter parameters (see Filter Parameters section above)
        // status: '<value>' // Filter by status
        // userId: '<value>' // Filter by userId
        // paymentConfirmation: '<value>' // Filter by paymentConfirmation
            }
  });
```   
**REST Response**


```json
{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "subscriptions",
	"method": "GET",
	"action": "list",
	"appVersion": "Version",
	"rowCount": "\"Number\"",
	"subscriptions": [
		{
			"id": "ID",
			"activatedAt": "Date",
			"cancelledAt": "Date",
			"currency": "String",
			"pricePaid": "Integer",
			"status": "Enum",
			"status_idx": "Integer",
			"statusUpdatedAt": "Date",
			"userId": "ID",
			"paymentConfirmation": "Enum",
			"paymentConfirmation_idx": "Integer",
			"isActive": true,
			"recordVersion": "Integer",
			"createdAt": "Date",
			"updatedAt": "Date",
			"_owner": "ID"
		},
		{},
		{}
	],
	"paging": {
		"pageNumber": "Number",
		"pageRowCount": "NUmber",
		"totalRowCount": "Number",
		"pageCount": "Number"
	},
	"filters": [],
	"uiPermissions": []
}
```


### `Update Pricingconfig` API
**[Default update API]** — This is the designated default `update` API for the `pricingConfig` data object. Frontend generators and AI agents should use this API for standard CRUD operations.
Update the subscription pricing configuration. Admin-only operation for adjusting price, currency, or description without code deployment.


**Rest Route**

The `updatePricingConfig` API REST controller can be triggered via the following route:

`/v1/pricingconfigs/:pricingConfigId`


**Rest Request Parameters**


The `updatePricingConfig` api has got 5 regular request parameters  

| Parameter              | Type                   | Required | Population                   |
| ---------------------- | ---------------------- | -------- | ---------------------------- |
| pricingConfigId  | ID  | true | request.params?.["pricingConfigId"] |
| currency  | String  | false | request.body?.["currency"] |
| description  | Text  | false | request.body?.["description"] |
| price  | Integer  | false | request.body?.["price"] |
| type  | Enum  | false | request.body?.["type"] |
**pricingConfigId** : This id paremeter is used to select the required data object that will be updated
**currency** : Currency code for pricing (e.g., usd).
**description** : Human-readable description of the subscription plan.
**price** : Current subscription price in cents (e.g., 999 = $9.99).
**type** : 



**REST Request**
To access the api you can use the **REST** controller with the path **PATCH  /v1/pricingconfigs/:pricingConfigId**
```js
  axios({
    method: 'PATCH',
    url: `/v1/pricingconfigs/${pricingConfigId}`,
    data: {
            currency:"String",  
            description:"Text",  
            price:"Integer",  
            type:"Enum",  
    
    },
    params: {
    
        }
  });
```   
**REST Response**


```json
{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "pricingConfig",
	"method": "PATCH",
	"action": "update",
	"appVersion": "Version",
	"rowCount": 1,
	"pricingConfig": {
		"id": "ID",
		"currency": "String",
		"description": "Text",
		"price": "Integer",
		"type": "Enum",
		"type_idx": "Integer",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}
```


### `Create Subscription` API



**Rest Route**

The `createSubscription` API REST controller can be triggered via the following route:

`/v1/subscriptions`


**Rest Request Parameters**


The `createSubscription` api has got 5 regular request parameters  

| Parameter              | Type                   | Required | Population                   |
| ---------------------- | ---------------------- | -------- | ---------------------------- |
| activatedAt  | Date  | false | request.body?.["activatedAt"] |
| cancelledAt  | Date  | false | request.body?.["cancelledAt"] |
| currency  | String  | true | request.body?.["currency"] |
| pricePaid  | Integer  | true | request.body?.["pricePaid"] |
| statusUpdatedAt  | Date  | false | request.body?.["statusUpdatedAt"] |
**activatedAt** : Timestamp when the subscription was activated after successful payment.
**cancelledAt** : Timestamp when the subscription was cancelled by the user.
**currency** : Currency code for the payment (e.g., usd).
**pricePaid** : Amount paid in cents at the time of subscription activation.
**statusUpdatedAt** : Timestamp of the last status update, auto-managed by Stripe payment flow.



**REST Request**
To access the api you can use the **REST** controller with the path **POST  /v1/subscriptions**
```js
  axios({
    method: 'POST',
    url: '/v1/subscriptions',
    data: {
            activatedAt:"Date",  
            cancelledAt:"Date",  
            currency:"String",  
            pricePaid:"Integer",  
            statusUpdatedAt:"Date",  
    
    },
    params: {
    
        }
  });
```   
**REST Response**


```json
{
	"status": "OK",
	"statusCode": "201",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "subscription",
	"method": "POST",
	"action": "create",
	"appVersion": "Version",
	"rowCount": 1,
	"subscription": {
		"id": "ID",
		"activatedAt": "Date",
		"cancelledAt": "Date",
		"currency": "String",
		"pricePaid": "Integer",
		"status": "Enum",
		"status_idx": "Integer",
		"statusUpdatedAt": "Date",
		"userId": "ID",
		"paymentConfirmation": "Enum",
		"paymentConfirmation_idx": "Integer",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}
```


### `Do Test` API



**Rest Route**

The `test` API REST controller can be triggered via the following route:

`/v1/test`


**Rest Request Parameters**
The `test` api has got no request parameters.    




**REST Request**
To access the api you can use the **REST** controller with the path **GET  /v1/test**
```js
  axios({
    method: 'GET',
    url: '/v1/test',
    data: {
    
    },
    params: {
    
        }
  });
```   
**REST Response**


```json
{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "pricingConfigs",
	"method": "GET",
	"action": "list",
	"appVersion": "Version",
	"rowCount": "\"Number\"",
	"pricingConfigs": [
		{
			"id": "ID",
			"currency": "String",
			"description": "Text",
			"price": "Integer",
			"type": "Enum",
			"type_idx": "Integer",
			"isActive": true,
			"recordVersion": "Integer",
			"createdAt": "Date",
			"updatedAt": "Date",
			"_owner": "ID"
		},
		{},
		{}
	],
	"paging": {
		"pageNumber": "Number",
		"pageRowCount": "NUmber",
		"totalRowCount": "Number",
		"pageCount": "Number"
	},
	"filters": [],
	"uiPermissions": []
}
```


### `Get Subscriptionpayment` API
This route is used to get the payment information by ID.


**Rest Route**

The `getSubscriptionPayment` API REST controller can be triggered via the following route:

`/v1/subscriptionpayment/:sys_subscriptionPaymentId`


**Rest Request Parameters**


The `getSubscriptionPayment` api has got 1 regular request parameter  

| Parameter              | Type                   | Required | Population                   |
| ---------------------- | ---------------------- | -------- | ---------------------------- |
| sys_subscriptionPaymentId  | ID  | true | request.params?.["sys_subscriptionPaymentId"] |
**sys_subscriptionPaymentId** : This id paremeter is used to query the required data object.



**REST Request**
To access the api you can use the **REST** controller with the path **GET  /v1/subscriptionpayment/:sys_subscriptionPaymentId**
```js
  axios({
    method: 'GET',
    url: `/v1/subscriptionpayment/${sys_subscriptionPaymentId}`,
    data: {
    
    },
    params: {
    
        }
  });
```   
**REST Response**


```json
{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "sys_subscriptionPayment",
	"method": "GET",
	"action": "get",
	"appVersion": "Version",
	"rowCount": 1,
	"sys_subscriptionPayment": {
		"id": "ID",
		"ownerId": "ID",
		"orderId": "ID",
		"paymentId": "String",
		"paymentStatus": "String",
		"statusLiteral": "String",
		"redirectUrl": "String",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}
```


### `List Subscriptionpayments` API
This route is used to list all payments.


**Rest Route**

The `listSubscriptionPayments` API REST controller can be triggered via the following route:

`/v1/subscriptionpayments`


**Rest Request Parameters**



**Filter Parameters**

The `listSubscriptionPayments` api supports 6 optional filter parameters for filtering list results:

**ownerId** (`ID`):  An ID value to represent owner user who created the order

- Single: `?ownerId=<value>`
- Multiple: `?ownerId=<value1>&ownerId=<value2>`
- Null: `?ownerId=null`


**orderId** (`ID`): an ID value to represent the orderId which is the ID parameter of the source subscription object

- Single: `?orderId=<value>`
- Multiple: `?orderId=<value1>&orderId=<value2>`
- Null: `?orderId=null`


**paymentId** (`String`): A String value to represent the paymentId which is generated on the Stripe gateway. This id may represent different objects due to the payment gateway and the chosen flow type

- Single (partial match, case-insensitive): `?paymentId=<value>`
- Multiple: `?paymentId=<value1>&paymentId=<value2>`
- Null: `?paymentId=null`


**paymentStatus** (`String`): A string value to represent the payment status which belongs to the lifecyle of a Stripe payment.

- Single (partial match, case-insensitive): `?paymentStatus=<value>`
- Multiple: `?paymentStatus=<value1>&paymentStatus=<value2>`
- Null: `?paymentStatus=null`


**statusLiteral** (`String`): A string value to represent the logical payment status which belongs to the application lifecycle itself.

- Single (partial match, case-insensitive): `?statusLiteral=<value>`
- Multiple: `?statusLiteral=<value1>&statusLiteral=<value2>`
- Null: `?statusLiteral=null`


**redirectUrl** (`String`): A string value to represent return page of the frontend to show the result of the payment, this is used when the callback is made to server not the client.

- Single (partial match, case-insensitive): `?redirectUrl=<value>`
- Multiple: `?redirectUrl=<value1>&redirectUrl=<value2>`
- Null: `?redirectUrl=null`



**REST Request**
To access the api you can use the **REST** controller with the path **GET  /v1/subscriptionpayments**
```js
  axios({
    method: 'GET',
    url: '/v1/subscriptionpayments',
    data: {
    
    },
    params: {
    
        // Filter parameters (see Filter Parameters section above)
        // ownerId: '<value>' // Filter by ownerId
        // orderId: '<value>' // Filter by orderId
        // paymentId: '<value>' // Filter by paymentId
        // paymentStatus: '<value>' // Filter by paymentStatus
        // statusLiteral: '<value>' // Filter by statusLiteral
        // redirectUrl: '<value>' // Filter by redirectUrl
            }
  });
```   
**REST Response**


```json
{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "sys_subscriptionPayments",
	"method": "GET",
	"action": "list",
	"appVersion": "Version",
	"rowCount": "\"Number\"",
	"sys_subscriptionPayments": [
		{
			"id": "ID",
			"ownerId": "ID",
			"orderId": "ID",
			"paymentId": "String",
			"paymentStatus": "String",
			"statusLiteral": "String",
			"redirectUrl": "String",
			"isActive": true,
			"recordVersion": "Integer",
			"createdAt": "Date",
			"updatedAt": "Date",
			"_owner": "ID"
		},
		{},
		{}
	],
	"paging": {
		"pageNumber": "Number",
		"pageRowCount": "NUmber",
		"totalRowCount": "Number",
		"pageCount": "Number"
	},
	"filters": [],
	"uiPermissions": []
}
```


### `Create Subscriptionpayment` API
This route is used to create a new payment.


**Rest Route**

The `createSubscriptionPayment` API REST controller can be triggered via the following route:

`/v1/subscriptionpayment`


**Rest Request Parameters**


The `createSubscriptionPayment` api has got 5 regular request parameters  

| Parameter              | Type                   | Required | Population                   |
| ---------------------- | ---------------------- | -------- | ---------------------------- |
| orderId  | ID  | true | request.body?.["orderId"] |
| paymentId  | String  | true | request.body?.["paymentId"] |
| paymentStatus  | String  | true | request.body?.["paymentStatus"] |
| statusLiteral  | String  | true | request.body?.["statusLiteral"] |
| redirectUrl  | String  | false | request.body?.["redirectUrl"] |
**orderId** : an ID value to represent the orderId which is the ID parameter of the source subscription object
**paymentId** : A String value to represent the paymentId which is generated on the Stripe gateway. This id may represent different objects due to the payment gateway and the chosen flow type
**paymentStatus** : A string value to represent the payment status which belongs to the lifecyle of a Stripe payment.
**statusLiteral** : A string value to represent the logical payment status which belongs to the application lifecycle itself.
**redirectUrl** : A string value to represent return page of the frontend to show the result of the payment, this is used when the callback is made to server not the client.



**REST Request**
To access the api you can use the **REST** controller with the path **POST  /v1/subscriptionpayment**
```js
  axios({
    method: 'POST',
    url: '/v1/subscriptionpayment',
    data: {
            orderId:"ID",  
            paymentId:"String",  
            paymentStatus:"String",  
            statusLiteral:"String",  
            redirectUrl:"String",  
    
    },
    params: {
    
        }
  });
```   
**REST Response**


```json
{
	"status": "OK",
	"statusCode": "201",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "sys_subscriptionPayment",
	"method": "POST",
	"action": "create",
	"appVersion": "Version",
	"rowCount": 1,
	"sys_subscriptionPayment": {
		"id": "ID",
		"ownerId": "ID",
		"orderId": "ID",
		"paymentId": "String",
		"paymentStatus": "String",
		"statusLiteral": "String",
		"redirectUrl": "String",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}
```


### `Update Subscriptionpayment` API
This route is used to update an existing payment.


**Rest Route**

The `updateSubscriptionPayment` API REST controller can be triggered via the following route:

`/v1/subscriptionpayment/:sys_subscriptionPaymentId`


**Rest Request Parameters**


The `updateSubscriptionPayment` api has got 5 regular request parameters  

| Parameter              | Type                   | Required | Population                   |
| ---------------------- | ---------------------- | -------- | ---------------------------- |
| sys_subscriptionPaymentId  | ID  | true | request.params?.["sys_subscriptionPaymentId"] |
| paymentId  | String  | false | request.body?.["paymentId"] |
| paymentStatus  | String  | false | request.body?.["paymentStatus"] |
| statusLiteral  | String  | false | request.body?.["statusLiteral"] |
| redirectUrl  | String  | false | request.body?.["redirectUrl"] |
**sys_subscriptionPaymentId** : This id paremeter is used to select the required data object that will be updated
**paymentId** : A String value to represent the paymentId which is generated on the Stripe gateway. This id may represent different objects due to the payment gateway and the chosen flow type
**paymentStatus** : A string value to represent the payment status which belongs to the lifecyle of a Stripe payment.
**statusLiteral** : A string value to represent the logical payment status which belongs to the application lifecycle itself.
**redirectUrl** : A string value to represent return page of the frontend to show the result of the payment, this is used when the callback is made to server not the client.



**REST Request**
To access the api you can use the **REST** controller with the path **PATCH  /v1/subscriptionpayment/:sys_subscriptionPaymentId**
```js
  axios({
    method: 'PATCH',
    url: `/v1/subscriptionpayment/${sys_subscriptionPaymentId}`,
    data: {
            paymentId:"String",  
            paymentStatus:"String",  
            statusLiteral:"String",  
            redirectUrl:"String",  
    
    },
    params: {
    
        }
  });
```   
**REST Response**


```json
{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "sys_subscriptionPayment",
	"method": "PATCH",
	"action": "update",
	"appVersion": "Version",
	"rowCount": 1,
	"sys_subscriptionPayment": {
		"id": "ID",
		"ownerId": "ID",
		"orderId": "ID",
		"paymentId": "String",
		"paymentStatus": "String",
		"statusLiteral": "String",
		"redirectUrl": "String",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}
```


### `Delete Subscriptionpayment` API
This route is used to delete a payment.


**Rest Route**

The `deleteSubscriptionPayment` API REST controller can be triggered via the following route:

`/v1/subscriptionpayment/:sys_subscriptionPaymentId`


**Rest Request Parameters**


The `deleteSubscriptionPayment` api has got 1 regular request parameter  

| Parameter              | Type                   | Required | Population                   |
| ---------------------- | ---------------------- | -------- | ---------------------------- |
| sys_subscriptionPaymentId  | ID  | true | request.params?.["sys_subscriptionPaymentId"] |
**sys_subscriptionPaymentId** : This id paremeter is used to select the required data object that will be deleted



**REST Request**
To access the api you can use the **REST** controller with the path **DELETE  /v1/subscriptionpayment/:sys_subscriptionPaymentId**
```js
  axios({
    method: 'DELETE',
    url: `/v1/subscriptionpayment/${sys_subscriptionPaymentId}`,
    data: {
    
    },
    params: {
    
        }
  });
```   
**REST Response**


```json
{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "sys_subscriptionPayment",
	"method": "DELETE",
	"action": "delete",
	"appVersion": "Version",
	"rowCount": 1,
	"sys_subscriptionPayment": {
		"id": "ID",
		"ownerId": "ID",
		"orderId": "ID",
		"paymentId": "String",
		"paymentStatus": "String",
		"statusLiteral": "String",
		"redirectUrl": "String",
		"isActive": false,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}
```


### `Get Subscriptionpaymentbyorderid` API
This route is used to get the payment information by order id.


**Rest Route**

The `getSubscriptionPaymentByOrderId` API REST controller can be triggered via the following route:

`/v1/subscriptionpaymentbyorderid/:orderId`


**Rest Request Parameters**


The `getSubscriptionPaymentByOrderId` api has got 1 regular request parameter  

| Parameter              | Type                   | Required | Population                   |
| ---------------------- | ---------------------- | -------- | ---------------------------- |
| orderId  | ID  | true | request.params?.["orderId"] |
**orderId** : an ID value to represent the orderId which is the ID parameter of the source subscription object. The parameter is used to query data.



**REST Request**
To access the api you can use the **REST** controller with the path **GET  /v1/subscriptionpaymentbyorderid/:orderId**
```js
  axios({
    method: 'GET',
    url: `/v1/subscriptionpaymentbyorderid/${orderId}`,
    data: {
    
    },
    params: {
    
        }
  });
```   
**REST Response**


```json
{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "sys_subscriptionPayment",
	"method": "GET",
	"action": "get",
	"appVersion": "Version",
	"rowCount": 1,
	"sys_subscriptionPayment": {
		"id": "ID",
		"ownerId": "ID",
		"orderId": "ID",
		"paymentId": "String",
		"paymentStatus": "String",
		"statusLiteral": "String",
		"redirectUrl": "String",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}
```


### `Get Subscriptionpaymentbypaymentid` API
This route is used to get the payment information by payment id.


**Rest Route**

The `getSubscriptionPaymentByPaymentId` API REST controller can be triggered via the following route:

`/v1/subscriptionpaymentbypaymentid/:paymentId`


**Rest Request Parameters**


The `getSubscriptionPaymentByPaymentId` api has got 1 regular request parameter  

| Parameter              | Type                   | Required | Population                   |
| ---------------------- | ---------------------- | -------- | ---------------------------- |
| paymentId  | String  | true | request.params?.["paymentId"] |
**paymentId** : A String value to represent the paymentId which is generated on the Stripe gateway. This id may represent different objects due to the payment gateway and the chosen flow type. The parameter is used to query data.



**REST Request**
To access the api you can use the **REST** controller with the path **GET  /v1/subscriptionpaymentbypaymentid/:paymentId**
```js
  axios({
    method: 'GET',
    url: `/v1/subscriptionpaymentbypaymentid/${paymentId}`,
    data: {
    
    },
    params: {
    
        }
  });
```   
**REST Response**


```json
{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "sys_subscriptionPayment",
	"method": "GET",
	"action": "get",
	"appVersion": "Version",
	"rowCount": 1,
	"sys_subscriptionPayment": {
		"id": "ID",
		"ownerId": "ID",
		"orderId": "ID",
		"paymentId": "String",
		"paymentStatus": "String",
		"statusLiteral": "String",
		"redirectUrl": "String",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}
```


### `Start Subscriptionpayment` API
Start payment for subscription


**Rest Route**

The `startSubscriptionPayment` API REST controller can be triggered via the following route:

`/v1/startsubscriptionpayment/:subscriptionId`


**Rest Request Parameters**


The `startSubscriptionPayment` api has got 2 regular request parameters  

| Parameter              | Type                   | Required | Population                   |
| ---------------------- | ---------------------- | -------- | ---------------------------- |
| subscriptionId  | ID  | true | request.params?.["subscriptionId"] |
| paymentUserParams  | Object  | true | request.body?.["paymentUserParams"] |
**subscriptionId** : This id paremeter is used to select the required data object that will be updated
**paymentUserParams** : The user parameters that should be defined to start a stripe payment process. Must include paymentMethodId.



**REST Request**
To access the api you can use the **REST** controller with the path **PATCH  /v1/startsubscriptionpayment/:subscriptionId**
```js
  axios({
    method: 'PATCH',
    url: `/v1/startsubscriptionpayment/${subscriptionId}`,
    data: {
            paymentUserParams:"Object",  
    
    },
    params: {
    
        }
  });
```   
**REST Response**


```json
{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "subscription",
	"method": "PATCH",
	"action": "update",
	"appVersion": "Version",
	"rowCount": 1,
	"subscription": {
		"id": "ID",
		"activatedAt": "Date",
		"cancelledAt": "Date",
		"currency": "String",
		"pricePaid": "Integer",
		"status": "Enum",
		"status_idx": "Integer",
		"statusUpdatedAt": "Date",
		"userId": "ID",
		"paymentConfirmation": "Enum",
		"paymentConfirmation_idx": "Integer",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	},
	"paymentResult": {
		"paymentTicketId": "ID",
		"orderId": "ID",
		"paymentId": "String",
		"paymentStatus": "Enum",
		"paymentIntentInfo": "Object",
		"statusLiteral": "String",
		"amount": "Double",
		"currency": "String",
		"success": true,
		"description": "String",
		"metadata": "Object",
		"paymentUserParams": "Object"
	}
}
```


### `Refresh Subscriptionpayment` API
Refresh payment info for subscription from Stripe


**Rest Route**

The `refreshSubscriptionPayment` API REST controller can be triggered via the following route:

`/v1/refreshsubscriptionpayment/:subscriptionId`


**Rest Request Parameters**


The `refreshSubscriptionPayment` api has got 2 regular request parameters  

| Parameter              | Type                   | Required | Population                   |
| ---------------------- | ---------------------- | -------- | ---------------------------- |
| subscriptionId  | ID  | true | request.params?.["subscriptionId"] |
| paymentUserParams  | Object  | false | request.body?.["paymentUserParams"] |
**subscriptionId** : This id paremeter is used to select the required data object that will be updated
**paymentUserParams** : The user parameters that should be defined to refresh a stripe payment process



**REST Request**
To access the api you can use the **REST** controller with the path **PATCH  /v1/refreshsubscriptionpayment/:subscriptionId**
```js
  axios({
    method: 'PATCH',
    url: `/v1/refreshsubscriptionpayment/${subscriptionId}`,
    data: {
            paymentUserParams:"Object",  
    
    },
    params: {
    
        }
  });
```   
**REST Response**


```json
{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "subscription",
	"method": "PATCH",
	"action": "update",
	"appVersion": "Version",
	"rowCount": 1,
	"subscription": {
		"id": "ID",
		"activatedAt": "Date",
		"cancelledAt": "Date",
		"currency": "String",
		"pricePaid": "Integer",
		"status": "Enum",
		"status_idx": "Integer",
		"statusUpdatedAt": "Date",
		"userId": "ID",
		"paymentConfirmation": "Enum",
		"paymentConfirmation_idx": "Integer",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	},
	"paymentResult": {
		"paymentTicketId": "ID",
		"orderId": "ID",
		"paymentId": "String",
		"paymentStatus": "Enum",
		"paymentIntentInfo": "Object",
		"statusLiteral": "String",
		"amount": "Double",
		"currency": "String",
		"success": true,
		"description": "String",
		"metadata": "Object",
		"paymentUserParams": "Object"
	}
}
```


### `Callback Subscriptionpayment` API
Refresh payment values by gateway webhook call for subscription


**Rest Route**

The `callbackSubscriptionPayment` API REST controller can be triggered via the following route:

`/v1/callbacksubscriptionpayment`


**Rest Request Parameters**


The `callbackSubscriptionPayment` api has got 1 regular request parameter  

| Parameter              | Type                   | Required | Population                   |
| ---------------------- | ---------------------- | -------- | ---------------------------- |
| subscriptionId  | ID  | false | request.body?.["subscriptionId"] |
**subscriptionId** : The order id parameter that will be read from webhook callback params



**REST Request**
To access the api you can use the **REST** controller with the path **POST  /v1/callbacksubscriptionpayment**
```js
  axios({
    method: 'POST',
    url: '/v1/callbacksubscriptionpayment',
    data: {
            subscriptionId:"ID",  
    
    },
    params: {
    
        }
  });
```   
**REST Response**


```json
{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "subscription",
	"method": "POST",
	"action": "update",
	"appVersion": "Version",
	"rowCount": 1,
	"subscription": {
		"id": "ID",
		"activatedAt": "Date",
		"cancelledAt": "Date",
		"currency": "String",
		"pricePaid": "Integer",
		"status": "Enum",
		"status_idx": "Integer",
		"statusUpdatedAt": "Date",
		"userId": "ID",
		"paymentConfirmation": "Enum",
		"paymentConfirmation_idx": "Integer",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	},
	"paymentResult": {
		"paymentTicketId": "ID",
		"orderId": "ID",
		"paymentId": "String",
		"paymentStatus": "Enum",
		"paymentIntentInfo": "Object",
		"statusLiteral": "String",
		"amount": "Double",
		"currency": "String",
		"success": true,
		"description": "String",
		"metadata": "Object",
		"paymentUserParams": "Object"
	}
}
```


### `Get Paymentcustomerbyuserid` API
This route is used to get the payment customer information by user id.


**Rest Route**

The `getPaymentCustomerByUserId` API REST controller can be triggered via the following route:

`/v1/paymentcustomers/:userId`


**Rest Request Parameters**


The `getPaymentCustomerByUserId` api has got 1 regular request parameter  

| Parameter              | Type                   | Required | Population                   |
| ---------------------- | ---------------------- | -------- | ---------------------------- |
| userId  | ID  | true | request.params?.["userId"] |
**userId** :  An ID value to represent the user who is created as a stripe customer. The parameter is used to query data.



**REST Request**
To access the api you can use the **REST** controller with the path **GET  /v1/paymentcustomers/:userId**
```js
  axios({
    method: 'GET',
    url: `/v1/paymentcustomers/${userId}`,
    data: {
    
    },
    params: {
    
        }
  });
```   
**REST Response**


```json
{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "sys_paymentCustomer",
	"method": "GET",
	"action": "get",
	"appVersion": "Version",
	"rowCount": 1,
	"sys_paymentCustomer": {
		"id": "ID",
		"userId": "ID",
		"customerId": "String",
		"platform": "String",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}
```


### `List Paymentcustomers` API
This route is used to list all payment customers.


**Rest Route**

The `listPaymentCustomers` API REST controller can be triggered via the following route:

`/v1/paymentcustomers`


**Rest Request Parameters**



**Filter Parameters**

The `listPaymentCustomers` api supports 3 optional filter parameters for filtering list results:

**userId** (`ID`):  An ID value to represent the user who is created as a stripe customer

- Single: `?userId=<value>`
- Multiple: `?userId=<value1>&userId=<value2>`
- Null: `?userId=null`


**customerId** (`String`): A string value to represent the customer id which is generated on the Stripe gateway. This id is used to represent the customer in the Stripe gateway

- Single (partial match, case-insensitive): `?customerId=<value>`
- Multiple: `?customerId=<value1>&customerId=<value2>`
- Null: `?customerId=null`


**platform** (`String`): A String value to represent payment platform which is used to make the payment. It is stripe as default. It will be used to distinguesh the payment gateways in the future.

- Single (partial match, case-insensitive): `?platform=<value>`
- Multiple: `?platform=<value1>&platform=<value2>`
- Null: `?platform=null`



**REST Request**
To access the api you can use the **REST** controller with the path **GET  /v1/paymentcustomers**
```js
  axios({
    method: 'GET',
    url: '/v1/paymentcustomers',
    data: {
    
    },
    params: {
    
        // Filter parameters (see Filter Parameters section above)
        // userId: '<value>' // Filter by userId
        // customerId: '<value>' // Filter by customerId
        // platform: '<value>' // Filter by platform
            }
  });
```   
**REST Response**


```json
{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "sys_paymentCustomers",
	"method": "GET",
	"action": "list",
	"appVersion": "Version",
	"rowCount": "\"Number\"",
	"sys_paymentCustomers": [
		{
			"id": "ID",
			"userId": "ID",
			"customerId": "String",
			"platform": "String",
			"isActive": true,
			"recordVersion": "Integer",
			"createdAt": "Date",
			"updatedAt": "Date",
			"_owner": "ID"
		},
		{},
		{}
	],
	"paging": {
		"pageNumber": "Number",
		"pageRowCount": "NUmber",
		"totalRowCount": "Number",
		"pageCount": "Number"
	},
	"filters": [],
	"uiPermissions": []
}
```


### `List Paymentcustomermethods` API
This route is used to list all payment customer methods.


**Rest Route**

The `listPaymentCustomerMethods` API REST controller can be triggered via the following route:

`/v1/paymentcustomermethods/:userId`


**Rest Request Parameters**


The `listPaymentCustomerMethods` api has got 1 regular request parameter  

| Parameter              | Type                   | Required | Population                   |
| ---------------------- | ---------------------- | -------- | ---------------------------- |
| userId  | ID  | true | request.params?.["userId"] |
**userId** :  An ID value to represent the user who owns the payment method. The parameter is used to query data.


**Filter Parameters**

The `listPaymentCustomerMethods` api supports 6 optional filter parameters for filtering list results:

**paymentMethodId** (`String`): A string value to represent the id of the payment method on the payment platform.

- Single (partial match, case-insensitive): `?paymentMethodId=<value>`
- Multiple: `?paymentMethodId=<value1>&paymentMethodId=<value2>`
- Null: `?paymentMethodId=null`


**customerId** (`String`): A string value to represent the customer id which is generated on the payment gateway.

- Single (partial match, case-insensitive): `?customerId=<value>`
- Multiple: `?customerId=<value1>&customerId=<value2>`
- Null: `?customerId=null`


**cardHolderName** (`String`): A string value to represent the name of the card holder. It can be different than the registered customer.

- Single (partial match, case-insensitive): `?cardHolderName=<value>`
- Multiple: `?cardHolderName=<value1>&cardHolderName=<value2>`
- Null: `?cardHolderName=null`


**cardHolderZip** (`String`): A string value to represent the zip code of the card holder. It is used for address verification in specific countries.

- Single (partial match, case-insensitive): `?cardHolderZip=<value>`
- Multiple: `?cardHolderZip=<value1>&cardHolderZip=<value2>`
- Null: `?cardHolderZip=null`


**platform** (`String`): A String value to represent payment platform which teh paymentMethod belongs. It is stripe as default. It will be used to distinguesh the payment gateways in the future.

- Single (partial match, case-insensitive): `?platform=<value>`
- Multiple: `?platform=<value1>&platform=<value2>`
- Null: `?platform=null`


**cardInfo** (`Object`): A Json value to store the card details of the payment method.

- Single: `?cardInfo=<value>`
- Multiple: `?cardInfo=<value1>&cardInfo=<value2>`
- Null: `?cardInfo=null`


**REST Request**
To access the api you can use the **REST** controller with the path **GET  /v1/paymentcustomermethods/:userId**
```js
  axios({
    method: 'GET',
    url: `/v1/paymentcustomermethods/${userId}`,
    data: {
    
    },
    params: {
    
        // Filter parameters (see Filter Parameters section above)
        // paymentMethodId: '<value>' // Filter by paymentMethodId
        // customerId: '<value>' // Filter by customerId
        // cardHolderName: '<value>' // Filter by cardHolderName
        // cardHolderZip: '<value>' // Filter by cardHolderZip
        // platform: '<value>' // Filter by platform
        // cardInfo: '<value>' // Filter by cardInfo
            }
  });
```   
**REST Response**


```json
{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "sys_paymentMethods",
	"method": "GET",
	"action": "list",
	"appVersion": "Version",
	"rowCount": "\"Number\"",
	"sys_paymentMethods": [
		{
			"id": "ID",
			"paymentMethodId": "String",
			"userId": "ID",
			"customerId": "String",
			"cardHolderName": "String",
			"cardHolderZip": "String",
			"platform": "String",
			"cardInfo": "Object",
			"isActive": true,
			"recordVersion": "Integer",
			"createdAt": "Date",
			"updatedAt": "Date",
			"_owner": "ID"
		},
		{},
		{}
	],
	"paging": {
		"pageNumber": "Number",
		"pageRowCount": "NUmber",
		"totalRowCount": "Number",
		"pageCount": "Number"
	},
	"filters": [],
	"uiPermissions": []
}
```




### Authentication Specific Routes



### Common Routes

### Route: currentuser

*Route Definition*: Retrieves the currently authenticated user's session information.

*Route Type*: sessionInfo

*Access Route*: `GET /currentuser`

#### Parameters

This route does **not** require any request parameters.

#### Behavior

- Returns the authenticated session object associated with the current access token.
- If no valid session exists, responds with a 401 Unauthorized.

```js
// Sample GET /currentuser call
axios.get("/currentuser", {
  headers: {
    "Authorization": "Bearer your-jwt-token"
  }
});
````
**Success Response**
Returns the session object, including user-related data and token information.
````
{
  "sessionId": "9cf23fa8-07d4-4e7c-80a6-ec6d6ac96bb9",
  "userId": "d92b9d4c-9b1e-4e95-842e-3fb9c8c1df38",
  "email": "user@example.com",
  "fullname": "John Doe",
  "roleId": "user",
  "tenantId": "abc123",
  "accessToken": "jwt-token-string",
  ...
}
````
**Error Response**
**401 Unauthorized:** No active session found.
````
{
  "status": "ERR",
  "message": "No login found"
}
````

**Notes**
* This route is typically used by frontend or mobile applications to fetch the current session state after login.
* The returned session includes key user identity fields, tenant information (if applicable), and the access token for further authenticated requests.
* Always ensure a valid access token is provided in the request to retrieve the session.

### Route: permissions

`*Route Definition*`: Retrieves all effective permission records assigned to the currently authenticated user.

`*Route Type*`: permissionFetch

*Access Route*: `GET /permissions`

#### Parameters

This route does **not** require any request parameters.

#### Behavior

- Fetches all active permission records (`givenPermissions` entries) associated with the current user session.
- Returns a full array of permission objects.
- Requires a valid session (`access token`) to be available.

```js
// Sample GET /permissions call
axios.get("/permissions", {
  headers: {
    "Authorization": "Bearer your-jwt-token"
  }
});
````
**Success Response**

Returns an array of permission objects.
```json
[
  {
    "id": "perm1",
    "permissionName": "adminPanel.access",
    "roleId": "admin",
    "subjectUserId": "d92b9d4c-9b1e-4e95-842e-3fb9c8c1df38",
    "subjectUserGroupId": null,
    "objectId": null,
    "canDo": true,
    "tenantCodename": "store123"
  },
  {
    "id": "perm2",
    "permissionName": "orders.manage",
    "roleId": null,
    "subjectUserId": "d92b9d4c-9b1e-4e95-842e-3fb9c8c1df38",
    "subjectUserGroupId": null,
    "objectId": null,
    "canDo": true,
    "tenantCodename": "store123"
  }
]
````
Each object reflects a single permission grant, aligned with the givenPermissions model:

- `**permissionName**`: The permission the user has.
- `**roleId**`: If the permission was granted through a role.
-` **subjectUserId**`: If directly granted to the user.
- `**subjectUserGroupId**`: If granted through a group.
- `**objectId**`: If tied to a specific object (OBAC).
- `**canDo**`: True or false flag to represent if permission is active or restricted.

**Error Responses**
* **401 Unauthorized**: No active session found.
```json
{
  "status": "ERR",
  "message": "No login found"
}
````
* **500 Internal Server Error**: Unexpected error fetching permissions.

**Notes**
* The /permissions route is available across all backend services generated by Mindbricks, not just the auth service.
* Auth service: Fetches permissions freshly from the live database (givenPermissions table).
* Other services: Typically use a cached or projected view of permissions stored in a common ElasticSearch store, optimized for faster authorization checks.

> **Tip**:
> Applications can cache permission results client-side or server-side, but should occasionally refresh by calling this endpoint, especially after login or permission-changing operations.

### Route: permissions/:permissionName

*Route Definition*: Checks whether the current user has access to a specific permission, and provides a list of scoped object exceptions or inclusions.

*Route Type*: permissionScopeCheck

*Access Route*: `GET /permissions/:permissionName`

#### Parameters

| Parameter         | Type   | Required | Population             |
|------------------|--------|----------|------------------------|
| permissionName   | String | Yes      | `request.params.permissionName` |

#### Behavior

- Evaluates whether the current user **has access** to the given `permissionName`.
- Returns a structured object indicating:
  - Whether the permission is generally granted (`canDo`)
  - Which object IDs are explicitly included or excluded from access (`exceptions`)
- Requires a valid session (`access token`).

```js
// Sample GET /permissions/orders.manage
axios.get("/permissions/orders.manage", {
  headers: {
    "Authorization": "Bearer your-jwt-token"
  }
});
````

**Success Response**

```json
{
  "canDo": true,
  "exceptions": [
    "a1f2e3d4-xxxx-yyyy-zzzz-object1",
    "b2c3d4e5-xxxx-yyyy-zzzz-object2"
  ]
}
````

* If `canDo` is `true`, the user generally has the permission, but not for the objects listed in `exceptions` (i.e., restrictions).
* If `canDo` is `false`, the user does not have the permission by default — but only for the objects in `exceptions`, they do have permission (i.e., selective overrides).
* The exceptions array contains valid **UUID strings**, each corresponding to an object ID (typically from the data model targeted by the permission).

## Copyright
All sources, documents and other digital materials are copyright of .

## About Us
For more information please visit our website: .

.
.