Subscriptions

Get Subscription by Id

Requires permission Order View

get

/Subscriptions/{id}

Authorizations

Path parameters

idstring · uuidrequired

The subscription identifier

Header parameters

api-versionstring

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.younium.com/Subscriptions/{id}'

200

400

401

403

404

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "orderNumber": "text",
  "version": 1,
  "isLastVersion": true,
  "description": "text",
  "remarks": "text",
  "effectiveStartDate": "2025-02-22T08:42:52.442Z",
  "effectiveEndDate": "2025-02-22T08:42:52.442Z",
  "cancellationDate": "2025-02-22T08:42:52.442Z",
  "effectiveChangeDate": "2025-02-22T08:42:52.442Z",
  "orderDate": "2025-02-22T08:42:52.442Z",
  "noticePeriodDate": "2025-02-22T08:42:52.442Z",
  "lastRenewalDate": "2025-02-22T08:42:52.442Z",
  "created": "2025-02-22T08:42:52.442Z",
  "modified": "2025-02-22T08:42:52.442Z",
  "lastUpdated": "2024-07-01",
  "noticePeriod": 1,
  "term": 1,
  "renewalTerm": 1,
  "isAutoRenewed": true,
  "invoiceSeparatly": true,
  "yourReference": "text",
  "ourReference": "text",
  "yourOrderNumber": "text",
  "buyerReference": "text",
  "setOrderBillingPeriod": true,
  "paymentTerm": "text",
  "useAccountInvoiceBatchGroup": true,
  "currency": "text",
  "externalERPId": "text",
  "externalCRMId": "text",
  "currencyCodeToUseWhenInvoice": "text",
  "customFields": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "products": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "productNumber": "text",
      "chargePlanId": "123e4567-e89b-12d3-a456-426614174000",
      "chargePlanName": "text",
      "chargePlanNumber": "text",
      "productLineNumber": 1,
      "name": "text",
      "externalERPId": "text",
      "externalCRMId": "text",
      "created": "2025-02-22T08:42:52.442Z",
      "modified": "2025-02-22T08:42:52.442Z",
      "customFields": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "charges": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "chargeNumber": "OPC-000001",
          "version": 1,
          "isLastVersion": true,
          "name": "text",
          "effectiveStartDate": "2025-02-22T08:42:52.442Z",
          "effectiveEndDate": "2025-02-22T08:42:52.442Z",
          "quantity": 1,
          "unitCode": "text",
          "chargedThroughDate": "2025-02-22T08:42:52.442Z",
          "lastRenewalDate": "2025-02-22T08:42:52.442Z",
          "lastPriceAdjustmentDate": "2025-02-22T08:42:52.442Z",
          "revenueRecognitionRule": "text",
          "specificBillingDay": 1,
          "alignmentDate": "2025-02-22T08:42:52.442Z",
          "taxTemplate": "text",
          "taxIncluded": true,
          "createInvoiceLinesPerTier": true,
          "estimatedUsage": 1,
          "estimatedQuantity": 1,
          "remainingQuantity": 1,
          "orderedQuantity": 1,
          "remarks": "text",
          "accountsReceivableAccount": "text",
          "deferredRevenueAccount": "text",
          "recognizedRevenueAccount": "text",
          "displayPrice": 1,
          "recurringMonthlyAmount": 1,
          "recurringMonthlyAmountBase": 1,
          "externalERPId": "text",
          "externalCRMId": "text",
          "orderProductId": "123e4567-e89b-12d3-a456-426614174000",
          "orderId": "123e4567-e89b-12d3-a456-426614174000",
          "chargeId": "123e4567-e89b-12d3-a456-426614174000",
          "created": "2025-02-22T08:42:52.442Z",
          "modified": "2025-02-22T08:42:52.442Z",
          "customFields": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "priceDetails": [
            {
              "tier": 1,
              "price": 1,
              "listPrice": 1,
              "description": "text",
              "fromQuantity": 1,
              "toQuantity": 1,
              "lineDiscountPercent": 1,
              "lineDiscountAmount": 1,
              "priceBase": "Flat"
            }
          ],
          "features": [
            {
              "code": "text",
              "description": "text"
            }
          ],
          "orderDiscounts": [
            {
              "orderDiscountId": "123e4567-e89b-12d3-a456-426614174000",
              "chargeId": "123e4567-e89b-12d3-a456-426614174000"
            }
          ],
          "chargeType": "OneOff",
          "priceModel": "Flat",
          "startOn": "AlignToSubscription",
          "endOn": "AlignToSubscription",
          "pricePeriod": "Monthly",
          "usageRating": "Sum",
          "billingDay": "None",
          "billingPeriod": "Monthly",
          "billingTiming": "InAdvance",
          "periodAlignment": "None",
          "changeState": "NotChanged",
          "cmrr": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2025-02-22T08:42:52.442Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "acv": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2025-02-22T08:42:52.442Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "tcv": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2025-02-22T08:42:52.442Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "emrr": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2025-02-22T08:42:52.442Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "oneTimeFees": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2025-02-22T08:42:52.442Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          }
        }
      ],
      "cmrr": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-02-22T08:42:52.442Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "acv": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-02-22T08:42:52.442Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "emrr": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-02-22T08:42:52.442Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "oneTimeFees": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-02-22T08:42:52.442Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "tcv": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-02-22T08:42:52.442Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      }
    }
  ],
  "milestones": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "orderId": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "milestoneDate": "2025-02-22T08:42:52.442Z",
      "plannedDate": "2025-02-22T08:42:52.442Z"
    }
  ],
  "orderDiscounts": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "orderId": "123e4567-e89b-12d3-a456-426614174000",
      "startDate": "2025-02-22T08:42:52.442Z",
      "endDate": "2025-02-22T08:42:52.442Z",
      "percent": 1,
      "onSpecificCharges": true,
      "orderProductCharges": [
        {
          "orderDiscountId": "123e4567-e89b-12d3-a456-426614174000",
          "chargeId": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "startOn": "AlignToOrder",
      "endOn": "AlignToOrder",
      "discountType": "Percent"
    }
  ],
  "status": "Draft",
  "orderType": "Subscription",
  "termType": "Termed",
  "orderPaymentMethod": "Invoice",
  "invoiceAddress": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "name": "text",
    "street": "text",
    "street2": "text",
    "city": "text",
    "county": "text",
    "state": "text",
    "zip": "text",
    "country": "text"
  },
  "deliveryAddress": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "name": "text",
    "street": "text",
    "street2": "text",
    "city": "text",
    "county": "text",
    "state": "text",
    "zip": "text",
    "country": "text"
  },
  "orderBillingPeriod": "Monthly",
  "invoiceBatchGroup": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "code": "text",
    "description": "text"
  },
  "account": {
    "name": "text",
    "accountNumber": "text",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "externalERPId": "text",
    "externalCRMId": "text"
  },
  "invoiceAccount": {
    "name": "text",
    "accountNumber": "text",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "externalERPId": "text",
    "externalCRMId": "text"
  },
  "cmrr": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2025-02-22T08:42:52.442Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  },
  "acv": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2025-02-22T08:42:52.442Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  },
  "emrr": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2025-02-22T08:42:52.442Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  },
  "oneTimeFees": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2025-02-22T08:42:52.442Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  },
  "tcv": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2025-02-22T08:42:52.442Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  }
}

