Update ProductSubscription

Updates an existing ProductSubscription. Product subscriptions link organizations to purchased products.

PUT /api/product-subscriptions/{id}

Update ProductSubscription

cURL

curl --request PUT \
  --url https://platform.kodexa.ai/api/product-subscriptions/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "changeSequence": 123,
  "organization": {
    "authGroupLink": {
      "authGroup": "<string>"
    },
    "changeSequence": 123,
    "createdOn": "2023-11-07T05:31:56Z",
    "defaultToPrivateTemplates": true,
    "description": "Document processing organization for Acme Corp.",
    "enterpriseOrganization": true,
    "features": {},
    "hasImage": true,
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "memory": {
      "orderedDashboards": [
        "<string>"
      ]
    },
    "name": "Acme Corp",
    "organizationStatus": "ACTIVE",
    "properties": {},
    "publicAccess": true,
    "searchText": "<string>",
    "slug": "acme-corp",
    "stripeCustomerId": "<string>",
    "supportAccess": true,
    "supportAccessExpiresAt": "2023-11-07T05:31:56Z",
    "updatedOn": "2023-11-07T05:31:56Z",
    "uuid": "550e8400e29b41d4a716446655440000",
    "archived": true
  },
  "product": {
    "changeSequence": 123,
    "createdOn": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "id": "<string>",
    "imageUrl": "<string>",
    "name": "<string>",
    "overviewMarkdown": "<string>",
    "productGroup": {
      "active": true,
      "changeSequence": 123,
      "createdOn": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "id": "<string>",
      "name": "<string>",
      "order": 123,
      "overviewMarkdown": "<string>",
      "products": "<array>",
      "searchText": "<string>",
      "updatedOn": "2023-11-07T05:31:56Z",
      "uuid": "<string>"
    },
    "productGroupId": "<string>",
    "projectTemplates": [
      "<unknown>"
    ],
    "searchText": "<string>",
    "updatedOn": "2023-11-07T05:31:56Z",
    "uuid": "<string>"
  },
  "productId": "<string>",
  "quantity": 123
}
'

200

{
  "changeSequence": 123,
  "createdOn": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "organization": {
    "authGroupLink": {
      "authGroup": "<string>"
    },
    "changeSequence": 123,
    "createdOn": "2023-11-07T05:31:56Z",
    "defaultToPrivateTemplates": true,
    "description": "Document processing organization for Acme Corp.",
    "enterpriseOrganization": true,
    "features": {},
    "hasImage": true,
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "memory": {
      "orderedDashboards": [
        "<string>"
      ]
    },
    "name": "Acme Corp",
    "organizationStatus": "ACTIVE",
    "properties": {},
    "publicAccess": true,
    "searchText": "<string>",
    "slug": "acme-corp",
    "stripeCustomerId": "<string>",
    "supportAccess": true,
    "supportAccessExpiresAt": "2023-11-07T05:31:56Z",
    "updatedOn": "2023-11-07T05:31:56Z",
    "uuid": "550e8400e29b41d4a716446655440000",
    "archived": true
  },
  "organizationId": "<string>",
  "product": {
    "changeSequence": 123,
    "createdOn": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "id": "<string>",
    "imageUrl": "<string>",
    "name": "<string>",
    "overviewMarkdown": "<string>",
    "productGroup": {
      "active": true,
      "changeSequence": 123,
      "createdOn": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "id": "<string>",
      "name": "<string>",
      "order": 123,
      "overviewMarkdown": "<string>",
      "products": "<array>",
      "searchText": "<string>",
      "updatedOn": "2023-11-07T05:31:56Z",
      "uuid": "<string>"
    },
    "productGroupId": "<string>",
    "projectTemplates": [
      "<unknown>"
    ],
    "searchText": "<string>",
    "updatedOn": "2023-11-07T05:31:56Z",
    "uuid": "<string>"
  },
  "productId": "<string>",
  "quantity": 123,
  "updatedOn": "2023-11-07T05:31:56Z",
  "uuid": "<string>"
}

Authorizations

x-api-keybearerAuth

x-api-key · string · header · required

API key for authentication. Create one from the Kodexa platform UI under Settings > Access Tokens.

Path Parameters

id · string<uuid> · required

Unique identifier (UUID) of the resource.

Body

application/json

A product subscription links an organization to a purchased product.

changeSequence · integer<int32>

organization · object | null

An organization is the top-level tenant in Kodexa. All projects, stores, and resources belong to an organization.

Show child attributes

product · object | null

A product represents a purchasable offering on the Kodexa platform.

Show child attributes

productId · string | null

quantity · integer<int64>

Response

200

application/json

Updated ProductSubscription

A product subscription links an organization to a purchased product.

changeSequence · integer<int32> · required

createdOn · string<date-time> · required

id · string · required

organization · object | null · required

An organization is the top-level tenant in Kodexa. All projects, stores, and resources belong to an organization.

Show child attributes

organizationId · string | null · required

product · object | null · required

A product represents a purchasable offering on the Kodexa platform.

Show child attributes

productId · string | null · required

quantity · integer<int64> · required

updatedOn · string<date-time> · required

uuid · string · required