Products

id

string · required

The unique identifier of the product

Example: 550e8400-e29b-41d4-a716-446655440000

productNumber

string · required

Unique product number within the company

Example: P001

name

string · required

Name of the product

Example: Web Hosting

unit

string · required

Unit of measurement

Example: pcs

productGroupId

string · required

Product group this product belongs to

productType

string · enum · required

Product type (goods or services) for EU VAT

Enum values:

goods

services

isActive

boolean · required

Whether the product is active

Example: true

isArchived

boolean · required

Whether the product is archived

Example: false

isLocked

boolean · required

Whether the product is locked (in use, cannot be deleted)

Example: false

createdAt

string · date-time · required

When the product was created

Example: 2024-01-15T10:30:00Z

updatedAt

string · date-time · required

When the product was last updated

Example: 2024-01-15T10:30:00Z

description

string | null

Optional description

Prices configured for this product

Entitlements granted by this product

POST/v1/products

curl https://api.ledgerbee.com/api/v1/products \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "productNumber": "P001",
  "name": "Web Hosting",
  "description": "string",
  "unit": "pcs",
  "productGroupId": "550e8400-e29b-41d4-a716-446655440000",
  "isActive": true,
  "productType": "services",
  "initialPrice": {
    "nickname": "Monthly",
    "unitAmount": "99.99",
    "billingPeriodType": "recurring",
    "pricingModel": "flat_rate",
    "billingInterval": "day",
    "billingIntervalCount": 1,
    "currency": "DKK",
    "meterId": "string",
    "tiers": []
  },
  "entitlementIds": [
    "string"
  ]
}'

Example Request Body

{
  "productNumber": "P001",
  "name": "Web Hosting",
  "description": "string",
  "unit": "pcs",
  "productGroupId": "550e8400-e29b-41d4-a716-446655440000",
  "isActive": true,
  "productType": "services",
  "initialPrice": {
    "nickname": "Monthly",
    "unitAmount": "99.99",
    "billingPeriodType": "recurring",
    "pricingModel": "flat_rate",
    "billingInterval": "day",
    "billingIntervalCount": 1,
    "currency": "DKK",
    "meterId": "string",
    "tiers": []
  },
  "entitlementIds": [
    "string"
  ]
}

json

application/json

Example Responses

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "productNumber": "P001",
  "name": "Web Hosting",
  "description": "description",
  "unit": "pcs",
  "productGroupId": "productGroupId",
  "productType": "goods",
  "isActive": true,
  "isArchived": false,
  "isLocked": false,
  "prices": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "productId": "productId",
      "nickname": "nickname",
      "unitAmount": "99.99",
      "billingPeriodType": "recurring",
      "pricingModel": "flat_rate",
      "billingInterval": "day",
      "billingIntervalCount": 1,
      "currency": "DKK",
      "baseCurrency": "DKK",
      "availableCurrencies": [
        "string"
      ],
      "status": "draft",
      "isDefault": false,
      "isLocked": false,
      "meterId": "meterId",
      "tiers": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "fromQuantity": 1,
          "toQuantity": 10,
          "unitAmount": "99.99",
          "flatFee": "10.00"
        }
      ],
      "vatRatesByZone": {}
    }
  ],
  "entitlements": [
    {
      "id": "id",
      "name": "Advanced reporting",
      "key": "advanced_reporting"
    }
  ],
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:30:00Z"
}

json

application/json

Get a product

GET

https://api.ledgerbee.com/api

/v1/products/{productId}

x-api-key (header)

OAuth 2.0

Returns a single product, including its prices.

Required Scope

products-read

Get a product › path Parameters

productId

string · required

Product ID

Get a product › Responses

Product details, including its prices

id

string · required

The unique identifier of the product

Example: 550e8400-e29b-41d4-a716-446655440000

productNumber

string · required

Unique product number within the company

Example: P001

name

string · required

Name of the product

Example: Web Hosting

unit

string · required

Unit of measurement

Example: pcs

productGroupId

string · required

Product group this product belongs to

productType

string · enum · required

Product type (goods or services) for EU VAT

Enum values:

goods

services

isActive

boolean · required

Whether the product is active

Example: true

isArchived

boolean · required

Whether the product is archived

Example: false

isLocked

boolean · required

Whether the product is locked (in use, cannot be deleted)

Example: false

createdAt

string · date-time · required

When the product was created

Example: 2024-01-15T10:30:00Z

updatedAt

string · date-time · required

When the product was last updated

Example: 2024-01-15T10:30:00Z

description

string | null

Optional description

Prices configured for this product

Entitlements granted by this product

GET/v1/products/{productId}

curl https://api.ledgerbee.com/api/v1/products/:productId \
  --header 'x-api-key: <api-key>'

Example Responses

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "productNumber": "P001",
  "name": "Web Hosting",
  "description": "description",
  "unit": "pcs",
  "productGroupId": "productGroupId",
  "productType": "goods",
  "isActive": true,
  "isArchived": false,
  "isLocked": false,
  "prices": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "productId": "productId",
      "nickname": "nickname",
      "unitAmount": "99.99",
      "billingPeriodType": "recurring",
      "pricingModel": "flat_rate",
      "billingInterval": "day",
      "billingIntervalCount": 1,
      "currency": "DKK",
      "baseCurrency": "DKK",
      "availableCurrencies": [
        "string"
      ],
      "status": "draft",
      "isDefault": false,
      "isLocked": false,
      "meterId": "meterId",
      "tiers": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "fromQuantity": 1,
          "toQuantity": 10,
          "unitAmount": "99.99",
          "flatFee": "10.00"
        }
      ],
      "vatRatesByZone": {}
    }
  ],
  "entitlements": [
    {
      "id": "id",
      "name": "Advanced reporting",
      "key": "advanced_reporting"
    }
  ],
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:30:00Z"
}

