Products

Get Product from ChargePlan Id

get
chevron-right
lockRequired scopes
This endpoint requires the following scopes:
  • : Access Younium API
Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
idstring · uuidRequired
Header parameters
api-versionstringOptional
Responses
chevron-right
200

Success

application/json
idstring · uuidOptional
productNumberstring · nullableOptional
namestring · nullableOptional
productTypeall ofOptional
string · 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
get
/Products/FromChargePlan/{id}

Get Product from Charge Id

get
chevron-right
lockRequired scopes
This endpoint requires the following scopes:
  • : Access Younium API
Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
idstring · uuidRequired
Header parameters
api-versionstringOptional
Responses
chevron-right
200

Success

application/json
idstring · uuidOptional
productNumberstring · nullableOptional
namestring · nullableOptional
productTypeall ofOptional
string · 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
get
/Products/FromCharge/{id}

Get Product Features

get
chevron-right
lockRequired scopes
This endpoint requires the following scopes:
  • : Access Younium API
Authorizations
OAuth2passwordRequired
Token URL:
Query parameters
FilterstringOptional

Filter the results. See developer resources for more information

Example: name eq 'Adam' and age gt 20
OrderBystringOptional

Sorting the results. See developer resources for more information

Example: accountNumber Desc
ModifiedAfterstring · date-timeOptional

Apply a separate modified After filter. See 'ModifiedBefore' filter for further details.

Example: 2026-02-01
ModifiedBeforestring · date-timeOptional

Apply a separate filter to only get records that has been modified Before the specified date time.

Example: 2026-02-01
PageSizeinteger · int32Optional

Page Size

Example: 20
PageNumberinteger · int32Optional

Page Number

Example: 1
Header parameters
api-versionstringOptional
Responses
chevron-right
200

Success

application/json
pageNumberinteger · int32Optional
pageSizeinteger · int32Optional
totalPagesinteger · int32 · nullableOptional
totalCountinteger · int32Optional
nextPagestring · uri · nullableOptional
previousPagestring · uri · nullableOptional
firstPagestring · uri · nullableOptional
lastPagestring · uri · nullableOptional
get
/Products/productFeatures

Create Product

post
chevron-right
lockRequired 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
Responses
post
/Products

Get Products

get
chevron-right
lockRequired scopes
This endpoint requires the following scopes:
  • : Access Younium API
Authorizations
OAuth2passwordRequired
Token URL:
Query parameters
FilterstringOptional

Filter the results. See developer resources for more information

Example: name eq 'Adam' and age gt 20
OrderBystringOptional

Sorting the results. See developer resources for more information

Example: accountNumber Desc
ModifiedAfterstring · date-timeOptional

Apply a separate modified After filter. See 'ModifiedBefore' filter for further details.

Example: 2026-02-01
ModifiedBeforestring · date-timeOptional

Filter is also applied on sub entities: 'chargePlans', 'charges', 'chargeDetails' and 'customFields' on these entities

Example: 2026-02-01
PageSizeinteger · int32Optional

Page Size

Example: 20
PageNumberinteger · int32Optional

Page Number

Example: 1
Header parameters
api-versionstringOptional
Responses
chevron-right
200

Success

application/json
pageNumberinteger · int32Optional
pageSizeinteger · int32Optional
totalPagesinteger · int32 · nullableOptional
totalCountinteger · int32Optional
nextPagestring · uri · nullableOptional
previousPagestring · uri · nullableOptional
firstPagestring · uri · nullableOptional
lastPagestring · uri · nullableOptional
get
/Products

Update Product

patch
chevron-right
lockRequired scopes
This endpoint requires the following scopes:
  • : Access Younium API
Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
idstring · uuidRequired
Header parameters
api-versionstringOptional
Body
Responses
patch
/Products/{id}

No content

Delete product

delete

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

chevron-right
lockRequired scopes
This endpoint requires the following scopes:
  • : Access Younium API
Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
idstring · uuidRequired
Header parameters
api-versionstringOptional
Responses
chevron-right
200

Success

No content

delete
/Products/{id}

No content

Get Products by Id

get
chevron-right
lockRequired scopes
This endpoint requires the following scopes:
  • : Access Younium API
Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
idstring · uuidRequired
Header parameters
api-versionstringOptional
Responses
chevron-right
200

Success

application/json
idstring · uuidOptional
productNumberstring · nullableOptional
namestring · nullableOptional
productTypeall ofOptional
string · 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
get
/Products/{id}
patch
chevron-right
lockRequired scopes
This endpoint requires the following scopes:
  • : Access Younium API
Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
chargeIdstring · uuidRequired
Header parameters
api-versionstringOptional
Body
Responses
patch
/Products/charges/{chargeId}

No content

Delete charge plan

delete

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

chevron-right
lockRequired scopes
This endpoint requires the following scopes:
  • : Access Younium API
Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
idstring · uuidRequired
Header parameters
api-versionstringOptional
Responses
chevron-right
200

Success

No content

delete
/Products/chargePlans/{id}

No content

Delete charges

delete

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

chevron-right
lockRequired scopes
This endpoint requires the following scopes:
  • : Access Younium API
Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
idstring · uuidRequired
Header parameters
api-versionstringOptional
Responses
chevron-right
200

Success

No content

delete
/Products/charges/{id}

No content


Last updated

Was this helpful?