Skip to main content
POST
/
api
/
product-subscriptions
Create ProductSubscription
curl --request POST \
  --url https://platform.kodexa.ai/api/product-subscriptions \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "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": "<string>",
    "enterpriseOrganization": true,
    "features": {},
    "hasImage": true,
    "id": "<string>",
    "memory": {
      "orderedDashboards": [
        "<string>"
      ]
    },
    "name": "<string>",
    "organizationStatus": "<string>",
    "properties": {},
    "publicAccess": true,
    "searchText": "<string>",
    "slug": "<string>",
    "stripeCustomerId": "<string>",
    "supportAccess": true,
    "supportAccessExpiresAt": "2023-11-07T05:31:56Z",
    "updatedOn": "2023-11-07T05:31:56Z",
    "uuid": "<string>"
  },
  "organizationId": "<string>",
  "product": {
    "active": true,
    "changeSequence": 123,
    "createdOn": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "hasQuantity": true,
    "id": "<string>",
    "imageUrl": "<string>",
    "name": "<string>",
    "numberOfCredits": 123,
    "order": 123,
    "overviewMarkdown": "<string>",
    "price": 123,
    "priceId": "<string>",
    "priceSuffix": "<string>",
    "productGroup": {
      "active": true,
      "changeSequence": 123,
      "createdOn": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "id": "<string>",
      "name": "<string>",
      "order": 123,
      "overviewMarkdown": "<string>",
      "products": [
        {}
      ],
      "searchText": "<string>",
      "updatedOn": "2023-11-07T05:31:56Z",
      "uuid": "<string>"
    },
    "productGroupId": "<string>",
    "projectTemplates": [
      "aSDinaTvuI8gbWludGxpZnk="
    ],
    "promoted": true,
    "searchText": "<string>",
    "updatedOn": "2023-11-07T05:31:56Z",
    "uuid": "<string>"
  },
  "productId": "<string>",
  "quantity": 123,
  "updatedOn": "2023-11-07T05:31:56Z",
  "uuid": "<string>"
}
'
{
  "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": "<string>",
    "enterpriseOrganization": true,
    "features": {},
    "hasImage": true,
    "id": "<string>",
    "memory": {
      "orderedDashboards": [
        "<string>"
      ]
    },
    "name": "<string>",
    "organizationStatus": "<string>",
    "properties": {},
    "publicAccess": true,
    "searchText": "<string>",
    "slug": "<string>",
    "stripeCustomerId": "<string>",
    "supportAccess": true,
    "supportAccessExpiresAt": "2023-11-07T05:31:56Z",
    "updatedOn": "2023-11-07T05:31:56Z",
    "uuid": "<string>"
  },
  "organizationId": "<string>",
  "product": {
    "active": true,
    "changeSequence": 123,
    "createdOn": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "hasQuantity": true,
    "id": "<string>",
    "imageUrl": "<string>",
    "name": "<string>",
    "numberOfCredits": 123,
    "order": 123,
    "overviewMarkdown": "<string>",
    "price": 123,
    "priceId": "<string>",
    "priceSuffix": "<string>",
    "productGroup": {
      "active": true,
      "changeSequence": 123,
      "createdOn": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "id": "<string>",
      "name": "<string>",
      "order": 123,
      "overviewMarkdown": "<string>",
      "products": [
        {}
      ],
      "searchText": "<string>",
      "updatedOn": "2023-11-07T05:31:56Z",
      "uuid": "<string>"
    },
    "productGroupId": "<string>",
    "projectTemplates": [
      "aSDinaTvuI8gbWludGxpZnk="
    ],
    "promoted": true,
    "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-key
string
header
required

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

Body

application/json

A product subscription links an organization to a purchased product.

changeSequence
integer<int32>
createdOn
string<date-time>
id
string
organization
object
organizationId
string | null
product
object
productId
string | null
quantity
integer<int64>
updatedOn
string<date-time>
uuid
string

Response

Created ProductSubscription

A product subscription links an organization to a purchased product.

changeSequence
integer<int32>
createdOn
string<date-time>
id
string
organization
object
organizationId
string | null
product
object
productId
string | null
quantity
integer<int64>
updatedOn
string<date-time>
uuid
string