Subscriptions

Get Subscription by Id

get

Requires permission Order View

Required scopes

This endpoint requires the following scopes:

• : Access Younium API

Authorizations

oauth2

OAuth2passwordRequired

Token URL:

Path parameters

idstring · uuidRequired

The subscription identifier

Header parameters

api-versionstringOptional

Responses

200

Success

application/json

400

Bad Request.

application/json

401

Unauthorized

403

Forbidden

404

Not Found

application/json

get

/Subscriptions/{id}

HTTPcURLJavaScriptPython

GET /Subscriptions/{id} HTTP/1.1
Host: api.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": "2025-12-19T13:11:42.674Z",
  "effectiveEndDate": "2025-12-19T13:11:42.674Z",
  "cancellationDate": "2025-12-19T13:11:42.674Z",
  "effectiveChangeDate": "2025-12-19T13:11:42.674Z",
  "orderDate": "2025-12-19T13:11:42.674Z",
  "noticePeriodDate": "2025-12-19T13:11:42.674Z",
  "lastRenewalDate": "2025-12-19T13:11:42.674Z",
  "created": "2025-12-19T13:11:42.674Z",
  "modified": "2025-12-19T13:11:42.674Z",
  "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": "2025-12-19T13:11:42.674Z",
          "effectiveEndDate": "2025-12-19T13:11:42.674Z",
          "quantity": 1,
          "unitCode": "text",
          "startOn": "AlignToSubscription",
          "endOn": "AlignToSubscription",
          "chargedThroughDate": "2025-12-19T13:11:42.674Z",
          "lastRenewalDate": "2025-12-19T13:11:42.674Z",
          "lastPriceAdjustmentDate": "2025-12-19T13:11:42.674Z",
          "pricePeriod": "Monthly",
          "usageRating": "Sum",
          "revenueRecognitionRule": "text",
          "billingDay": "None",
          "specificBillingDay": 1,
          "offsetBillingDays": 1,
          "billingPeriod": "Monthly",
          "billingTiming": "InAdvance",
          "periodAlignment": "None",
          "alignmentDate": "2025-12-19T13:11:42.674Z",
          "taxTemplate": "text",
          "taxIncluded": true,
          "createInvoiceLinesPerTier": true,
          "estimatedUsage": 1,
          "estimatedQuantity": 1,
          "remainingQuantity": 1,
          "orderedQuantity": 1,
          "deliveryDate": "2025-12-19T13:11:42.674Z",
          "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": "2025-12-19T13:11:42.674Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "acv": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2025-12-19T13:11:42.674Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "tcv": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2025-12-19T13:11:42.674Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "emrr": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2025-12-19T13:11:42.674Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "oneTimeFees": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2025-12-19T13:11:42.674Z",
            "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": "2025-12-19T13:11:42.674Z",
          "modified": "2025-12-19T13:11:42.674Z"
        }
      ],
      "customFields": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "externalERPId": "text",
      "externalCRMId": "text",
      "cmrr": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-12-19T13:11:42.674Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "acv": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-12-19T13:11:42.674Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "emrr": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-12-19T13:11:42.674Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "oneTimeFees": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-12-19T13:11:42.674Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "tcv": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-12-19T13:11:42.674Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "created": "2025-12-19T13:11:42.674Z",
      "modified": "2025-12-19T13:11:42.674Z"
    }
  ],
  "milestones": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "orderId": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "milestoneDate": "2025-12-19T13:11:42.674Z",
      "plannedDate": "2025-12-19T13:11:42.674Z"
    }
  ],
  "orderDiscounts": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "orderId": "123e4567-e89b-12d3-a456-426614174000",
      "startOn": "AlignToOrder",
      "endOn": "AlignToOrder",
      "startDate": "2025-12-19T13:11:42.674Z",
      "endDate": "2025-12-19T13:11:42.674Z",
      "percent": 1,
      "discountType": "Percent",
      "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": "2025-12-19T13:11:42.674Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  },
  "acv": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2025-12-19T13:11:42.674Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  },
  "emrr": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2025-12-19T13:11:42.674Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  },
  "oneTimeFees": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2025-12-19T13:11:42.674Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  },
  "tcv": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2025-12-19T13:11:42.674Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  }
}

Patch Subscription

patch

Required scopes

This endpoint requires the following scopes:

• : Access Younium API

Authorizations

oauth2

OAuth2passwordRequired

Token URL:

Path parameters

idstring · uuidRequired

Header parameters

api-versionstringOptional

Body

application/merge-patch+json

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

400

Bad Request.

application/json

401

Unauthorized

403

Forbidden

patch

/Subscriptions/{id}

HTTPcURLJavaScriptPython

PATCH /Subscriptions/{id} HTTP/1.1
Host: api.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

oauth2

OAuth2passwordRequired

Token URL:

Path parameters

idstring · uuidRequired

subscription id

Header parameters

api-versionstringOptional

Responses

200

Success

No content

400