Success

Patch Subscription

patch

/Subscriptions/{id}

Authorizations

Path parameters

idstring · uuidrequired

Header parameters

api-versionstring

Body

descriptionstring | nullable

remarksstring | nullable

noticePeriodinteger · int32 | nullable

invoiceSeparatlyboolean

useAccountInvoiceBatchGroupboolean

invoiceBatchGroupIdstring · uuid | nullableDeprecated

invoiceTemplateIdstring · uuid | nullable

externalERPIdstring | nullable

externalCRMIdstring | nullable

buyerReferencestring | nullable

yourOrderNumberstring | nullable

customFieldsobject | nullable

invoiceBatchGroupall of | nullable

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url 'https://api.younium.com/Subscriptions/{id}' \
  --header 'Content-Type: application/merge-patch+json' \
  --data '{"customFields":{"ANY_ADDITIONAL_PROPERTY":"anything"},"invoiceBatchGroup":{}}'

200

400

401

403

200

No body

Success

Delete Subscription

delete

/Subscriptions/{id}

Authorizations

Path parameters

idstring · uuidrequired

subscription id

Header parameters

api-versionstring

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://api.younium.com/Subscriptions/{id}'

200

400

401

403

404

200

No body

Success

Get Subscriptions

get

/Subscriptions

Authorizations

Query parameters

Filterstring

Filter the results. See ODATA documentation for more information

Example: name eq 'Adam' and age gt 20

OrderBystring

Sorting the results. See ODATA specification for more information

Example: accountNumber Desc

ModifiedAfterstring · date-time

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

Example: 11/01/2024 00:00:00

ModifiedBeforestring · date-time

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

Example: 11/01/2024 00:00:00

PageSizeinteger · int32

Page Size

Example: 20

PageNumberinteger · int32

Page Number

Example: 1

Header parameters

api-versionstring

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.younium.com/Subscriptions'

200

400

401

403

200

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

Success

Create subscription

post

/Subscriptions

Authorizations

Header parameters

api-versionstring

Body

descriptionstring | nullable

remarksstring | nullable

effectiveStartDatestring · date-time | nullable

orderDatestring · date-time | nullable

noticePeriodDatestring · date-time | nullable

lastRenewalDatestring · date-time | nullable

noticePeriodinteger · int32 | nullable

terminteger · int32 | nullable

renewalTerminteger · int32 | nullable

isAutoRenewedboolean | nullable

invoiceSeparatlyboolean | nullable

yourReferencestring | nullable

ourReferencestring | nullable

yourOrderNumberstring | nullable

buyerReferencestring | nullable

invoiceAddressIdstring · uuid | nullable

deliveryAddressIdstring · uuid | nullable

externalERPIdstring | nullable

externalCRMIdstring | nullable

useAccountInvoiceBatchGroupboolean | nullable

invoicingCurrencystring | nullable

invoiceTemplateIdstring · uuid | nullable

invoiceBatchGroupIdstring · uuid | nullableDeprecated

setOrderBillingPeriodboolean | nullable

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

customFieldsobject | nullable

productsobject[] | nullable

milestonesobject[] | nullable

orderDiscountsobject[] | nullable

statusall ofrequired

orderTypeall of | nullable

subscriptionTypeall of | nullable

orderPaymentMethodall of

paymentTermall of | nullable

Allowed as string input: Name, PaymentTerm-Id.

Example: NET30

accountall ofrequired

Allowed as string input: AccountNumber, Account-Id, Name.

Example: A-000001

invoiceAccountall of | nullable

Allowed as string input: AccountNumber, Account-Id, Name.

Example: A-000001

currencyall of | nullable

Allowed as string input: Code, Currency-Id.

Example: SEK

invoiceBatchGroupall of | nullable

