Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Subscriptions

Get Subscription by Id

get

Requires permission Order View

Required scopes
This endpoint requires the following scopes:
  • : Access Younium API
Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
idstring · uuidRequired

The subscription identifier

Header parameters
api-versionstringOptional
Responses
200

Success

application/json
idstring · uuidOptional
orderNumberstring · nullableOptional
versioninteger · int32Optional
isLastVersionbooleanOptional
statusstring · enumOptionalPossible values:
descriptionstring · nullableOptional
remarksstring · nullableOptional
effectiveStartDatestring · date-timeOptional
effectiveEndDatestring · date-time · nullableOptional
cancellationDatestring · date-time · nullableOptional
effectiveChangeDatestring · date-time · nullableOptional
orderDatestring · date-time · nullableOptional
noticePeriodDatestring · date-time · nullableOptional
lastRenewalDatestring · date-time · nullableOptional
createdstring · date-timeOptional
modifiedstring · date-timeOptional
lastUpdatedstring · date-time · nullableOptional

Date of when latest update occurred on the order or it's sub entities

Example: 2024-07-01
noticePeriodinteger · int32Optional
terminteger · int32Optional
renewalTerminteger · int32Optional
isAutoRenewedbooleanOptional
orderTypestring · enumOptionalPossible values:
termTypestring · enumOptionalPossible values:
orderPaymentMethodstring · enumOptionalPossible values:
invoiceSeparatlybooleanOptional
yourReferencestring · nullableOptional
ourReferencestring · nullableOptional
yourOrderNumberstring · nullableOptional
buyerReferencestring · nullableOptional
orderBillingPeriodstring · enumOptionalPossible values:
setOrderBillingPeriodbooleanOptional
paymentTermstring · nullableOptional
useAccountInvoiceBatchGroupbooleanOptional
currencystring · nullableOptional
externalERPIdstring · nullableOptional
externalCRMIdstring · nullableOptional
currencyCodeToUseWhenInvoicestring · nullableOptional
get/Subscriptions/{id}
GET /Subscriptions/{id} HTTP/1.1
Host: api.sandbox.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "orderNumber": "text",
  "version": 1,
  "isLastVersion": true,
  "status": "Draft",
  "description": "text",
  "remarks": "text",
  "effectiveStartDate": "2026-01-01T00:00:00.000Z",
  "effectiveEndDate": "2026-01-01T00:00:00.000Z",
  "cancellationDate": "2026-01-01T00:00:00.000Z",
  "effectiveChangeDate": "2026-01-01T00:00:00.000Z",
  "orderDate": "2026-01-01T00:00:00.000Z",
  "noticePeriodDate": "2026-01-01T00:00:00.000Z",
  "lastRenewalDate": "2026-01-01T00:00:00.000Z",
  "created": "2026-01-01T00:00:00.000Z",
  "modified": "2026-01-01T00:00:00.000Z",
  "lastUpdated": "2024-07-01",
  "noticePeriod": 1,
  "term": 1,
  "renewalTerm": 1,
  "isAutoRenewed": true,
  "orderType": "Subscription",
  "termType": "Termed",
  "orderPaymentMethod": "Invoice",
  "invoiceSeparatly": true,
  "yourReference": "text",
  "ourReference": "text",
  "yourOrderNumber": "text",
  "buyerReference": "text",
  "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",
  "setOrderBillingPeriod": true,
  "invoiceBatchGroup": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "code": "text",
    "description": "text"
  },
  "paymentTerm": "text",
  "useAccountInvoiceBatchGroup": true,
  "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"
  },
  "products": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "productNumber": "text",
      "chargePlanId": "123e4567-e89b-12d3-a456-426614174000",
      "chargePlanName": "text",
      "chargePlanNumber": "text",
      "productLineNumber": 1,
      "name": "text",
      "charges": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "chargeNumber": "OPC-000001",
          "version": 1,
          "isLastVersion": true,
          "name": "text",
          "chargeType": "OneOff",
          "priceModel": "Flat",
          "effectiveStartDate": "2026-01-01T00:00:00.000Z",
          "effectiveEndDate": "2026-01-01T00:00:00.000Z",
          "quantity": 1,
          "unitCode": "text",
          "startOn": "AlignToSubscription",
          "endOn": "AlignToSubscription",
          "chargedThroughDate": "2026-01-01T00:00:00.000Z",
          "lastRenewalDate": "2026-01-01T00:00:00.000Z",
          "lastPriceAdjustmentDate": "2026-01-01T00:00:00.000Z",
          "pricePeriod": "Monthly",
          "usageRating": "Sum",
          "revenueRecognitionRule": "text",
          "billingDay": "None",
          "specificBillingDay": 1,
          "offsetBillingDays": 1,
          "billingPeriod": "Monthly",
          "billingTiming": "InAdvance",
          "periodAlignment": "None",
          "alignmentDate": "2026-01-01T00:00:00.000Z",
          "taxTemplate": "text",
          "taxIncluded": true,
          "createInvoiceLinesPerTier": true,
          "estimatedUsage": 1,
          "estimatedQuantity": 1,
          "remainingQuantity": 1,
          "orderedQuantity": 1,
          "deliveryDate": "2026-01-01T00:00:00.000Z",
          "remarks": "text",
          "accountsReceivableAccount": "text",
          "deferredRevenueAccount": "text",
          "recognizedRevenueAccount": "text",
          "changeState": "NotChanged",
          "displayPrice": 1,
          "customFields": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "priceDetails": [
            {
              "tier": 1,
              "price": 1,
              "listPrice": 1,
              "description": "text",
              "fromQuantity": 1,
              "toQuantity": 1,
              "priceBase": "Flat",
              "lineDiscountPercent": 1,
              "lineDiscountAmount": 1
            }
          ],
          "recurringMonthlyAmount": 1,
          "recurringMonthlyAmountBase": 1,
          "features": [
            {
              "code": "text",
              "description": "text"
            }
          ],
          "orderDiscounts": [
            {
              "orderDiscountId": "123e4567-e89b-12d3-a456-426614174000",
              "chargeId": "123e4567-e89b-12d3-a456-426614174000"
            }
          ],
          "externalERPId": "text",
          "externalCRMId": "text",
          "cmrr": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2026-01-01T00:00:00.000Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "acv": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2026-01-01T00:00:00.000Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "tcv": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2026-01-01T00:00:00.000Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "emrr": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2026-01-01T00:00:00.000Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "oneTimeFees": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2026-01-01T00:00:00.000Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "price": 1,
          "listPrice": 1,
          "discountAmount": 1,
          "discountPercentage": 1,
          "totalPrice": 1,
          "totalListPrice": 1,
          "totalDiscountAmount": 1,
          "totalDiscountPercentage": 1,
          "totalPerInvoice": 1,
          "orderProductId": "123e4567-e89b-12d3-a456-426614174000",
          "orderId": "123e4567-e89b-12d3-a456-426614174000",
          "chargeId": "123e4567-e89b-12d3-a456-426614174000",
          "created": "2026-01-01T00:00:00.000Z",
          "modified": "2026-01-01T00:00:00.000Z"
        }
      ],
      "customFields": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "externalERPId": "text",
      "externalCRMId": "text",
      "cmrr": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2026-01-01T00:00:00.000Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "acv": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2026-01-01T00:00:00.000Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "emrr": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2026-01-01T00:00:00.000Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "oneTimeFees": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2026-01-01T00:00:00.000Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "tcv": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2026-01-01T00:00:00.000Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "created": "2026-01-01T00:00:00.000Z",
      "modified": "2026-01-01T00:00:00.000Z"
    }
  ],
  "milestones": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "orderId": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "milestoneDate": "2026-01-01T00:00:00.000Z",
      "plannedDate": "2026-01-01T00:00:00.000Z"
    }
  ],
  "orderDiscounts": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "orderId": "123e4567-e89b-12d3-a456-426614174000",
      "startOn": "AlignToOrder",
      "endOn": "AlignToOrder",
      "startDate": "2026-01-01T00:00:00.000Z",
      "endDate": "2026-01-01T00:00:00.000Z",
      "percent": 1,
      "discountType": "Percent",
      "description": "text",
      "orderProductCharges": [
        {
          "orderDiscountId": "123e4567-e89b-12d3-a456-426614174000",
          "chargeId": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "onSpecificCharges": true
    }
  ],
  "currency": "text",
  "externalERPId": "text",
  "externalCRMId": "text",
  "currencyCodeToUseWhenInvoice": "text",
  "customFields": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "cmrr": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2026-01-01T00:00:00.000Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  },
  "acv": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2026-01-01T00:00:00.000Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  },
  "emrr": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2026-01-01T00:00:00.000Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  },
  "oneTimeFees": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2026-01-01T00:00:00.000Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  },
  "tcv": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2026-01-01T00:00:00.000Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  }
}

Patch Subscription

patch
Required scopes
This endpoint requires the following scopes:
  • : Access Younium API
Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
idstring · uuidRequired
Header parameters
api-versionstringOptional
Body
descriptionstring · nullableOptional
remarksstring · nullableOptional
noticePeriodinteger · int32 · nullableOptional
invoiceSeparatlybooleanOptional
useAccountInvoiceBatchGroupbooleanOptional
invoiceBatchGroupIdstring · uuid · nullableOptionalDeprecated
invoiceTemplateIdstring · uuid · nullableOptional
externalERPIdstring · nullableOptional
externalCRMIdstring · nullableOptional
buyerReferencestring · nullableOptional
yourOrderNumberstring · nullableOptional
yourReferencestring · nullableOptional
ourReferencestring · nullableOptional
Responses
200

Success