Bad Request.

application/json

401

Unauthorized

403

Forbidden

404

Not Found

application/json

delete

/Subscriptions/{id}

HTTPcURLJavaScriptPython

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

No content

Get Subscriptions

get

Required scopes

This endpoint requires the following scopes:

• : Access Younium API

Authorizations

oauth2

OAuth2passwordRequired

Token URL:

Query parameters

FilterstringOptional

Filter the results. See developer resources for more information

Example: name eq 'Adam' and age gt 20

OrderBystringOptional

Sorting the results. See developer resources for more information

Example: accountNumber Desc

ModifiedAfterstring · date-timeOptional

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

Example: 2025-12-01

ModifiedBeforestring · date-timeOptional

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

Example: 2025-12-01

PageSizeinteger · int32Optional

Page Size

Example: 20

PageNumberinteger · int32Optional

Page Number

Example: 1

Header parameters

api-versionstringOptional

Responses

200

Success

application/json

400

Bad Request.

application/json

401

Unauthorized

403

Forbidden

get

/Subscriptions

HTTPcURLJavaScriptPython

GET /Subscriptions HTTP/1.1
Host: api.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "pageNumber": 1,
  "pageSize": 1,
  "totalPages": 1,
  "totalCount": 1,
  "nextPage": "https://example.com",
  "previousPage": "https://example.com",
  "firstPage": "https://example.com",
  "lastPage": "https://example.com",
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "orderNumber": "text",
      "version": 1,
      "isLastVersion": true,
      "status": "Draft",
      "description": "text",
      "remarks": "text",
      "effectiveStartDate": "2025-12-19T13:11:42.674Z",
      "effectiveEndDate": "2025-12-19T13:11:42.674Z",
      "cancellationDate": "2025-12-19T13:11:42.674Z",
      "effectiveChangeDate": "2025-12-19T13:11:42.674Z",
      "orderDate": "2025-12-19T13:11:42.674Z",
      "noticePeriodDate": "2025-12-19T13:11:42.674Z",
      "lastRenewalDate": "2025-12-19T13:11:42.674Z",
      "created": "2025-12-19T13:11:42.674Z",
      "modified": "2025-12-19T13:11:42.674Z",
      "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": "2025-12-19T13:11:42.674Z",
              "effectiveEndDate": "2025-12-19T13:11:42.674Z",
              "quantity": 1,
              "unitCode": "text",
              "startOn": "AlignToSubscription",
              "endOn": "AlignToSubscription",
              "chargedThroughDate": "2025-12-19T13:11:42.674Z",
              "lastRenewalDate": "2025-12-19T13:11:42.674Z",
              "lastPriceAdjustmentDate": "2025-12-19T13:11:42.674Z",
              "pricePeriod": "Monthly",
              "usageRating": "Sum",
              "revenueRecognitionRule": "text",
              "billingDay": "None",
              "specificBillingDay": 1,
              "offsetBillingDays": 1,
              "billingPeriod": "Monthly",
              "billingTiming": "InAdvance",
              "periodAlignment": "None",
              "alignmentDate": "2025-12-19T13:11:42.674Z",
              "taxTemplate": "text",
              "taxIncluded": true,
              "createInvoiceLinesPerTier": true,
              "estimatedUsage": 1,
              "estimatedQuantity": 1,
              "remainingQuantity": 1,
              "orderedQuantity": 1,
              "deliveryDate": "2025-12-19T13:11:42.674Z",
              "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": "2025-12-19T13:11:42.674Z",
                "baseCurrencyAmount": 1,
                "baseCurrencyCode": "text"
              },
              "acv": {
                "amount": 1,
                "currencyCode": "text",
                "currencyConversionDate": "2025-12-19T13:11:42.674Z",
                "baseCurrencyAmount": 1,
                "baseCurrencyCode": "text"
              },
              "tcv": {
                "amount": 1,
                "currencyCode": "text",
                "currencyConversionDate": "2025-12-19T13:11:42.674Z",
                "baseCurrencyAmount": 1,
                "baseCurrencyCode": "text"
              },
              "emrr": {
                "amount": 1,
                "currencyCode": "text",
                "currencyConversionDate": "2025-12-19T13:11:42.674Z",
                "baseCurrencyAmount": 1,
                "baseCurrencyCode": "text"
              },
              "oneTimeFees": {
                "amount": 1,
                "currencyCode": "text",
                "currencyConversionDate": "2025-12-19T13:11:42.674Z",
                "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": "2025-12-19T13:11:42.674Z",
              "modified": "2025-12-19T13:11:42.674Z"
            }
          ],
          "customFields": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "externalERPId": "text",
          "externalCRMId": "text",
          "cmrr": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2025-12-19T13:11:42.674Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "acv": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2025-12-19T13:11:42.674Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "emrr": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2025-12-19T13:11:42.674Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "oneTimeFees": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2025-12-19T13:11:42.674Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "tcv": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2025-12-19T13:11:42.674Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "created": "2025-12-19T13:11:42.674Z",
          "modified": "2025-12-19T13:11:42.674Z"
        }
      ],
      "milestones": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "orderId": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "description": "text",
          "milestoneDate": "2025-12-19T13:11:42.674Z",
          "plannedDate": "2025-12-19T13:11:42.674Z"
        }
      ],
      "orderDiscounts": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "orderId": "123e4567-e89b-12d3-a456-426614174000",
          "startOn": "AlignToOrder",
          "endOn": "AlignToOrder",
          "startDate": "2025-12-19T13:11:42.674Z",
          "endDate": "2025-12-19T13:11:42.674Z",
          "percent": 1,
          "discountType": "Percent",
          "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": "2025-12-19T13:11:42.674Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "acv": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-12-19T13:11:42.674Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "emrr": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-12-19T13:11:42.674Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "oneTimeFees": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-12-19T13:11:42.674Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "tcv": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-12-19T13:11:42.674Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      }
    }
  ]
}