orderBillingPeriodall of | nullable

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.younium.com/Subscriptions' \
  --header 'Content-Type: application/json' \
  --data '{"customFields":{"ANY_ADDITIONAL_PROPERTY":"anything"},"products":[{"customFields":{"ANY_ADDITIONAL_PROPERTY":"anything"},"charges":[{"customFields":{"ANY_ADDITIONAL_PROPERTY":"anything"},"priceDetails":[{"priceBase":"Flat"}],"features":[{"feature":{}}],"orderDiscountMappingKey":[null],"charge":{},"chargeType":"OneOff","priceModel":"Flat","unitCode":"pcs","startOn":"AlignToSubscription","endOn":"AlignToSubscription","pricePeriod":"Monthly","usageRating":"Sum","revenueRecognitionRule":{},"billingDay":"None","billingPeriod":"Monthly","billingTiming":"InAdvance","periodAlignment":"None","taxTemplate":"Sweden standard","deferredRevenueAccount":"1510","recognizedRevenueAccount":"1510","changeState":"NotChanged"}],"product":"P-000001","chargePlan":"CP-000001"}],"milestones":[{"name":"text"}],"orderDiscounts":[{"orderProductCharges":[{"charge":"OPC-000001","operation":"Remove"}],"operation":"Change","OrderDiscountId":"GUID","startOn":"AlignToOrder","endOn":"AlignToOrder"}],"status":"Draft","orderType":"Subscription","subscriptionType":"Termed","orderPaymentMethod":"Invoice","paymentTerm":"NET30","account":"A-000001","invoiceAccount":"A-000001","currency":"SEK","invoiceBatchGroup":{},"orderBillingPeriod":"Monthly"}'

201

400

401

403

201

No body

Subscription created.

Get Subscription versions

get

/Subscriptions/{orderNumber}/versions

Authorizations

Path parameters

orderNumberstringrequired

Query parameters

Filterstring

Filter the results. See ODATA documentation for more information

Example: name eq 'Adam' and age gt 20

OrderBystring

Sorting the results. See ODATA specification for more information

Example: accountNumber Desc

ModifiedAfterstring · date-time

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

Example: 11/01/2024 00:00:00

ModifiedBeforestring · date-time

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

Example: 11/01/2024 00:00:00

PageSizeinteger · int32

Page Size

Example: 20

PageNumberinteger · int32

Page Number

Example: 1

Header parameters

api-versionstring

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.younium.com/Subscriptions/{orderNumber}/versions'

200

400

401

403

