Products
Authorizations
Query parameters
Skipinteger · int32OptionalExample:
Skip number of records
10
Takeinteger · int32OptionalExample:
Take number of records
5
FilterstringOptionalExample:
Filter the resulsts. See ODATA documentation for more information
name eq 'Adam' and age gt 20
SortstringOptionalExample:
Sorting the results. See ODATA specificaion for more information
name
Header parameters
api-versionstringOptional
Responses
200
Success
application/json
400
Bad Request.
application/json
401
Unauthorized
403
Forbidden
get
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": "2025-07-06T15:59:39.719Z",
"endOfNewSalesDate": "2025-07-06T15:59:39.719Z",
"endOfRenewalDate": "2025-07-06T15:59:39.719Z",
"endOfLifeDate": "2025-07-06T15:59:39.719Z",
"isFrameworkProduct": true,
"chargePlans": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"chargePlanNumber": "text",
"name": "text",
"effectiveStartDate": "2025-07-06T15:59:39.719Z",
"endOfNewSalesDate": "2025-07-06T15:59:39.719Z",
"effectiveEndDate": "2025-07-06T15:59:39.719Z",
"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-06T15:59:39.719Z",
"modified": "2025-07-06T15:59:39.719Z",
"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-06T15:59:39.719Z",
"modified": "2025-07-06T15:59:39.719Z"
}
],
"externalERPId": "text",
"externalCRMId": "text",
"created": "2025-07-06T15:59:39.719Z",
"modified": "2025-07-06T15:59:39.719Z",
"customFields": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
}
]
Authorizations
Header parameters
api-versionstringOptional
younium-idempotency-keystringOptional
younium-idempotency-durationInHoursintegerOptional
Body
all ofOptional
Responses
201
Created
application/json
400
Bad Request.
application/json
401
Unauthorized
403
Forbidden
post
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-06T15:59:39.719Z",
"externalERPId": "text",
"externalCRMId": "text",
"customFields": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
}
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"message": "text"
}
Authorizations
Path parameters
idstring · uuidRequired
Header parameters
api-versionstringOptional
Body
all ofOptional
Responses
204
No Content
400
Bad Request.
application/json
401
Unauthorized
403
Forbidden
404
Not Found
application/json
patch
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-06T15:59:39.719Z",
"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.
Authorizations
Path parameters
idstring · uuidRequired
Header parameters
api-versionstringOptional
Responses
200
Success
400
Bad Request.
application/json
401
Unauthorized
403
Forbidden
404
Not Found
application/json
delete
DELETE /Products/{id} HTTP/1.1
Host: api.sandbox.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
No content
Authorizations
Path parameters
idstring · uuidRequired
Header parameters
api-versionstringOptional
Responses
200
Success
application/json
400
Bad Request.
application/json
401
Unauthorized
403
Forbidden
404
Not Found
application/json
get
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-06T15:59:39.719Z",
"endOfNewSalesDate": "2025-07-06T15:59:39.719Z",
"endOfRenewalDate": "2025-07-06T15:59:39.719Z",
"endOfLifeDate": "2025-07-06T15:59:39.719Z",
"isFrameworkProduct": true,
"chargePlans": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"chargePlanNumber": "text",
"name": "text",
"effectiveStartDate": "2025-07-06T15:59:39.719Z",
"endOfNewSalesDate": "2025-07-06T15:59:39.719Z",
"effectiveEndDate": "2025-07-06T15:59:39.719Z",
"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-06T15:59:39.719Z",
"modified": "2025-07-06T15:59:39.719Z",
"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-06T15:59:39.719Z",
"modified": "2025-07-06T15:59:39.719Z"
}
],
"externalERPId": "text",
"externalCRMId": "text",
"created": "2025-07-06T15:59:39.719Z",
"modified": "2025-07-06T15:59:39.719Z",
"customFields": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
}
A charge plan can only be deleted if it's not in use on any active orders.
Authorizations
Path parameters
idstring · uuidRequired
Header parameters
api-versionstringOptional
Responses
200
Success
400
Bad Request.
application/json
401
Unauthorized
403
Forbidden
404
Not Found
application/json
delete
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.
Authorizations
Path parameters
idstring · uuidRequired
Header parameters
api-versionstringOptional
Responses
200
Success
400
Bad Request.
application/json
401
Unauthorized
403
Forbidden
404
Not Found
application/json
delete
DELETE /Products/charges/{id} HTTP/1.1
Host: api.sandbox.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
No content
Last updated