Create subscription

post

Required scopes

This endpoint requires the following scopes:

• : Access Younium API

Authorizations

oauth2

OAuth2passwordRequired

Token URL:

Header parameters

api-versionstringOptional

younium-idempotency-keystringOptional

younium-idempotency-durationInHoursintegerOptional

Body

application/json

Responses

201

Subscription created.

400

Bad Request.

application/json

401

Unauthorized

403

Forbidden

post

/Subscriptions

HTTPcURLJavaScriptPython

POST /Subscriptions HTTP/1.1
Host: api.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 3129

{
  "status": "Draft",
  "description": "text",
  "remarks": "text",
  "effectiveStartDate": "2025-12-19T13:11:42.674Z",
  "effectiveEndDate": "2025-12-19T13:11:42.674Z",
  "orderDate": "2025-12-19T13:11:42.674Z",
  "noticePeriodDate": "2025-12-19T13:11:42.674Z",
  "lastRenewalDate": "2025-12-19T13:11:42.674Z",
  "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": "2025-12-19T13:11:42.674Z",
          "effectiveEndDate": "2025-12-19T13:11:42.674Z",
          "startMilestone": "text",
          "endMilestone": "text",
          "quantity": 1,
          "unitCode": "pcs",
          "startOn": "AlignToSubscription",
          "endOn": "AlignToSubscription",
          "chargedThroughDate": "2025-12-19T13:11:42.674Z",
          "lastRenewalDate": "2025-12-19T13:11:42.674Z",
          "lastPriceAdjustmentDate": "2025-12-19T13:11:42.674Z",
          "pricePeriod": "Monthly",
          "usageRating": "Sum",
          "revenueRecognitionRule": {
            "key": "text",
            "value": "text"
          },
          "billingDay": "None",
          "specificBillingDay": 1,
          "offsetBillingDays": 1,
          "billingPeriod": "Monthly",
          "billingTiming": "InAdvance",
          "periodAlignment": "None",
          "alignmentDate": "2025-12-19T13:11:42.674Z",
          "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": "2025-12-19T13:11:42.674Z"
    }
  ],
  "orderDiscounts": [
    {
      "operation": "Change",
      "OrderDiscountId": "GUID",
      "startOn": "AlignToOrder",
      "endOn": "AlignToOrder",
      "startDate": "2025-12-19T13:11:42.674Z",
      "endDate": "2025-12-19T13:11:42.674Z",
      "percent": 1,
      "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 Subscription versions

get

Required scopes

This endpoint requires the following scopes:

• : Access Younium API

Authorizations

oauth2

OAuth2passwordRequired

Token URL:

Path parameters

orderNumberstringRequired

Query parameters

FilterstringOptional

Filter the results. See developer resources for more information

Example: name eq 'Adam' and age gt 20

OrderBystringOptional

Sorting the results. See developer resources for more information

Example: accountNumber Desc

ModifiedAfterstring · date-timeOptional

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

Example: 2025-12-01

ModifiedBeforestring · date-timeOptional

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

Example: 2025-12-01

PageSizeinteger · int32Optional

Page Size

Example: 20

PageNumberinteger · int32Optional

Page Number

Example: 1

Header parameters

api-versionstringOptional

Responses

200

Success

application/json

400

Bad Request.

application/json

401

Unauthorized

403

Forbidden

get

/Subscriptions/{orderNumber}/versions

HTTPcURLJavaScriptPython

GET /Subscriptions/{orderNumber}/versions HTTP/1.1
Host: api.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": "2025-12-19T13:11:42.674Z",
    "effectiveEndDate": "2025-12-19T13:11:42.674Z",
    "cancellationDate": "2025-12-19T13:11:42.674Z",
    "effectiveChangeDate": "2025-12-19T13:11:42.674Z",
    "orderDate": "2025-12-19T13:11:42.674Z",
    "noticePeriodDate": "2025-12-19T13:11:42.674Z",
    "lastRenewalDate": "2025-12-19T13:11:42.674Z",
    "created": "2025-12-19T13:11:42.674Z",
    "modified": "2025-12-19T13:11:42.674Z",
    "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": "2025-12-19T13:11:42.674Z",
            "effectiveEndDate": "2025-12-19T13:11:42.674Z",
            "quantity": 1,
            "unitCode": "text",
            "startOn": "AlignToSubscription",
            "endOn": "AlignToSubscription",
            "chargedThroughDate": "2025-12-19T13:11:42.674Z",
            "lastRenewalDate": "2025-12-19T13:11:42.674Z",
            "lastPriceAdjustmentDate": "2025-12-19T13:11:42.674Z",
            "pricePeriod": "Monthly",
            "usageRating": "Sum",
            "revenueRecognitionRule": "text",
            "billingDay": "None",
            "specificBillingDay": 1,
            "offsetBillingDays": 1,
            "billingPeriod": "Monthly",
            "billingTiming": "InAdvance",
            "periodAlignment": "None",
            "alignmentDate": "2025-12-19T13:11:42.674Z",
            "taxTemplate": "text",
            "taxIncluded": true,
            "createInvoiceLinesPerTier": true,
            "estimatedUsage": 1,
            "estimatedQuantity": 1,
            "remainingQuantity": 1,
            "orderedQuantity": 1,
            "deliveryDate": "2025-12-19T13:11:42.674Z",
            "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": "2025-12-19T13:11:42.674Z",
              "baseCurrencyAmount": 1,
              "baseCurrencyCode": "text"
            },
            "acv": {
              "amount": 1,
              "currencyCode": "text",
              "currencyConversionDate": "2025-12-19T13:11:42.674Z",
              "baseCurrencyAmount": 1,
              "baseCurrencyCode": "text"
            },
            "tcv": {
              "amount": 1,
              "currencyCode": "text",
              "currencyConversionDate": "2025-12-19T13:11:42.674Z",
              "baseCurrencyAmount": 1,
              "baseCurrencyCode": "text"
            },
            "emrr": {
              "amount": 1,
              "currencyCode": "text",
              "currencyConversionDate": "2025-12-19T13:11:42.674Z",
              "baseCurrencyAmount": 1,
              "baseCurrencyCode": "text"
            },
            "oneTimeFees": {
              "amount": 1,
              "currencyCode": "text",
              "currencyConversionDate": "2025-12-19T13:11:42.674Z",
              "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": "2025-12-19T13:11:42.674Z",
            "modified": "2025-12-19T13:11:42.674Z"
          }
        ],
        "customFields": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "externalERPId": "text",
        "externalCRMId": "text",
        "cmrr": {
          "amount": 1,
          "currencyCode": "text",
          "currencyConversionDate": "2025-12-19T13:11:42.674Z",
          "baseCurrencyAmount": 1,
          "baseCurrencyCode": "text"
        },
        "acv": {
          "amount": 1,
          "currencyCode": "text",
          "currencyConversionDate": "2025-12-19T13:11:42.674Z",
          "baseCurrencyAmount": 1,
          "baseCurrencyCode": "text"
        },
        "emrr": {
          "amount": 1,
          "currencyCode": "text",
          "currencyConversionDate": "2025-12-19T13:11:42.674Z",
          "baseCurrencyAmount": 1,
          "baseCurrencyCode": "text"
        },
        "oneTimeFees": {
          "amount": 1,
          "currencyCode": "text",
          "currencyConversionDate": "2025-12-19T13:11:42.674Z",
          "baseCurrencyAmount": 1,
          "baseCurrencyCode": "text"
        },
        "tcv": {
          "amount": 1,
          "currencyCode": "text",
          "currencyConversionDate": "2025-12-19T13:11:42.674Z",
          "baseCurrencyAmount": 1,
          "baseCurrencyCode": "text"
        },
        "created": "2025-12-19T13:11:42.674Z",
        "modified": "2025-12-19T13:11:42.674Z"
      }
    ],
    "milestones": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "orderId": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "description": "text",
        "milestoneDate": "2025-12-19T13:11:42.674Z",
        "plannedDate": "2025-12-19T13:11:42.674Z"
      }
    ],
    "orderDiscounts": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "orderId": "123e4567-e89b-12d3-a456-426614174000",
        "startOn": "AlignToOrder",
        "endOn": "AlignToOrder",
        "startDate": "2025-12-19T13:11:42.674Z",
        "endDate": "2025-12-19T13:11:42.674Z",
        "percent": 1,
        "discountType": "Percent",
        "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": "2025-12-19T13:11:42.674Z",
      "baseCurrencyAmount": 1,
      "baseCurrencyCode": "text"
    },
    "acv": {
      "amount": 1,
      "currencyCode": "text",
      "currencyConversionDate": "2025-12-19T13:11:42.674Z",
      "baseCurrencyAmount": 1,
      "baseCurrencyCode": "text"
    },
    "emrr": {
      "amount": 1,
      "currencyCode": "text",
      "currencyConversionDate": "2025-12-19T13:11:42.674Z",
      "baseCurrencyAmount": 1,
      "baseCurrencyCode": "text"
    },
    "oneTimeFees": {
      "amount": 1,
      "currencyCode": "text",
      "currencyConversionDate": "2025-12-19T13:11:42.674Z",
      "baseCurrencyAmount": 1,
      "baseCurrencyCode": "text"
    },
    "tcv": {
      "amount": 1,
      "currencyCode": "text",
      "currencyConversionDate": "2025-12-19T13:11:42.674Z",
      "baseCurrencyAmount": 1,
      "baseCurrencyCode": "text"
    }
  }
]