200

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "orderNumber": "text",
    "version": 1,
    "isLastVersion": true,
    "description": "text",
    "remarks": "text",
    "effectiveStartDate": "2025-02-22T08:42:52.442Z",
    "effectiveEndDate": "2025-02-22T08:42:52.442Z",
    "cancellationDate": "2025-02-22T08:42:52.442Z",
    "effectiveChangeDate": "2025-02-22T08:42:52.442Z",
    "orderDate": "2025-02-22T08:42:52.442Z",
    "noticePeriodDate": "2025-02-22T08:42:52.442Z",
    "lastRenewalDate": "2025-02-22T08:42:52.442Z",
    "created": "2025-02-22T08:42:52.442Z",
    "modified": "2025-02-22T08:42:52.442Z",
    "lastUpdated": "2024-07-01",
    "noticePeriod": 1,
    "term": 1,
    "renewalTerm": 1,
    "isAutoRenewed": true,
    "invoiceSeparatly": true,
    "yourReference": "text",
    "ourReference": "text",
    "yourOrderNumber": "text",
    "buyerReference": "text",
    "setOrderBillingPeriod": true,
    "paymentTerm": "text",
    "useAccountInvoiceBatchGroup": true,
    "currency": "text",
    "externalERPId": "text",
    "externalCRMId": "text",
    "currencyCodeToUseWhenInvoice": "text",
    "customFields": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "products": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "productNumber": "text",
        "chargePlanId": "123e4567-e89b-12d3-a456-426614174000",
        "chargePlanName": "text",
        "chargePlanNumber": "text",
        "productLineNumber": 1,
        "name": "text",
        "externalERPId": "text",
        "externalCRMId": "text",
        "created": "2025-02-22T08:42:52.442Z",
        "modified": "2025-02-22T08:42:52.442Z",
        "customFields": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "charges": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "chargeNumber": "OPC-000001",
            "version": 1,
            "isLastVersion": true,
            "name": "text",
            "effectiveStartDate": "2025-02-22T08:42:52.442Z",
            "effectiveEndDate": "2025-02-22T08:42:52.442Z",
            "quantity": 1,
            "unitCode": "text",
            "chargedThroughDate": "2025-02-22T08:42:52.442Z",
            "lastRenewalDate": "2025-02-22T08:42:52.442Z",
            "lastPriceAdjustmentDate": "2025-02-22T08:42:52.442Z",
            "revenueRecognitionRule": "text",
            "specificBillingDay": 1,
            "alignmentDate": "2025-02-22T08:42:52.442Z",
            "taxTemplate": "text",
            "taxIncluded": true,
            "createInvoiceLinesPerTier": true,
            "estimatedUsage": 1,
            "estimatedQuantity": 1,
            "remainingQuantity": 1,
            "orderedQuantity": 1,
            "remarks": "text",
            "accountsReceivableAccount": "text",
            "deferredRevenueAccount": "text",
            "recognizedRevenueAccount": "text",
            "displayPrice": 1,
            "recurringMonthlyAmount": 1,
            "recurringMonthlyAmountBase": 1,
            "externalERPId": "text",
            "externalCRMId": "text",
            "orderProductId": "123e4567-e89b-12d3-a456-426614174000",
            "orderId": "123e4567-e89b-12d3-a456-426614174000",
            "chargeId": "123e4567-e89b-12d3-a456-426614174000",
            "created": "2025-02-22T08:42:52.442Z",
            "modified": "2025-02-22T08:42:52.442Z",
            "customFields": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            },
            "priceDetails": [
              {
                "tier": 1,
                "price": 1,
                "listPrice": 1,
                "description": "text",
                "fromQuantity": 1,
                "toQuantity": 1,
                "lineDiscountPercent": 1,
                "lineDiscountAmount": 1,
                "priceBase": "Flat"
              }
            ],
            "features": [
              {
                "code": "text",
                "description": "text"
              }
            ],
            "orderDiscounts": [
              {
                "orderDiscountId": "123e4567-e89b-12d3-a456-426614174000",
                "chargeId": "123e4567-e89b-12d3-a456-426614174000"
              }
            ],
            "chargeType": "OneOff",
            "priceModel": "Flat",
            "startOn": "AlignToSubscription",
            "endOn": "AlignToSubscription",
            "pricePeriod": "Monthly",
            "usageRating": "Sum",
            "billingDay": "None",
            "billingPeriod": "Monthly",
            "billingTiming": "InAdvance",
            "periodAlignment": "None",
            "changeState": "NotChanged",
            "cmrr": {
              "amount": 1,
              "currencyCode": "text",
              "currencyConversionDate": "2025-02-22T08:42:52.442Z",
              "baseCurrencyAmount": 1,
              "baseCurrencyCode": "text"
            },
            "acv": {
              "amount": 1,
              "currencyCode": "text",
              "currencyConversionDate": "2025-02-22T08:42:52.442Z",
              "baseCurrencyAmount": 1,
              "baseCurrencyCode": "text"
            },
            "tcv": {
              "amount": 1,
              "currencyCode": "text",
              "currencyConversionDate": "2025-02-22T08:42:52.442Z",
              "baseCurrencyAmount": 1,
              "baseCurrencyCode": "text"
            },
            "emrr": {
              "amount": 1,
              "currencyCode": "text",
              "currencyConversionDate": "2025-02-22T08:42:52.442Z",
              "baseCurrencyAmount": 1,
              "baseCurrencyCode": "text"
            },
            "oneTimeFees": {
              "amount": 1,
              "currencyCode": "text",
              "currencyConversionDate": "2025-02-22T08:42:52.442Z",
              "baseCurrencyAmount": 1,
              "baseCurrencyCode": "text"
            }
          }
        ],
        "cmrr": {
          "amount": 1,
          "currencyCode": "text",
          "currencyConversionDate": "2025-02-22T08:42:52.442Z",
          "baseCurrencyAmount": 1,
          "baseCurrencyCode": "text"
        },
        "acv": {
          "amount": 1,
          "currencyCode": "text",
          "currencyConversionDate": "2025-02-22T08:42:52.442Z",
          "baseCurrencyAmount": 1,
          "baseCurrencyCode": "text"
        },
        "emrr": {
          "amount": 1,
          "currencyCode": "text",
          "currencyConversionDate": "2025-02-22T08:42:52.442Z",
          "baseCurrencyAmount": 1,
          "baseCurrencyCode": "text"
        },
        "oneTimeFees": {
          "amount": 1,
          "currencyCode": "text",
          "currencyConversionDate": "2025-02-22T08:42:52.442Z",
          "baseCurrencyAmount": 1,
          "baseCurrencyCode": "text"
        },
        "tcv": {
          "amount": 1,
          "currencyCode": "text",
          "currencyConversionDate": "2025-02-22T08:42:52.442Z",
          "baseCurrencyAmount": 1,
          "baseCurrencyCode": "text"
        }
      }
    ],
    "milestones": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "orderId": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "description": "text",
        "milestoneDate": "2025-02-22T08:42:52.442Z",
        "plannedDate": "2025-02-22T08:42:52.442Z"
      }
    ],
    "orderDiscounts": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "orderId": "123e4567-e89b-12d3-a456-426614174000",
        "startDate": "2025-02-22T08:42:52.442Z",
        "endDate": "2025-02-22T08:42:52.442Z",
        "percent": 1,
        "onSpecificCharges": true,
        "orderProductCharges": [
          {
            "orderDiscountId": "123e4567-e89b-12d3-a456-426614174000",
            "chargeId": "123e4567-e89b-12d3-a456-426614174000"
          }
        ],
        "startOn": "AlignToOrder",
        "endOn": "AlignToOrder",
        "discountType": "Percent"
      }
    ],
    "status": "Draft",
    "orderType": "Subscription",
    "termType": "Termed",
    "orderPaymentMethod": "Invoice",
    "invoiceAddress": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "description": "text",
      "name": "text",
      "street": "text",
      "street2": "text",
      "city": "text",
      "county": "text",
      "state": "text",
      "zip": "text",
      "country": "text"
    },
    "deliveryAddress": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "description": "text",
      "name": "text",
      "street": "text",
      "street2": "text",
      "city": "text",
      "county": "text",
      "state": "text",
      "zip": "text",
      "country": "text"
    },
    "orderBillingPeriod": "Monthly",
    "invoiceBatchGroup": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "code": "text",
      "description": "text"
    },
    "account": {
      "name": "text",
      "accountNumber": "text",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "externalERPId": "text",
      "externalCRMId": "text"
    },
    "invoiceAccount": {
      "name": "text",
      "accountNumber": "text",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "externalERPId": "text",
      "externalCRMId": "text"
    },
    "cmrr": {
      "amount": 1,
      "currencyCode": "text",
      "currencyConversionDate": "2025-02-22T08:42:52.442Z",
      "baseCurrencyAmount": 1,
      "baseCurrencyCode": "text"
    },
    "acv": {
      "amount": 1,
      "currencyCode": "text",
      "currencyConversionDate": "2025-02-22T08:42:52.442Z",
      "baseCurrencyAmount": 1,
      "baseCurrencyCode": "text"
    },
    "emrr": {
      "amount": 1,
      "currencyCode": "text",
      "currencyConversionDate": "2025-02-22T08:42:52.442Z",
      "baseCurrencyAmount": 1,
      "baseCurrencyCode": "text"
    },
    "oneTimeFees": {
      "amount": 1,
      "currencyCode": "text",
      "currencyConversionDate": "2025-02-22T08:42:52.442Z",
      "baseCurrencyAmount": 1,
      "baseCurrencyCode": "text"
    },
    "tcv": {
      "amount": 1,
      "currencyCode": "text",
      "currencyConversionDate": "2025-02-22T08:42:52.442Z",
      "baseCurrencyAmount": 1,
      "baseCurrencyCode": "text"
    }
  }
]

