Products

Get Products

GEThttps://api.younium.com/Products

Authorization

oauth2

Query parameters

Header parameters

Response

200400401403

Success

Body

application/json

idstring (uuid)

productNumbernullable string

namenullable string

productTypeall of

categorynullable string

activationDatenullable string (date-time)

endOfNewSalesDatenullable string (date-time)

endOfRenewalDatenullable string (date-time)

endOfLifeDatenullable string (date-time)

isFrameworkProductboolean

chargePlansnullable array of ChargePlanResponse (object)

externalERPIdnullable string

externalCRMIdnullable string

createdstring (date-time)

modifiedstring (date-time)

customFieldsnullable object

Request

JavaScriptCurlPython

const response = await fetch('https://api.younium.com/Products', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "productNumber": "text",
    "name": "text",
    "productType": {},
    "category": "text",
    "activationDate": "2024-12-22T01:43:47.153Z",
    "endOfNewSalesDate": "2024-12-22T01:43:47.153Z",
    "endOfRenewalDate": "2024-12-22T01:43:47.153Z",
    "endOfLifeDate": "2024-12-22T01:43:47.153Z",
    "isFrameworkProduct": false,
    "chargePlans": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "chargePlanNumber": "text",
        "name": "text",
        "effectiveStartDate": "2024-12-22T01:43:47.153Z",
        "endOfNewSalesDate": "2024-12-22T01:43:47.153Z",
        "effectiveEndDate": "2024-12-22T01:43:47.153Z",
        "charges": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "chargeNumber": "C-000001",
            "name": "text",
            "model": {},
            "chargeType": {},
            "unitCode": "text",
            "defaultQuantity": 0,
            "pricePeriod": {},
            "usageRating": {},
            "createInvoiceLinesPerTier": false,
            "billingDay": {},
            "specificBillingDay": 0,
            "billingPeriod": {},
            "periodAlignment": {},
            "billingTiming": {},
            "taxTemplate": "text",
            "taxIncluded": false,
            "externalERPId": "text",
            "externalCRMId": "text",
            "created": "2024-12-22T01:43:47.153Z",
            "modified": "2024-12-22T01:43:47.153Z",
            "deferredRevenueAccount": "text",
            "recognizedRevenueAccount": "text",
            "priceDetails": [
              {
                "currency": "text",
                "price": 0,
                "tier": 0,
                "description": "text",
                "fromQuantity": 0,
                "toQuantity": 0,
                "priceBase": {}
              }
            ],
            "features": [
              {
                "code": "text",
                "description": "text"
              }
            ]
          }
        ],
        "created": "2024-12-22T01:43:47.153Z",
        "modified": "2024-12-22T01:43:47.153Z"
      }
    ],
    "externalERPId": "text",
    "externalCRMId": "text",
    "created": "2024-12-22T01:43:47.153Z",
    "modified": "2024-12-22T01:43:47.153Z"
  }
]

Create Product

POSThttps://api.younium.com/Products

Authorization

oauth2

Header parameters

Body

application/json

productTypeall of

chargePlansnullable array of CreateChargePlanRequest (object)

namenullable string

categorynullable all of

Allowed as string input: Name, ProductCategory-Id.

Example: "Add-on"

activationDatenullable string (date-time)

externalERPIdnullable string

externalCRMIdnullable string

customFieldsnullable object

Response

201400401403

Created

Body

application/json

idnullable string (uuid)

messagenullable string

Request

JavaScriptCurlPython