Get Subscription Version by Id

get

Required scopes

This endpoint requires the following scopes:

• : Access Younium API

Authorizations

oauth2

OAuth2passwordRequired

Token URL:

Path parameters

idstring · uuidRequired

Header parameters

api-versionstringOptional

Responses

200

Success

application/json

400

Bad Request.

application/json

401

Unauthorized

403

Forbidden

404

Not Found

application/json

get

/Subscriptions/{id}/version

HTTPcURLJavaScriptPython

GET /Subscriptions/{id}/version HTTP/1.1
Host: api.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": "2025-12-19T13:11:42.674Z",
  "effectiveEndDate": "2025-12-19T13:11:42.674Z",
  "cancellationDate": "2025-12-19T13:11:42.674Z",
  "effectiveChangeDate": "2025-12-19T13:11:42.674Z",
  "orderDate": "2025-12-19T13:11:42.674Z",
  "noticePeriodDate": "2025-12-19T13:11:42.674Z",
  "lastRenewalDate": "2025-12-19T13:11:42.674Z",
  "created": "2025-12-19T13:11:42.674Z",
  "modified": "2025-12-19T13:11:42.674Z",
  "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": "2025-12-19T13:11:42.674Z",
          "effectiveEndDate": "2025-12-19T13:11:42.674Z",
          "quantity": 1,
          "unitCode": "text",
          "startOn": "AlignToSubscription",
          "endOn": "AlignToSubscription",
          "chargedThroughDate": "2025-12-19T13:11:42.674Z",
          "lastRenewalDate": "2025-12-19T13:11:42.674Z",
          "lastPriceAdjustmentDate": "2025-12-19T13:11:42.674Z",
          "pricePeriod": "Monthly",
          "usageRating": "Sum",
          "revenueRecognitionRule": "text",
          "billingDay": "None",
          "specificBillingDay": 1,
          "offsetBillingDays": 1,
          "billingPeriod": "Monthly",
          "billingTiming": "InAdvance",
          "periodAlignment": "None",
          "alignmentDate": "2025-12-19T13:11:42.674Z",
          "taxTemplate": "text",
          "taxIncluded": true,
          "createInvoiceLinesPerTier": true,
          "estimatedUsage": 1,
          "estimatedQuantity": 1,
          "remainingQuantity": 1,
          "orderedQuantity": 1,
          "deliveryDate": "2025-12-19T13:11:42.674Z",
          "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": "2025-12-19T13:11:42.674Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "acv": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2025-12-19T13:11:42.674Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "tcv": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2025-12-19T13:11:42.674Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "emrr": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2025-12-19T13:11:42.674Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "oneTimeFees": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2025-12-19T13:11:42.674Z",
            "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": "2025-12-19T13:11:42.674Z",
          "modified": "2025-12-19T13:11:42.674Z"
        }
      ],
      "customFields": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "externalERPId": "text",
      "externalCRMId": "text",
      "cmrr": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-12-19T13:11:42.674Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "acv": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-12-19T13:11:42.674Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "emrr": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-12-19T13:11:42.674Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "oneTimeFees": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-12-19T13:11:42.674Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "tcv": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-12-19T13:11:42.674Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "created": "2025-12-19T13:11:42.674Z",
      "modified": "2025-12-19T13:11:42.674Z"
    }
  ],
  "milestones": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "orderId": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "milestoneDate": "2025-12-19T13:11:42.674Z",
      "plannedDate": "2025-12-19T13:11:42.674Z"
    }
  ],
  "orderDiscounts": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "orderId": "123e4567-e89b-12d3-a456-426614174000",
      "startOn": "AlignToOrder",
      "endOn": "AlignToOrder",
      "startDate": "2025-12-19T13:11:42.674Z",
      "endDate": "2025-12-19T13:11:42.674Z",
      "percent": 1,
      "discountType": "Percent",
      "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": "2025-12-19T13:11:42.674Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  },
  "acv": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2025-12-19T13:11:42.674Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  },
  "emrr": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2025-12-19T13:11:42.674Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  },
  "oneTimeFees": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2025-12-19T13:11:42.674Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  },
  "tcv": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2025-12-19T13:11:42.674Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  }
}