Success

Get Subscription Version by Id

get

/Subscriptions/{id}/version

Authorizations

Path parameters

idstring · uuidrequired

Header parameters

api-versionstring

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.younium.com/Subscriptions/{id}/version'

200

400

401

403

404

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "orderNumber": "text",
  "version": 1,
  "isLastVersion": true,
  "description": "text",
  "remarks": "text",
  "effectiveStartDate": "2025-02-22T08:42:52.442Z",
  "effectiveEndDate": "2025-02-22T08:42:52.442Z",
  "cancellationDate": "2025-02-22T08:42:52.442Z",
  "effectiveChangeDate": "2025-02-22T08:42:52.442Z",
  "orderDate": "2025-02-22T08:42:52.442Z",
  "noticePeriodDate": "2025-02-22T08:42:52.442Z",
  "lastRenewalDate": "2025-02-22T08:42:52.442Z",
  "created": "2025-02-22T08:42:52.442Z",
  "modified": "2025-02-22T08:42:52.442Z",
  "lastUpdated": "2024-07-01",
  "noticePeriod": 1,
  "term": 1,
  "renewalTerm": 1,
  "isAutoRenewed": true,
  "invoiceSeparatly": true,
  "yourReference": "text",
  "ourReference": "text",
  "yourOrderNumber": "text",
  "buyerReference": "text",
  "setOrderBillingPeriod": true,
  "paymentTerm": "text",
  "useAccountInvoiceBatchGroup": true,
  "currency": "text",
  "externalERPId": "text",
  "externalCRMId": "text",
  "currencyCodeToUseWhenInvoice": "text",
  "customFields": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "products": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "productNumber": "text",
      "chargePlanId": "123e4567-e89b-12d3-a456-426614174000",
      "chargePlanName": "text",
      "chargePlanNumber": "text",
      "productLineNumber": 1,
      "name": "text",
      "externalERPId": "text",
      "externalCRMId": "text",
      "created": "2025-02-22T08:42:52.442Z",
      "modified": "2025-02-22T08:42:52.442Z",
      "customFields": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "charges": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "chargeNumber": "OPC-000001",
          "version": 1,
          "isLastVersion": true,
          "name": "text",
          "effectiveStartDate": "2025-02-22T08:42:52.442Z",
          "effectiveEndDate": "2025-02-22T08:42:52.442Z",
          "quantity": 1,
          "unitCode": "text",
          "chargedThroughDate": "2025-02-22T08:42:52.442Z",
          "lastRenewalDate": "2025-02-22T08:42:52.442Z",
          "lastPriceAdjustmentDate": "2025-02-22T08:42:52.442Z",
          "revenueRecognitionRule": "text",
          "specificBillingDay": 1,
          "alignmentDate": "2025-02-22T08:42:52.442Z",
          "taxTemplate": "text",
          "taxIncluded": true,
          "createInvoiceLinesPerTier": true,
          "estimatedUsage": 1,
          "estimatedQuantity": 1,
          "remainingQuantity": 1,
          "orderedQuantity": 1,
          "remarks": "text",
          "accountsReceivableAccount": "text",
          "deferredRevenueAccount": "text",
          "recognizedRevenueAccount": "text",
          "displayPrice": 1,
          "recurringMonthlyAmount": 1,
          "recurringMonthlyAmountBase": 1,
          "externalERPId": "text",
          "externalCRMId": "text",
          "orderProductId": "123e4567-e89b-12d3-a456-426614174000",
          "orderId": "123e4567-e89b-12d3-a456-426614174000",
          "chargeId": "123e4567-e89b-12d3-a456-426614174000",
          "created": "2025-02-22T08:42:52.442Z",
          "modified": "2025-02-22T08:42:52.442Z",
          "customFields": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "priceDetails": [
            {
              "tier": 1,
              "price": 1,
              "listPrice": 1,
              "description": "text",
              "fromQuantity": 1,
              "toQuantity": 1,
              "lineDiscountPercent": 1,
              "lineDiscountAmount": 1,
              "priceBase": "Flat"
            }
          ],
          "features": [
            {
              "code": "text",
              "description": "text"
            }
          ],
          "orderDiscounts": [
            {
              "orderDiscountId": "123e4567-e89b-12d3-a456-426614174000",
              "chargeId": "123e4567-e89b-12d3-a456-426614174000"
            }
          ],
          "chargeType": "OneOff",
          "priceModel": "Flat",
          "startOn": "AlignToSubscription",
          "endOn": "AlignToSubscription",
          "pricePeriod": "Monthly",
          "usageRating": "Sum",
          "billingDay": "None",
          "billingPeriod": "Monthly",
          "billingTiming": "InAdvance",
          "periodAlignment": "None",
          "changeState": "NotChanged",
          "cmrr": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2025-02-22T08:42:52.442Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "acv": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2025-02-22T08:42:52.442Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "tcv": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2025-02-22T08:42:52.442Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "emrr": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2025-02-22T08:42:52.442Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "oneTimeFees": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2025-02-22T08:42:52.442Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          }
        }
      ],
      "cmrr": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-02-22T08:42:52.442Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "acv": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-02-22T08:42:52.442Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "emrr": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-02-22T08:42:52.442Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "oneTimeFees": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-02-22T08:42:52.442Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "tcv": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-02-22T08:42:52.442Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      }
    }
  ],
  "milestones": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "orderId": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "milestoneDate": "2025-02-22T08:42:52.442Z",
      "plannedDate": "2025-02-22T08:42:52.442Z"
    }
  ],
  "orderDiscounts": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "orderId": "123e4567-e89b-12d3-a456-426614174000",
      "startDate": "2025-02-22T08:42:52.442Z",
      "endDate": "2025-02-22T08:42:52.442Z",
      "percent": 1,
      "onSpecificCharges": true,
      "orderProductCharges": [
        {
          "orderDiscountId": "123e4567-e89b-12d3-a456-426614174000",
          "chargeId": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "startOn": "AlignToOrder",
      "endOn": "AlignToOrder",
      "discountType": "Percent"
    }
  ],
  "status": "Draft",
  "orderType": "Subscription",
  "termType": "Termed",
  "orderPaymentMethod": "Invoice",
  "invoiceAddress": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "name": "text",
    "street": "text",
    "street2": "text",
    "city": "text",
    "county": "text",
    "state": "text",
    "zip": "text",
    "country": "text"
  },
  "deliveryAddress": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "name": "text",
    "street": "text",
    "street2": "text",
    "city": "text",
    "county": "text",
    "state": "text",
    "zip": "text",
    "country": "text"
  },
  "orderBillingPeriod": "Monthly",
  "invoiceBatchGroup": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "code": "text",
    "description": "text"
  },
  "account": {
    "name": "text",
    "accountNumber": "text",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "externalERPId": "text",
    "externalCRMId": "text"
  },
  "invoiceAccount": {
    "name": "text",
    "accountNumber": "text",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "externalERPId": "text",
    "externalCRMId": "text"
  },
  "cmrr": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2025-02-22T08:42:52.442Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  },
  "acv": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2025-02-22T08:42:52.442Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  },
  "emrr": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2025-02-22T08:42:52.442Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  },
  "oneTimeFees": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2025-02-22T08:42:52.442Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  },
  "tcv": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2025-02-22T08:42:52.442Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  }
}

