Products

Get Products

get

Required scopes

This endpoint requires the following scopes:

: Access Younium API

Authorizations

OAuth2passwordRequired

Token URL:

Query parameters

Skipinteger · int32Optional

Skip number of records

Example: 10

Takeinteger · int32Optional

Take number of records

Example: 5

FilterstringOptional

Filter the resulsts. See ODATA documentation for more information

Example: name eq 'Adam' and age gt 20

SortstringOptional

Sorting the results. See ODATA specificaion for more information

Example: name

Header parameters

api-versionstringOptional

Responses

200

Success

application/json

idstring · uuidOptional

productNumberstring · nullableOptional

namestring · nullableOptional

productTypestring · enumOptionalPossible values:

categorystring · nullableOptional

activationDatestring · date-time · nullableOptional

endOfNewSalesDatestring · date-time · nullableOptional

endOfRenewalDatestring · date-time · nullableOptional

endOfLifeDatestring · date-time · nullableOptional

isFrameworkProductbooleanOptional

externalERPIdstring · nullableOptional

externalCRMIdstring · nullableOptional

createdstring · date-timeOptional

modifiedstring · date-timeOptional

legalEntityIdstring · uuidOptional

400

Bad Request.

application/json

401

Unauthorized

403

Forbidden

get/Products

GET /Products HTTP/1.1
Host: api.sandbox.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "productNumber": "text",
    "name": "text",
    "productType": "Simple",
    "category": "text",
    "activationDate": "2026-01-01T00:00:00.000Z",
    "endOfNewSalesDate": "2026-01-01T00:00:00.000Z",
    "endOfRenewalDate": "2026-01-01T00:00:00.000Z",
    "endOfLifeDate": "2026-01-01T00:00:00.000Z",
    "isFrameworkProduct": true,
    "chargePlans": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "chargePlanNumber": "text",
        "name": "text",
        "effectiveStartDate": "2026-01-01T00:00:00.000Z",
        "endOfNewSalesDate": "2026-01-01T00:00:00.000Z",
        "effectiveEndDate": "2026-01-01T00:00:00.000Z",
        "charges": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "chargeNumber": "C-000001",
            "name": "text",
            "model": "Flat",
            "chargeType": "OneOff",
            "unitCode": "text",
            "defaultQuantity": 1,
            "pricePeriod": "Monthly",
            "usageRating": "Sum",
            "createInvoiceLinesPerTier": true,
            "billingDay": "None",
            "specificBillingDay": 1,
            "billingPeriod": "Monthly",
            "periodAlignment": "None",
            "billingTiming": "InAdvance",
            "taxTemplate": "text",
            "taxIncluded": true,
            "externalERPId": "text",
            "externalCRMId": "text",
            "created": "2026-01-01T00:00:00.000Z",
            "modified": "2026-01-01T00:00:00.000Z",
            "revenueRecognition": "text",
            "deferredRevenueAccount": "text",
            "recognizedRevenueAccount": "text",
            "customFields": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            },
            "priceDetails": [
              {
                "currency": "text",
                "price": 1,
                "tier": 1,
                "description": "text",
                "fromQuantity": 1,
                "toQuantity": 1,
                "priceBase": "Flat"
              }
            ],
            "features": [
              {
                "code": "text",
                "description": "text"
              }
            ]
          }
        ],
        "customFields": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "created": "2026-01-01T00:00:00.000Z",
        "modified": "2026-01-01T00:00:00.000Z"
      }
    ],
    "externalERPId": "text",
    "externalCRMId": "text",
    "created": "2026-01-01T00:00:00.000Z",
    "modified": "2026-01-01T00:00:00.000Z",
    "legalEntityId": "123e4567-e89b-12d3-a456-426614174000",
    "customFields": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  }
]

Create Product

post

Required scopes

This endpoint requires the following scopes:

: Access Younium API

Authorizations

OAuth2passwordRequired

Token URL:

Header parameters

api-versionstringOptional

younium-idempotency-keystringOptional

younium-idempotency-durationInHoursintegerOptional

Body