Get Subscription Version by OrderNumber

get

Required scopes

This endpoint requires the following scopes:

• : Access Younium API

Authorizations

oauth2

OAuth2passwordRequired

Token URL:

Path parameters

orderNumberstringRequired

versioninteger · int32Required

Header parameters

api-versionstringOptional

Responses

200

Success

application/json

400

Bad Request.

application/json

401

Unauthorized

403

Forbidden

get

/Subscriptions/{orderNumber}/versions/{version}

HTTPcURLJavaScriptPython

GET /Subscriptions/{orderNumber}/versions/{version} HTTP/1.1
Host: api.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": "2025-12-19T13:11:42.674Z",
  "effectiveEndDate": "2025-12-19T13:11:42.674Z",
  "cancellationDate": "2025-12-19T13:11:42.674Z",
  "effectiveChangeDate": "2025-12-19T13:11:42.674Z",
  "orderDate": "2025-12-19T13:11:42.674Z",
  "noticePeriodDate": "2025-12-19T13:11:42.674Z",
  "lastRenewalDate": "2025-12-19T13:11:42.674Z",
  "created": "2025-12-19T13:11:42.674Z",
  "modified": "2025-12-19T13:11:42.674Z",
  "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": "2025-12-19T13:11:42.674Z",
          "effectiveEndDate": "2025-12-19T13:11:42.674Z",
          "quantity": 1,
          "unitCode": "text",
          "startOn": "AlignToSubscription",
          "endOn": "AlignToSubscription",
          "chargedThroughDate": "2025-12-19T13:11:42.674Z",
          "lastRenewalDate": "2025-12-19T13:11:42.674Z",
          "lastPriceAdjustmentDate": "2025-12-19T13:11:42.674Z",
          "pricePeriod": "Monthly",
          "usageRating": "Sum",
          "revenueRecognitionRule": "text",
          "billingDay": "None",
          "specificBillingDay": 1,
          "offsetBillingDays": 1,
          "billingPeriod": "Monthly",
          "billingTiming": "InAdvance",
          "periodAlignment": "None",
          "alignmentDate": "2025-12-19T13:11:42.674Z",
          "taxTemplate": "text",
          "taxIncluded": true,
          "createInvoiceLinesPerTier": true,
          "estimatedUsage": 1,
          "estimatedQuantity": 1,
          "remainingQuantity": 1,
          "orderedQuantity": 1,
          "deliveryDate": "2025-12-19T13:11:42.674Z",
          "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": "2025-12-19T13:11:42.674Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "acv": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2025-12-19T13:11:42.674Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "tcv": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2025-12-19T13:11:42.674Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "emrr": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2025-12-19T13:11:42.674Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "oneTimeFees": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2025-12-19T13:11:42.674Z",
            "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": "2025-12-19T13:11:42.674Z",
          "modified": "2025-12-19T13:11:42.674Z"
        }
      ],
      "customFields": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "externalERPId": "text",
      "externalCRMId": "text",
      "cmrr": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-12-19T13:11:42.674Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "acv": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-12-19T13:11:42.674Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "emrr": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-12-19T13:11:42.674Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "oneTimeFees": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-12-19T13:11:42.674Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "tcv": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-12-19T13:11:42.674Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "created": "2025-12-19T13:11:42.674Z",
      "modified": "2025-12-19T13:11:42.674Z"
    }
  ],
  "milestones": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "orderId": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "milestoneDate": "2025-12-19T13:11:42.674Z",
      "plannedDate": "2025-12-19T13:11:42.674Z"
    }
  ],
  "orderDiscounts": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "orderId": "123e4567-e89b-12d3-a456-426614174000",
      "startOn": "AlignToOrder",
      "endOn": "AlignToOrder",
      "startDate": "2025-12-19T13:11:42.674Z",
      "endDate": "2025-12-19T13:11:42.674Z",
      "percent": 1,
      "discountType": "Percent",
      "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": "2025-12-19T13:11:42.674Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  },
  "acv": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2025-12-19T13:11:42.674Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  },
  "emrr": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2025-12-19T13:11:42.674Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  },
  "oneTimeFees": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2025-12-19T13:11:42.674Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  },
  "tcv": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2025-12-19T13:11:42.674Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  }
}