Success

Get Subscription Version by OrderNumber

get

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

Authorizations

Path parameters

orderNumberstringrequired

versioninteger · int32required

Header parameters

api-versionstring

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.younium.com/Subscriptions/{orderNumber}/versions/{version}'

200

400

401

403

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "orderNumber": "text",
  "version": 1,
  "isLastVersion": true,
  "description": "text",
  "remarks": "text",
  "effectiveStartDate": "2025-02-22T08:42:52.442Z",
  "effectiveEndDate": "2025-02-22T08:42:52.442Z",
  "cancellationDate": "2025-02-22T08:42:52.442Z",
  "effectiveChangeDate": "2025-02-22T08:42:52.442Z",
  "orderDate": "2025-02-22T08:42:52.442Z",
  "noticePeriodDate": "2025-02-22T08:42:52.442Z",
  "lastRenewalDate": "2025-02-22T08:42:52.442Z",
  "created": "2025-02-22T08:42:52.442Z",
  "modified": "2025-02-22T08:42:52.442Z",
  "lastUpdated": "2024-07-01",
  "noticePeriod": 1,
  "term": 1,
  "renewalTerm": 1,
  "isAutoRenewed": true,
  "invoiceSeparatly": true,
  "yourReference": "text",
  "ourReference": "text",
  "yourOrderNumber": "text",
  "buyerReference": "text",
  "setOrderBillingPeriod": true,
  "paymentTerm": "text",
  "useAccountInvoiceBatchGroup": true,
  "currency": "text",
  "externalERPId": "text",
  "externalCRMId": "text",
  "currencyCodeToUseWhenInvoice": "text",
  "customFields": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "products": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "productNumber": "text",
      "chargePlanId": "123e4567-e89b-12d3-a456-426614174000",
      "chargePlanName": "text",
      "chargePlanNumber": "text",
      "productLineNumber": 1,
      "name": "text",
      "externalERPId": "text",
      "externalCRMId": "text",
      "created": "2025-02-22T08:42:52.442Z",
      "modified": "2025-02-22T08:42:52.442Z",
      "customFields": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "charges": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "chargeNumber": "OPC-000001",
          "version": 1,
          "isLastVersion": true,
          "name": "text",
          "effectiveStartDate": "2025-02-22T08:42:52.442Z",
          "effectiveEndDate": "2025-02-22T08:42:52.442Z",
          "quantity": 1,
          "unitCode": "text",
          "chargedThroughDate": "2025-02-22T08:42:52.442Z",
          "lastRenewalDate": "2025-02-22T08:42:52.442Z",
          "lastPriceAdjustmentDate": "2025-02-22T08:42:52.442Z",
          "revenueRecognitionRule": "text",
          "specificBillingDay": 1,
          "alignmentDate": "2025-02-22T08:42:52.442Z",
          "taxTemplate": "text",
          "taxIncluded": true,
          "createInvoiceLinesPerTier": true,
          "estimatedUsage": 1,
          "estimatedQuantity": 1,
          "remainingQuantity": 1,
          "orderedQuantity": 1,
          "remarks": "text",
          "accountsReceivableAccount": "text",
          "deferredRevenueAccount": "text",
          "recognizedRevenueAccount": "text",
          "displayPrice": 1,
          "recurringMonthlyAmount": 1,
          "recurringMonthlyAmountBase": 1,
          "externalERPId": "text",
          "externalCRMId": "text",
          "orderProductId": "123e4567-e89b-12d3-a456-426614174000",
          "orderId": "123e4567-e89b-12d3-a456-426614174000",
          "chargeId": "123e4567-e89b-12d3-a456-426614174000",
          "created": "2025-02-22T08:42:52.442Z",
          "modified": "2025-02-22T08:42:52.442Z",
          "customFields": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "priceDetails": [
            {
              "tier": 1,
              "price": 1,
              "listPrice": 1,
              "description": "text",
              "fromQuantity": 1,
              "toQuantity": 1,
              "lineDiscountPercent": 1,
              "lineDiscountAmount": 1,
              "priceBase": "Flat"
            }
          ],
          "features": [
            {
              "code": "text",
              "description": "text"
            }
          ],
          "orderDiscounts": [
            {
              "orderDiscountId": "123e4567-e89b-12d3-a456-426614174000",
              "chargeId": "123e4567-e89b-12d3-a456-426614174000"
            }
          ],
          "chargeType": "OneOff",
          "priceModel": "Flat",
          "startOn": "AlignToSubscription",
          "endOn": "AlignToSubscription",
          "pricePeriod": "Monthly",
          "usageRating": "Sum",
          "billingDay": "None",
          "billingPeriod": "Monthly",
          "billingTiming": "InAdvance",
          "periodAlignment": "None",
          "changeState": "NotChanged",
          "cmrr": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2025-02-22T08:42:52.442Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "acv": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2025-02-22T08:42:52.442Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "tcv": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2025-02-22T08:42:52.442Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "emrr": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2025-02-22T08:42:52.442Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "oneTimeFees": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2025-02-22T08:42:52.442Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          }
        }
      ],
      "cmrr": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-02-22T08:42:52.442Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "acv": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-02-22T08:42:52.442Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "emrr": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-02-22T08:42:52.442Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "oneTimeFees": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-02-22T08:42:52.442Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "tcv": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-02-22T08:42:52.442Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      }
    }
  ],
  "milestones": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "orderId": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "milestoneDate": "2025-02-22T08:42:52.442Z",
      "plannedDate": "2025-02-22T08:42:52.442Z"
    }
  ],
  "orderDiscounts": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "orderId": "123e4567-e89b-12d3-a456-426614174000",
      "startDate": "2025-02-22T08:42:52.442Z",
      "endDate": "2025-02-22T08:42:52.442Z",
      "percent": 1,
      "onSpecificCharges": true,
      "orderProductCharges": [
        {
          "orderDiscountId": "123e4567-e89b-12d3-a456-426614174000",
          "chargeId": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "startOn": "AlignToOrder",
      "endOn": "AlignToOrder",
      "discountType": "Percent"
    }
  ],
  "status": "Draft",
  "orderType": "Subscription",
  "termType": "Termed",
  "orderPaymentMethod": "Invoice",
  "invoiceAddress": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "name": "text",
    "street": "text",
    "street2": "text",
    "city": "text",
    "county": "text",
    "state": "text",
    "zip": "text",
    "country": "text"
  },
  "deliveryAddress": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "name": "text",
    "street": "text",
    "street2": "text",
    "city": "text",
    "county": "text",
    "state": "text",
    "zip": "text",
    "country": "text"
  },
  "orderBillingPeriod": "Monthly",
  "invoiceBatchGroup": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "code": "text",
    "description": "text"
  },
  "account": {
    "name": "text",
    "accountNumber": "text",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "externalERPId": "text",
    "externalCRMId": "text"
  },
  "invoiceAccount": {
    "name": "text",
    "accountNumber": "text",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "externalERPId": "text",
    "externalCRMId": "text"
  },
  "cmrr": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2025-02-22T08:42:52.442Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  },
  "acv": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2025-02-22T08:42:52.442Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  },
  "emrr": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2025-02-22T08:42:52.442Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  },
  "oneTimeFees": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2025-02-22T08:42:52.442Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  },
  "tcv": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2025-02-22T08:42:52.442Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  }
}