productTypestring · enumOptionalPossible values:

namestring · nullableOptional

activationDatestring · date-time · nullableOptional

externalERPIdstring · nullableOptional

externalCRMIdstring · nullableOptional

Responses

201

Created

application/json

idstring · uuid · nullableOptional

messagestring · nullableOptional

400

Bad Request.

application/json

401

Unauthorized

403

Forbidden

post/Products

POST /Products HTTP/1.1
Host: api.sandbox.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1057

{
  "productType": "Simple",
  "chargePlans": [
    {
      "charges": [
        {
          "PriceDetails": [
            {
              "isInfinite": true,
              "currency": "SEK",
              "price": 1,
              "description": "text",
              "priceBase": "Flat",
              "tier": 1,
              "toQuantity": 1
            }
          ],
          "features": [
            {
              "feature": {
                "key": "text",
                "value": "text"
              }
            }
          ],
          "name": "text",
          "model": "Flat",
          "chargeType": "OneOff",
          "customFields": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "externalCRMId": "text",
          "externalERPId": "text",
          "unit": "pcs",
          "pricePeriod": "Monthly",
          "usageRating": "Sum",
          "measurementsRule": "LatestDate",
          "defaultQuantity": 1,
          "billingPeriod": "Monthly",
          "periodAlignment": "None",
          "billingDay": "None",
          "billingTiming": "InAdvance",
          "specificBillingDay": 1,
          "offsetBillingDays": 1,
          "taxIncluded": true,
          "revenueRecognition": {
            "key": "text",
            "value": "text"
          },
          "taxTemplate": "Sweden standard",
          "deferredRevenueAccount": "1510",
          "recognizedRevenueAccount": "1510"
        }
      ],
      "name": "text",
      "customFields": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ],
  "name": "text",
  "category": "Add-on",
  "activationDate": "2026-01-01T00:00:00.000Z",
  "externalERPId": "text",
  "externalCRMId": "text",
  "customFields": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "message": "text"
}

Update Product

patch

Required scopes

This endpoint requires the following scopes:

: Access Younium API

Authorizations

OAuth2passwordRequired

Token URL:

Path parameters

idstring · uuidRequired

Header parameters

api-versionstringOptional

Body

productTypestring · enumOptionalPossible values:

namestring · nullableOptional

activationDatestring · date-time · nullableOptional

externalERPIdstring · nullableOptional

externalCRMIdstring · nullableOptional

Responses

204

No Content

No content

400

Bad Request.

application/json

401

Unauthorized

403

Forbidden

404

Not Found

application/json

patch/Products/{id}

PATCH /Products/{id} HTTP/1.1
Host: api.sandbox.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/merge-patch+json
Accept: */*
Content-Length: 1205

{
  "productType": "Simple",
  "chargePlans": [
    {
      "operation": "Change",
      "chargePlan": "CP-000001",
      "charges": [
        {
          "charge": {
            "key": "text",
            "value": "text"
          },
          "operation": "Change",
          "PriceDetails": [
            {
              "operation": "Change",
              "isInfinite": true,
              "currency": "SEK",
              "price": 1,
              "description": "text",
              "priceBase": "Flat",
              "tier": 1,
              "toQuantity": 1
            }
          ],
          "features": [
            {
              "operation": "Remove",
              "feature": {
                "key": "text",
                "value": "text"
              }
            }
          ],
          "name": "text",
          "model": "Flat",
          "chargeType": "OneOff",
          "customFields": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "externalCRMId": "text",
          "externalERPId": "text",
          "unit": "pcs",
          "pricePeriod": "Monthly",
          "usageRating": "Sum",
          "measurementsRule": "LatestDate",
          "defaultQuantity": 1,
          "billingPeriod": "Monthly",
          "periodAlignment": "None",
          "billingDay": "None",
          "billingTiming": "InAdvance",
          "specificBillingDay": 1,
          "offsetBillingDays": 1,
          "taxIncluded": true,
          "revenueRecognition": {
            "key": "text",
            "value": "text"
          },
          "taxTemplate": "Sweden standard",
          "deferredRevenueAccount": "1510",
          "recognizedRevenueAccount": "1510"
        }
      ],
      "name": "text",
      "customFields": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ],
  "name": "text",
  "category": "Add-on",
  "activationDate": "2026-01-01T00:00:00.000Z",
  "externalERPId": "text",
  "externalCRMId": "text",
  "customFields": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

No content

Delete product

delete

A product can only be deleted if it's not in use on any active orders.

Required scopes

This endpoint requires the following scopes:

: Access Younium API

Authorizations

OAuth2passwordRequired

Token URL:

Path parameters

idstring · uuidRequired

Header parameters

api-versionstringOptional

Responses

200

Success

No content

400

Bad Request.

application/json

401

Unauthorized

403

Forbidden

404

Not Found

application/json

delete/Products/{id}

DELETE /Products/{id} HTTP/1.1
Host: api.sandbox.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

Get Products by Id

get

Required scopes

This endpoint requires the following scopes:

: Access Younium API

Authorizations

OAuth2passwordRequired

Token URL:

Path parameters

idstring · uuidRequired

Header parameters

api-versionstringOptional

Responses

200

Success

application/json

idstring · uuidOptional

productNumberstring · nullableOptional

namestring · nullableOptional

productTypestring · enumOptionalPossible values:

categorystring · nullableOptional

activationDatestring · date-time · nullableOptional

endOfNewSalesDatestring · date-time · nullableOptional

endOfRenewalDatestring · date-time · nullableOptional

endOfLifeDatestring · date-time · nullableOptional

isFrameworkProductbooleanOptional

externalERPIdstring · nullableOptional

externalCRMIdstring · nullableOptional

createdstring · date-timeOptional

modifiedstring · date-timeOptional

legalEntityIdstring · uuidOptional

400

Bad Request.

application/json

401

Unauthorized

403

Forbidden

404

Not Found

application/json

get/Products/{id}

GET /Products/{id} HTTP/1.1
Host: api.sandbox.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "productNumber": "text",
  "name": "text",
  "productType": "Simple",
  "category": "text",
  "activationDate": "2026-01-01T00:00:00.000Z",
  "endOfNewSalesDate": "2026-01-01T00:00:00.000Z",
  "endOfRenewalDate": "2026-01-01T00:00:00.000Z",
  "endOfLifeDate": "2026-01-01T00:00:00.000Z",
  "isFrameworkProduct": true,
  "chargePlans": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "chargePlanNumber": "text",
      "name": "text",
      "effectiveStartDate": "2026-01-01T00:00:00.000Z",
      "endOfNewSalesDate": "2026-01-01T00:00:00.000Z",
      "effectiveEndDate": "2026-01-01T00:00:00.000Z",
      "charges": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "chargeNumber": "C-000001",
          "name": "text",
          "model": "Flat",
          "chargeType": "OneOff",
          "unitCode": "text",
          "defaultQuantity": 1,
          "pricePeriod": "Monthly",
          "usageRating": "Sum",
          "createInvoiceLinesPerTier": true,
          "billingDay": "None",
          "specificBillingDay": 1,
          "billingPeriod": "Monthly",
          "periodAlignment": "None",
          "billingTiming": "InAdvance",
          "taxTemplate": "text",
          "taxIncluded": true,
          "externalERPId": "text",
          "externalCRMId": "text",
          "created": "2026-01-01T00:00:00.000Z",
          "modified": "2026-01-01T00:00:00.000Z",
          "revenueRecognition": "text",
          "deferredRevenueAccount": "text",
          "recognizedRevenueAccount": "text",
          "customFields": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "priceDetails": [
            {
              "currency": "text",
              "price": 1,
              "tier": 1,
              "description": "text",
              "fromQuantity": 1,
              "toQuantity": 1,
              "priceBase": "Flat"
            }
          ],
          "features": [
            {
              "code": "text",
              "description": "text"
            }
          ]
        }
      ],
      "customFields": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "created": "2026-01-01T00:00:00.000Z",
      "modified": "2026-01-01T00:00:00.000Z"
    }
  ],
  "externalERPId": "text",
  "externalCRMId": "text",
  "created": "2026-01-01T00:00:00.000Z",
  "modified": "2026-01-01T00:00:00.000Z",
  "legalEntityId": "123e4567-e89b-12d3-a456-426614174000",
  "customFields": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Update Charge

patch

Required scopes

This endpoint requires the following scopes:

: Access Younium API

Authorizations

OAuth2passwordRequired

Token URL:

Path parameters

chargeIdstring · uuidRequired

Header parameters

api-versionstringOptional

Body

namestring · nullableOptional

modelstring · enumOptionalPossible values:

chargeTypestring · enumOptionalPossible values:

externalCRMIdstring · nullableOptional

externalERPIdstring · nullableOptional

pricePeriodstring · enumOptionalPossible values:

usageRatingstring · enumOptionalPossible values:

measurementsRulestring · enumOptionalPossible values:

defaultQuantitynumber · double · nullableOptional

billingPeriodstring · enumOptionalPossible values:

periodAlignmentstring · enumOptionalPossible values:

billingDaystring · enumOptionalPossible values:

billingTimingstring · enumOptionalPossible values:

specificBillingDayinteger · int32 · nullableOptional

offsetBillingDaysinteger · int32 · nullableOptional

taxIncludedboolean · nullableOptional

Responses

204

No Content

No content

400

Bad Request.

application/json

401

Unauthorized

403

Forbidden

404

Not Found

application/json

patch/Products/charges/{chargeId}

PATCH /Products/charges/{chargeId} HTTP/1.1
Host: api.sandbox.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/merge-patch+json
Accept: */*
Content-Length: 798

{
  "PriceDetails": [
    {
      "operation": "Change",
      "isInfinite": true,
      "currency": "SEK",
      "price": 1,
      "description": "text",
      "priceBase": "Flat",
      "tier": 1,
      "toQuantity": 1
    }
  ],
  "features": [
    {
      "operation": "Remove",
      "feature": {
        "key": "text",
        "value": "text"
      }
    }
  ],
  "name": "text",
  "model": "Flat",
  "chargeType": "OneOff",
  "customFields": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "externalCRMId": "text",
  "externalERPId": "text",
  "unit": "pcs",
  "pricePeriod": "Monthly",
  "usageRating": "Sum",
  "measurementsRule": "LatestDate",
  "defaultQuantity": 1,
  "billingPeriod": "Monthly",
  "periodAlignment": "None",
  "billingDay": "None",
  "billingTiming": "InAdvance",
  "specificBillingDay": 1,
  "offsetBillingDays": 1,
  "taxIncluded": true,
  "revenueRecognition": {
    "key": "text",
    "value": "text"
  },
  "taxTemplate": "Sweden standard",
  "deferredRevenueAccount": "1510",
  "recognizedRevenueAccount": "1510"
}

No content

Delete charge plan

delete

A charge plan can only be deleted if it's not in use on any active orders.

Required scopes

This endpoint requires the following scopes:

: Access Younium API

Authorizations

OAuth2passwordRequired

Token URL:

Path parameters

idstring · uuidRequired

Header parameters

api-versionstringOptional

Responses

200

Success

No content

400

Bad Request.

application/json

401

Unauthorized

403

Forbidden

404

Not Found

application/json

delete/Products/chargePlans/{id}

DELETE /Products/chargePlans/{id} HTTP/1.1
Host: api.sandbox.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

Delete charges

delete

A charge can only be deleted if it's not in use on any active orders.

Required scopes

This endpoint requires the following scopes:

: Access Younium API

Authorizations

OAuth2passwordRequired

Token URL:

Path parameters

idstring · uuidRequired

Header parameters

api-versionstringOptional

Responses

200

Success

No content

400

Bad Request.

application/json

401

Unauthorized

403

Forbidden

404

Not Found

application/json

delete/Products/charges/{id}

DELETE /Products/charges/{id} HTTP/1.1
Host: api.sandbox.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

PreviousPaymentterms NextQuotes

Last updated 5 months ago