Axiomatic Docs

Quotes, orders, subscriptions — read:sales / write:sales scopes. Send Authorization: Bearer ak_... and entityId. Browser sessions may use x-entity-id.

Sales + subscription dashboard metrics

Authorization

bearerAuth

AuthorizationBearer <token>

Create keys under Settings → API keys. Prefix ak_. Send as Authorization: Bearer ak_....

In: header

Query Parameters

entityId*string

Entity UUID; must match the API key’s entity when using Bearer auth.

Formatuuid

Response Body

curl -X GET "https://example.com/api/sales/dashboard?entityId=497f6eca-6276-4993-bfeb-53cbbbba6f08"

Empty

List customers (counterparties)

Authorization

bearerAuth

AuthorizationBearer <token>

Create keys under Settings → API keys. Prefix ak_. Send as Authorization: Bearer ak_....

In: header

Query Parameters

entityId*string

Entity UUID; must match the API key’s entity when using Bearer auth.

Formatuuid

Response Body

curl -X GET "https://example.com/api/sales/customers?entityId=497f6eca-6276-4993-bfeb-53cbbbba6f08"

Empty

List quotes

Authorization

bearerAuth

AuthorizationBearer <token>

Create keys under Settings → API keys. Prefix ak_. Send as Authorization: Bearer ak_....

In: header

Query Parameters

entityId*string

Entity UUID; must match the API key’s entity when using Bearer auth.

Formatuuid

status?string

page?integer

pageSize?integer

Response Body

curl -X GET "https://example.com/api/sales/quotes?entityId=497f6eca-6276-4993-bfeb-53cbbbba6f08"

Empty

Create quote

Authorization

bearerAuth

AuthorizationBearer <token>

Create keys under Settings → API keys. Prefix ak_. Send as Authorization: Bearer ak_....

In: header

Query Parameters

entityId*string

Entity UUID; must match the API key’s entity when using Bearer auth.

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

customerId?string

title?string

validUntil?string

terms?string

notes?string

lines?array<>

Response Body

curl -X POST "https://example.com/api/sales/quotes?entityId=497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Get quote with lines

Authorization

bearerAuth

AuthorizationBearer <token>

Create keys under Settings → API keys. Prefix ak_. Send as Authorization: Bearer ak_....

In: header

Path Parameters

quoteId*string

Formatuuid

Query Parameters

entityId*string

Entity UUID; must match the API key’s entity when using Bearer auth.

Formatuuid

Response Body

`application/json`

curl -X GET "https://example.com/api/sales/quotes/497f6eca-6276-4993-bfeb-53cbbbba6f08?entityId=497f6eca-6276-4993-bfeb-53cbbbba6f08"

Empty

{
  "error": "string"
}

Patch quote (commerce schema)

Authorization

bearerAuth

AuthorizationBearer <token>

Create keys under Settings → API keys. Prefix ak_. Send as Authorization: Bearer ak_....

In: header

Path Parameters

quoteId*string

Formatuuid

Query Parameters

entityId*string

Entity UUID; must match the API key’s entity when using Bearer auth.

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

See @axiomatic/commerce patchQuoteRequestSchema

Response Body

`application/json`

curl -X PATCH "https://example.com/api/sales/quotes/497f6eca-6276-4993-bfeb-53cbbbba6f08?entityId=497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{}'

Empty

{
  "error": "string"
}

Delete draft quote

Authorization

bearerAuth

AuthorizationBearer <token>

Create keys under Settings → API keys. Prefix ak_. Send as Authorization: Bearer ak_....

In: header

Path Parameters

quoteId*string

Formatuuid

Query Parameters

entityId*string

Entity UUID; must match the API key’s entity when using Bearer auth.

Formatuuid

Response Body

curl -X DELETE "https://example.com/api/sales/quotes/497f6eca-6276-4993-bfeb-53cbbbba6f08?entityId=497f6eca-6276-4993-bfeb-53cbbbba6f08"

Empty

List orders

Authorization

bearerAuth

AuthorizationBearer <token>

Create keys under Settings → API keys. Prefix ak_. Send as Authorization: Bearer ak_....