Success

Change Subscription

post

/Subscriptions/{id}/change

Authorizations

Path parameters

idstring · uuidrequired

Header parameters

api-versionstring

Body

descriptionstring | nullable

remarksstring | nullable

effectiveStartDatestring · date-time | nullable

effectiveChangeDatestring · date-time | nullable

effectiveEndDatestring · date-time | nullable

orderDatestring · date-time | nullable

noticePeriodDatestring · date-time | nullable

lastRenewalDatestring · date-time | nullable

terminteger · int32 | nullable

renewalTerminteger · int32 | nullable

noticePeriodinteger · int32 | nullable

isAutoRenewedboolean | nullable

invoiceSeparatlyboolean | nullable

invoiceAddressIdstring · uuid | nullableDeprecated

deliveryAddressIdstring · uuid | nullableDeprecated

yourReferencestring | nullable

ourReferencestring | nullable

yourOrderNumberstring | nullable

buyerReferencestring | nullable

externalERPIdstring | nullable

externalCRMIdstring | nullable

useAccountInvoiceBatchGroupboolean | nullable

invoiceBatchGroupIdstring · uuid | nullableDeprecated

invoicingCurrencystring | nullable

invoiceTemplateIdstring · uuid | nullable

setOrderBillingPeriodboolean | nullable

customFieldsobject | nullable

productsobject[] | nullable

milestonesobject[] | nullable

orderDiscountsobject[] | nullable

accountall of | nullable

Allowed as string input: AccountNumber, Account-Id, Name.

Example: A-000001

invoiceAccountall of | nullable

Allowed as string input: AccountNumber, Account-Id, Name.

Example: A-000001

subscriptionTypeall of | nullable

currencyall of | nullable

Allowed as string input: Code, Currency-Id.

