Skip to main content
POST
/
api
/
credit-transactions
Create CreditTransaction
curl --request POST \
  --url https://platform.kodexa.ai/api/credit-transactions \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "amount": 123,
  "changeSequence": 123,
  "createdOn": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "modelCosts": [
    "aSDinaTvuI8gbWludGxpZnk="
  ],
  "note": "<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>",
  "transactionId": "<string>",
  "updatedOn": "2023-11-07T05:31:56Z",
  "user": "aSDinaTvuI8gbWludGxpZnk=",
  "userId": "<string>",
  "uuid": "<string>"
}
'
{
  "amount": 123,
  "changeSequence": 123,
  "createdOn": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "modelCosts": [
    "aSDinaTvuI8gbWludGxpZnk="
  ],
  "note": "<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>",
  "transactionId": "<string>",
  "updatedOn": "2023-11-07T05:31:56Z",
  "user": "aSDinaTvuI8gbWludGxpZnk=",
  "userId": "<string>",
  "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 credit transaction records a billing credit usage or addition for an organization.

amount
number<double>
changeSequence
integer<int32>
createdOn
string<date-time>
id
string
modelCosts
string<byte>[]
note
string
organization
object
organizationId
string | null
transactionId
string
updatedOn
string<date-time>
user
string<byte>
userId
string | null
uuid
string

Response

Created CreditTransaction

A credit transaction records a billing credit usage or addition for an organization.

amount
number<double>
changeSequence
integer<int32>
createdOn
string<date-time>
id
string
modelCosts
string<byte>[]
note
string
organization
object
organizationId
string | null
transactionId
string
updatedOn
string<date-time>
user
string<byte>
userId
string | null
uuid
string