Subscriptions
Last updated
Was this helpful?
Last updated
Was this helpful?
Requires permission Order View
/Subscriptions/{id}
The subscription identifier
curl -L \
--url 'https://api.younium.com/Subscriptions/{id}'
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"orderNumber": "text",
"version": 1,
"isLastVersion": true,
"description": "text",
"remarks": "text",
"effectiveStartDate": "2025-02-22T08:48:58.756Z",
"effectiveEndDate": "2025-02-22T08:48:58.756Z",
"cancellationDate": "2025-02-22T08:48:58.756Z",
"effectiveChangeDate": "2025-02-22T08:48:58.756Z",
"orderDate": "2025-02-22T08:48:58.756Z",
"noticePeriodDate": "2025-02-22T08:48:58.756Z",
"lastRenewalDate": "2025-02-22T08:48:58.756Z",
"created": "2025-02-22T08:48:58.756Z",
"modified": "2025-02-22T08:48:58.756Z",
"lastUpdated": "2024-07-01",
"noticePeriod": 1,
"term": 1,
"renewalTerm": 1,
"isAutoRenewed": true,
"invoiceSeparatly": true,
"yourReference": "text",
"ourReference": "text",
"yourOrderNumber": "text",
"buyerReference": "text",
"setOrderBillingPeriod": true,
"paymentTerm": "text",
"useAccountInvoiceBatchGroup": true,
"currency": "text",
"externalERPId": "text",
"externalCRMId": "text",
"currencyCodeToUseWhenInvoice": "text",
"customFields": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"products": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"productNumber": "text",
"chargePlanId": "123e4567-e89b-12d3-a456-426614174000",
"chargePlanName": "text",
"chargePlanNumber": "text",
"productLineNumber": 1,
"name": "text",
"externalERPId": "text",
"externalCRMId": "text",
"created": "2025-02-22T08:48:58.756Z",
"modified": "2025-02-22T08:48:58.756Z",
"customFields": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"charges": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"chargeNumber": "OPC-000001",
"version": 1,
"isLastVersion": true,
"name": "text",
"effectiveStartDate": "2025-02-22T08:48:58.756Z",
"effectiveEndDate": "2025-02-22T08:48:58.756Z",
"quantity": 1,
"unitCode": "text",
"chargedThroughDate": "2025-02-22T08:48:58.756Z",
"lastRenewalDate": "2025-02-22T08:48:58.756Z",
"lastPriceAdjustmentDate": "2025-02-22T08:48:58.756Z",
"revenueRecognitionRule": "text",
"specificBillingDay": 1,
"alignmentDate": "2025-02-22T08:48:58.756Z",
"taxTemplate": "text",
"taxIncluded": true,
"createInvoiceLinesPerTier": true,
"estimatedUsage": 1,
"estimatedQuantity": 1,
"remainingQuantity": 1,
"orderedQuantity": 1,
"remarks": "text",
"accountsReceivableAccount": "text",
"deferredRevenueAccount": "text",
"recognizedRevenueAccount": "text",
"displayPrice": 1,
"recurringMonthlyAmount": 1,
"recurringMonthlyAmountBase": 1,
"externalERPId": "text",
"externalCRMId": "text",
"orderProductId": "123e4567-e89b-12d3-a456-426614174000",
"orderId": "123e4567-e89b-12d3-a456-426614174000",
"chargeId": "123e4567-e89b-12d3-a456-426614174000",
"created": "2025-02-22T08:48:58.756Z",
"modified": "2025-02-22T08:48:58.756Z",
"customFields": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"priceDetails": [
{
"tier": 1,
"price": 1,
"listPrice": 1,
"description": "text",
"fromQuantity": 1,
"toQuantity": 1,
"lineDiscountPercent": 1,
"lineDiscountAmount": 1,
"priceBase": "Flat"
}
],
"features": [
{
"code": "text",
"description": "text"
}
],
"orderDiscounts": [
{
"orderDiscountId": "123e4567-e89b-12d3-a456-426614174000",
"chargeId": "123e4567-e89b-12d3-a456-426614174000"
}
],
"chargeType": "OneOff",
"priceModel": "Flat",
"startOn": "AlignToSubscription",
"endOn": "AlignToSubscription",
"pricePeriod": "Monthly",
"usageRating": "Sum",
"billingDay": "None",
"billingPeriod": "Monthly",
"billingTiming": "InAdvance",
"periodAlignment": "None",
"changeState": "NotChanged",
"cmrr": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:48:58.756Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"acv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:48:58.756Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"tcv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:48:58.756Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"emrr": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:48:58.756Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"oneTimeFees": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:48:58.756Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
}
}
],
"cmrr": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:48:58.756Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"acv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:48:58.756Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"emrr": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:48:58.756Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"oneTimeFees": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:48:58.756Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"tcv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:48:58.756Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
}
}
],
"milestones": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"orderId": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"description": "text",
"milestoneDate": "2025-02-22T08:48:58.756Z",
"plannedDate": "2025-02-22T08:48:58.756Z"
}
],
"orderDiscounts": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"orderId": "123e4567-e89b-12d3-a456-426614174000",
"startDate": "2025-02-22T08:48:58.756Z",
"endDate": "2025-02-22T08:48:58.756Z",
"percent": 1,
"onSpecificCharges": true,
"orderProductCharges": [
{
"orderDiscountId": "123e4567-e89b-12d3-a456-426614174000",
"chargeId": "123e4567-e89b-12d3-a456-426614174000"
}
],
"startOn": "AlignToOrder",
"endOn": "AlignToOrder",
"discountType": "Percent"
}
],
"status": "Draft",
"orderType": "Subscription",
"termType": "Termed",
"orderPaymentMethod": "Invoice",
"invoiceAddress": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"description": "text",
"name": "text",
"street": "text",
"street2": "text",
"city": "text",
"county": "text",
"state": "text",
"zip": "text",
"country": "text"
},
"deliveryAddress": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"description": "text",
"name": "text",
"street": "text",
"street2": "text",
"city": "text",
"county": "text",
"state": "text",
"zip": "text",
"country": "text"
},
"orderBillingPeriod": "Monthly",
"invoiceBatchGroup": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"code": "text",
"description": "text"
},
"account": {
"name": "text",
"accountNumber": "text",
"id": "123e4567-e89b-12d3-a456-426614174000",
"externalERPId": "text",
"externalCRMId": "text"
},
"invoiceAccount": {
"name": "text",
"accountNumber": "text",
"id": "123e4567-e89b-12d3-a456-426614174000",
"externalERPId": "text",
"externalCRMId": "text"
},
"cmrr": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:48:58.756Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"acv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:48:58.756Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"emrr": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:48:58.756Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"oneTimeFees": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:48:58.756Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"tcv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:48:58.756Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
}
}
Success
/Subscriptions/{id}
curl -L \
--request PATCH \
--url 'https://api.younium.com/Subscriptions/{id}' \
--header 'Content-Type: application/merge-patch+json' \
--data '{"customFields":{"ANY_ADDITIONAL_PROPERTY":"anything"},"invoiceBatchGroup":{}}'
No body
Success
/Subscriptions/{id}
subscription id
curl -L \
--request DELETE \
--url 'https://api.younium.com/Subscriptions/{id}'
No body
Success
/Subscriptions/{orderNumber}/versions
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.
11/01/2024 00:00:00
Filter is also applied on sub entities: 'orderProducts', 'orderCharges', 'chargeDetails', 'orderDiscounts', 'milestones' and 'customFields' on these entities
11/01/2024 00:00:00
Page Size
20
Page Number
1
curl -L \
--url 'https://api.younium.com/Subscriptions/{orderNumber}/versions'
[
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"orderNumber": "text",
"version": 1,
"isLastVersion": true,
"description": "text",
"remarks": "text",
"effectiveStartDate": "2025-02-22T08:48:58.756Z",
"effectiveEndDate": "2025-02-22T08:48:58.756Z",
"cancellationDate": "2025-02-22T08:48:58.756Z",
"effectiveChangeDate": "2025-02-22T08:48:58.756Z",
"orderDate": "2025-02-22T08:48:58.756Z",
"noticePeriodDate": "2025-02-22T08:48:58.756Z",
"lastRenewalDate": "2025-02-22T08:48:58.756Z",
"created": "2025-02-22T08:48:58.756Z",
"modified": "2025-02-22T08:48:58.756Z",
"lastUpdated": "2024-07-01",
"noticePeriod": 1,
"term": 1,
"renewalTerm": 1,
"isAutoRenewed": true,
"invoiceSeparatly": true,
"yourReference": "text",
"ourReference": "text",
"yourOrderNumber": "text",
"buyerReference": "text",
"setOrderBillingPeriod": true,
"paymentTerm": "text",
"useAccountInvoiceBatchGroup": true,
"currency": "text",
"externalERPId": "text",
"externalCRMId": "text",
"currencyCodeToUseWhenInvoice": "text",
"customFields": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"products": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"productNumber": "text",
"chargePlanId": "123e4567-e89b-12d3-a456-426614174000",
"chargePlanName": "text",
"chargePlanNumber": "text",
"productLineNumber": 1,
"name": "text",
"externalERPId": "text",
"externalCRMId": "text",
"created": "2025-02-22T08:48:58.756Z",
"modified": "2025-02-22T08:48:58.756Z",
"customFields": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"charges": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"chargeNumber": "OPC-000001",
"version": 1,
"isLastVersion": true,
"name": "text",
"effectiveStartDate": "2025-02-22T08:48:58.756Z",
"effectiveEndDate": "2025-02-22T08:48:58.756Z",
"quantity": 1,
"unitCode": "text",
"chargedThroughDate": "2025-02-22T08:48:58.756Z",
"lastRenewalDate": "2025-02-22T08:48:58.756Z",
"lastPriceAdjustmentDate": "2025-02-22T08:48:58.756Z",
"revenueRecognitionRule": "text",
"specificBillingDay": 1,
"alignmentDate": "2025-02-22T08:48:58.756Z",
"taxTemplate": "text",
"taxIncluded": true,
"createInvoiceLinesPerTier": true,
"estimatedUsage": 1,
"estimatedQuantity": 1,
"remainingQuantity": 1,
"orderedQuantity": 1,
"remarks": "text",
"accountsReceivableAccount": "text",
"deferredRevenueAccount": "text",
"recognizedRevenueAccount": "text",
"displayPrice": 1,
"recurringMonthlyAmount": 1,
"recurringMonthlyAmountBase": 1,
"externalERPId": "text",
"externalCRMId": "text",
"orderProductId": "123e4567-e89b-12d3-a456-426614174000",
"orderId": "123e4567-e89b-12d3-a456-426614174000",
"chargeId": "123e4567-e89b-12d3-a456-426614174000",
"created": "2025-02-22T08:48:58.756Z",
"modified": "2025-02-22T08:48:58.756Z",
"customFields": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"priceDetails": [
{
"tier": 1,
"price": 1,
"listPrice": 1,
"description": "text",
"fromQuantity": 1,
"toQuantity": 1,
"lineDiscountPercent": 1,
"lineDiscountAmount": 1,
"priceBase": "Flat"
}
],
"features": [
{
"code": "text",
"description": "text"
}
],
"orderDiscounts": [
{
"orderDiscountId": "123e4567-e89b-12d3-a456-426614174000",
"chargeId": "123e4567-e89b-12d3-a456-426614174000"
}
],
"chargeType": "OneOff",
"priceModel": "Flat",
"startOn": "AlignToSubscription",
"endOn": "AlignToSubscription",
"pricePeriod": "Monthly",
"usageRating": "Sum",
"billingDay": "None",
"billingPeriod": "Monthly",
"billingTiming": "InAdvance",
"periodAlignment": "None",
"changeState": "NotChanged",
"cmrr": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:48:58.756Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"acv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:48:58.756Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"tcv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:48:58.756Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"emrr": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:48:58.756Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"oneTimeFees": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:48:58.756Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
}
}
],
"cmrr": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:48:58.756Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"acv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:48:58.756Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"emrr": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:48:58.756Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"oneTimeFees": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:48:58.756Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"tcv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:48:58.756Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
}
}
],
"milestones": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"orderId": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"description": "text",
"milestoneDate": "2025-02-22T08:48:58.756Z",
"plannedDate": "2025-02-22T08:48:58.756Z"
}
],
"orderDiscounts": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"orderId": "123e4567-e89b-12d3-a456-426614174000",
"startDate": "2025-02-22T08:48:58.756Z",
"endDate": "2025-02-22T08:48:58.756Z",
"percent": 1,
"onSpecificCharges": true,
"orderProductCharges": [
{
"orderDiscountId": "123e4567-e89b-12d3-a456-426614174000",
"chargeId": "123e4567-e89b-12d3-a456-426614174000"
}
],
"startOn": "AlignToOrder",
"endOn": "AlignToOrder",
"discountType": "Percent"
}
],
"status": "Draft",
"orderType": "Subscription",
"termType": "Termed",
"orderPaymentMethod": "Invoice",
"invoiceAddress": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"description": "text",
"name": "text",
"street": "text",
"street2": "text",
"city": "text",
"county": "text",
"state": "text",
"zip": "text",
"country": "text"
},
"deliveryAddress": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"description": "text",
"name": "text",
"street": "text",
"street2": "text",
"city": "text",
"county": "text",
"state": "text",
"zip": "text",
"country": "text"
},
"orderBillingPeriod": "Monthly",
"invoiceBatchGroup": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"code": "text",
"description": "text"
},
"account": {
"name": "text",
"accountNumber": "text",
"id": "123e4567-e89b-12d3-a456-426614174000",
"externalERPId": "text",
"externalCRMId": "text"
},
"invoiceAccount": {
"name": "text",
"accountNumber": "text",
"id": "123e4567-e89b-12d3-a456-426614174000",
"externalERPId": "text",
"externalCRMId": "text"
},
"cmrr": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:48:58.756Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"acv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:48:58.756Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"emrr": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:48:58.756Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"oneTimeFees": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:48:58.756Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"tcv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:48:58.756Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
}
}
]
Success
/Subscriptions/{id}/version
curl -L \
--url 'https://api.younium.com/Subscriptions/{id}/version'
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"orderNumber": "text",
"version": 1,
"isLastVersion": true,
"description": "text",
"remarks": "text",
"effectiveStartDate": "2025-02-22T08:48:58.756Z",
"effectiveEndDate": "2025-02-22T08:48:58.756Z",
"cancellationDate": "2025-02-22T08:48:58.756Z",
"effectiveChangeDate": "2025-02-22T08:48:58.756Z",
"orderDate": "2025-02-22T08:48:58.756Z",
"noticePeriodDate": "2025-02-22T08:48:58.756Z",
"lastRenewalDate": "2025-02-22T08:48:58.756Z",
"created": "2025-02-22T08:48:58.756Z",
"modified": "2025-02-22T08:48:58.756Z",
"lastUpdated": "2024-07-01",
"noticePeriod": 1,
"term": 1,
"renewalTerm": 1,
"isAutoRenewed": true,
"invoiceSeparatly": true,
"yourReference": "text",
"ourReference": "text",
"yourOrderNumber": "text",
"buyerReference": "text",
"setOrderBillingPeriod": true,
"paymentTerm": "text",
"useAccountInvoiceBatchGroup": true,
"currency": "text",
"externalERPId": "text",
"externalCRMId": "text",
"currencyCodeToUseWhenInvoice": "text",
"customFields": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"products": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"productNumber": "text",
"chargePlanId": "123e4567-e89b-12d3-a456-426614174000",
"chargePlanName": "text",
"chargePlanNumber": "text",
"productLineNumber": 1,
"name": "text",
"externalERPId": "text",
"externalCRMId": "text",
"created": "2025-02-22T08:48:58.756Z",
"modified": "2025-02-22T08:48:58.756Z",
"customFields": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"charges": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"chargeNumber": "OPC-000001",
"version": 1,
"isLastVersion": true,
"name": "text",
"effectiveStartDate": "2025-02-22T08:48:58.756Z",
"effectiveEndDate": "2025-02-22T08:48:58.756Z",
"quantity": 1,
"unitCode": "text",
"chargedThroughDate": "2025-02-22T08:48:58.756Z",
"lastRenewalDate": "2025-02-22T08:48:58.756Z",
"lastPriceAdjustmentDate": "2025-02-22T08:48:58.756Z",
"revenueRecognitionRule": "text",
"specificBillingDay": 1,
"alignmentDate": "2025-02-22T08:48:58.756Z",
"taxTemplate": "text",
"taxIncluded": true,
"createInvoiceLinesPerTier": true,
"estimatedUsage": 1,
"estimatedQuantity": 1,
"remainingQuantity": 1,
"orderedQuantity": 1,
"remarks": "text",
"accountsReceivableAccount": "text",
"deferredRevenueAccount": "text",
"recognizedRevenueAccount": "text",
"displayPrice": 1,
"recurringMonthlyAmount": 1,
"recurringMonthlyAmountBase": 1,
"externalERPId": "text",
"externalCRMId": "text",
"orderProductId": "123e4567-e89b-12d3-a456-426614174000",
"orderId": "123e4567-e89b-12d3-a456-426614174000",
"chargeId": "123e4567-e89b-12d3-a456-426614174000",
"created": "2025-02-22T08:48:58.756Z",
"modified": "2025-02-22T08:48:58.756Z",
"customFields": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"priceDetails": [
{
"tier": 1,
"price": 1,
"listPrice": 1,
"description": "text",
"fromQuantity": 1,
"toQuantity": 1,
"lineDiscountPercent": 1,
"lineDiscountAmount": 1,
"priceBase": "Flat"
}
],
"features": [
{
"code": "text",
"description": "text"
}
],
"orderDiscounts": [
{
"orderDiscountId": "123e4567-e89b-12d3-a456-426614174000",
"chargeId": "123e4567-e89b-12d3-a456-426614174000"
}
],
"chargeType": "OneOff",
"priceModel": "Flat",
"startOn": "AlignToSubscription",
"endOn": "AlignToSubscription",
"pricePeriod": "Monthly",
"usageRating": "Sum",
"billingDay": "None",
"billingPeriod": "Monthly",
"billingTiming": "InAdvance",
"periodAlignment": "None",
"changeState": "NotChanged",
"cmrr": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:48:58.756Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"acv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:48:58.756Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"tcv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:48:58.756Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"emrr": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:48:58.756Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"oneTimeFees": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:48:58.756Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
}
}
],
"cmrr": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:48:58.756Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"acv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:48:58.756Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"emrr": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:48:58.756Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"oneTimeFees": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:48:58.756Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"tcv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:48:58.756Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
}
}
],
"milestones": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"orderId": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"description": "text",
"milestoneDate": "2025-02-22T08:48:58.756Z",
"plannedDate": "2025-02-22T08:48:58.756Z"
}
],
"orderDiscounts": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"orderId": "123e4567-e89b-12d3-a456-426614174000",
"startDate": "2025-02-22T08:48:58.756Z",
"endDate": "2025-02-22T08:48:58.756Z",
"percent": 1,
"onSpecificCharges": true,
"orderProductCharges": [
{
"orderDiscountId": "123e4567-e89b-12d3-a456-426614174000",
"chargeId": "123e4567-e89b-12d3-a456-426614174000"
}
],
"startOn": "AlignToOrder",
"endOn": "AlignToOrder",
"discountType": "Percent"
}
],
"status": "Draft",
"orderType": "Subscription",
"termType": "Termed",
"orderPaymentMethod": "Invoice",
"invoiceAddress": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"description": "text",
"name": "text",
"street": "text",
"street2": "text",
"city": "text",
"county": "text",
"state": "text",
"zip": "text",
"country": "text"
},
"deliveryAddress": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"description": "text",
"name": "text",
"street": "text",
"street2": "text",
"city": "text",
"county": "text",
"state": "text",
"zip": "text",
"country": "text"
},
"orderBillingPeriod": "Monthly",
"invoiceBatchGroup": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"code": "text",
"description": "text"
},
"account": {
"name": "text",
"accountNumber": "text",
"id": "123e4567-e89b-12d3-a456-426614174000",
"externalERPId": "text",
"externalCRMId": "text"
},
"invoiceAccount": {
"name": "text",
"accountNumber": "text",
"id": "123e4567-e89b-12d3-a456-426614174000",
"externalERPId": "text",
"externalCRMId": "text"
},
"cmrr": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:48:58.756Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"acv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:48:58.756Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"emrr": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:48:58.756Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"oneTimeFees": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:48:58.756Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"tcv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:48:58.756Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
}
}
Success
/Subscriptions/{orderNumber}/versions/{version}
curl -L \
--url 'https://api.younium.com/Subscriptions/{orderNumber}/versions/{version}'
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"orderNumber": "text",
"version": 1,
"isLastVersion": true,
"description": "text",
"remarks": "text",
"effectiveStartDate": "2025-02-22T08:48:58.756Z",
"effectiveEndDate": "2025-02-22T08:48:58.756Z",
"cancellationDate": "2025-02-22T08:48:58.756Z",
"effectiveChangeDate": "2025-02-22T08:48:58.756Z",
"orderDate": "2025-02-22T08:48:58.756Z",
"noticePeriodDate": "2025-02-22T08:48:58.756Z",
"lastRenewalDate": "2025-02-22T08:48:58.756Z",
"created": "2025-02-22T08:48:58.756Z",
"modified": "2025-02-22T08:48:58.756Z",
"lastUpdated": "2024-07-01",
"noticePeriod": 1,
"term": 1,
"renewalTerm": 1,
"isAutoRenewed": true,
"invoiceSeparatly": true,
"yourReference": "text",
"ourReference": "text",
"yourOrderNumber": "text",
"buyerReference": "text",
"setOrderBillingPeriod": true,
"paymentTerm": "text",
"useAccountInvoiceBatchGroup": true,
"currency": "text",
"externalERPId": "text",
"externalCRMId": "text",
"currencyCodeToUseWhenInvoice": "text",
"customFields": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"products": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"productNumber": "text",
"chargePlanId": "123e4567-e89b-12d3-a456-426614174000",
"chargePlanName": "text",
"chargePlanNumber": "text",
"productLineNumber": 1,
"name": "text",
"externalERPId": "text",
"externalCRMId": "text",
"created": "2025-02-22T08:48:58.756Z",
"modified": "2025-02-22T08:48:58.756Z",
"customFields": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"charges": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"chargeNumber": "OPC-000001",
"version": 1,
"isLastVersion": true,
"name": "text",
"effectiveStartDate": "2025-02-22T08:48:58.756Z",
"effectiveEndDate": "2025-02-22T08:48:58.756Z",
"quantity": 1,
"unitCode": "text",
"chargedThroughDate": "2025-02-22T08:48:58.756Z",
"lastRenewalDate": "2025-02-22T08:48:58.756Z",
"lastPriceAdjustmentDate": "2025-02-22T08:48:58.756Z",
"revenueRecognitionRule": "text",
"specificBillingDay": 1,
"alignmentDate": "2025-02-22T08:48:58.756Z",
"taxTemplate": "text",
"taxIncluded": true,
"createInvoiceLinesPerTier": true,
"estimatedUsage": 1,
"estimatedQuantity": 1,
"remainingQuantity": 1,
"orderedQuantity": 1,
"remarks": "text",
"accountsReceivableAccount": "text",
"deferredRevenueAccount": "text",
"recognizedRevenueAccount": "text",
"displayPrice": 1,
"recurringMonthlyAmount": 1,
"recurringMonthlyAmountBase": 1,
"externalERPId": "text",
"externalCRMId": "text",
"orderProductId": "123e4567-e89b-12d3-a456-426614174000",
"orderId": "123e4567-e89b-12d3-a456-426614174000",
"chargeId": "123e4567-e89b-12d3-a456-426614174000",
"created": "2025-02-22T08:48:58.756Z",
"modified": "2025-02-22T08:48:58.756Z",
"customFields": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"priceDetails": [
{
"tier": 1,
"price": 1,
"listPrice": 1,
"description": "text",
"fromQuantity": 1,
"toQuantity": 1,
"lineDiscountPercent": 1,
"lineDiscountAmount": 1,
"priceBase": "Flat"
}
],
"features": [
{
"code": "text",
"description": "text"
}
],
"orderDiscounts": [
{
"orderDiscountId": "123e4567-e89b-12d3-a456-426614174000",
"chargeId": "123e4567-e89b-12d3-a456-426614174000"
}
],
"chargeType": "OneOff",
"priceModel": "Flat",
"startOn": "AlignToSubscription",
"endOn": "AlignToSubscription",
"pricePeriod": "Monthly",
"usageRating": "Sum",
"billingDay": "None",
"billingPeriod": "Monthly",
"billingTiming": "InAdvance",
"periodAlignment": "None",
"changeState": "NotChanged",
"cmrr": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:48:58.756Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"acv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:48:58.756Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"tcv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:48:58.756Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"emrr": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:48:58.756Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"oneTimeFees": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:48:58.756Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
}
}
],
"cmrr": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:48:58.756Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"acv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:48:58.756Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"emrr": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:48:58.756Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"oneTimeFees": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:48:58.756Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"tcv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:48:58.756Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
}
}
],
"milestones": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"orderId": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"description": "text",
"milestoneDate": "2025-02-22T08:48:58.756Z",
"plannedDate": "2025-02-22T08:48:58.756Z"
}
],
"orderDiscounts": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"orderId": "123e4567-e89b-12d3-a456-426614174000",
"startDate": "2025-02-22T08:48:58.756Z",
"endDate": "2025-02-22T08:48:58.756Z",
"percent": 1,
"onSpecificCharges": true,
"orderProductCharges": [
{
"orderDiscountId": "123e4567-e89b-12d3-a456-426614174000",
"chargeId": "123e4567-e89b-12d3-a456-426614174000"
}
],
"startOn": "AlignToOrder",
"endOn": "AlignToOrder",
"discountType": "Percent"
}
],
"status": "Draft",
"orderType": "Subscription",
"termType": "Termed",
"orderPaymentMethod": "Invoice",
"invoiceAddress": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"description": "text",
"name": "text",
"street": "text",
"street2": "text",
"city": "text",
"county": "text",
"state": "text",
"zip": "text",
"country": "text"
},
"deliveryAddress": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"description": "text",
"name": "text",
"street": "text",
"street2": "text",
"city": "text",
"county": "text",
"state": "text",
"zip": "text",
"country": "text"
},
"orderBillingPeriod": "Monthly",
"invoiceBatchGroup": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"code": "text",
"description": "text"
},
"account": {
"name": "text",
"accountNumber": "text",
"id": "123e4567-e89b-12d3-a456-426614174000",
"externalERPId": "text",
"externalCRMId": "text"
},
"invoiceAccount": {
"name": "text",
"accountNumber": "text",
"id": "123e4567-e89b-12d3-a456-426614174000",
"externalERPId": "text",
"externalCRMId": "text"
},
"cmrr": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:48:58.756Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"acv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:48:58.756Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"emrr": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:48:58.756Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"oneTimeFees": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:48:58.756Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"tcv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:48:58.756Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
}
}
Success
/Subscriptions
If true, billing period will be set from order billing period and billing period on charges will be ignored.
Allowed as string input: Name, PaymentTerm-Id.
NET30
Allowed as string input: AccountNumber, Account-Id, Name.
A-000001
Allowed as string input: AccountNumber, Account-Id, Name.
A-000001
Allowed as string input: Code, Currency-Id.
SEK
curl -L \
--request POST \
--url 'https://api.younium.com/Subscriptions' \
--header 'Content-Type: application/json' \
--data '{"customFields":{"ANY_ADDITIONAL_PROPERTY":"anything"},"products":[{"customFields":{"ANY_ADDITIONAL_PROPERTY":"anything"},"charges":[{"customFields":{"ANY_ADDITIONAL_PROPERTY":"anything"},"priceDetails":[{"priceBase":"Flat"}],"features":[{"feature":{}}],"orderDiscountMappingKey":[null],"charge":{},"chargeType":"OneOff","priceModel":"Flat","unitCode":"pcs","startOn":"AlignToSubscription","endOn":"AlignToSubscription","pricePeriod":"Monthly","usageRating":"Sum","revenueRecognitionRule":{},"billingDay":"None","billingPeriod":"Monthly","billingTiming":"InAdvance","periodAlignment":"None","taxTemplate":"Sweden standard","deferredRevenueAccount":"1510","recognizedRevenueAccount":"1510","changeState":"NotChanged"}],"product":"P-000001","chargePlan":"CP-000001"}],"milestones":[{"name":"text"}],"orderDiscounts":[{"orderProductCharges":[{"charge":"OPC-000001","operation":"Remove"}],"operation":"Change","OrderDiscountId":"GUID","startOn":"AlignToOrder","endOn":"AlignToOrder"}],"status":"Draft","orderType":"Subscription","subscriptionType":"Termed","orderPaymentMethod":"Invoice","paymentTerm":"NET30","account":"A-000001","invoiceAccount":"A-000001","currency":"SEK","invoiceBatchGroup":{},"orderBillingPeriod":"Monthly"}'
No body
Subscription created.
/Subscriptions
Skip number of records
10
Take number of records
5
Filter the resulsts. See ODATA documentation for more information
name eq 'Adam' and age gt 20
Sorting the results. See ODATA specificaion for more information
name
curl -L \
--url 'https://api.younium.com/Subscriptions'
[
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"orderNumber": "text",
"version": 1,
"isLastVersion": true,
"description": "text",
"remarks": "text",
"effectiveStartDate": "2025-02-22T08:48:58.756Z",
"effectiveEndDate": "2025-02-22T08:48:58.756Z",
"cancellationDate": "2025-02-22T08:48:58.756Z",
"effectiveChangeDate": "2025-02-22T08:48:58.756Z",
"orderDate": "2025-02-22T08:48:58.756Z",
"noticePeriodDate": "2025-02-22T08:48:58.756Z",
"lastRenewalDate": "2025-02-22T08:48:58.756Z",
"created": "2025-02-22T08:48:58.756Z",
"modified": "2025-02-22T08:48:58.756Z",
"lastUpdated": "2024-07-01",
"noticePeriod": 1,
"term": 1,
"renewalTerm": 1,
"isAutoRenewed": true,
"invoiceSeparatly": true,
"yourReference": "text",
"ourReference": "text",
"yourOrderNumber": "text",
"buyerReference": "text",
"setOrderBillingPeriod": true,
"paymentTerm": "text",
"useAccountInvoiceBatchGroup": true,
"currency": "text",
"externalERPId": "text",
"externalCRMId": "text",
"currencyCodeToUseWhenInvoice": "text",
"customFields": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"products": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"productNumber": "text",
"chargePlanId": "123e4567-e89b-12d3-a456-426614174000",
"chargePlanName": "text",
"chargePlanNumber": "text",
"productLineNumber": 1,
"name": "text",
"externalERPId": "text",
"externalCRMId": "text",
"created": "2025-02-22T08:48:58.756Z",
"modified": "2025-02-22T08:48:58.756Z",
"customFields": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"charges": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"chargeNumber": "OPC-000001",
"version": 1,
"isLastVersion": true,
"name": "text",
"effectiveStartDate": "2025-02-22T08:48:58.756Z",
"effectiveEndDate": "2025-02-22T08:48:58.756Z",
"quantity": 1,
"unitCode": "text",
"chargedThroughDate": "2025-02-22T08:48:58.756Z",
"lastRenewalDate": "2025-02-22T08:48:58.756Z",
"lastPriceAdjustmentDate": "2025-02-22T08:48:58.756Z",
"revenueRecognitionRule": "text",
"specificBillingDay": 1,
"alignmentDate": "2025-02-22T08:48:58.756Z",
"taxTemplate": "text",
"taxIncluded": true,
"createInvoiceLinesPerTier": true,
"estimatedUsage": 1,
"estimatedQuantity": 1,
"remainingQuantity": 1,
"orderedQuantity": 1,
"remarks": "text",
"accountsReceivableAccount": "text",
"deferredRevenueAccount": "text",
"recognizedRevenueAccount": "text",
"displayPrice": 1,
"recurringMonthlyAmount": 1,
"recurringMonthlyAmountBase": 1,
"externalERPId": "text",
"externalCRMId": "text",
"orderProductId": "123e4567-e89b-12d3-a456-426614174000",
"orderId": "123e4567-e89b-12d3-a456-426614174000",
"chargeId": "123e4567-e89b-12d3-a456-426614174000",
"created": "2025-02-22T08:48:58.756Z",
"modified": "2025-02-22T08:48:58.756Z",
"customFields": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"priceDetails": [
{
"tier": 1,
"price": 1,
"listPrice": 1,
"description": "text",
"fromQuantity": 1,
"toQuantity": 1,
"lineDiscountPercent": 1,
"lineDiscountAmount": 1,
"priceBase": "Flat"
}
],
"features": [
{
"code": "text",
"description": "text"
}
],
"orderDiscounts": [
{
"orderDiscountId": "123e4567-e89b-12d3-a456-426614174000",
"chargeId": "123e4567-e89b-12d3-a456-426614174000"
}
],
"chargeType": "OneOff",
"priceModel": "Flat",
"startOn": "AlignToSubscription",
"endOn": "AlignToSubscription",
"pricePeriod": "Monthly",
"usageRating": "Sum",
"billingDay": "None",
"billingPeriod": "Monthly",
"billingTiming": "InAdvance",
"periodAlignment": "None",
"changeState": "NotChanged",
"cmrr": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:48:58.756Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"acv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:48:58.756Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"tcv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:48:58.756Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"emrr": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:48:58.756Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"oneTimeFees": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:48:58.756Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
}
}
],
"cmrr": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:48:58.756Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"acv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:48:58.756Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"emrr": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:48:58.756Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"oneTimeFees": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:48:58.756Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"tcv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:48:58.756Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
}
}
],
"milestones": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"orderId": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"description": "text",
"milestoneDate": "2025-02-22T08:48:58.756Z",
"plannedDate": "2025-02-22T08:48:58.756Z"
}
],
"orderDiscounts": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"orderId": "123e4567-e89b-12d3-a456-426614174000",
"startDate": "2025-02-22T08:48:58.756Z",
"endDate": "2025-02-22T08:48:58.756Z",
"percent": 1,
"onSpecificCharges": true,
"orderProductCharges": [
{
"orderDiscountId": "123e4567-e89b-12d3-a456-426614174000",
"chargeId": "123e4567-e89b-12d3-a456-426614174000"
}
],
"startOn": "AlignToOrder",
"endOn": "AlignToOrder",
"discountType": "Percent"
}
],
"status": "Draft",
"orderType": "Subscription",
"termType": "Termed",
"orderPaymentMethod": "Invoice",
"invoiceAddress": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"description": "text",
"name": "text",
"street": "text",
"street2": "text",
"city": "text",
"county": "text",
"state": "text",
"zip": "text",
"country": "text"
},
"deliveryAddress": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"description": "text",
"name": "text",
"street": "text",
"street2": "text",
"city": "text",
"county": "text",
"state": "text",
"zip": "text",
"country": "text"
},
"orderBillingPeriod": "Monthly",
"invoiceBatchGroup": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"code": "text",
"description": "text"
},
"account": {
"name": "text",
"accountNumber": "text",
"id": "123e4567-e89b-12d3-a456-426614174000",
"externalERPId": "text",
"externalCRMId": "text"
},
"invoiceAccount": {
"name": "text",
"accountNumber": "text",
"id": "123e4567-e89b-12d3-a456-426614174000",
"externalERPId": "text",
"externalCRMId": "text"
},
"cmrr": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:48:58.756Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"acv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:48:58.756Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"emrr": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:48:58.756Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"oneTimeFees": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:48:58.756Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"tcv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:48:58.756Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
}
}
]
Success
/Subscriptions/{id}/change
Allowed as string input: AccountNumber, Account-Id, Name.
A-000001
Allowed as string input: AccountNumber, Account-Id, Name.
A-000001
Allowed as string input: Code, Currency-Id.
SEK
Allowed as string input: Name, PaymentTerm-Id.
NET30
curl -L \
--request POST \
--url 'https://api.younium.com/Subscriptions/{id}/change' \
--header 'Content-Type: application/json' \
--data '{"customFields":{"ANY_ADDITIONAL_PROPERTY":"anything"},"products":[{"customFields":{"ANY_ADDITIONAL_PROPERTY":"anything"},"charges":[{"customFields":{"ANY_ADDITIONAL_PROPERTY":"anything"},"priceDetails":[{"operation":"Change","priceBase":"Flat"}],"features":[{"operation":"Remove","feature":{}}],"orderDiscountMappingKey":[null],"charge":"OPC-000001","chargeType":"OneOff","priceModel":"Flat","pricePeriod":"Monthly","unitCode":"pcs","startOn":"AlignToSubscription","endOn":"AlignToSubscription","deferredRevenueAccount":"1510","recognizedRevenueAccount":"1510","usageRating":"Sum","revenueRecognitionRule":{},"billingDay":"None","billingPeriod":"Monthly","billingTiming":"InAdvance","periodAlignment":"None","taxTemplate":"Sweden standard","startMilestone":"MilestoneName","endMilestone":"MilestoneName"}],"operation":"Change","product":"OP-000001","chargePlan":"CP-000001","cancelProductOn":"EffectiveEndDate"}],"milestones":[{"name":"text"}],"orderDiscounts":[{"orderProductCharges":[{"charge":"OPC-000001","operation":"Remove"}],"operation":"Change","OrderDiscountId":"GUID","startOn":"AlignToOrder","endOn":"AlignToOrder"}],"account":"A-000001","invoiceAccount":"A-000001","subscriptionType":"Termed","currency":"SEK","paymentTerm":"NET30","orderPaymentMethod":"Invoice","invoiceBatchGroup":{},"orderBillingPeriod":"Monthly"}'
No body
New version of Subscription created.
/Subscriptions/cancel/{id}
subscription id
The first effective day of the cancellation. I.e if the subscriptions ends Dec 31, the first day of cancellation is Jan 1
2024-07-01
Subscription end date
2024-12-31
List of order product charge numbers and cancellation dates
curl -L \
--request POST \
--url 'https://api.younium.com/Subscriptions/cancel/{id}' \
--header 'Content-Type: application/json' \
--data '{"firstDayOfCancellation":"2024-07-01","endDate":"2024-12-31","cancellationDate":"2025-02-22T08:48:58.756Z","cancellationDatePerCharges":{},"cancellationMode":"OnOrderCancellationDate"}'
No body
Success
/Subscriptions/renew/{id}
subscription id
curl -L \
--request POST \
--url 'https://api.younium.com/Subscriptions/renew/{id}' \
--header 'Content-Type: application/json' \
--data '{"renewalTerm":1,"nextRenewalTerm":1}'
No body
Success
/Subscriptions/revert/{id}
subscription id
curl -L \
--request POST \
--url 'https://api.younium.com/Subscriptions/revert/{id}'
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"message": "text"
}
Success
/Subscriptions/activate/{id}
curl -L \
--request POST \
--url 'https://api.younium.com/Subscriptions/activate/{id}'
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"message": "text"
}
Success
/Subscriptions/{id}/milestones
subscription id
curl -L \
--url 'https://api.younium.com/Subscriptions/{id}/milestones'
[
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"orderId": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"description": "text",
"milestoneDate": "2025-02-22T08:48:58.756Z",
"plannedDate": "2025-02-22T08:48:58.756Z"
}
]
Success
/Subscriptions/milestones/set/{id}
Subscription Milestone Id
curl -L \
--request POST \
--url 'https://api.younium.com/Subscriptions/milestones/set/{id}' \
--header 'Content-Type: application/json' \
--data '{"milestoneDate":"2025-02-22T08:48:58.756Z"}'
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"orderId": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"description": "text",
"milestoneDate": "2025-02-22T08:48:58.756Z",
"plannedDate": "2025-02-22T08:48:58.756Z"
}
Success
Edit and create OrderDiscounts on an existing order. This will create a new version of the order.
/Subscriptions/{id}/OrderDiscounts
curl -L \
--request POST \
--url 'https://api.younium.com/Subscriptions/{id}/OrderDiscounts' \
--header 'Content-Type: application/json' \
--data '{"orderDiscounts":[{"orderProductCharges":[{"charge":"OPC-000001","operation":"Remove"}],"operation":"Change","OrderDiscountId":"GUID","startOn":"AlignToOrder","endOn":"AlignToOrder"}]}'
No body
Success