Example: SEK

paymentTermall of | nullable

Allowed as string input: Name, PaymentTerm-Id.

Example: NET30

orderPaymentMethodall of

invoiceBatchGroupall of | nullable

orderBillingPeriodall of | nullable

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.younium.com/Subscriptions/{id}/change' \
  --header 'Content-Type: application/json' \
  --data '{"customFields":{"ANY_ADDITIONAL_PROPERTY":"anything"},"products":[{"customFields":{"ANY_ADDITIONAL_PROPERTY":"anything"},"charges":[{"customFields":{"ANY_ADDITIONAL_PROPERTY":"anything"},"priceDetails":[{"operation":"Change","priceBase":"Flat"}],"features":[{"operation":"Remove","feature":{}}],"orderDiscountMappingKey":[null],"charge":"OPC-000001","chargeType":"OneOff","priceModel":"Flat","pricePeriod":"Monthly","unitCode":"pcs","startOn":"AlignToSubscription","endOn":"AlignToSubscription","deferredRevenueAccount":"1510","recognizedRevenueAccount":"1510","usageRating":"Sum","revenueRecognitionRule":{},"billingDay":"None","billingPeriod":"Monthly","billingTiming":"InAdvance","periodAlignment":"None","taxTemplate":"Sweden standard","startMilestone":"MilestoneName","endMilestone":"MilestoneName"}],"operation":"Change","product":"OP-000001","chargePlan":"CP-000001","cancelProductOn":"EffectiveEndDate"}],"milestones":[{"name":"text"}],"orderDiscounts":[{"orderProductCharges":[{"charge":"OPC-000001","operation":"Remove"}],"operation":"Change","OrderDiscountId":"GUID","startOn":"AlignToOrder","endOn":"AlignToOrder"}],"account":"A-000001","invoiceAccount":"A-000001","subscriptionType":"Termed","currency":"SEK","paymentTerm":"NET30","orderPaymentMethod":"Invoice","invoiceBatchGroup":{},"orderBillingPeriod":"Monthly"}'

201

400

401

403

201

No body

New version of Subscription created.

Cancel Subscription

post

/Subscriptions/cancel/{id}

Authorizations

Path parameters

idstring · uuidrequired

subscription id

Header parameters

api-versionstring

Body

firstDayOfCancellationstring · date-time | nullableDeprecated

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 | nullable

Subscription end date

Example: 2024-12-31

cancellationDatestring · date-timerequired

cancellationDatePerChargesobject | nullable

List of order product charge numbers and cancellation dates

cancellationModeall ofrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.younium.com/Subscriptions/cancel/{id}' \
  --header 'Content-Type: application/json' \
  --data '{"firstDayOfCancellation":"2024-07-01","endDate":"2024-12-31","cancellationDate":"2025-02-22T08:42:52.442Z","cancellationDatePerCharges":{},"cancellationMode":"OnOrderCancellationDate"}'

200

400

401

403

200

No body

Success

Renew Subscription

post

/Subscriptions/renew/{id}

Authorizations

Path parameters

idstring · uuidrequired

subscription id

Header parameters

api-versionstring

Body

renewalTerminteger · int32required

nextRenewalTerminteger · int32required

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.younium.com/Subscriptions/renew/{id}' \
  --header 'Content-Type: application/json' \
  --data '{"renewalTerm":1,"nextRenewalTerm":1}'

200

400

401

403

200

No body

Success

Revert Subscription

post

/Subscriptions/revert/{id}

Authorizations

Path parameters

idstring · uuidrequired

subscription id

Header parameters

api-versionstring

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.younium.com/Subscriptions/revert/{id}'

200

400

401

403

200

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

Success

Activate Subscription

post

/Subscriptions/activate/{id}

Authorizations

Path parameters

idstring · uuidrequired

Header parameters

api-versionstring

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.younium.com/Subscriptions/activate/{id}'

200

400

401

403

200

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

Success

Get Subscription Milestones

get

/Subscriptions/{id}/milestones

Authorizations

Path parameters

idstring · uuidrequired

subscription id

Header parameters

api-versionstring

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.younium.com/Subscriptions/{id}/milestones'

200

400

401

403

404

200

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "orderId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "milestoneDate": "2025-02-22T08:42:52.442Z",
    "plannedDate": "2025-02-22T08:42:52.442Z"
  }
]

Success

Set Subscription Milestone date

post

/Subscriptions/milestones/set/{id}

Authorizations

Path parameters

idstring · uuidrequired

Subscription Milestone Id

Header parameters

api-versionstring

Body

milestoneDatestring · date-timerequired

milestoneIdstring · uuid

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.younium.com/Subscriptions/milestones/set/{id}' \
  --header 'Content-Type: application/json' \
  --data '{"milestoneDate":"2025-02-22T08:42:52.442Z"}'

200

400

401

403

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "orderId": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "milestoneDate": "2025-02-22T08:42:52.442Z",
  "plannedDate": "2025-02-22T08:42:52.442Z"
}

Success

Edit and create OrderDiscounts

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

post

/Subscriptions/{id}/OrderDiscounts

Authorizations

Path parameters

idstring · uuidrequired

Header parameters

api-versionstring

Body

effectiveChangeDatestring · date-time | nullable

orderDiscountsobject[] | nullable

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.younium.com/Subscriptions/{id}/OrderDiscounts' \
  --header 'Content-Type: application/json' \
  --data '{"orderDiscounts":[{"orderProductCharges":[{"charge":"OPC-000001","operation":"Remove"}],"operation":"Change","OrderDiscountId":"GUID","startOn":"AlignToOrder","endOn":"AlignToOrder"}]}'

200

400

401

403

200

No body

Success

---