const response = await fetch('https://api.younium.com/Products', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

201400

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

Update Product

PATCHhttps://api.younium.com/Products/{id}

Authorization

oauth2

Path parameters

id*string (uuid)

Header parameters

Body

application/merge-patch+json

productTypenullable all of

chargePlansnullable array of UpdateChargePlanRequest (object)

namenullable string

categorynullable all of

Allowed as string input: Name, ProductCategory-Id.

Example: "Add-on"

activationDatenullable string (date-time)

externalERPIdnullable string

externalCRMIdnullable string

customFieldsnullable object

Response

204400401403404

No Content

Request

JavaScriptCurlPython

const response = await fetch('https://api.younium.com/Products/{id}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/merge-patch+json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

400404

{
  "type": "text",
  "title": "text",
  "status": 0,
  "detail": "text",
  "instance": "text"
}

Delete product

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

DELETEhttps://api.younium.com/Products/{id}

Authorization

oauth2

Path parameters

id*string (uuid)

Header parameters

Response

200400401403404

Success

Request

JavaScriptCurlPython

const response = await fetch('https://api.younium.com/Products/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

400404

{
  "type": "text",
  "title": "text",
  "status": 0,
  "detail": "text",
  "instance": "text"
}

Get Products by Id

GEThttps://api.younium.com/Products/{id}

Authorization

oauth2

Path parameters

id*string (uuid)

Header parameters

Response

200400401403404

Success

Body

application/json

idstring (uuid)

productNumbernullable string

namenullable string

productTypeall of

categorynullable string

activationDatenullable string (date-time)

endOfNewSalesDatenullable string (date-time)

endOfRenewalDatenullable string (date-time)

endOfLifeDatenullable string (date-time)

isFrameworkProductboolean

chargePlansnullable array of ChargePlanResponse (object)

externalERPIdnullable string

externalCRMIdnullable string

createdstring (date-time)

modifiedstring (date-time)

customFieldsnullable object

Request

JavaScriptCurlPython

const response = await fetch('https://api.younium.com/Products/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400404

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "productNumber": "text",
  "name": "text",
  "productType": {},
  "category": "text",
  "activationDate": "2024-12-22T01:43:47.153Z",
  "endOfNewSalesDate": "2024-12-22T01:43:47.153Z",
  "endOfRenewalDate": "2024-12-22T01:43:47.153Z",
  "endOfLifeDate": "2024-12-22T01:43:47.153Z",
  "isFrameworkProduct": false,
  "chargePlans": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "chargePlanNumber": "text",
      "name": "text",
      "effectiveStartDate": "2024-12-22T01:43:47.153Z",
      "endOfNewSalesDate": "2024-12-22T01:43:47.153Z",
      "effectiveEndDate": "2024-12-22T01:43:47.153Z",
      "charges": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "chargeNumber": "C-000001",
          "name": "text",
          "model": {},
          "chargeType": {},
          "unitCode": "text",
          "defaultQuantity": 0,
          "pricePeriod": {},
          "usageRating": {},
          "createInvoiceLinesPerTier": false,
          "billingDay": {},
          "specificBillingDay": 0,
          "billingPeriod": {},
          "periodAlignment": {},
          "billingTiming": {},
          "taxTemplate": "text",
          "taxIncluded": false,
          "externalERPId": "text",
          "externalCRMId": "text",
          "created": "2024-12-22T01:43:47.153Z",
          "modified": "2024-12-22T01:43:47.153Z",
          "deferredRevenueAccount": "text",
          "recognizedRevenueAccount": "text",
          "priceDetails": [
            {
              "currency": "text",
              "price": 0,
              "tier": 0,
              "description": "text",
              "fromQuantity": 0,
              "toQuantity": 0,
              "priceBase": {}
            }
          ],
          "features": [
            {
              "code": "text",
              "description": "text"
            }
          ]
        }
      ],
      "created": "2024-12-22T01:43:47.153Z",
      "modified": "2024-12-22T01:43:47.153Z"
    }
  ],
  "externalERPId": "text",
  "externalCRMId": "text",
  "created": "2024-12-22T01:43:47.153Z",
  "modified": "2024-12-22T01:43:47.153Z"
}

Delete charge plan

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

DELETEhttps://api.younium.com/Products/chargePlans/{id}

Authorization

oauth2

Path parameters

id*string (uuid)

Header parameters

Response

200400401403404

Success

Request

JavaScriptCurlPython

const response = await fetch('https://api.younium.com/Products/chargePlans/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

400404

{
  "type": "text",
  "title": "text",
  "status": 0,
  "detail": "text",
  "instance": "text"
}

Delete charges

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

DELETEhttps://api.younium.com/Products/charges/{id}

Authorization

oauth2

Path parameters

id*string (uuid)

Header parameters

Response

200400401403404

Success

Request

JavaScriptCurlPython

const response = await fetch('https://api.younium.com/Products/charges/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

400404

{
  "type": "text",
  "title": "text",
  "status": 0,
  "detail": "text",
  "instance": "text"
}

---