Products
GET /Products/FromChargePlan/{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": "2025-07-01T20:29:17.904Z",
"endOfNewSalesDate": "2025-07-01T20:29:17.904Z",
"endOfRenewalDate": "2025-07-01T20:29:17.904Z",
"endOfLifeDate": "2025-07-01T20:29:17.904Z",
"isFrameworkProduct": true,
"chargePlans": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"chargePlanNumber": "text",
"name": "text",
"effectiveStartDate": "2025-07-01T20:29:17.904Z",
"endOfNewSalesDate": "2025-07-01T20:29:17.904Z",
"effectiveEndDate": "2025-07-01T20:29:17.904Z",
"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": "2025-07-01T20:29:17.904Z",
"modified": "2025-07-01T20:29:17.904Z",
"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": "2025-07-01T20:29:17.904Z",
"modified": "2025-07-01T20:29:17.904Z"
}
],
"externalERPId": "text",
"externalCRMId": "text",
"created": "2025-07-01T20:29:17.904Z",
"modified": "2025-07-01T20:29:17.904Z",
"customFields": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
}
GET /Products/FromCharge/{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": "2025-07-01T20:29:17.904Z",
"endOfNewSalesDate": "2025-07-01T20:29:17.904Z",
"endOfRenewalDate": "2025-07-01T20:29:17.904Z",
"endOfLifeDate": "2025-07-01T20:29:17.904Z",
"isFrameworkProduct": true,
"chargePlans": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"chargePlanNumber": "text",
"name": "text",
"effectiveStartDate": "2025-07-01T20:29:17.904Z",
"endOfNewSalesDate": "2025-07-01T20:29:17.904Z",
"effectiveEndDate": "2025-07-01T20:29:17.904Z",
"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": "2025-07-01T20:29:17.904Z",
"modified": "2025-07-01T20:29:17.904Z",
"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": "2025-07-01T20:29:17.904Z",
"modified": "2025-07-01T20:29:17.904Z"
}
],
"externalERPId": "text",
"externalCRMId": "text",
"created": "2025-07-01T20:29:17.904Z",
"modified": "2025-07-01T20:29:17.904Z",
"customFields": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
}
Filter the results. See ODATA documentation for more information
name eq 'Adam' and age gt 20
Sorting the results. See ODATA specification for more information
accountNumber Desc
Apply a separate modified After filter. See 'ModifiedBefore' filter for further details.
06/01/2025 00:00:00
Apply a separate filter to only get records that has been modified Before the specified date time.
06/01/2025 00:00:00
Page Size
20
Page Number
1
GET /Products/productFeatures HTTP/1.1
Host: api.sandbox.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"pageNumber": 1,
"pageSize": 1,
"totalPages": 1,
"totalCount": 1,
"nextPage": "https://example.com",
"previousPage": "https://example.com",
"firstPage": "https://example.com",
"lastPage": "https://example.com",
"data": {
"code": "text",
"description": "text"
}
}
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": "2025-07-01T20:29:17.904Z",
"externalERPId": "text",
"externalCRMId": "text",
"customFields": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
}
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"message": "text"
}
Filter the results. See ODATA documentation for more information
name eq 'Adam' and age gt 20
Sorting the results. See ODATA specification for more information
accountNumber Desc
Apply a separate modified After filter. See 'ModifiedBefore' filter for further details.
06/01/2025 00:00:00
Filter is also applied on sub entities: 'chargePlans', 'charges', 'chargeDetails' and 'customFields' on these entities
06/01/2025 00:00:00
Page Size
20
Page Number
1
GET /Products HTTP/1.1
Host: api.sandbox.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"pageNumber": 1,
"pageSize": 1,
"totalPages": 1,
"totalCount": 1,
"nextPage": "https://example.com",
"previousPage": "https://example.com",
"firstPage": "https://example.com",
"lastPage": "https://example.com",
"data": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"productNumber": "text",
"name": "text",
"productType": "Simple",
"category": "text",
"activationDate": "2025-07-01T20:29:17.904Z",
"endOfNewSalesDate": "2025-07-01T20:29:17.904Z",
"endOfRenewalDate": "2025-07-01T20:29:17.904Z",
"endOfLifeDate": "2025-07-01T20:29:17.904Z",
"isFrameworkProduct": true,
"chargePlans": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"chargePlanNumber": "text",
"name": "text",
"effectiveStartDate": "2025-07-01T20:29:17.904Z",
"endOfNewSalesDate": "2025-07-01T20:29:17.904Z",
"effectiveEndDate": "2025-07-01T20:29:17.904Z",
"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": "2025-07-01T20:29:17.904Z",
"modified": "2025-07-01T20:29:17.904Z",
"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": "2025-07-01T20:29:17.904Z",
"modified": "2025-07-01T20:29:17.904Z"
}
],
"externalERPId": "text",
"externalCRMId": "text",
"created": "2025-07-01T20:29:17.904Z",
"modified": "2025-07-01T20:29:17.904Z",
"customFields": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
}
]
}
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": "2025-07-01T20:29:17.904Z",
"externalERPId": "text",
"externalCRMId": "text",
"customFields": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
}
No content
A product can only be deleted if it's not in use on any active orders.
DELETE /Products/{id} HTTP/1.1
Host: api.sandbox.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
No content
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": "2025-07-01T20:29:17.904Z",
"endOfNewSalesDate": "2025-07-01T20:29:17.904Z",
"endOfRenewalDate": "2025-07-01T20:29:17.904Z",
"endOfLifeDate": "2025-07-01T20:29:17.904Z",
"isFrameworkProduct": true,
"chargePlans": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"chargePlanNumber": "text",
"name": "text",
"effectiveStartDate": "2025-07-01T20:29:17.904Z",
"endOfNewSalesDate": "2025-07-01T20:29:17.904Z",
"effectiveEndDate": "2025-07-01T20:29:17.904Z",
"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": "2025-07-01T20:29:17.904Z",
"modified": "2025-07-01T20:29:17.904Z",
"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": "2025-07-01T20:29:17.904Z",
"modified": "2025-07-01T20:29:17.904Z"
}
],
"externalERPId": "text",
"externalCRMId": "text",
"created": "2025-07-01T20:29:17.904Z",
"modified": "2025-07-01T20:29:17.904Z",
"customFields": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
}
A charge plan can only be deleted if it's not in use on any active orders.
DELETE /Products/chargePlans/{id} HTTP/1.1
Host: api.sandbox.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
No content
A charge can only be deleted if it's not in use on any active orders.
DELETE /Products/charges/{id} HTTP/1.1
Host: api.sandbox.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
No content
Last updated