Skip to content
API & INTEGRATION/
/Contract Items

Monitoring - One Platform Organizations Integration API (v1)

Monitoring - Public endpoints to integrate Organization with One Platform

Download OpenAPI description
organizations.json
organizations.yaml
Languages
Servers
https://docs.namirial.app

Consumptions

Show consumptions of your product in One Platform

Operations

Business Relations

Operations

Consumers

Operations

Contract Items

Operations

GET_v1_organizations_id_contract-item-rules

Request

Security policies: OrganizationOrGlobalContractView

Security
OpenIdConnect
Query
contractTypestring

The contract type to filter rules by.

skuIdstring

The sku identifier to filter rules by.

curl -i -X GET \
  'https://docs.namirial.app/v1/organizations/{id}/contract-item-rules?contractType=string&skuId=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

GET_v1_organizations_id_contracts_contractId_contract-item-rules

Request

Security policies: OrganizationOrGlobalContractView

Security
OpenIdConnect
Path
contractIdstringrequired
curl -i -X GET \
  'https://docs.namirial.app/v1/organizations/{id}/contracts/{contractId}/contract-item-rules' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Create a contract item on given contract

Request

Security policies: OrganizationOrGlobalContractCreate

Security
OpenIdConnect
Path
contractIdstringrequired

The identifier of the contract.

Bodyapplication/jsonrequired
productIdstring

Unique identifier of product associated to this contract item

resellContractItemIdstring or null

Reseller contract item identifier related to this contract item

parentIdstring or null

Parent contract item identifier. When set, onboarding info may be resolved from parent SKU overrides.

skuIdstring

Sku identifier code of this contract item

descriptionstring

Description for this contract item

billingModelIdstring

Billing model identifier for this contract item

billingModelParametersobject

Billing model parameters for this contract item

Example: {"your-parameter":"value of parameter"}
businessRelationIdstring

Business relation model identifier for this contract item

channelstring or null

Sales or acquisition channel associated with this contract item

subscriptionIdstring

Subscription identifier for this contract item

skuParametersobject

Sku parameters for this contract item

featureIdsArray of strings

SKU feature identifiers selected for this contract item.

dataSourcesobject

Values resolved for external data sources referenced by SKU parameters

signedboolean

Indicates whether this contract item is signed or not.

provisionedboolean

Indicates whether this contract item is provisioned or not.

startDatestring(date)

Date and time indicating starting date for this contract item.

Example: "2023-11-28"
endDatestring or null(date)

Date and time indicating ending date for this contract item.

Example: "2023-11-29"
quantityinteger(int32)

Quantity for this contract item.

envelopeParametersArray of objects(ContractItemEnvelopeParametersDto)

Documents parameters for this contract item.

onboardingExtraParametersobject or null

Extra parameters supporting the onboarding process.

userIdstring or null

MyNamirial user identifier of this contract item (optional).

skustring
Deprecated

🗑️ DEPRECATED (Will no longer be available in the next release) 🗑️: This property is DEPRECATED and will be removed on 2026-04-01, use property 'SkuId' instead.

curl -i -X POST \
  'https://docs.namirial.app/v1/organizations/{id}/contracts/{contractId}/contract-items' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "productId": "string",
    "resellContractItemId": "string",
    "parentId": "string",
    "sku": "string",
    "skuId": "string",
    "description": "string",
    "billingModelId": "string",
    "billingModelParameters": {
      "your-parameter": "value of parameter"
    },
    "businessRelationId": "string",
    "channel": "string",
    "subscriptionId": "string",
    "skuParameters": {
      "property1": "string",
      "property2": "string"
    },
    "featureIds": [
      "string"
    ],
    "dataSources": {
      "property1": [
        {
          "value": "string",
          "label": {
            "en": "parameter label in english",
            "it": "label del parametro in italiano",
            "de": "...",
            "fr": "...",
            "es": "...",
            "pt": "...",
            "ro": "..."
          }
        }
      ],
      "property2": [
        {
          "value": "string",
          "label": {
            "en": "parameter label in english",
            "it": "label del parametro in italiano",
            "de": "...",
            "fr": "...",
            "es": "...",
            "pt": "...",
            "ro": "..."
          }
        }
      ]
    },
    "signed": true,
    "provisioned": true,
    "startDate": "2023-11-28",
    "endDate": "2023-11-29",
    "quantity": 0,
    "envelopeParameters": [
      {
        "documentId": "string",
        "version": 0,
        "recipient": {
          "name": "string",
          "surname": "string",
          "email": "string",
          "phoneNumber": "string",
          "language": "string"
        },
        "requestedLanguage": "string",
        "resolvedLanguage": "string",
        "parameters": {
          "property1": "string",
          "property2": "string"
        }
      }
    ],
    "onboardingExtraParameters": {
      "property1": "string",
      "property2": "string"
    },
    "userId": "string"
  }'

Responses

OK

Bodyapplication/json
idstring
Response
application/json
{
  "id": "string"
}

Contracts

Operations

Counters

Operations

Product Metrics

Operations

Service Activation Groups

Operations