No content
patch/Subscriptions/{id}
PATCH /Subscriptions/{id} HTTP/1.1
Host: api.sandbox.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/merge-patch+json
Accept: */*
Content-Length: 440

{
  "description": "text",
  "remarks": "text",
  "noticePeriod": 1,
  "invoiceSeparatly": true,
  "useAccountInvoiceBatchGroup": true,
  "invoiceBatchGroup": {
    "key": "text",
    "value": "text"
  },
  "paymentTerm": "NET30",
  "invoiceTemplateId": "123e4567-e89b-12d3-a456-426614174000",
  "customFields": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "externalERPId": "text",
  "externalCRMId": "text",
  "buyerReference": "text",
  "yourOrderNumber": "text",
  "yourReference": "text",
  "ourReference": "text"
}
No content

Delete Subscription

delete
Required scopes
This endpoint requires the following scopes:
  • : Access Younium API
Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
idstring · uuidRequired

subscription id

Header parameters
api-versionstringOptional
Responses
200

Success

No content
delete/Subscriptions/{id}
DELETE /Subscriptions/{id} HTTP/1.1
Host: api.sandbox.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

Get Subscription versions

get
Required scopes
This endpoint requires the following scopes:
  • : Access Younium API
Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
orderNumberstringRequired
Query parameters
FilterstringOptional

Filter the results. See developer resources for more information. On endpoints whose entity supports custom fields you can also filter by custom field: customFieldEq('fieldName', 'value') (equals) or customFieldExist('fieldName') (field has a non-empty value). Custom-field functions may only be combined with and.

Example: name eq 'Adam' and age gt 20 and customFieldEq('region', 'EU')
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-07-01
ModifiedBeforestring · date-timeOptional

Filter is also applied on sub entities: 'orderProducts', 'orderCharges', 'chargeDetails', 'orderDiscounts', 'milestones' and 'customFields' on these entities

Example: 2026-07-01
PageSizeinteger · int32Optional

Page Size

Example: 20
PageNumberinteger · int32Optional

Page Number

Example: 1
Header parameters
api-versionstringOptional
Responses
200

Success

application/json
idstring · uuidOptional
orderNumberstring · nullableOptional
versioninteger · int32Optional
isLastVersionbooleanOptional
statusstring · enumOptionalPossible values:
descriptionstring · nullableOptional
remarksstring · nullableOptional
effectiveStartDatestring · date-timeOptional
effectiveEndDatestring · date-time · nullableOptional
cancellationDatestring · date-time · nullableOptional
effectiveChangeDatestring · date-time · nullableOptional
orderDatestring · date-time · nullableOptional
noticePeriodDatestring · date-time · nullableOptional
lastRenewalDatestring · date-time · nullableOptional
createdstring · date-timeOptional
modifiedstring · date-timeOptional
lastUpdatedstring · date-time · nullableOptional

Date of when latest update occurred on the order or it's sub entities

Example: 2024-07-01
noticePeriodinteger · int32Optional
terminteger · int32Optional
renewalTerminteger · int32Optional
isAutoRenewedbooleanOptional
orderTypestring · enumOptionalPossible values:
termTypestring · enumOptionalPossible values:
orderPaymentMethodstring · enumOptionalPossible values:
invoiceSeparatlybooleanOptional
yourReferencestring · nullableOptional
ourReferencestring · nullableOptional
yourOrderNumberstring · nullableOptional
buyerReferencestring · nullableOptional
orderBillingPeriodstring · enumOptionalPossible values:
setOrderBillingPeriodbooleanOptional
paymentTermstring · nullableOptional
useAccountInvoiceBatchGroupbooleanOptional
currencystring · nullableOptional
externalERPIdstring · nullableOptional
externalCRMIdstring · nullableOptional
currencyCodeToUseWhenInvoicestring · nullableOptional
get/Subscriptions/{orderNumber}/versions
GET /Subscriptions/{orderNumber}/versions HTTP/1.1
Host: api.sandbox.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "orderNumber": "text",
    "version": 1,
    "isLastVersion": true,
    "status": "Draft",
    "description": "text",
    "remarks": "text",
    "effectiveStartDate": "2026-01-01T00:00:00.000Z",
    "effectiveEndDate": "2026-01-01T00:00:00.000Z",
    "cancellationDate": "2026-01-01T00:00:00.000Z",
    "effectiveChangeDate": "2026-01-01T00:00:00.000Z",
    "orderDate": "2026-01-01T00:00:00.000Z",
    "noticePeriodDate": "2026-01-01T00:00:00.000Z",
    "lastRenewalDate": "2026-01-01T00:00:00.000Z",
    "created": "2026-01-01T00:00:00.000Z",
    "modified": "2026-01-01T00:00:00.000Z",
    "lastUpdated": "2024-07-01",
    "noticePeriod": 1,
    "term": 1,
    "renewalTerm": 1,
    "isAutoRenewed": true,
    "orderType": "Subscription",
    "termType": "Termed",
    "orderPaymentMethod": "Invoice",
    "invoiceSeparatly": true,
    "yourReference": "text",
    "ourReference": "text",
    "yourOrderNumber": "text",
    "buyerReference": "text",
    "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",
    "setOrderBillingPeriod": true,
    "invoiceBatchGroup": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "code": "text",
      "description": "text"
    },
    "paymentTerm": "text",
    "useAccountInvoiceBatchGroup": true,
    "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"
    },
    "products": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "productNumber": "text",
        "chargePlanId": "123e4567-e89b-12d3-a456-426614174000",
        "chargePlanName": "text",
        "chargePlanNumber": "text",
        "productLineNumber": 1,
        "name": "text",
        "charges": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "chargeNumber": "OPC-000001",
            "version": 1,
            "isLastVersion": true,
            "name": "text",
            "chargeType": "OneOff",
            "priceModel": "Flat",
            "effectiveStartDate": "2026-01-01T00:00:00.000Z",
            "effectiveEndDate": "2026-01-01T00:00:00.000Z",
            "quantity": 1,
            "unitCode": "text",
            "startOn": "AlignToSubscription",
            "endOn": "AlignToSubscription",
            "chargedThroughDate": "2026-01-01T00:00:00.000Z",
            "lastRenewalDate": "2026-01-01T00:00:00.000Z",
            "lastPriceAdjustmentDate": "2026-01-01T00:00:00.000Z",
            "pricePeriod": "Monthly",
            "usageRating": "Sum",
            "revenueRecognitionRule": "text",
            "billingDay": "None",
            "specificBillingDay": 1,
            "offsetBillingDays": 1,
            "billingPeriod": "Monthly",
            "billingTiming": "InAdvance",
            "periodAlignment": "None",
            "alignmentDate": "2026-01-01T00:00:00.000Z",
            "taxTemplate": "text",
            "taxIncluded": true,
            "createInvoiceLinesPerTier": true,
            "estimatedUsage": 1,
            "estimatedQuantity": 1,
            "remainingQuantity": 1,
            "orderedQuantity": 1,
            "deliveryDate": "2026-01-01T00:00:00.000Z",
            "remarks": "text",
            "accountsReceivableAccount": "text",
            "deferredRevenueAccount": "text",
            "recognizedRevenueAccount": "text",
            "changeState": "NotChanged",
            "displayPrice": 1,
            "customFields": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            },
            "priceDetails": [
              {
                "tier": 1,
                "price": 1,
                "listPrice": 1,
                "description": "text",
                "fromQuantity": 1,
                "toQuantity": 1,
                "priceBase": "Flat",
                "lineDiscountPercent": 1,
                "lineDiscountAmount": 1
              }
            ],
            "recurringMonthlyAmount": 1,
            "recurringMonthlyAmountBase": 1,
            "features": [
              {
                "code": "text",
                "description": "text"
              }
            ],
            "orderDiscounts": [
              {
                "orderDiscountId": "123e4567-e89b-12d3-a456-426614174000",
                "chargeId": "123e4567-e89b-12d3-a456-426614174000"
              }
            ],
            "externalERPId": "text",
            "externalCRMId": "text",
            "cmrr": {
              "amount": 1,
              "currencyCode": "text",
              "currencyConversionDate": "2026-01-01T00:00:00.000Z",
              "baseCurrencyAmount": 1,
              "baseCurrencyCode": "text"
            },
            "acv": {
              "amount": 1,
              "currencyCode": "text",
              "currencyConversionDate": "2026-01-01T00:00:00.000Z",
              "baseCurrencyAmount": 1,
              "baseCurrencyCode": "text"
            },
            "tcv": {
              "amount": 1,
              "currencyCode": "text",
              "currencyConversionDate": "2026-01-01T00:00:00.000Z",
              "baseCurrencyAmount": 1,
              "baseCurrencyCode": "text"
            },
            "emrr": {
              "amount": 1,
              "currencyCode": "text",
              "currencyConversionDate": "2026-01-01T00:00:00.000Z",
              "baseCurrencyAmount": 1,
              "baseCurrencyCode": "text"
            },
            "oneTimeFees": {
              "amount": 1,
              "currencyCode": "text",
              "currencyConversionDate": "2026-01-01T00:00:00.000Z",
              "baseCurrencyAmount": 1,
              "baseCurrencyCode": "text"
            },
            "price": 1,
            "listPrice": 1,
            "discountAmount": 1,
            "discountPercentage": 1,
            "totalPrice": 1,
            "totalListPrice": 1,
            "totalDiscountAmount": 1,
            "totalDiscountPercentage": 1,
            "totalPerInvoice": 1,
            "orderProductId": "123e4567-e89b-12d3-a456-426614174000",
            "orderId": "123e4567-e89b-12d3-a456-426614174000",
            "chargeId": "123e4567-e89b-12d3-a456-426614174000",
            "created": "2026-01-01T00:00:00.000Z",
            "modified": "2026-01-01T00:00:00.000Z"
          }
        ],
        "customFields": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "externalERPId": "text",
        "externalCRMId": "text",
        "cmrr": {
          "amount": 1,
          "currencyCode": "text",
          "currencyConversionDate": "2026-01-01T00:00:00.000Z",
          "baseCurrencyAmount": 1,
          "baseCurrencyCode": "text"
        },
        "acv": {
          "amount": 1,
          "currencyCode": "text",
          "currencyConversionDate": "2026-01-01T00:00:00.000Z",
          "baseCurrencyAmount": 1,
          "baseCurrencyCode": "text"
        },
        "emrr": {
          "amount": 1,
          "currencyCode": "text",
          "currencyConversionDate": "2026-01-01T00:00:00.000Z",
          "baseCurrencyAmount": 1,
          "baseCurrencyCode": "text"
        },
        "oneTimeFees": {
          "amount": 1,
          "currencyCode": "text",
          "currencyConversionDate": "2026-01-01T00:00:00.000Z",
          "baseCurrencyAmount": 1,
          "baseCurrencyCode": "text"
        },
        "tcv": {
          "amount": 1,
          "currencyCode": "text",
          "currencyConversionDate": "2026-01-01T00:00:00.000Z",
          "baseCurrencyAmount": 1,
          "baseCurrencyCode": "text"
        },
        "created": "2026-01-01T00:00:00.000Z",
        "modified": "2026-01-01T00:00:00.000Z"
      }
    ],
    "milestones": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "orderId": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "description": "text",
        "milestoneDate": "2026-01-01T00:00:00.000Z",
        "plannedDate": "2026-01-01T00:00:00.000Z"
      }
    ],
    "orderDiscounts": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "orderId": "123e4567-e89b-12d3-a456-426614174000",
        "startOn": "AlignToOrder",
        "endOn": "AlignToOrder",
        "startDate": "2026-01-01T00:00:00.000Z",
        "endDate": "2026-01-01T00:00:00.000Z",
        "percent": 1,
        "discountType": "Percent",
        "description": "text",
        "orderProductCharges": [
          {
            "orderDiscountId": "123e4567-e89b-12d3-a456-426614174000",
            "chargeId": "123e4567-e89b-12d3-a456-426614174000"
          }
        ],
        "onSpecificCharges": true
      }
    ],
    "currency": "text",
    "externalERPId": "text",
    "externalCRMId": "text",
    "currencyCodeToUseWhenInvoice": "text",
    "customFields": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "cmrr": {
      "amount": 1,
      "currencyCode": "text",
      "currencyConversionDate": "2026-01-01T00:00:00.000Z",
      "baseCurrencyAmount": 1,
      "baseCurrencyCode": "text"
    },
    "acv": {
      "amount": 1,
      "currencyCode": "text",
      "currencyConversionDate": "2026-01-01T00:00:00.000Z",
      "baseCurrencyAmount": 1,
      "baseCurrencyCode": "text"
    },
    "emrr": {
      "amount": 1,
      "currencyCode": "text",
      "currencyConversionDate": "2026-01-01T00:00:00.000Z",
      "baseCurrencyAmount": 1,
      "baseCurrencyCode": "text"
    },
    "oneTimeFees": {
      "amount": 1,
      "currencyCode": "text",
      "currencyConversionDate": "2026-01-01T00:00:00.000Z",
      "baseCurrencyAmount": 1,
      "baseCurrencyCode": "text"
    },
    "tcv": {
      "amount": 1,
      "currencyCode": "text",
      "currencyConversionDate": "2026-01-01T00:00:00.000Z",
      "baseCurrencyAmount": 1,
      "baseCurrencyCode": "text"
    }
  }
]

Get Subscription Version by Id

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

Success

application/json
idstring · uuidOptional
orderNumberstring · nullableOptional
versioninteger · int32Optional
isLastVersionbooleanOptional
statusstring · enumOptionalPossible values:
descriptionstring · nullableOptional
remarksstring · nullableOptional
effectiveStartDatestring · date-timeOptional
effectiveEndDatestring · date-time · nullableOptional
cancellationDatestring · date-time · nullableOptional
effectiveChangeDatestring · date-time · nullableOptional
orderDatestring · date-time · nullableOptional
noticePeriodDatestring · date-time · nullableOptional
lastRenewalDatestring · date-time · nullableOptional
createdstring · date-timeOptional
modifiedstring · date-timeOptional
lastUpdatedstring · date-time · nullableOptional

Date of when latest update occurred on the order or it's sub entities

Example: 2024-07-01
noticePeriodinteger · int32Optional
terminteger · int32Optional
renewalTerminteger · int32Optional
isAutoRenewedbooleanOptional
orderTypestring · enumOptionalPossible values:
termTypestring · enumOptionalPossible values:
orderPaymentMethodstring · enumOptionalPossible values:
invoiceSeparatlybooleanOptional
yourReferencestring · nullableOptional
ourReferencestring · nullableOptional
yourOrderNumberstring · nullableOptional
buyerReferencestring · nullableOptional
orderBillingPeriodstring · enumOptionalPossible values:
setOrderBillingPeriodbooleanOptional
paymentTermstring · nullableOptional
useAccountInvoiceBatchGroupbooleanOptional
currencystring · nullableOptional
externalERPIdstring · nullableOptional
externalCRMIdstring · nullableOptional
currencyCodeToUseWhenInvoicestring · nullableOptional
get/Subscriptions/{id}/version
GET /Subscriptions/{id}/version HTTP/1.1
Host: api.sandbox.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "orderNumber": "text",
  "version": 1,
  "isLastVersion": true,
  "status": "Draft",
  "description": "text",
  "remarks": "text",
  "effectiveStartDate": "2026-01-01T00:00:00.000Z",
  "effectiveEndDate": "2026-01-01T00:00:00.000Z",
  "cancellationDate": "2026-01-01T00:00:00.000Z",
  "effectiveChangeDate": "2026-01-01T00:00:00.000Z",
  "orderDate": "2026-01-01T00:00:00.000Z",
  "noticePeriodDate": "2026-01-01T00:00:00.000Z",
  "lastRenewalDate": "2026-01-01T00:00:00.000Z",
  "created": "2026-01-01T00:00:00.000Z",
  "modified": "2026-01-01T00:00:00.000Z",
  "lastUpdated": "2024-07-01",
  "noticePeriod": 1,
  "term": 1,
  "renewalTerm": 1,
  "isAutoRenewed": true,
  "orderType": "Subscription",
  "termType": "Termed",
  "orderPaymentMethod": "Invoice",
  "invoiceSeparatly": true,
  "yourReference": "text",
  "ourReference": "text",
  "yourOrderNumber": "text",
  "buyerReference": "text",
  "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",
  "setOrderBillingPeriod": true,
  "invoiceBatchGroup": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "code": "text",
    "description": "text"
  },
  "paymentTerm": "text",
  "useAccountInvoiceBatchGroup": true,
  "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"
  },
  "products": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "productNumber": "text",
      "chargePlanId": "123e4567-e89b-12d3-a456-426614174000",
      "chargePlanName": "text",
      "chargePlanNumber": "text",
      "productLineNumber": 1,
      "name": "text",
      "charges": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "chargeNumber": "OPC-000001",
          "version": 1,
          "isLastVersion": true,
          "name": "text",
          "chargeType": "OneOff",
          "priceModel": "Flat",
          "effectiveStartDate": "2026-01-01T00:00:00.000Z",
          "effectiveEndDate": "2026-01-01T00:00:00.000Z",
          "quantity": 1,
          "unitCode": "text",
          "startOn": "AlignToSubscription",
          "endOn": "AlignToSubscription",
          "chargedThroughDate": "2026-01-01T00:00:00.000Z",
          "lastRenewalDate": "2026-01-01T00:00:00.000Z",
          "lastPriceAdjustmentDate": "2026-01-01T00:00:00.000Z",
          "pricePeriod": "Monthly",
          "usageRating": "Sum",
          "revenueRecognitionRule": "text",
          "billingDay": "None",
          "specificBillingDay": 1,
          "offsetBillingDays": 1,
          "billingPeriod": "Monthly",
          "billingTiming": "InAdvance",
          "periodAlignment": "None",
          "alignmentDate": "2026-01-01T00:00:00.000Z",
          "taxTemplate": "text",
          "taxIncluded": true,
          "createInvoiceLinesPerTier": true,
          "estimatedUsage": 1,
          "estimatedQuantity": 1,
          "remainingQuantity": 1,
          "orderedQuantity": 1,
          "deliveryDate": "2026-01-01T00:00:00.000Z",
          "remarks": "text",
          "accountsReceivableAccount": "text",
          "deferredRevenueAccount": "text",
          "recognizedRevenueAccount": "text",
          "changeState": "NotChanged",
          "displayPrice": 1,
          "customFields": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "priceDetails": [
            {
              "tier": 1,
              "price": 1,
              "listPrice": 1,
              "description": "text",
              "fromQuantity": 1,
              "toQuantity": 1,
              "priceBase": "Flat",
              "lineDiscountPercent": 1,
              "lineDiscountAmount": 1
            }
          ],
          "recurringMonthlyAmount": 1,
          "recurringMonthlyAmountBase": 1,
          "features": [
            {
              "code": "text",
              "description": "text"
            }
          ],
          "orderDiscounts": [
            {
              "orderDiscountId": "123e4567-e89b-12d3-a456-426614174000",
              "chargeId": "123e4567-e89b-12d3-a456-426614174000"
            }
          ],
          "externalERPId": "text",
          "externalCRMId": "text",
          "cmrr": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2026-01-01T00:00:00.000Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "acv": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2026-01-01T00:00:00.000Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "tcv": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2026-01-01T00:00:00.000Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "emrr": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2026-01-01T00:00:00.000Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "oneTimeFees": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2026-01-01T00:00:00.000Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "price": 1,
          "listPrice": 1,
          "discountAmount": 1,
          "discountPercentage": 1,
          "totalPrice": 1,
          "totalListPrice": 1,
          "totalDiscountAmount": 1,
          "totalDiscountPercentage": 1,
          "totalPerInvoice": 1,
          "orderProductId": "123e4567-e89b-12d3-a456-426614174000",
          "orderId": "123e4567-e89b-12d3-a456-426614174000",
          "chargeId": "123e4567-e89b-12d3-a456-426614174000",
          "created": "2026-01-01T00:00:00.000Z",
          "modified": "2026-01-01T00:00:00.000Z"
        }
      ],
      "customFields": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "externalERPId": "text",
      "externalCRMId": "text",
      "cmrr": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2026-01-01T00:00:00.000Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "acv": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2026-01-01T00:00:00.000Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "emrr": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2026-01-01T00:00:00.000Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "oneTimeFees": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2026-01-01T00:00:00.000Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "tcv": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2026-01-01T00:00:00.000Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "created": "2026-01-01T00:00:00.000Z",
      "modified": "2026-01-01T00:00:00.000Z"
    }
  ],
  "milestones": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "orderId": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "milestoneDate": "2026-01-01T00:00:00.000Z",
      "plannedDate": "2026-01-01T00:00:00.000Z"
    }
  ],
  "orderDiscounts": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "orderId": "123e4567-e89b-12d3-a456-426614174000",
      "startOn": "AlignToOrder",
      "endOn": "AlignToOrder",
      "startDate": "2026-01-01T00:00:00.000Z",
      "endDate": "2026-01-01T00:00:00.000Z",
      "percent": 1,
      "discountType": "Percent",
      "description": "text",
      "orderProductCharges": [
        {
          "orderDiscountId": "123e4567-e89b-12d3-a456-426614174000",
          "chargeId": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "onSpecificCharges": true
    }
  ],
  "currency": "text",
  "externalERPId": "text",
  "externalCRMId": "text",
  "currencyCodeToUseWhenInvoice": "text",
  "customFields": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "cmrr": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2026-01-01T00:00:00.000Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  },
  "acv": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2026-01-01T00:00:00.000Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  },
  "emrr": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2026-01-01T00:00:00.000Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  },
  "oneTimeFees": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2026-01-01T00:00:00.000Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  },
  "tcv": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2026-01-01T00:00:00.000Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  }
}

Get Subscription Version by OrderNumber

get
Required scopes
This endpoint requires the following scopes:
  • : Access Younium API
Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
orderNumberstringRequired
versioninteger · int32Required
Header parameters
api-versionstringOptional
Responses
200

Success

application/json
idstring · uuidOptional
orderNumberstring · nullableOptional
versioninteger · int32Optional
isLastVersionbooleanOptional
statusstring · enumOptionalPossible values:
descriptionstring · nullableOptional
remarksstring · nullableOptional
effectiveStartDatestring · date-timeOptional
effectiveEndDatestring · date-time · nullableOptional
cancellationDatestring · date-time · nullableOptional
effectiveChangeDatestring · date-time · nullableOptional
orderDatestring · date-time · nullableOptional
noticePeriodDatestring · date-time · nullableOptional
lastRenewalDatestring · date-time · nullableOptional
createdstring · date-timeOptional
modifiedstring · date-timeOptional
lastUpdatedstring · date-time · nullableOptional

Date of when latest update occurred on the order or it's sub entities

Example: 2024-07-01
noticePeriodinteger · int32Optional
terminteger · int32Optional
renewalTerminteger · int32Optional
isAutoRenewedbooleanOptional
orderTypestring · enumOptionalPossible values:
termTypestring · enumOptionalPossible values:
orderPaymentMethodstring · enumOptionalPossible values:
invoiceSeparatlybooleanOptional
yourReferencestring · nullableOptional
ourReferencestring · nullableOptional
yourOrderNumberstring · nullableOptional
buyerReferencestring · nullableOptional
orderBillingPeriodstring · enumOptionalPossible values:
setOrderBillingPeriodbooleanOptional
paymentTermstring · nullableOptional
useAccountInvoiceBatchGroupbooleanOptional
currencystring · nullableOptional
externalERPIdstring · nullableOptional
externalCRMIdstring · nullableOptional
currencyCodeToUseWhenInvoicestring · nullableOptional
get/Subscriptions/{orderNumber}/versions/{version}
GET /Subscriptions/{orderNumber}/versions/{version} HTTP/1.1
Host: api.sandbox.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "orderNumber": "text",
  "version": 1,
  "isLastVersion": true,
  "status": "Draft",
  "description": "text",
  "remarks": "text",
  "effectiveStartDate": "2026-01-01T00:00:00.000Z",
  "effectiveEndDate": "2026-01-01T00:00:00.000Z",
  "cancellationDate": "2026-01-01T00:00:00.000Z",
  "effectiveChangeDate": "2026-01-01T00:00:00.000Z",
  "orderDate": "2026-01-01T00:00:00.000Z",
  "noticePeriodDate": "2026-01-01T00:00:00.000Z",
  "lastRenewalDate": "2026-01-01T00:00:00.000Z",
  "created": "2026-01-01T00:00:00.000Z",
  "modified": "2026-01-01T00:00:00.000Z",
  "lastUpdated": "2024-07-01",
  "noticePeriod": 1,
  "term": 1,
  "renewalTerm": 1,
  "isAutoRenewed": true,
  "orderType": "Subscription",
  "termType": "Termed",
  "orderPaymentMethod": "Invoice",
  "invoiceSeparatly": true,
  "yourReference": "text",
  "ourReference": "text",
  "yourOrderNumber": "text",
  "buyerReference": "text",
  "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",
  "setOrderBillingPeriod": true,
  "invoiceBatchGroup": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "code": "text",
    "description": "text"
  },
  "paymentTerm": "text",
  "useAccountInvoiceBatchGroup": true,
  "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"
  },
  "products": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "productNumber": "text",
      "chargePlanId": "123e4567-e89b-12d3-a456-426614174000",
      "chargePlanName": "text",
      "chargePlanNumber": "text",
      "productLineNumber": 1,
      "name": "text",
      "charges": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "chargeNumber": "OPC-000001",
          "version": 1,
          "isLastVersion": true,
          "name": "text",
          "chargeType": "OneOff",
          "priceModel": "Flat",
          "effectiveStartDate": "2026-01-01T00:00:00.000Z",
          "effectiveEndDate": "2026-01-01T00:00:00.000Z",
          "quantity": 1,
          "unitCode": "text",
          "startOn": "AlignToSubscription",
          "endOn": "AlignToSubscription",
          "chargedThroughDate": "2026-01-01T00:00:00.000Z",
          "lastRenewalDate": "2026-01-01T00:00:00.000Z",
          "lastPriceAdjustmentDate": "2026-01-01T00:00:00.000Z",
          "pricePeriod": "Monthly",
          "usageRating": "Sum",
          "revenueRecognitionRule": "text",
          "billingDay": "None",
          "specificBillingDay": 1,
          "offsetBillingDays": 1,
          "billingPeriod": "Monthly",
          "billingTiming": "InAdvance",
          "periodAlignment": "None",
          "alignmentDate": "2026-01-01T00:00:00.000Z",
          "taxTemplate": "text",
          "taxIncluded": true,
          "createInvoiceLinesPerTier": true,
          "estimatedUsage": 1,
          "estimatedQuantity": 1,
          "remainingQuantity": 1,
          "orderedQuantity": 1,
          "deliveryDate": "2026-01-01T00:00:00.000Z",
          "remarks": "text",
          "accountsReceivableAccount": "text",
          "deferredRevenueAccount": "text",
          "recognizedRevenueAccount": "text",
          "changeState": "NotChanged",
          "displayPrice": 1,
          "customFields": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "priceDetails": [
            {
              "tier": 1,
              "price": 1,
              "listPrice": 1,
              "description": "text",
              "fromQuantity": 1,
              "toQuantity": 1,
              "priceBase": "Flat",
              "lineDiscountPercent": 1,
              "lineDiscountAmount": 1
            }
          ],
          "recurringMonthlyAmount": 1,
          "recurringMonthlyAmountBase": 1,
          "features": [
            {
              "code": "text",
              "description": "text"
            }
          ],
          "orderDiscounts": [
            {
              "orderDiscountId": "123e4567-e89b-12d3-a456-426614174000",
              "chargeId": "123e4567-e89b-12d3-a456-426614174000"
            }
          ],
          "externalERPId": "text",
          "externalCRMId": "text",
          "cmrr": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2026-01-01T00:00:00.000Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "acv": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2026-01-01T00:00:00.000Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "tcv": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2026-01-01T00:00:00.000Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "emrr": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2026-01-01T00:00:00.000Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "oneTimeFees": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2026-01-01T00:00:00.000Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "price": 1,
          "listPrice": 1,
          "discountAmount": 1,
          "discountPercentage": 1,
          "totalPrice": 1,
          "totalListPrice": 1,
          "totalDiscountAmount": 1,
          "totalDiscountPercentage": 1,
          "totalPerInvoice": 1,
          "orderProductId": "123e4567-e89b-12d3-a456-426614174000",
          "orderId": "123e4567-e89b-12d3-a456-426614174000",
          "chargeId": "123e4567-e89b-12d3-a456-426614174000",
          "created": "2026-01-01T00:00:00.000Z",
          "modified": "2026-01-01T00:00:00.000Z"
        }
      ],
      "customFields": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "externalERPId": "text",
      "externalCRMId": "text",
      "cmrr": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2026-01-01T00:00:00.000Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "acv": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2026-01-01T00:00:00.000Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "emrr": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2026-01-01T00:00:00.000Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "oneTimeFees": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2026-01-01T00:00:00.000Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "tcv": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2026-01-01T00:00:00.000Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "created": "2026-01-01T00:00:00.000Z",
      "modified": "2026-01-01T00:00:00.000Z"
    }
  ],
  "milestones": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "orderId": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "milestoneDate": "2026-01-01T00:00:00.000Z",
      "plannedDate": "2026-01-01T00:00:00.000Z"
    }
  ],
  "orderDiscounts": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "orderId": "123e4567-e89b-12d3-a456-426614174000",
      "startOn": "AlignToOrder",
      "endOn": "AlignToOrder",
      "startDate": "2026-01-01T00:00:00.000Z",
      "endDate": "2026-01-01T00:00:00.000Z",
      "percent": 1,
      "discountType": "Percent",
      "description": "text",
      "orderProductCharges": [
        {
          "orderDiscountId": "123e4567-e89b-12d3-a456-426614174000",
          "chargeId": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "onSpecificCharges": true
    }
  ],
  "currency": "text",
  "externalERPId": "text",
  "externalCRMId": "text",
  "currencyCodeToUseWhenInvoice": "text",
  "customFields": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "cmrr": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2026-01-01T00:00:00.000Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  },
  "acv": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2026-01-01T00:00:00.000Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  },
  "emrr": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2026-01-01T00:00:00.000Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  },
  "oneTimeFees": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2026-01-01T00:00:00.000Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  },
  "tcv": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2026-01-01T00:00:00.000Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  }
}

Create subscription

post
Required 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
statusstring · enumRequiredPossible values:
descriptionstring · nullableOptional
remarksstring · nullableOptional
effectiveStartDatestring · date-time · nullableOptional
effectiveEndDatestring · date-time · nullableOptional
orderDatestring · date-time · nullableOptional
noticePeriodDatestring · date-time · nullableOptional
lastRenewalDatestring · date-time · nullableOptional
noticePeriodinteger · int32 · nullableOptional
terminteger · int32 · nullableOptional
renewalTerminteger · int32 · nullableOptional
isAutoRenewedboolean · nullableOptional
orderTypestring · enumOptionalPossible values:
subscriptionTypestring · enumOptionalPossible values:
orderPaymentMethodstring · enumOptionalPossible values:
invoiceSeparatlyboolean · nullableOptional
yourReferencestring · nullableOptional
ourReferencestring · nullableOptional
yourOrderNumberstring · nullableOptional
buyerReferencestring · nullableOptional
invoiceAddressIdstring · uuid · nullableOptional
deliveryAddressIdstring · uuid · nullableOptional
externalERPIdstring · nullableOptional
externalCRMIdstring · nullableOptional
useAccountInvoiceBatchGroupboolean · nullableOptional
invoicingCurrencystring · nullableOptional
invoiceTemplateIdstring · uuid · nullableOptional
invoiceBatchGroupIdstring · uuid · nullableOptionalDeprecated
orderBillingPeriodstring · enumOptionalPossible values:
setOrderBillingPeriodboolean · nullableOptional

If true, billing period will be set from order billing period and billing period on charges will be ignored.

Responses
201

Subscription created.

No content
post/Subscriptions
POST /Subscriptions HTTP/1.1
Host: api.sandbox.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 3150

{
  "status": "Draft",
  "description": "text",
  "remarks": "text",
  "effectiveStartDate": "2026-01-01T00:00:00.000Z",
  "effectiveEndDate": "2026-01-01T00:00:00.000Z",
  "orderDate": "2026-01-01T00:00:00.000Z",
  "noticePeriodDate": "2026-01-01T00:00:00.000Z",
  "lastRenewalDate": "2026-01-01T00:00:00.000Z",
  "noticePeriod": 1,
  "term": 1,
  "renewalTerm": 1,
  "isAutoRenewed": true,
  "orderType": "Subscription",
  "subscriptionType": "Termed",
  "orderPaymentMethod": "Invoice",
  "invoiceSeparatly": true,
  "yourReference": "text",
  "ourReference": "text",
  "yourOrderNumber": "text",
  "buyerReference": "text",
  "invoiceAddressId": "123e4567-e89b-12d3-a456-426614174000",
  "deliveryAddressId": "123e4567-e89b-12d3-a456-426614174000",
  "externalERPId": "text",
  "externalCRMId": "text",
  "paymentTerm": "NET30",
  "useAccountInvoiceBatchGroup": true,
  "account": "A-000001",
  "invoiceAccount": "A-000001",
  "currency": "SEK",
  "invoicingCurrency": "text",
  "products": [
    {
      "product": "P-000001",
      "chargePlan": "CP-000001",
      "productLineNumber": 1,
      "name": "text",
      "charges": [
        {
          "charge": {
            "key": "text",
            "value": "text"
          },
          "name": "text",
          "chargeType": "OneOff",
          "priceModel": "Flat",
          "effectiveStartDate": "2026-01-01T00:00:00.000Z",
          "effectiveEndDate": "2026-01-01T00:00:00.000Z",
          "startMilestone": "text",
          "endMilestone": "text",
          "quantity": 1,
          "unitCode": "pcs",
          "startOn": "AlignToSubscription",
          "endOn": "AlignToSubscription",
          "chargedThroughDate": "2026-01-01T00:00:00.000Z",
          "lastRenewalDate": "2026-01-01T00:00:00.000Z",
          "lastPriceAdjustmentDate": "2026-01-01T00:00:00.000Z",
          "pricePeriod": "Monthly",
          "usageRating": "Sum",
          "revenueRecognitionRule": {
            "key": "text",
            "value": "text"
          },
          "billingDay": "None",
          "specificBillingDay": 1,
          "offsetBillingDays": 1,
          "billingPeriod": "Monthly",
          "billingTiming": "InAdvance",
          "periodAlignment": "None",
          "alignmentDate": "2026-01-01T00:00:00.000Z",
          "taxTemplate": "Sweden standard",
          "taxIncluded": true,
          "createInvoiceLinesPerTier": true,
          "remarks": "text",
          "deferredRevenueAccount": "1510",
          "recognizedRevenueAccount": "1510",
          "changeState": "NotChanged",
          "displayPrice": 1,
          "priceDetails": [
            {
              "toQuantity": 1,
              "tier": 1,
              "price": 1,
              "listPrice": 1,
              "description": "text",
              "fromQuantity": 1,
              "priceBase": "Flat",
              "lineDiscountPercent": 1,
              "lineDiscountAmount": 1
            }
          ],
          "features": [
            {
              "feature": {
                "key": "text",
                "value": "text"
              }
            }
          ],
          "estimatedUsage": 1,
          "estimatedQuantity": 1,
          "orderedQuantity": 1,
          "recurringMonthlyAmount": 1,
          "externalERPId": "text",
          "externalCRMId": "text",
          "customFields": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "orderDiscountMappingKey": [
            "text"
          ]
        }
      ],
      "externalERPId": "text",
      "externalCRMId": "text",
      "customFields": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ],
  "milestones": [
    {
      "name": "text",
      "description": "text",
      "plannedDate": "2026-01-01T00:00:00.000Z"
    }
  ],
  "orderDiscounts": [
    {
      "operation": "Change",
      "OrderDiscountId": "GUID",
      "startOn": "AlignToOrder",
      "endOn": "AlignToOrder",
      "startDate": "2026-01-01T00:00:00.000Z",
      "endDate": "2026-01-01T00:00:00.000Z",
      "percent": 1,
      "description": "text",
      "onSpecificCharges": true,
      "orderProductCharges": [
        {
          "charge": "OPC-000001",
          "operation": "Remove"
        }
      ],
      "chargeMappingKey": "text"
    }
  ],
  "invoiceTemplateId": "123e4567-e89b-12d3-a456-426614174000",
  "invoiceBatchGroup": {
    "key": "text",
    "value": "text"
  },
  "orderBillingPeriod": "Monthly",
  "setOrderBillingPeriod": true,
  "customFields": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}
No content
get
Required scopes
This endpoint requires the following scopes:
  • : Access Younium API
Authorizations
OAuth2passwordRequired
Token URL:
Query parameters
Skipinteger · int32Optional

Skip number of records

Example: 10
Takeinteger · int32Optional

Take number of records

Example: 5
FilterstringOptional

Filter the resulsts. See ODATA documentation for more information

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

Sorting the results. See ODATA specificaion for more information

Example: name
Header parameters
api-versionstringOptional
Responses
200

Success

application/json
idstring · uuidOptional
orderNumberstring · nullableOptional
versioninteger · int32Optional
isLastVersionbooleanOptional
statusstring · enumOptionalPossible values:
descriptionstring · nullableOptional
remarksstring · nullableOptional
effectiveStartDatestring · date-timeOptional
effectiveEndDatestring · date-time · nullableOptional
cancellationDatestring · date-time · nullableOptional
effectiveChangeDatestring · date-time · nullableOptional
orderDatestring · date-time · nullableOptional
noticePeriodDatestring · date-time · nullableOptional
lastRenewalDatestring · date-time · nullableOptional
createdstring · date-timeOptional
modifiedstring · date-timeOptional
lastUpdatedstring · date-time · nullableOptional

Date of when latest update occurred on the order or it's sub entities

Example: 2024-07-01
noticePeriodinteger · int32Optional
terminteger · int32Optional
renewalTerminteger · int32Optional
isAutoRenewedbooleanOptional
orderTypestring · enumOptionalPossible values:
termTypestring · enumOptionalPossible values:
orderPaymentMethodstring · enumOptionalPossible values:
invoiceSeparatlybooleanOptional
yourReferencestring · nullableOptional
ourReferencestring · nullableOptional
yourOrderNumberstring · nullableOptional
buyerReferencestring · nullableOptional
orderBillingPeriodstring · enumOptionalPossible values:
setOrderBillingPeriodbooleanOptional
paymentTermstring · nullableOptional
useAccountInvoiceBatchGroupbooleanOptional
currencystring · nullableOptional
externalERPIdstring · nullableOptional
externalCRMIdstring · nullableOptional
currencyCodeToUseWhenInvoicestring · nullableOptional
get/Subscriptions
GET /Subscriptions HTTP/1.1
Host: api.sandbox.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "orderNumber": "text",
    "version": 1,
    "isLastVersion": true,
    "status": "Draft",
    "description": "text",
    "remarks": "text",
    "effectiveStartDate": "2026-01-01T00:00:00.000Z",
    "effectiveEndDate": "2026-01-01T00:00:00.000Z",
    "cancellationDate": "2026-01-01T00:00:00.000Z",
    "effectiveChangeDate": "2026-01-01T00:00:00.000Z",
    "orderDate": "2026-01-01T00:00:00.000Z",
    "noticePeriodDate": "2026-01-01T00:00:00.000Z",
    "lastRenewalDate": "2026-01-01T00:00:00.000Z",
    "created": "2026-01-01T00:00:00.000Z",
    "modified": "2026-01-01T00:00:00.000Z",
    "lastUpdated": "2024-07-01",
    "noticePeriod": 1,
    "term": 1,
    "renewalTerm": 1,
    "isAutoRenewed": true,
    "orderType": "Subscription",
    "termType": "Termed",
    "orderPaymentMethod": "Invoice",
    "invoiceSeparatly": true,
    "yourReference": "text",
    "ourReference": "text",
    "yourOrderNumber": "text",
    "buyerReference": "text",
    "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",
    "setOrderBillingPeriod": true,
    "invoiceBatchGroup": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "code": "text",
      "description": "text"
    },
    "paymentTerm": "text",
    "useAccountInvoiceBatchGroup": true,
    "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"
    },
    "products": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "productNumber": "text",
        "chargePlanId": "123e4567-e89b-12d3-a456-426614174000",
        "chargePlanName": "text",
        "chargePlanNumber": "text",
        "productLineNumber": 1,
        "name": "text",
        "charges": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "chargeNumber": "OPC-000001",
            "version": 1,
            "isLastVersion": true,
            "name": "text",
            "chargeType": "OneOff",
            "priceModel": "Flat",
            "effectiveStartDate": "2026-01-01T00:00:00.000Z",
            "effectiveEndDate": "2026-01-01T00:00:00.000Z",
            "quantity": 1,
            "unitCode": "text",
            "startOn": "AlignToSubscription",
            "endOn": "AlignToSubscription",
            "chargedThroughDate": "2026-01-01T00:00:00.000Z",
            "lastRenewalDate": "2026-01-01T00:00:00.000Z",
            "lastPriceAdjustmentDate": "2026-01-01T00:00:00.000Z",
            "pricePeriod": "Monthly",
            "usageRating": "Sum",
            "revenueRecognitionRule": "text",
            "billingDay": "None",
            "specificBillingDay": 1,
            "offsetBillingDays": 1,
            "billingPeriod": "Monthly",
            "billingTiming": "InAdvance",
            "periodAlignment": "None",
            "alignmentDate": "2026-01-01T00:00:00.000Z",
            "taxTemplate": "text",
            "taxIncluded": true,
            "createInvoiceLinesPerTier": true,
            "estimatedUsage": 1,
            "estimatedQuantity": 1,
            "remainingQuantity": 1,
            "orderedQuantity": 1,
            "deliveryDate": "2026-01-01T00:00:00.000Z",
            "remarks": "text",
            "accountsReceivableAccount": "text",
            "deferredRevenueAccount": "text",
            "recognizedRevenueAccount": "text",
            "changeState": "NotChanged",
            "displayPrice": 1,
            "customFields": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            },
            "priceDetails": [
              {
                "tier": 1,
                "price": 1,
                "listPrice": 1,
                "description": "text",
                "fromQuantity": 1,
                "toQuantity": 1,
                "priceBase": "Flat",
                "lineDiscountPercent": 1,
                "lineDiscountAmount": 1
              }
            ],
            "recurringMonthlyAmount": 1,
            "recurringMonthlyAmountBase": 1,
            "features": [
              {
                "code": "text",
                "description": "text"
              }
            ],
            "orderDiscounts": [
              {
                "orderDiscountId": "123e4567-e89b-12d3-a456-426614174000",
                "chargeId": "123e4567-e89b-12d3-a456-426614174000"
              }
            ],
            "externalERPId": "text",
            "externalCRMId": "text",
            "cmrr": {
              "amount": 1,
              "currencyCode": "text",
              "currencyConversionDate": "2026-01-01T00:00:00.000Z",
              "baseCurrencyAmount": 1,
              "baseCurrencyCode": "text"
            },
            "acv": {
              "amount": 1,
              "currencyCode": "text",
              "currencyConversionDate": "2026-01-01T00:00:00.000Z",
              "baseCurrencyAmount": 1,
              "baseCurrencyCode": "text"
            },
            "tcv": {
              "amount": 1,
              "currencyCode": "text",
              "currencyConversionDate": "2026-01-01T00:00:00.000Z",
              "baseCurrencyAmount": 1,
              "baseCurrencyCode": "text"
            },
            "emrr": {
              "amount": 1,
              "currencyCode": "text",
              "currencyConversionDate": "2026-01-01T00:00:00.000Z",
              "baseCurrencyAmount": 1,
              "baseCurrencyCode": "text"
            },
            "oneTimeFees": {
              "amount": 1,
              "currencyCode": "text",
              "currencyConversionDate": "2026-01-01T00:00:00.000Z",
              "baseCurrencyAmount": 1,
              "baseCurrencyCode": "text"
            },
            "price": 1,
            "listPrice": 1,
            "discountAmount": 1,
            "discountPercentage": 1,
            "totalPrice": 1,
            "totalListPrice": 1,
            "totalDiscountAmount": 1,
            "totalDiscountPercentage": 1,
            "totalPerInvoice": 1,
            "orderProductId": "123e4567-e89b-12d3-a456-426614174000",
            "orderId": "123e4567-e89b-12d3-a456-426614174000",
            "chargeId": "123e4567-e89b-12d3-a456-426614174000",
            "created": "2026-01-01T00:00:00.000Z",
            "modified": "2026-01-01T00:00:00.000Z"
          }
        ],
        "customFields": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "externalERPId": "text",
        "externalCRMId": "text",
        "cmrr": {
          "amount": 1,
          "currencyCode": "text",
          "currencyConversionDate": "2026-01-01T00:00:00.000Z",
          "baseCurrencyAmount": 1,
          "baseCurrencyCode": "text"
        },
        "acv": {
          "amount": 1,
          "currencyCode": "text",
          "currencyConversionDate": "2026-01-01T00:00:00.000Z",
          "baseCurrencyAmount": 1,
          "baseCurrencyCode": "text"
        },
        "emrr": {
          "amount": 1,
          "currencyCode": "text",
          "currencyConversionDate": "2026-01-01T00:00:00.000Z",
          "baseCurrencyAmount": 1,
          "baseCurrencyCode": "text"
        },
        "oneTimeFees": {
          "amount": 1,
          "currencyCode": "text",
          "currencyConversionDate": "2026-01-01T00:00:00.000Z",
          "baseCurrencyAmount": 1,
          "baseCurrencyCode": "text"
        },
        "tcv": {
          "amount": 1,
          "currencyCode": "text",
          "currencyConversionDate": "2026-01-01T00:00:00.000Z",
          "baseCurrencyAmount": 1,
          "baseCurrencyCode": "text"
        },
        "created": "2026-01-01T00:00:00.000Z",
        "modified": "2026-01-01T00:00:00.000Z"
      }
    ],
    "milestones": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "orderId": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "description": "text",
        "milestoneDate": "2026-01-01T00:00:00.000Z",
        "plannedDate": "2026-01-01T00:00:00.000Z"
      }
    ],
    "orderDiscounts": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "orderId": "123e4567-e89b-12d3-a456-426614174000",
        "startOn": "AlignToOrder",
        "endOn": "AlignToOrder",
        "startDate": "2026-01-01T00:00:00.000Z",
        "endDate": "2026-01-01T00:00:00.000Z",
        "percent": 1,
        "discountType": "Percent",
        "description": "text",
        "orderProductCharges": [
          {
            "orderDiscountId": "123e4567-e89b-12d3-a456-426614174000",
            "chargeId": "123e4567-e89b-12d3-a456-426614174000"
          }
        ],
        "onSpecificCharges": true
      }
    ],
    "currency": "text",
    "externalERPId": "text",
    "externalCRMId": "text",
    "currencyCodeToUseWhenInvoice": "text",
    "customFields": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "cmrr": {
      "amount": 1,
      "currencyCode": "text",
      "currencyConversionDate": "2026-01-01T00:00:00.000Z",
      "baseCurrencyAmount": 1,
      "baseCurrencyCode": "text"
    },
    "acv": {
      "amount": 1,
      "currencyCode": "text",
      "currencyConversionDate": "2026-01-01T00:00:00.000Z",
      "baseCurrencyAmount": 1,
      "baseCurrencyCode": "text"
    },
    "emrr": {
      "amount": 1,
      "currencyCode": "text",
      "currencyConversionDate": "2026-01-01T00:00:00.000Z",
      "baseCurrencyAmount": 1,
      "baseCurrencyCode": "text"
    },
    "oneTimeFees": {
      "amount": 1,
      "currencyCode": "text",
      "currencyConversionDate": "2026-01-01T00:00:00.000Z",
      "baseCurrencyAmount": 1,
      "baseCurrencyCode": "text"
    },
    "tcv": {
      "amount": 1,
      "currencyCode": "text",
      "currencyConversionDate": "2026-01-01T00:00:00.000Z",
      "baseCurrencyAmount": 1,
      "baseCurrencyCode": "text"
    }
  }
]

Change Subscription

post
Required scopes
This endpoint requires the following scopes:
  • : Access Younium API
Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
idstring · uuidRequired
Header parameters
api-versionstringOptional
younium-idempotency-keystringOptional
younium-idempotency-durationInHoursintegerOptional
Body
descriptionstring · nullableOptional
remarksstring · nullableOptional
effectiveStartDatestring · date-time · nullableOptional
effectiveChangeDatestring · date-time · nullableOptional
effectiveEndDatestring · date-time · nullableOptional
orderDatestring · date-time · nullableOptional
noticePeriodDatestring · date-time · nullableRead-onlyOptional
lastRenewalDatestring · date-time · nullableRead-onlyOptional
subscriptionTypestring · enumOptionalPossible values:
terminteger · int32 · nullableOptional
renewalTerminteger · int32 · nullableOptional
noticePeriodinteger · int32 · nullableOptional
isAutoRenewedboolean · nullableOptional
invoiceSeparatlyboolean · nullableOptional
invoiceAddressIdstring · uuid · nullableOptionalDeprecated
deliveryAddressIdstring · uuid · nullableOptionalDeprecated
orderPaymentMethodstring · enumOptionalPossible values:
yourReferencestring · nullableOptional
ourReferencestring · nullableOptional
yourOrderNumberstring · nullableOptional
buyerReferencestring · nullableOptional
externalERPIdstring · nullableOptional
externalCRMIdstring · nullableOptional
useAccountInvoiceBatchGroupboolean · nullableOptional
invoiceBatchGroupIdstring · uuid · nullableOptionalDeprecated
invoicingCurrencystring · nullableOptional
invoiceTemplateIdstring · uuid · nullableOptional
orderBillingPeriodstring · enumOptionalPossible values:
setOrderBillingPeriodboolean · nullableOptional
Responses
201

New version of Subscription created.

No content
post/Subscriptions/{id}/change
POST /Subscriptions/{id}/change HTTP/1.1
Host: api.sandbox.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 3160

{
  "account": "A-000001",
  "invoiceAccount": "A-000001",
  "description": "text",
  "remarks": "text",
  "effectiveStartDate": "2026-01-01T00:00:00.000Z",
  "effectiveChangeDate": "2026-01-01T00:00:00.000Z",
  "effectiveEndDate": "2026-01-01T00:00:00.000Z",
  "orderDate": "2026-01-01T00:00:00.000Z",
  "subscriptionType": "Termed",
  "term": 1,
  "renewalTerm": 1,
  "noticePeriod": 1,
  "isAutoRenewed": true,
  "currency": "SEK",
  "invoiceSeparatly": true,
  "invoiceAddress": {
    "key": "text",
    "value": "text"
  },
  "deliveryAddress": {
    "key": "text",
    "value": "text"
  },
  "paymentTerm": "NET30",
  "orderPaymentMethod": "Invoice",
  "yourReference": "text",
  "ourReference": "text",
  "yourOrderNumber": "text",
  "buyerReference": "text",
  "externalERPId": "text",
  "externalCRMId": "text",
  "useAccountInvoiceBatchGroup": true,
  "invoiceBatchGroup": {
    "key": "text",
    "value": "text"
  },
  "invoicingCurrency": "text",
  "products": [
    {
      "operation": "Change",
      "product": "OP-000001",
      "chargePlan": "CP-000001",
      "productLineNumber": 1,
      "name": "text",
      "charges": [
        {
          "charge": "OPC-000001",
          "name": "text",
          "chargeType": "OneOff",
          "priceModel": "Flat",
          "pricePeriod": "Monthly",
          "quantity": 1,
          "unitCode": "pcs",
          "startOn": "AlignToSubscription",
          "endOn": "AlignToSubscription",
          "chargedThroughDate": "2026-01-01T00:00:00.000Z",
          "lastRenewalDate": "2026-01-01T00:00:00.000Z",
          "lastPriceAdjustmentDate": "2026-01-01T00:00:00.000Z",
          "displayPrice": 1,
          "priceDetails": [
            {
              "isInfinite": true,
              "toQuantity": 1,
              "operation": "Change",
              "tier": 1,
              "price": 1,
              "listPrice": 1,
              "description": "text",
              "fromQuantity": 1,
              "priceBase": "Flat",
              "lineDiscountPercent": 1,
              "lineDiscountAmount": 1
            }
          ],
          "features": [
            {
              "operation": "Remove",
              "feature": {
                "key": "text",
                "value": "text"
              }
            }
          ],
          "deferredRevenueAccount": "1510",
          "recognizedRevenueAccount": "1510",
          "usageRating": "Sum",
          "revenueRecognitionRule": {
            "key": "text",
            "value": "text"
          },
          "billingDay": "None",
          "specificBillingDay": 1,
          "offsetBillingDays": 1,
          "billingPeriod": "Monthly",
          "billingTiming": "InAdvance",
          "periodAlignment": "None",
          "alignmentDate": "2026-01-01T00:00:00.000Z",
          "taxTemplate": "Sweden standard",
          "taxIncluded": true,
          "createInvoiceLinesPerTier": true,
          "remarks": "text",
          "externalERPId": "text",
          "externalCRMId": "text",
          "customFields": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "recurringMonthlyAmount": 1,
          "effectiveStartDate": "2026-01-01T00:00:00.000Z",
          "effectiveEndDate": "2026-01-01T00:00:00.000Z",
          "startMilestone": "MilestoneName",
          "endMilestone": "MilestoneName",
          "estimatedUsage": 1,
          "estimatedQuantity": 1,
          "orderDiscountMappingKey": [
            "text"
          ]
        }
      ],
      "externalERPId": "text",
      "externalCRMId": "text",
      "customFields": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "cancelProductOn": "EffectiveEndDate",
      "cancelationDate": "2026-01-01T00:00:00.000Z"
    }
  ],
  "milestones": [
    {
      "name": "text",
      "description": "text",
      "plannedDate": "2026-01-01T00:00:00.000Z"
    }
  ],
  "orderDiscounts": [
    {
      "operation": "Change",
      "OrderDiscountId": "GUID",
      "startOn": "AlignToOrder",
      "endOn": "AlignToOrder",
      "startDate": "2026-01-01T00:00:00.000Z",
      "endDate": "2026-01-01T00:00:00.000Z",
      "percent": 1,
      "description": "text",
      "onSpecificCharges": true,
      "orderProductCharges": [
        {
          "charge": "OPC-000001",
          "operation": "Remove"
        }
      ],
      "chargeMappingKey": "text"
    }
  ],
  "invoiceTemplateId": "123e4567-e89b-12d3-a456-426614174000",
  "orderBillingPeriod": "Monthly",
  "setOrderBillingPeriod": true,
  "customFields": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}
No content

Renew and change Subscription.

post

Renew the Subscription and then perform a change in a single transaction, reverting the renewals in case of failure on the change. Use renewal term and next renewal term for specifying the renewal. Other properties set will be applied to the change.

Required scopes
This endpoint requires the following scopes:
  • : Access Younium API
Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
idstring · uuidRequired
Header parameters
api-versionstringOptional
younium-idempotency-keystringOptional
younium-idempotency-durationInHoursintegerOptional
Body
nextRenewalTerminteger · int32 · nullableOptional

Term for next renewal in months. Renewal term will be used as default

descriptionstring · nullableOptional
remarksstring · nullableOptional
effectiveStartDatestring · date-time · nullableOptional
effectiveChangeDatestring · date-time · nullableOptional
effectiveEndDatestring · date-time · nullableOptional
orderDatestring · date-time · nullableOptional
noticePeriodDatestring · date-time · nullableRead-onlyOptional
lastRenewalDatestring · date-time · nullableRead-onlyOptional
subscriptionTypestring · enumOptionalPossible values:
terminteger · int32 · nullableOptional
renewalTerminteger · int32 · nullableOptional
noticePeriodinteger · int32 · nullableOptional
isAutoRenewedboolean · nullableOptional
invoiceSeparatlyboolean · nullableOptional
invoiceAddressIdstring · uuid · nullableOptionalDeprecated
deliveryAddressIdstring · uuid · nullableOptionalDeprecated
orderPaymentMethodstring · enumOptionalPossible values:
yourReferencestring · nullableOptional
ourReferencestring · nullableOptional
yourOrderNumberstring · nullableOptional
buyerReferencestring · nullableOptional
externalERPIdstring · nullableOptional
externalCRMIdstring · nullableOptional
useAccountInvoiceBatchGroupboolean · nullableOptional
invoiceBatchGroupIdstring · uuid · nullableOptionalDeprecated
invoicingCurrencystring · nullableOptional
invoiceTemplateIdstring · uuid · nullableOptional
orderBillingPeriodstring · enumOptionalPossible values:
setOrderBillingPeriodboolean · nullableOptional
Responses
200

Success

application/json
idstring · uuid · nullableOptional
messagestring · nullableOptional
post/Subscriptions/{id}/RenewAndChange
POST /Subscriptions/{id}/RenewAndChange HTTP/1.1
Host: api.sandbox.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 3180

{
  "nextRenewalTerm": 1,
  "account": "A-000001",
  "invoiceAccount": "A-000001",
  "description": "text",
  "remarks": "text",
  "effectiveStartDate": "2026-01-01T00:00:00.000Z",
  "effectiveChangeDate": "2026-01-01T00:00:00.000Z",
  "effectiveEndDate": "2026-01-01T00:00:00.000Z",
  "orderDate": "2026-01-01T00:00:00.000Z",
  "subscriptionType": "Termed",
  "term": 1,
  "renewalTerm": 1,
  "noticePeriod": 1,
  "isAutoRenewed": true,
  "currency": "SEK",
  "invoiceSeparatly": true,
  "invoiceAddress": {
    "key": "text",
    "value": "text"
  },
  "deliveryAddress": {
    "key": "text",
    "value": "text"
  },
  "paymentTerm": "NET30",
  "orderPaymentMethod": "Invoice",
  "yourReference": "text",
  "ourReference": "text",
  "yourOrderNumber": "text",
  "buyerReference": "text",
  "externalERPId": "text",
  "externalCRMId": "text",
  "useAccountInvoiceBatchGroup": true,
  "invoiceBatchGroup": {
    "key": "text",
    "value": "text"
  },
  "invoicingCurrency": "text",
  "products": [
    {
      "operation": "Change",
      "product": "OP-000001",
      "chargePlan": "CP-000001",
      "productLineNumber": 1,
      "name": "text",
      "charges": [
        {
          "charge": "OPC-000001",
          "name": "text",
          "chargeType": "OneOff",
          "priceModel": "Flat",
          "pricePeriod": "Monthly",
          "quantity": 1,
          "unitCode": "pcs",
          "startOn": "AlignToSubscription",
          "endOn": "AlignToSubscription",
          "chargedThroughDate": "2026-01-01T00:00:00.000Z",
          "lastRenewalDate": "2026-01-01T00:00:00.000Z",
          "lastPriceAdjustmentDate": "2026-01-01T00:00:00.000Z",
          "displayPrice": 1,
          "priceDetails": [
            {
              "isInfinite": true,
              "toQuantity": 1,
              "operation": "Change",
              "tier": 1,
              "price": 1,
              "listPrice": 1,
              "description": "text",
              "fromQuantity": 1,
              "priceBase": "Flat",
              "lineDiscountPercent": 1,
              "lineDiscountAmount": 1
            }
          ],
          "features": [
            {
              "operation": "Remove",
              "feature": {
                "key": "text",
                "value": "text"
              }
            }
          ],
          "deferredRevenueAccount": "1510",
          "recognizedRevenueAccount": "1510",
          "usageRating": "Sum",
          "revenueRecognitionRule": {
            "key": "text",
            "value": "text"
          },
          "billingDay": "None",
          "specificBillingDay": 1,
          "offsetBillingDays": 1,
          "billingPeriod": "Monthly",
          "billingTiming": "InAdvance",
          "periodAlignment": "None",
          "alignmentDate": "2026-01-01T00:00:00.000Z",
          "taxTemplate": "Sweden standard",
          "taxIncluded": true,
          "createInvoiceLinesPerTier": true,
          "remarks": "text",
          "externalERPId": "text",
          "externalCRMId": "text",
          "customFields": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "recurringMonthlyAmount": 1,
          "effectiveStartDate": "2026-01-01T00:00:00.000Z",
          "effectiveEndDate": "2026-01-01T00:00:00.000Z",
          "startMilestone": "MilestoneName",
          "endMilestone": "MilestoneName",
          "estimatedUsage": 1,
          "estimatedQuantity": 1,
          "orderDiscountMappingKey": [
            "text"
          ]
        }
      ],
      "externalERPId": "text",
      "externalCRMId": "text",
      "customFields": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "cancelProductOn": "EffectiveEndDate",
      "cancelationDate": "2026-01-01T00:00:00.000Z"
    }
  ],
  "milestones": [
    {
      "name": "text",
      "description": "text",
      "plannedDate": "2026-01-01T00:00:00.000Z"
    }
  ],
  "orderDiscounts": [
    {
      "operation": "Change",
      "OrderDiscountId": "GUID",
      "startOn": "AlignToOrder",
      "endOn": "AlignToOrder",
      "startDate": "2026-01-01T00:00:00.000Z",
      "endDate": "2026-01-01T00:00:00.000Z",
      "percent": 1,
      "description": "text",
      "onSpecificCharges": true,
      "orderProductCharges": [
        {
          "charge": "OPC-000001",
          "operation": "Remove"
        }
      ],
      "chargeMappingKey": "text"
    }
  ],
  "invoiceTemplateId": "123e4567-e89b-12d3-a456-426614174000",
  "orderBillingPeriod": "Monthly",
  "setOrderBillingPeriod": true,
  "customFields": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "message": "text"
}

Cancel Subscription

post
Required scopes
This endpoint requires the following scopes:
  • : Access Younium API
Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
idstring · uuidRequired

subscription id

Header parameters
api-versionstringOptional
younium-idempotency-keystringOptional
younium-idempotency-durationInHoursintegerOptional
Body
firstDayOfCancellationstring · date-time · nullableOptionalDeprecated

The first effective day of the cancellation. I.e if the subscriptions ends Dec 31, the first day of cancellation is Jan 1

Example: 2024-07-01
endDatestring · date-time · nullableOptional

Subscription end date

Example: 2024-12-31
cancellationDatestring · date-timeRequired
cancellationModestring · enumRequiredPossible values:
Responses
200

Success

No content
post/Subscriptions/cancel/{id}
POST /Subscriptions/cancel/{id} HTTP/1.1
Host: api.sandbox.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 199

{
  "endDate": "2024-12-31",
  "cancellationDate": "2026-01-01T00:00:00.000Z",
  "cancellationMode": "OnOrderCancellationDate",
  "cancellationDatePerCharges": {
    "ANY_ADDITIONAL_PROPERTY": "2026-01-01T00:00:00.000Z"
  }
}
No content

Renew Subscription

post
Required scopes
This endpoint requires the following scopes:
  • : Access Younium API
Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
idstring · uuidRequired

subscription id

Header parameters
api-versionstringOptional
younium-idempotency-keystringOptional
younium-idempotency-durationInHoursintegerOptional
Body
renewalTerminteger · int32Required
nextRenewalTerminteger · int32 · nullableOptional

Term for next renewal in months. Renewal term will be used as default

Responses
200

Success

No content
post/Subscriptions/renew/{id}
POST /Subscriptions/renew/{id} HTTP/1.1
Host: api.sandbox.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 37

{
  "renewalTerm": 1,
  "nextRenewalTerm": 1
}
No content

Revert Subscription

post
Required scopes
This endpoint requires the following scopes:
  • : Access Younium API
Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
idstring · uuidRequired

subscription id

Header parameters
api-versionstringOptional
younium-idempotency-keystringOptional
younium-idempotency-durationInHoursintegerOptional
Responses
200

Success

application/json
idstring · uuid · nullableOptional
messagestring · nullableOptional
post/Subscriptions/revert/{id}
POST /Subscriptions/revert/{id} HTTP/1.1
Host: api.sandbox.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

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

Activate Subscription

post
Required scopes
This endpoint requires the following scopes:
  • : Access Younium API
Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
idstring · uuidRequired
Header parameters
api-versionstringOptional
younium-idempotency-keystringOptional
younium-idempotency-durationInHoursintegerOptional
Responses
200

Success

application/json
idstring · uuid · nullableOptional
messagestring · nullableOptional
post/Subscriptions/activate/{id}
POST /Subscriptions/activate/{id} HTTP/1.1
Host: api.sandbox.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

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

Get Subscription Milestones

get
Required scopes
This endpoint requires the following scopes:
  • : Access Younium API
Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
idstring · uuidRequired

subscription id

Header parameters
api-versionstringOptional
Responses
200

Success

application/json
idstring · uuidOptional
orderIdstring · uuidOptional
namestring · nullableOptional
descriptionstring · nullableOptional
milestoneDatestring · date-time · nullableOptional
plannedDatestring · date-time · nullableOptional
get/Subscriptions/{id}/milestones
GET /Subscriptions/{id}/milestones HTTP/1.1
Host: api.sandbox.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "orderId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "milestoneDate": "2026-01-01T00:00:00.000Z",
    "plannedDate": "2026-01-01T00:00:00.000Z"
  }
]

Set Subscription Milestone date

post
Required scopes
This endpoint requires the following scopes:
  • : Access Younium API
Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
idstring · uuidRequired

Subscription Milestone Id

Header parameters
api-versionstringOptional
younium-idempotency-keystringOptional
younium-idempotency-durationInHoursintegerOptional
Body
milestoneDatestring · date-timeRequired
milestoneIdstring · uuidOptional
Responses
200

Success

application/json
idstring · uuidOptional
orderIdstring · uuidOptional
namestring · nullableOptional
descriptionstring · nullableOptional
milestoneDatestring · date-time · nullableOptional
plannedDatestring · date-time · nullableOptional
post/Subscriptions/milestones/set/{id}
POST /Subscriptions/milestones/set/{id} HTTP/1.1
Host: api.sandbox.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 97

{
  "milestoneDate": "2026-01-01T00:00:00.000Z",
  "milestoneId": "123e4567-e89b-12d3-a456-426614174000"
}
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "orderId": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "milestoneDate": "2026-01-01T00:00:00.000Z",
  "plannedDate": "2026-01-01T00:00:00.000Z"
}

Edit and create OrderDiscounts

post

Edit and create OrderDiscounts on an existing order. This will create a new version of the order.

Required scopes
This endpoint requires the following scopes:
  • : Access Younium API
Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
idstring · uuidRequired
Header parameters
api-versionstringOptional
younium-idempotency-keystringOptional
younium-idempotency-durationInHoursintegerOptional
Body
effectiveChangeDatestring · date-time · nullableOptional
Responses
200

Success

No content
post/Subscriptions/{id}/OrderDiscounts
POST /Subscriptions/{id}/OrderDiscounts HTTP/1.1
Host: api.sandbox.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 394

{
  "effectiveChangeDate": "2026-01-01T00:00:00.000Z",
  "orderDiscounts": [
    {
      "operation": "Change",
      "OrderDiscountId": "GUID",
      "startOn": "AlignToOrder",
      "endOn": "AlignToOrder",
      "startDate": "2026-01-01T00:00:00.000Z",
      "endDate": "2026-01-01T00:00:00.000Z",
      "percent": 1,
      "description": "text",
      "onSpecificCharges": true,
      "orderProductCharges": [
        {
          "charge": "OPC-000001",
          "operation": "Remove"
        }
      ],
      "chargeMappingKey": "text"
    }
  ]
}
No content
PreviousSimpleproductsNextTaxtemplates

Last updated