In: header

Query Parameters

entityId*string

Entity UUID; must match the API key’s entity when using Bearer auth.

Formatuuid

status?string

page?integer

pageSize?integer

Response Body

curl -X GET "https://example.com/api/sales/orders?entityId=497f6eca-6276-4993-bfeb-53cbbbba6f08"

Empty

Create order

Authorization

bearerAuth

AuthorizationBearer <token>

Create keys under Settings → API keys. Prefix ak_. Send as Authorization: Bearer ak_....

In: header

Query Parameters

entityId*string

Entity UUID; must match the API key’s entity when using Bearer auth.

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

customerId?string

quoteId?string

Formatuuid

orderDate*string

requestedDeliveryDate?string

shippingAddress?string

paymentTerms?string

notes?string

lines?array<>

Response Body

curl -X POST "https://example.com/api/sales/orders?entityId=497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{    "orderDate": "string"  }'

Empty

Get order detail

Authorization

bearerAuth

AuthorizationBearer <token>

Create keys under Settings → API keys. Prefix ak_. Send as Authorization: Bearer ak_....

In: header

Path Parameters

orderId*string

Formatuuid

Query Parameters

entityId*string

Entity UUID; must match the API key’s entity when using Bearer auth.

Formatuuid

Response Body

`application/json`

curl -X GET "https://example.com/api/sales/orders/497f6eca-6276-4993-bfeb-53cbbbba6f08?entityId=497f6eca-6276-4993-bfeb-53cbbbba6f08"

Empty

{
  "error": "string"
}

Patch order

Authorization

bearerAuth

AuthorizationBearer <token>

Create keys under Settings → API keys. Prefix ak_. Send as Authorization: Bearer ak_....

In: header

Path Parameters

orderId*string

Formatuuid

Query Parameters

entityId*string

Entity UUID; must match the API key’s entity when using Bearer auth.

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

patchOrderRequestSchema

Response Body

curl -X PATCH "https://example.com/api/sales/orders/497f6eca-6276-4993-bfeb-53cbbbba6f08?entityId=497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Delete draft order only

Authorization

bearerAuth

AuthorizationBearer <token>

Create keys under Settings → API keys. Prefix ak_. Send as Authorization: Bearer ak_....

In: header

Path Parameters

orderId*string

Formatuuid

Query Parameters

entityId*string

Entity UUID; must match the API key’s entity when using Bearer auth.

Formatuuid

Response Body

curl -X DELETE "https://example.com/api/sales/orders/497f6eca-6276-4993-bfeb-53cbbbba6f08?entityId=497f6eca-6276-4993-bfeb-53cbbbba6f08"

Empty

List subscription plans

Authorization

bearerAuth

AuthorizationBearer <token>

Create keys under Settings → API keys. Prefix ak_. Send as Authorization: Bearer ak_....

In: header

Query Parameters

entityId*string

Entity UUID; must match the API key’s entity when using Bearer auth.

Formatuuid

Response Body

curl -X GET "https://example.com/api/sales/plans?entityId=497f6eca-6276-4993-bfeb-53cbbbba6f08"

Empty

Create subscription plan

Authorization

bearerAuth

AuthorizationBearer <token>

Create keys under Settings → API keys. Prefix ak_. Send as Authorization: Bearer ak_....

In: header

Query Parameters

entityId*string

Entity UUID; must match the API key’s entity when using Bearer auth.

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?string

description?string

Or arbitrary JSON depending on client

price?string|number

currency?string

billingInterval?string

Value in"monthly" | "quarterly" | "annual"

trialDays?number|string

features?

isActive?boolean

sortOrder?number|string

Response Body

curl -X POST "https://example.com/api/sales/plans?entityId=497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Update subscription plan

Authorization

bearerAuth

AuthorizationBearer <token>

Create keys under Settings → API keys. Prefix ak_. Send as Authorization: Bearer ak_....

In: header

Path Parameters

planId*string

Formatuuid

Query Parameters

entityId*string

Entity UUID; must match the API key’s entity when using Bearer auth.

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