json

application/json

Delete a product

DELETE

https://api.ledgerbee.com/api

/v1/products/{productId}

x-api-key (header)

OAuth 2.0

Deletes a product. A product that is locked (in use) cannot be deleted.

Required Scope

products-write

Delete a product › path Parameters

productId

string · required

Product ID

Delete a product › Headers

x-api-idempotency-key

string · maxLength: 255

Optional idempotency key for safely retrying mutating requests.

Delete a product › Responses

Product deleted successfully

No data returned

Update a product

PATCH

https://api.ledgerbee.com/api

/v1/products/{productId}

x-api-key (header)

OAuth 2.0

Updates a product. Only the fields provided in the request are changed.

Required Scope

products-write

Update a product › path Parameters

productId

string · required

Product ID

Update a product › Headers

x-api-idempotency-key

string · maxLength: 255

Optional idempotency key for safely retrying mutating requests.

Update a product › Request Body

UpdateProductRequest

productNumber

string

Unique product number within the company

Example: P001

name

string · maxLength: 300

Name of the product

Example: Web Hosting

description

string · maxLength: 1000

Optional description

unit

string · maxLength: 255

Unit of measurement

Example: pcs

productGroupId

string

Product group this product belongs to

isActive

boolean

Whether the product is active

productType

string · enum

Product type (goods or services)

Enum values:

goods

services

entitlementIds

array | null · maxItems: 100

Externally managed entitlement IDs to bind (max 100)

Update a product › Responses

Product updated successfully

id

string · required

The unique identifier of the product

Example: 550e8400-e29b-41d4-a716-446655440000

productNumber

string · required

Unique product number within the company

Example: P001

name

string · required

Name of the product

Example: Web Hosting

unit

string · required

Unit of measurement

Example: pcs

productGroupId

string · required

Product group this product belongs to

productType

string · enum · required

Product type (goods or services) for EU VAT

Enum values:

goods

services

isActive

boolean · required

Whether the product is active

Example: true

isArchived

boolean · required

Whether the product is archived

Example: false

isLocked

boolean · required

Whether the product is locked (in use, cannot be deleted)

Example: false

createdAt

string · date-time · required

When the product was created

Example: 2024-01-15T10:30:00Z

updatedAt

string · date-time · required

When the product was last updated

Example: 2024-01-15T10:30:00Z

description

string | null

Optional description

Prices configured for this product

Entitlements granted by this product

PATCH/v1/products/{productId}

curl https://api.ledgerbee.com/api/v1/products/:productId \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "productNumber": "P001",
  "name": "Web Hosting",
  "description": "string",
  "unit": "pcs",
  "productGroupId": "string",
  "isActive": true,
  "productType": "goods",
  "entitlementIds": [
    "string"
  ]
}'

Example Request Body

{
  "productNumber": "P001",
  "name": "Web Hosting",
  "description": "string",
  "unit": "pcs",
  "productGroupId": "string",
  "isActive": true,
  "productType": "goods",
  "entitlementIds": [
    "string"
  ]
}

json

application/json

Example Responses

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "productNumber": "P001",
  "name": "Web Hosting",
  "description": "description",
  "unit": "pcs",
  "productGroupId": "productGroupId",
  "productType": "goods",
  "isActive": true,
  "isArchived": false,
  "isLocked": false,
  "prices": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "productId": "productId",
      "nickname": "nickname",
      "unitAmount": "99.99",
      "billingPeriodType": "recurring",
      "pricingModel": "flat_rate",
      "billingInterval": "day",
      "billingIntervalCount": 1,
      "currency": "DKK",
      "baseCurrency": "DKK",
      "availableCurrencies": [
        "string"
      ],
      "status": "draft",
      "isDefault": false,
      "isLocked": false,
      "meterId": "meterId",
      "tiers": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "fromQuantity": 1,
          "toQuantity": 10,
          "unitAmount": "99.99",
          "flatFee": "10.00"
        }
      ],
      "vatRatesByZone": {}
    }
  ],
  "entitlements": [
    {
      "id": "id",
      "name": "Advanced reporting",
      "key": "advanced_reporting"
    }
  ],
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:30:00Z"
}

json

application/json

Archive a product

POST

https://api.ledgerbee.com/api

/v1/products/{productId}/archive

x-api-key (header)

OAuth 2.0

Archives a product and every price on it. Nothing new can be sold against an archived product, while the subscriptions and documents already referencing it keep resolving — which is why this, not DELETE, is what a product in use gets. There is no unarchive.

Required Scope

products-write

Archive a product › path Parameters

productId

string · required

Product ID

Archive a product › Headers

x-api-idempotency-key

string · maxLength: 255

Optional idempotency key for safely retrying mutating requests.

Archive a product › Responses

Product archived successfully

id

string · required

The unique identifier of the product

Example: 550e8400-e29b-41d4-a716-446655440000

productNumber

string · required

Unique product number within the company

Example: P001

name

string · required

Name of the product

Example: Web Hosting

unit

string · required

Unit of measurement

Example: pcs

productGroupId

string · required

Product group this product belongs to

productType

string · enum · required

Product type (goods or services) for EU VAT

Enum values:

goods

services

isActive

boolean · required

Whether the product is active

Example: true

isArchived

boolean · required

Whether the product is archived

Example: false

isLocked

boolean · required

Whether the product is locked (in use, cannot be deleted)

Example: false

createdAt

string · date-time · required

When the product was created

Example: 2024-01-15T10:30:00Z

updatedAt

string · date-time · required

When the product was last updated

Example: 2024-01-15T10:30:00Z

description

string | null

Optional description

Prices configured for this product