Change Subscription

post

Required scopes

This endpoint requires the following scopes:

• : Access Younium API

Authorizations

oauth2

OAuth2passwordRequired

Token URL:

Path parameters

idstring · uuidRequired

Header parameters

api-versionstringOptional

younium-idempotency-keystringOptional

younium-idempotency-durationInHoursintegerOptional

Body

application/json

Responses

201

New version of Subscription created.

400

Bad Request.

application/json

401

Unauthorized

403

Forbidden

post

/Subscriptions/{id}/change

HTTPcURLJavaScriptPython

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

{
  "account": "A-000001",
  "invoiceAccount": "A-000001",
  "description": "text",
  "remarks": "text",
  "effectiveStartDate": "2025-12-19T13:11:42.674Z",
  "effectiveChangeDate": "2025-12-19T13:11:42.674Z",
  "effectiveEndDate": "2025-12-19T13:11:42.674Z",
  "orderDate": "2025-12-19T13:11:42.674Z",
  "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": "2025-12-19T13:11:42.674Z",
          "lastRenewalDate": "2025-12-19T13:11:42.674Z",
          "lastPriceAdjustmentDate": "2025-12-19T13:11:42.674Z",
          "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": "2025-12-19T13:11:42.674Z",
          "taxTemplate": "Sweden standard",
          "taxIncluded": true,
          "createInvoiceLinesPerTier": true,
          "remarks": "text",
          "externalERPId": "text",
          "externalCRMId": "text",
          "customFields": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "recurringMonthlyAmount": 1,
          "effectiveStartDate": "2025-12-19T13:11:42.674Z",
          "effectiveEndDate": "2025-12-19T13:11:42.674Z",
          "startMilestone": "MilestoneName",
          "endMilestone": "MilestoneName",
          "estimatedUsage": 1,
          "estimatedQuantity": 1,
          "orderDiscountMappingKey": [
            "text"
          ]
        }
      ],
      "externalERPId": "text",
      "externalCRMId": "text",
      "customFields": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "cancelProductOn": "EffectiveEndDate",
      "cancelationDate": "2025-12-19T13:11:42.674Z"
    }
  ],
  "milestones": [
    {
      "name": "text",
      "description": "text",
      "plannedDate": "2025-12-19T13:11:42.674Z"
    }
  ],
  "orderDiscounts": [
    {
      "operation": "Change",
      "OrderDiscountId": "GUID",
      "startOn": "AlignToOrder",
      "endOn": "AlignToOrder",
      "startDate": "2025-12-19T13:11:42.674Z",
      "endDate": "2025-12-19T13:11:42.674Z",
      "percent": 1,
      "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

oauth2

OAuth2passwordRequired

Token URL:

Path parameters

idstring · uuidRequired

Header parameters

api-versionstringOptional

younium-idempotency-keystringOptional

younium-idempotency-durationInHoursintegerOptional

Body

application/json

Responses

200

Success

application/json

400

Bad Request.

application/json

401

Unauthorized

403

Forbidden

post

/Subscriptions/{id}/RenewAndChange

HTTPcURLJavaScriptPython

POST /Subscriptions/{id}/RenewAndChange HTTP/1.1
Host: api.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 3159

{
  "nextRenewalTerm": 1,
  "account": "A-000001",
  "invoiceAccount": "A-000001",
  "description": "text",
  "remarks": "text",
  "effectiveStartDate": "2025-12-19T13:11:42.674Z",
  "effectiveChangeDate": "2025-12-19T13:11:42.674Z",
  "effectiveEndDate": "2025-12-19T13:11:42.674Z",
  "orderDate": "2025-12-19T13:11:42.674Z",
  "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": "2025-12-19T13:11:42.674Z",
          "lastRenewalDate": "2025-12-19T13:11:42.674Z",
          "lastPriceAdjustmentDate": "2025-12-19T13:11:42.674Z",
          "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": "2025-12-19T13:11:42.674Z",
          "taxTemplate": "Sweden standard",
          "taxIncluded": true,
          "createInvoiceLinesPerTier": true,
          "remarks": "text",
          "externalERPId": "text",
          "externalCRMId": "text",
          "customFields": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "recurringMonthlyAmount": 1,
          "effectiveStartDate": "2025-12-19T13:11:42.674Z",
          "effectiveEndDate": "2025-12-19T13:11:42.674Z",
          "startMilestone": "MilestoneName",
          "endMilestone": "MilestoneName",
          "estimatedUsage": 1,
          "estimatedQuantity": 1,
          "orderDiscountMappingKey": [
            "text"
          ]
        }
      ],
      "externalERPId": "text",
      "externalCRMId": "text",
      "customFields": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "cancelProductOn": "EffectiveEndDate",
      "cancelationDate": "2025-12-19T13:11:42.674Z"
    }
  ],
  "milestones": [
    {
      "name": "text",
      "description": "text",
      "plannedDate": "2025-12-19T13:11:42.674Z"
    }
  ],
  "orderDiscounts": [
    {
      "operation": "Change",
      "OrderDiscountId": "GUID",
      "startOn": "AlignToOrder",
      "endOn": "AlignToOrder",
      "startDate": "2025-12-19T13:11:42.674Z",
      "endDate": "2025-12-19T13:11:42.674Z",
      "percent": 1,
      "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

oauth2

OAuth2passwordRequired

Token URL:

Path parameters

idstring · uuidRequired

subscription id

Header parameters

api-versionstringOptional

younium-idempotency-keystringOptional

younium-idempotency-durationInHoursintegerOptional

Body

application/json

Responses

200

Success

No content

400

Bad Request.

application/json

401

Unauthorized

403

Forbidden

post

/Subscriptions/cancel/{id}

HTTPcURLJavaScriptPython

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

{
  "endDate": "2024-12-31",
  "cancellationDate": "2025-12-19T13:11:42.674Z",
  "cancellationMode": "OnOrderCancellationDate",
  "cancellationDatePerCharges": {
    "ANY_ADDITIONAL_PROPERTY": "2025-12-19T13:11:42.674Z"
  }
}

No content

Renew Subscription

post

Required scopes

This endpoint requires the following scopes:

• : Access Younium API

Authorizations

oauth2

OAuth2passwordRequired

Token URL:

Path parameters

idstring · uuidRequired

subscription id

Header parameters

api-versionstringOptional

younium-idempotency-keystringOptional

younium-idempotency-durationInHoursintegerOptional

Body

application/json

Responses

200

Success

No content

400

Bad Request.

application/json

401

Unauthorized

403

Forbidden

post

/Subscriptions/renew/{id}

HTTPcURLJavaScriptPython

POST /Subscriptions/renew/{id} HTTP/1.1
Host: api.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

oauth2

OAuth2passwordRequired

Token URL:

Path parameters

idstring · uuidRequired

subscription id

Header parameters

api-versionstringOptional

younium-idempotency-keystringOptional

younium-idempotency-durationInHoursintegerOptional

Responses

200

Success

application/json

400

Bad Request.

application/json

401

Unauthorized

403

Forbidden

post

/Subscriptions/revert/{id}

HTTPcURLJavaScriptPython

POST /Subscriptions/revert/{id} HTTP/1.1
Host: api.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

oauth2

OAuth2passwordRequired

Token URL:

Path parameters

idstring · uuidRequired

Header parameters

api-versionstringOptional

younium-idempotency-keystringOptional

younium-idempotency-durationInHoursintegerOptional

Responses

200

Success

application/json

400

Bad Request.

application/json

401

Unauthorized

403

Forbidden

post

/Subscriptions/activate/{id}

HTTPcURLJavaScriptPython

POST /Subscriptions/activate/{id} HTTP/1.1
Host: api.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

oauth2

OAuth2passwordRequired

Token URL:

Path parameters

idstring · uuidRequired

subscription id

Header parameters

api-versionstringOptional

Responses

200

Success

application/json

400

Bad Request.

application/json

401

Unauthorized

403

Forbidden

404

Not Found

application/json

get

/Subscriptions/{id}/milestones

HTTPcURLJavaScriptPython

GET /Subscriptions/{id}/milestones HTTP/1.1
Host: api.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": "2025-12-19T13:11:42.674Z",
    "plannedDate": "2025-12-19T13:11:42.674Z"
  }
]