isActive?boolean

name?string

description?string

price?string|number

currency?string

billingInterval?string

Value in"monthly" | "quarterly" | "annual"

trialDays?number|string

features?

sortOrder?number|string

Response Body

curl -X PATCH "https://example.com/api/sales/plans/497f6eca-6276-4993-bfeb-53cbbbba6f08?entityId=497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{}'

Empty

List subscriptions

Authorization

bearerAuth

AuthorizationBearer <token>

Create keys under Settings → API keys. Prefix ak_. Send as Authorization: Bearer ak_....

In: header

Query Parameters

entityId*string

Entity UUID; must match the API key’s entity when using Bearer auth.

Formatuuid

status?string

Response Body

curl -X GET "https://example.com/api/sales/subscriptions?entityId=497f6eca-6276-4993-bfeb-53cbbbba6f08"

Empty

Create subscription

Authorization

bearerAuth

AuthorizationBearer <token>

Create keys under Settings → API keys. Prefix ak_. Send as Authorization: Bearer ak_....

In: header

Query Parameters

entityId*string

Entity UUID; must match the API key’s entity when using Bearer auth.

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

planId*string

customerId?string|number

Response Body

curl -X POST "https://example.com/api/sales/subscriptions?entityId=497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{    "planId": "string"  }'

Empty

Update subscription status / cancel / pause / resume

Authorization

bearerAuth

AuthorizationBearer <token>

Create keys under Settings → API keys. Prefix ak_. Send as Authorization: Bearer ak_....

In: header

Path Parameters

subscriptionId*string

Formatuuid

Query Parameters

entityId*string

Entity UUID; must match the API key’s entity when using Bearer auth.

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

status?string

action?string

Value in"cancel" | "pause" | "resume"

cancellationReason?string

Response Body

curl -X PATCH "https://example.com/api/sales/subscriptions/497f6eca-6276-4993-bfeb-53cbbbba6f08?entityId=497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Generate invoice from subscription

Authorization

bearerAuth

AuthorizationBearer <token>

Create keys under Settings → API keys. Prefix ak_. Send as Authorization: Bearer ak_....

In: header

Path Parameters

subscriptionId*string

Formatuuid

Query Parameters

entityId*string

Entity UUID; must match the API key’s entity when using Bearer auth.

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

`application/json`

curl -X POST "https://example.com/api/sales/subscriptions/497f6eca-6276-4993-bfeb-53cbbbba6f08/generate-invoice?entityId=497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{}'

Empty

{
  "error": "string"
}

Dunning action (remind / grace_period / suspend)

Authorization

bearerAuth

AuthorizationBearer <token>

Create keys under Settings → API keys. Prefix ak_. Send as Authorization: Bearer ak_....

In: header

Path Parameters

subscriptionId*string

Formatuuid

Query Parameters

entityId*string

Entity UUID; must match the API key’s entity when using Bearer auth.

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

action*string

Value in"remind" | "grace_period" | "suspend"

Response Body

curl -X POST "https://example.com/api/sales/subscriptions/497f6eca-6276-4993-bfeb-53cbbbba6f08/dunning?entityId=497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{    "action": "remind"  }'

Empty

Change subscription plan (proration)

Authorization

bearerAuth

AuthorizationBearer <token>

Create keys under Settings → API keys. Prefix ak_. Send as Authorization: Bearer ak_....

In: header

Path Parameters

subscriptionId*string

Formatuuid

Query Parameters

entityId*string

Entity UUID; must match the API key’s entity when using Bearer auth.

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

newPlanId*string

Formatuuid

Response Body

`application/json`

curl -X POST "https://example.com/api/sales/subscriptions/497f6eca-6276-4993-bfeb-53cbbbba6f08/change-plan?entityId=497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{    "newPlanId": "f1f5c646-a768-4f15-ab7e-5e3088389de0"  }'

Empty

{
  "error": "string"
}

Sales

200

200

200

201

200

404application/json

200

400application/json

200

400

200

201

400

200

404application/json

200

200

400

200

201

200

404

200

201

200

404

200

400application/json

200

200

400application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`