Set Subscription Milestone date

post

Required scopes

This endpoint requires the following scopes:

• : Access Younium API

Authorizations

oauth2

OAuth2passwordRequired

Token URL:

Path parameters

idstring · uuidRequired

Subscription Milestone Id

Header parameters

api-versionstringOptional

younium-idempotency-keystringOptional

younium-idempotency-durationInHoursintegerOptional

Body

application/json

Responses

200

Success

application/json

400

Bad Request.

application/json

401

Unauthorized

403

Forbidden

post

/Subscriptions/milestones/set/{id}

HTTPcURLJavaScriptPython

POST /Subscriptions/milestones/set/{id} HTTP/1.1
Host: api.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 97

{
  "milestoneDate": "2025-12-19T13:11:42.674Z",
  "milestoneId": "123e4567-e89b-12d3-a456-426614174000"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "orderId": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "milestoneDate": "2025-12-19T13:11:42.674Z",
  "plannedDate": "2025-12-19T13:11:42.674Z"
}

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

oauth2

OAuth2passwordRequired

Token URL:

Path parameters

idstring · uuidRequired

Header parameters

api-versionstringOptional

younium-idempotency-keystringOptional

younium-idempotency-durationInHoursintegerOptional

Body

application/json

Responses

200

Success

No content

400

Bad Request.

application/json

401

Unauthorized

403

Forbidden

post

/Subscriptions/{id}/OrderDiscounts

HTTPcURLJavaScriptPython

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

{
  "effectiveChangeDate": "2025-12-19T13:11:42.674Z",
  "orderDiscounts": [
    {
      "operation": "Change",
      "OrderDiscountId": "GUID",
      "startOn": "AlignToOrder",
      "endOn": "AlignToOrder",
      "startDate": "2025-12-19T13:11:42.674Z",
      "endDate": "2025-12-19T13:11:42.674Z",
      "percent": 1,
      "onSpecificCharges": true,
      "orderProductCharges": [
        {
          "charge": "OPC-000001",
          "operation": "Remove"
        }
      ],
      "chargeMappingKey": "text"
    }
  ]
}

No content

---