Younium Developer Portal
  • Welcome
  • Get started
  • API:s
    • API 2.0
      • Accounts
      • Bookings
      • Chartofaccounts
      • Countries
      • Currency
      • Documenttemplate
      • Exchangerate
      • Invoices
      • Journals
      • Measurements
      • Orders
      • Paymentterms
      • Products
      • Quotes
      • Salesorders
      • Simpleproducts
      • Subscriptions
      • Taxtemplates
      • Unitofmeasurements
      • Usage
      • Webhooks
    • API 2.1
      • Accounts
      • Bookings
      • Chartofaccounts
      • Countries
      • Currency
      • Customfieldconfigurations
      • Documenttemplate
      • Exchangerate
      • Invoicebatches
      • Invoicebatchgroups
      • Invoices
      • Journals
      • Measurements
      • Orders
      • Payments
      • Paymentterms
      • Products
      • Quotes
      • Reports
      • Revenueschedule
      • Salesorders
      • Simpleproducts
      • Subscriptions
      • Taxtemplates
      • Unitofmeasurements
      • Usage
      • Webhooks
  • Documentation
    • Developer resources
    • Invoice operations
    • Product guide
    • Webhooks
    • Idempotent requests
  • Sandbox
Powered by GitBook
On this page

Was this helpful?

  1. API:s
  2. API 2.1

Subscriptions

PreviousSimpleproductsNextTaxtemplates

Last updated 5 months ago

Was this helpful?

Get Subscription by Id

get

Requires permission Order View

Authorizations
Path parameters
idstring · uuidrequired

The subscription identifier

Header parameters
api-versionstringoptional
Responses
application/json
application/json
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --url 'https://api.younium.com/Subscriptions/{id}'
200
400
401
403
404
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "orderNumber": "text",
  "version": 1,
  "isLastVersion": true,
  "status": "Draft",
  "description": "text",
  "remarks": "text",
  "effectiveStartDate": "2025-03-24T23:57:44.041Z",
  "effectiveEndDate": "2025-03-24T23:57:44.041Z",
  "cancellationDate": "2025-03-24T23:57:44.041Z",
  "effectiveChangeDate": "2025-03-24T23:57:44.041Z",
  "orderDate": "2025-03-24T23:57:44.041Z",
  "noticePeriodDate": "2025-03-24T23:57:44.041Z",
  "lastRenewalDate": "2025-03-24T23:57:44.041Z",
  "created": "2025-03-24T23:57:44.041Z",
  "modified": "2025-03-24T23:57:44.041Z",
  "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-03-24T23:57:44.041Z",
          "effectiveEndDate": "2025-03-24T23:57:44.041Z",
          "quantity": 1,
          "unitCode": "text",
          "startOn": "AlignToSubscription",
          "endOn": "AlignToSubscription",
          "chargedThroughDate": "2025-03-24T23:57:44.041Z",
          "lastRenewalDate": "2025-03-24T23:57:44.041Z",
          "lastPriceAdjustmentDate": "2025-03-24T23:57:44.041Z",
          "pricePeriod": "Monthly",
          "usageRating": "Sum",
          "revenueRecognitionRule": "text",
          "billingDay": "None",
          "specificBillingDay": 1,
          "billingPeriod": "Monthly",
          "billingTiming": "InAdvance",
          "periodAlignment": "None",
          "alignmentDate": "2025-03-24T23:57:44.041Z",
          "taxTemplate": "text",
          "taxIncluded": true,
          "createInvoiceLinesPerTier": true,
          "estimatedUsage": 1,
          "estimatedQuantity": 1,
          "remainingQuantity": 1,
          "orderedQuantity": 1,
          "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-03-24T23:57:44.041Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "acv": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2025-03-24T23:57:44.041Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "tcv": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2025-03-24T23:57:44.041Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "emrr": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2025-03-24T23:57:44.041Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "oneTimeFees": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2025-03-24T23:57:44.041Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "orderProductId": "123e4567-e89b-12d3-a456-426614174000",
          "orderId": "123e4567-e89b-12d3-a456-426614174000",
          "chargeId": "123e4567-e89b-12d3-a456-426614174000",
          "created": "2025-03-24T23:57:44.041Z",
          "modified": "2025-03-24T23:57:44.041Z"
        }
      ],
      "customFields": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "externalERPId": "text",
      "externalCRMId": "text",
      "cmrr": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-03-24T23:57:44.041Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "acv": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-03-24T23:57:44.041Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "emrr": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-03-24T23:57:44.041Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "oneTimeFees": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-03-24T23:57:44.041Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "tcv": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-03-24T23:57:44.041Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "created": "2025-03-24T23:57:44.041Z",
      "modified": "2025-03-24T23:57:44.041Z"
    }
  ],
  "milestones": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "orderId": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "milestoneDate": "2025-03-24T23:57:44.041Z",
      "plannedDate": "2025-03-24T23:57:44.041Z"
    }
  ],
  "orderDiscounts": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "orderId": "123e4567-e89b-12d3-a456-426614174000",
      "startOn": "AlignToOrder",
      "endOn": "AlignToOrder",
      "startDate": "2025-03-24T23:57:44.041Z",
      "endDate": "2025-03-24T23:57:44.041Z",
      "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-03-24T23:57:44.041Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  },
  "acv": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2025-03-24T23:57:44.041Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  },
  "emrr": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2025-03-24T23:57:44.041Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  },
  "oneTimeFees": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2025-03-24T23:57:44.041Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  },
  "tcv": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2025-03-24T23:57:44.041Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  }
}

Success

Delete Subscription

delete
Authorizations
Path parameters
idstring · uuidrequired

subscription id

Header parameters
api-versionstringoptional
Responses
application/json
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --request DELETE \
  --url 'https://api.younium.com/Subscriptions/{id}'
200
400
401
403
404
No body

Success

Get Subscriptions

get
Authorizations
Query parameters
Filterstringoptional

Filter the results. See ODATA documentation for more information

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

Sorting the results. See ODATA specification for more information

Example: accountNumber Desc
ModifiedAfterstring · date-timeoptional

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

Example: 03/01/2025 00:00:00
ModifiedBeforestring · date-timeoptional

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

Example: 03/01/2025 00:00:00
PageSizeinteger · int32optional

Page Size

Example: 20
PageNumberinteger · int32optional

Page Number

Example: 1
Header parameters
api-versionstringoptional
Responses
application/json
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --url 'https://api.younium.com/Subscriptions'
200
400
401
403
{
  "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-03-24T23:57:44.041Z",
      "effectiveEndDate": "2025-03-24T23:57:44.041Z",
      "cancellationDate": "2025-03-24T23:57:44.041Z",
      "effectiveChangeDate": "2025-03-24T23:57:44.041Z",
      "orderDate": "2025-03-24T23:57:44.041Z",
      "noticePeriodDate": "2025-03-24T23:57:44.041Z",
      "lastRenewalDate": "2025-03-24T23:57:44.041Z",
      "created": "2025-03-24T23:57:44.041Z",
      "modified": "2025-03-24T23:57:44.041Z",
      "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-03-24T23:57:44.041Z",
              "effectiveEndDate": "2025-03-24T23:57:44.041Z",
              "quantity": 1,
              "unitCode": "text",
              "startOn": "AlignToSubscription",
              "endOn": "AlignToSubscription",
              "chargedThroughDate": "2025-03-24T23:57:44.041Z",
              "lastRenewalDate": "2025-03-24T23:57:44.041Z",
              "lastPriceAdjustmentDate": "2025-03-24T23:57:44.041Z",
              "pricePeriod": "Monthly",
              "usageRating": "Sum",
              "revenueRecognitionRule": "text",
              "billingDay": "None",
              "specificBillingDay": 1,
              "billingPeriod": "Monthly",
              "billingTiming": "InAdvance",
              "periodAlignment": "None",
              "alignmentDate": "2025-03-24T23:57:44.041Z",
              "taxTemplate": "text",
              "taxIncluded": true,
              "createInvoiceLinesPerTier": true,
              "estimatedUsage": 1,
              "estimatedQuantity": 1,
              "remainingQuantity": 1,
              "orderedQuantity": 1,
              "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-03-24T23:57:44.041Z",
                "baseCurrencyAmount": 1,
                "baseCurrencyCode": "text"
              },
              "acv": {
                "amount": 1,
                "currencyCode": "text",
                "currencyConversionDate": "2025-03-24T23:57:44.041Z",
                "baseCurrencyAmount": 1,
                "baseCurrencyCode": "text"
              },
              "tcv": {
                "amount": 1,
                "currencyCode": "text",
                "currencyConversionDate": "2025-03-24T23:57:44.041Z",
                "baseCurrencyAmount": 1,
                "baseCurrencyCode": "text"
              },
              "emrr": {
                "amount": 1,
                "currencyCode": "text",
                "currencyConversionDate": "2025-03-24T23:57:44.041Z",
                "baseCurrencyAmount": 1,
                "baseCurrencyCode": "text"
              },
              "oneTimeFees": {
                "amount": 1,
                "currencyCode": "text",
                "currencyConversionDate": "2025-03-24T23:57:44.041Z",
                "baseCurrencyAmount": 1,
                "baseCurrencyCode": "text"
              },
              "orderProductId": "123e4567-e89b-12d3-a456-426614174000",
              "orderId": "123e4567-e89b-12d3-a456-426614174000",
              "chargeId": "123e4567-e89b-12d3-a456-426614174000",
              "created": "2025-03-24T23:57:44.041Z",
              "modified": "2025-03-24T23:57:44.041Z"
            }
          ],
          "customFields": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "externalERPId": "text",
          "externalCRMId": "text",
          "cmrr": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2025-03-24T23:57:44.041Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "acv": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2025-03-24T23:57:44.041Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "emrr": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2025-03-24T23:57:44.041Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "oneTimeFees": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2025-03-24T23:57:44.041Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "tcv": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2025-03-24T23:57:44.041Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "created": "2025-03-24T23:57:44.041Z",
          "modified": "2025-03-24T23:57:44.041Z"
        }
      ],
      "milestones": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "orderId": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "description": "text",
          "milestoneDate": "2025-03-24T23:57:44.041Z",
          "plannedDate": "2025-03-24T23:57:44.041Z"
        }
      ],
      "orderDiscounts": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "orderId": "123e4567-e89b-12d3-a456-426614174000",
          "startOn": "AlignToOrder",
          "endOn": "AlignToOrder",
          "startDate": "2025-03-24T23:57:44.041Z",
          "endDate": "2025-03-24T23:57:44.041Z",
          "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-03-24T23:57:44.041Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "acv": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-03-24T23:57:44.041Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "emrr": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-03-24T23:57:44.041Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "oneTimeFees": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-03-24T23:57:44.041Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "tcv": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-03-24T23:57:44.041Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      }
    }
  ]
}

Success

Get Subscription versions

get
Authorizations
Path parameters
orderNumberstringrequired
Query parameters
Filterstringoptional

Filter the results. See ODATA documentation for more information

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

Sorting the results. See ODATA specification for more information

Example: accountNumber Desc
ModifiedAfterstring · date-timeoptional

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

Example: 03/01/2025 00:00:00
ModifiedBeforestring · date-timeoptional

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

Example: 03/01/2025 00:00:00
PageSizeinteger · int32optional

Page Size

Example: 20
PageNumberinteger · int32optional

Page Number

Example: 1
Header parameters
api-versionstringoptional
Responses
application/json
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --url 'https://api.younium.com/Subscriptions/{orderNumber}/versions'
200
400
401
403
[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "orderNumber": "text",
    "version": 1,
    "isLastVersion": true,
    "status": "Draft",
    "description": "text",
    "remarks": "text",
    "effectiveStartDate": "2025-03-24T23:57:44.041Z",
    "effectiveEndDate": "2025-03-24T23:57:44.041Z",
    "cancellationDate": "2025-03-24T23:57:44.041Z",
    "effectiveChangeDate": "2025-03-24T23:57:44.041Z",
    "orderDate": "2025-03-24T23:57:44.041Z",
    "noticePeriodDate": "2025-03-24T23:57:44.041Z",
    "lastRenewalDate": "2025-03-24T23:57:44.041Z",
    "created": "2025-03-24T23:57:44.041Z",
    "modified": "2025-03-24T23:57:44.041Z",
    "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-03-24T23:57:44.041Z",
            "effectiveEndDate": "2025-03-24T23:57:44.041Z",
            "quantity": 1,
            "unitCode": "text",
            "startOn": "AlignToSubscription",
            "endOn": "AlignToSubscription",
            "chargedThroughDate": "2025-03-24T23:57:44.041Z",
            "lastRenewalDate": "2025-03-24T23:57:44.041Z",
            "lastPriceAdjustmentDate": "2025-03-24T23:57:44.041Z",
            "pricePeriod": "Monthly",
            "usageRating": "Sum",
            "revenueRecognitionRule": "text",
            "billingDay": "None",
            "specificBillingDay": 1,
            "billingPeriod": "Monthly",
            "billingTiming": "InAdvance",
            "periodAlignment": "None",
            "alignmentDate": "2025-03-24T23:57:44.041Z",
            "taxTemplate": "text",
            "taxIncluded": true,
            "createInvoiceLinesPerTier": true,
            "estimatedUsage": 1,
            "estimatedQuantity": 1,
            "remainingQuantity": 1,
            "orderedQuantity": 1,
            "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-03-24T23:57:44.041Z",
              "baseCurrencyAmount": 1,
              "baseCurrencyCode": "text"
            },
            "acv": {
              "amount": 1,
              "currencyCode": "text",
              "currencyConversionDate": "2025-03-24T23:57:44.041Z",
              "baseCurrencyAmount": 1,
              "baseCurrencyCode": "text"
            },
            "tcv": {
              "amount": 1,
              "currencyCode": "text",
              "currencyConversionDate": "2025-03-24T23:57:44.041Z",
              "baseCurrencyAmount": 1,
              "baseCurrencyCode": "text"
            },
            "emrr": {
              "amount": 1,
              "currencyCode": "text",
              "currencyConversionDate": "2025-03-24T23:57:44.041Z",
              "baseCurrencyAmount": 1,
              "baseCurrencyCode": "text"
            },
            "oneTimeFees": {
              "amount": 1,
              "currencyCode": "text",
              "currencyConversionDate": "2025-03-24T23:57:44.041Z",
              "baseCurrencyAmount": 1,
              "baseCurrencyCode": "text"
            },
            "orderProductId": "123e4567-e89b-12d3-a456-426614174000",
            "orderId": "123e4567-e89b-12d3-a456-426614174000",
            "chargeId": "123e4567-e89b-12d3-a456-426614174000",
            "created": "2025-03-24T23:57:44.041Z",
            "modified": "2025-03-24T23:57:44.041Z"
          }
        ],
        "customFields": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "externalERPId": "text",
        "externalCRMId": "text",
        "cmrr": {
          "amount": 1,
          "currencyCode": "text",
          "currencyConversionDate": "2025-03-24T23:57:44.041Z",
          "baseCurrencyAmount": 1,
          "baseCurrencyCode": "text"
        },
        "acv": {
          "amount": 1,
          "currencyCode": "text",
          "currencyConversionDate": "2025-03-24T23:57:44.041Z",
          "baseCurrencyAmount": 1,
          "baseCurrencyCode": "text"
        },
        "emrr": {
          "amount": 1,
          "currencyCode": "text",
          "currencyConversionDate": "2025-03-24T23:57:44.041Z",
          "baseCurrencyAmount": 1,
          "baseCurrencyCode": "text"
        },
        "oneTimeFees": {
          "amount": 1,
          "currencyCode": "text",
          "currencyConversionDate": "2025-03-24T23:57:44.041Z",
          "baseCurrencyAmount": 1,
          "baseCurrencyCode": "text"
        },
        "tcv": {
          "amount": 1,
          "currencyCode": "text",
          "currencyConversionDate": "2025-03-24T23:57:44.041Z",
          "baseCurrencyAmount": 1,
          "baseCurrencyCode": "text"
        },
        "created": "2025-03-24T23:57:44.041Z",
        "modified": "2025-03-24T23:57:44.041Z"
      }
    ],
    "milestones": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "orderId": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "description": "text",
        "milestoneDate": "2025-03-24T23:57:44.041Z",
        "plannedDate": "2025-03-24T23:57:44.041Z"
      }
    ],
    "orderDiscounts": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "orderId": "123e4567-e89b-12d3-a456-426614174000",
        "startOn": "AlignToOrder",
        "endOn": "AlignToOrder",
        "startDate": "2025-03-24T23:57:44.041Z",
        "endDate": "2025-03-24T23:57:44.041Z",
        "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-03-24T23:57:44.041Z",
      "baseCurrencyAmount": 1,
      "baseCurrencyCode": "text"
    },
    "acv": {
      "amount": 1,
      "currencyCode": "text",
      "currencyConversionDate": "2025-03-24T23:57:44.041Z",
      "baseCurrencyAmount": 1,
      "baseCurrencyCode": "text"
    },
    "emrr": {
      "amount": 1,
      "currencyCode": "text",
      "currencyConversionDate": "2025-03-24T23:57:44.041Z",
      "baseCurrencyAmount": 1,
      "baseCurrencyCode": "text"
    },
    "oneTimeFees": {
      "amount": 1,
      "currencyCode": "text",
      "currencyConversionDate": "2025-03-24T23:57:44.041Z",
      "baseCurrencyAmount": 1,
      "baseCurrencyCode": "text"
    },
    "tcv": {
      "amount": 1,
      "currencyCode": "text",
      "currencyConversionDate": "2025-03-24T23:57:44.041Z",
      "baseCurrencyAmount": 1,
      "baseCurrencyCode": "text"
    }
  }
]

Success

Get Subscription Version by Id

get
Authorizations
Path parameters
idstring · uuidrequired
Header parameters
api-versionstringoptional
Responses
application/json
application/json
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --url 'https://api.younium.com/Subscriptions/{id}/version'
200
400
401
403
404
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "orderNumber": "text",
  "version": 1,
  "isLastVersion": true,
  "status": "Draft",
  "description": "text",
  "remarks": "text",
  "effectiveStartDate": "2025-03-24T23:57:44.041Z",
  "effectiveEndDate": "2025-03-24T23:57:44.041Z",
  "cancellationDate": "2025-03-24T23:57:44.041Z",
  "effectiveChangeDate": "2025-03-24T23:57:44.041Z",
  "orderDate": "2025-03-24T23:57:44.041Z",
  "noticePeriodDate": "2025-03-24T23:57:44.041Z",
  "lastRenewalDate": "2025-03-24T23:57:44.041Z",
  "created": "2025-03-24T23:57:44.041Z",
  "modified": "2025-03-24T23:57:44.041Z",
  "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-03-24T23:57:44.041Z",
          "effectiveEndDate": "2025-03-24T23:57:44.041Z",
          "quantity": 1,
          "unitCode": "text",
          "startOn": "AlignToSubscription",
          "endOn": "AlignToSubscription",
          "chargedThroughDate": "2025-03-24T23:57:44.041Z",
          "lastRenewalDate": "2025-03-24T23:57:44.041Z",
          "lastPriceAdjustmentDate": "2025-03-24T23:57:44.041Z",
          "pricePeriod": "Monthly",
          "usageRating": "Sum",
          "revenueRecognitionRule": "text",
          "billingDay": "None",
          "specificBillingDay": 1,
          "billingPeriod": "Monthly",
          "billingTiming": "InAdvance",
          "periodAlignment": "None",
          "alignmentDate": "2025-03-24T23:57:44.041Z",
          "taxTemplate": "text",
          "taxIncluded": true,
          "createInvoiceLinesPerTier": true,
          "estimatedUsage": 1,
          "estimatedQuantity": 1,
          "remainingQuantity": 1,
          "orderedQuantity": 1,
          "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-03-24T23:57:44.041Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "acv": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2025-03-24T23:57:44.041Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "tcv": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2025-03-24T23:57:44.041Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "emrr": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2025-03-24T23:57:44.041Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "oneTimeFees": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2025-03-24T23:57:44.041Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "orderProductId": "123e4567-e89b-12d3-a456-426614174000",
          "orderId": "123e4567-e89b-12d3-a456-426614174000",
          "chargeId": "123e4567-e89b-12d3-a456-426614174000",
          "created": "2025-03-24T23:57:44.041Z",
          "modified": "2025-03-24T23:57:44.041Z"
        }
      ],
      "customFields": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "externalERPId": "text",
      "externalCRMId": "text",
      "cmrr": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-03-24T23:57:44.041Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "acv": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-03-24T23:57:44.041Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "emrr": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-03-24T23:57:44.041Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "oneTimeFees": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-03-24T23:57:44.041Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "tcv": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-03-24T23:57:44.041Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "created": "2025-03-24T23:57:44.041Z",
      "modified": "2025-03-24T23:57:44.041Z"
    }
  ],
  "milestones": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "orderId": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "milestoneDate": "2025-03-24T23:57:44.041Z",
      "plannedDate": "2025-03-24T23:57:44.041Z"
    }
  ],
  "orderDiscounts": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "orderId": "123e4567-e89b-12d3-a456-426614174000",
      "startOn": "AlignToOrder",
      "endOn": "AlignToOrder",
      "startDate": "2025-03-24T23:57:44.041Z",
      "endDate": "2025-03-24T23:57:44.041Z",
      "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-03-24T23:57:44.041Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  },
  "acv": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2025-03-24T23:57:44.041Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  },
  "emrr": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2025-03-24T23:57:44.041Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  },
  "oneTimeFees": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2025-03-24T23:57:44.041Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  },
  "tcv": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2025-03-24T23:57:44.041Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  }
}

Success

Get Subscription Version by OrderNumber

get
Authorizations
Path parameters
orderNumberstringrequired
versioninteger · int32required
Header parameters
api-versionstringoptional
Responses
application/json
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --url 'https://api.younium.com/Subscriptions/{orderNumber}/versions/{version}'
200
400
401
403
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "orderNumber": "text",
  "version": 1,
  "isLastVersion": true,
  "status": "Draft",
  "description": "text",
  "remarks": "text",
  "effectiveStartDate": "2025-03-24T23:57:44.041Z",
  "effectiveEndDate": "2025-03-24T23:57:44.041Z",
  "cancellationDate": "2025-03-24T23:57:44.041Z",
  "effectiveChangeDate": "2025-03-24T23:57:44.041Z",
  "orderDate": "2025-03-24T23:57:44.041Z",
  "noticePeriodDate": "2025-03-24T23:57:44.041Z",
  "lastRenewalDate": "2025-03-24T23:57:44.041Z",
  "created": "2025-03-24T23:57:44.041Z",
  "modified": "2025-03-24T23:57:44.041Z",
  "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-03-24T23:57:44.041Z",
          "effectiveEndDate": "2025-03-24T23:57:44.041Z",
          "quantity": 1,
          "unitCode": "text",
          "startOn": "AlignToSubscription",
          "endOn": "AlignToSubscription",
          "chargedThroughDate": "2025-03-24T23:57:44.041Z",
          "lastRenewalDate": "2025-03-24T23:57:44.041Z",
          "lastPriceAdjustmentDate": "2025-03-24T23:57:44.041Z",
          "pricePeriod": "Monthly",
          "usageRating": "Sum",
          "revenueRecognitionRule": "text",
          "billingDay": "None",
          "specificBillingDay": 1,
          "billingPeriod": "Monthly",
          "billingTiming": "InAdvance",
          "periodAlignment": "None",
          "alignmentDate": "2025-03-24T23:57:44.041Z",
          "taxTemplate": "text",
          "taxIncluded": true,
          "createInvoiceLinesPerTier": true,
          "estimatedUsage": 1,
          "estimatedQuantity": 1,
          "remainingQuantity": 1,
          "orderedQuantity": 1,
          "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-03-24T23:57:44.041Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "acv": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2025-03-24T23:57:44.041Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "tcv": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2025-03-24T23:57:44.041Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "emrr": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2025-03-24T23:57:44.041Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "oneTimeFees": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2025-03-24T23:57:44.041Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "orderProductId": "123e4567-e89b-12d3-a456-426614174000",
          "orderId": "123e4567-e89b-12d3-a456-426614174000",
          "chargeId": "123e4567-e89b-12d3-a456-426614174000",
          "created": "2025-03-24T23:57:44.041Z",
          "modified": "2025-03-24T23:57:44.041Z"
        }
      ],
      "customFields": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "externalERPId": "text",
      "externalCRMId": "text",
      "cmrr": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-03-24T23:57:44.041Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "acv": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-03-24T23:57:44.041Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "emrr": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-03-24T23:57:44.041Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "oneTimeFees": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-03-24T23:57:44.041Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "tcv": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-03-24T23:57:44.041Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "created": "2025-03-24T23:57:44.041Z",
      "modified": "2025-03-24T23:57:44.041Z"
    }
  ],
  "milestones": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "orderId": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "milestoneDate": "2025-03-24T23:57:44.041Z",
      "plannedDate": "2025-03-24T23:57:44.041Z"
    }
  ],
  "orderDiscounts": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "orderId": "123e4567-e89b-12d3-a456-426614174000",
      "startOn": "AlignToOrder",
      "endOn": "AlignToOrder",
      "startDate": "2025-03-24T23:57:44.041Z",
      "endDate": "2025-03-24T23:57:44.041Z",
      "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-03-24T23:57:44.041Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  },
  "acv": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2025-03-24T23:57:44.041Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  },
  "emrr": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2025-03-24T23:57:44.041Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  },
  "oneTimeFees": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2025-03-24T23:57:44.041Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  },
  "tcv": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2025-03-24T23:57:44.041Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  }
}

Success

Revert Subscription

post
Authorizations
Path parameters
idstring · uuidrequired

subscription id

Header parameters
api-versionstringoptional
younium-idempotency-keystringoptional
younium-idempotency-durationInHoursintegeroptional
Responses
application/json
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --request POST \
  --url 'https://api.younium.com/Subscriptions/revert/{id}'
200
400
401
403
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "message": "text"
}

Success

Activate Subscription

post
Authorizations
Path parameters
idstring · uuidrequired
Header parameters
api-versionstringoptional
younium-idempotency-keystringoptional
younium-idempotency-durationInHoursintegeroptional
Responses
application/json
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --request POST \
  --url 'https://api.younium.com/Subscriptions/activate/{id}'
200
400
401
403
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "message": "text"
}

Success

Get Subscription Milestones

get
Authorizations
Path parameters
idstring · uuidrequired

subscription id

Header parameters
api-versionstringoptional
Responses
application/json
application/json
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --url 'https://api.younium.com/Subscriptions/{id}/milestones'
200
400
401
403
404
[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "orderId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "milestoneDate": "2025-03-24T23:57:44.041Z",
    "plannedDate": "2025-03-24T23:57:44.041Z"
  }
]

Success

  • GETGet Subscription by Id
  • PATCHPatch Subscription
  • DELETEDelete Subscription
  • GETGet Subscriptions
  • POSTCreate subscription
  • GETGet Subscription versions
  • GETGet Subscription Version by Id
  • GETGet Subscription Version by OrderNumber
  • POSTChange Subscription
  • POSTCancel Subscription
  • POSTRenew Subscription
  • POSTRevert Subscription
  • POSTActivate Subscription
  • GETGet Subscription Milestones
  • POSTSet Subscription Milestone date
  • POSTEdit and create OrderDiscounts

Patch Subscription

patch
Authorizations
Path parameters
idstring · uuidrequired
Header parameters
api-versionstringoptional
Body
descriptionstring | nullableoptional
remarksstring | nullableoptional
noticePeriodinteger · int32 | nullableoptional
invoiceSeparatlybooleanoptional
useAccountInvoiceBatchGroupbooleanoptional
invoiceBatchGroupIdstring · uuid | nullableoptionalDeprecated
invoiceBatchGroupall of | nullableoptional

Used for identifying or referencing related entities. Accept both uuid, string and key-value-pair-object as input. Read more on: https://developer.younium.com/developer-resources#Vq4UM

invoiceTemplateIdstring · uuid | nullableoptional
customFieldsobject | nullableoptional

externalERPIdstring | nullableoptional
externalCRMIdstring | nullableoptional
buyerReferencestring | nullableoptional
yourOrderNumberstring | nullableoptional
Responses
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --request PATCH \
  --url 'https://api.younium.com/Subscriptions/{id}' \
  --header 'Content-Type: application/merge-patch+json' \
  --data '{
    "description": "text",
    "remarks": "text",
    "noticePeriod": 1,
    "invoiceSeparatly": true,
    "useAccountInvoiceBatchGroup": true,
    "invoiceBatchGroupId": "123e4567-e89b-12d3-a456-426614174000",
    "invoiceBatchGroup": {
      "key": "text",
      "value": "text"
    },
    "invoiceTemplateId": "123e4567-e89b-12d3-a456-426614174000",
    "customFields": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "externalERPId": "text",
    "externalCRMId": "text",
    "buyerReference": "text",
    "yourOrderNumber": "text"
  }'
200
400
401
403
No body

Success

Create subscription

post
Authorizations
Header parameters
api-versionstringoptional
younium-idempotency-keystringoptional
younium-idempotency-durationInHoursintegeroptional
Body
all ofoptional

Responses
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --request POST \
  --url 'https://api.younium.com/Subscriptions' \
  --header 'Content-Type: application/json' \
  --data '{
    "status": "Draft",
    "description": "text",
    "remarks": "text",
    "effectiveStartDate": "2025-03-24T23:57:44.041Z",
    "effectiveEndDate": "2025-03-24T23:57:44.041Z",
    "orderDate": "2025-03-24T23:57:44.041Z",
    "noticePeriodDate": "2025-03-24T23:57:44.041Z",
    "lastRenewalDate": "2025-03-24T23:57:44.041Z",
    "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-03-24T23:57:44.041Z",
            "effectiveEndDate": "2025-03-24T23:57:44.041Z",
            "startMilestone": "text",
            "endMilestone": "text",
            "quantity": 1,
            "unitCode": "pcs",
            "startOn": "AlignToSubscription",
            "endOn": "AlignToSubscription",
            "chargedThroughDate": "2025-03-24T23:57:44.041Z",
            "lastRenewalDate": "2025-03-24T23:57:44.041Z",
            "lastPriceAdjustmentDate": "2025-03-24T23:57:44.041Z",
            "pricePeriod": "Monthly",
            "usageRating": "Sum",
            "revenueRecognitionRule": {
              "key": "text",
              "value": "text"
            },
            "billingDay": "None",
            "specificBillingDay": 1,
            "billingPeriod": "Monthly",
            "billingTiming": "InAdvance",
            "periodAlignment": "None",
            "alignmentDate": "2025-03-24T23:57:44.041Z",
            "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-03-24T23:57:44.041Z"
      }
    ],
    "orderDiscounts": [
      {
        "operation": "Change",
        "OrderDiscountId": "GUID",
        "startOn": "AlignToOrder",
        "endOn": "AlignToOrder",
        "startDate": "2025-03-24T23:57:44.041Z",
        "endDate": "2025-03-24T23:57:44.041Z",
        "percent": 1,
        "onSpecificCharges": true,
        "orderProductCharges": [
          {
            "charge": "OPC-000001",
            "operation": "Remove"
          }
        ],
        "chargeMappingKey": "text"
      }
    ],
    "invoiceTemplateId": "123e4567-e89b-12d3-a456-426614174000",
    "invoiceBatchGroupId": "123e4567-e89b-12d3-a456-426614174000",
    "invoiceBatchGroup": {
      "key": "text",
      "value": "text"
    },
    "orderBillingPeriod": "Monthly",
    "setOrderBillingPeriod": true,
    "customFields": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  }'
201
400
401
403
No body

Subscription created.

Change Subscription

post
Authorizations
Path parameters
idstring · uuidrequired
Header parameters
api-versionstringoptional
younium-idempotency-keystringoptional
younium-idempotency-durationInHoursintegeroptional
Body
all ofoptional

Responses
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --request POST \
  --url 'https://api.younium.com/Subscriptions/{id}/change' \
  --header 'Content-Type: application/json' \
  --data '{
    "account": "A-000001",
    "invoiceAccount": "A-000001",
    "description": "text",
    "remarks": "text",
    "effectiveStartDate": "2025-03-24T23:57:44.041Z",
    "effectiveChangeDate": "2025-03-24T23:57:44.041Z",
    "effectiveEndDate": "2025-03-24T23:57:44.041Z",
    "orderDate": "2025-03-24T23:57:44.041Z",
    "subscriptionType": "Termed",
    "term": 1,
    "renewalTerm": 1,
    "noticePeriod": 1,
    "isAutoRenewed": true,
    "currency": "SEK",
    "invoiceSeparatly": true,
    "invoiceAddressId": "123e4567-e89b-12d3-a456-426614174000",
    "deliveryAddressId": "123e4567-e89b-12d3-a456-426614174000",
    "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,
    "invoiceBatchGroupId": "123e4567-e89b-12d3-a456-426614174000",
    "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-03-24T23:57:44.041Z",
            "lastRenewalDate": "2025-03-24T23:57:44.041Z",
            "lastPriceAdjustmentDate": "2025-03-24T23:57:44.041Z",
            "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,
            "billingPeriod": "Monthly",
            "billingTiming": "InAdvance",
            "periodAlignment": "None",
            "alignmentDate": "2025-03-24T23:57:44.041Z",
            "taxTemplate": "Sweden standard",
            "taxIncluded": true,
            "createInvoiceLinesPerTier": true,
            "remarks": "text",
            "externalERPId": "text",
            "externalCRMId": "text",
            "customFields": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            },
            "recurringMonthlyAmount": 1,
            "effectiveStartDate": "2025-03-24T23:57:44.041Z",
            "effectiveEndDate": "2025-03-24T23:57:44.041Z",
            "startMilestone": "MilestoneName",
            "endMilestone": "MilestoneName",
            "estimatedUsage": 1,
            "estimatedQuantity": 1,
            "orderDiscountMappingKey": [
              "text"
            ]
          }
        ],
        "externalERPId": "text",
        "externalCRMId": "text",
        "customFields": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "cancelProductOn": "EffectiveEndDate",
        "cancelationDate": "2025-03-24T23:57:44.041Z"
      }
    ],
    "milestones": [
      {
        "name": "text",
        "description": "text",
        "plannedDate": "2025-03-24T23:57:44.041Z"
      }
    ],
    "orderDiscounts": [
      {
        "operation": "Change",
        "OrderDiscountId": "GUID",
        "startOn": "AlignToOrder",
        "endOn": "AlignToOrder",
        "startDate": "2025-03-24T23:57:44.041Z",
        "endDate": "2025-03-24T23:57:44.041Z",
        "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"
    }
  }'
201
400
401
403
No body

New version of Subscription created.

Cancel Subscription

post
Authorizations
Path parameters
idstring · uuidrequired

subscription id

Header parameters
api-versionstringoptional
younium-idempotency-keystringoptional
younium-idempotency-durationInHoursintegeroptional
Body
all ofoptional

Responses
application/json
cURL
JavaScript
Python
HTTP
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-03-24T23:57:44.041Z",
    "cancellationMode": "OnOrderCancellationDate",
    "cancellationDatePerCharges": {
      "ANY_ADDITIONAL_PROPERTY": "2025-03-24T23:57:44.041Z"
    }
  }'
200
400
401
403
No body

Success

Renew Subscription

post
Authorizations
Path parameters
idstring · uuidrequired

subscription id

Header parameters
api-versionstringoptional
younium-idempotency-keystringoptional
younium-idempotency-durationInHoursintegeroptional
Body
all ofoptional

Responses
application/json
cURL
JavaScript
Python
HTTP
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
No body

Success

Set Subscription Milestone date

post
Authorizations
Path parameters
idstring · uuidrequired

Subscription Milestone Id

Header parameters
api-versionstringoptional
younium-idempotency-keystringoptional
younium-idempotency-durationInHoursintegeroptional
Body
all ofoptional

Responses
application/json
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --request POST \
  --url 'https://api.younium.com/Subscriptions/milestones/set/{id}' \
  --header 'Content-Type: application/json' \
  --data '{
    "milestoneDate": "2025-03-24T23:57:44.041Z",
    "milestoneId": "123e4567-e89b-12d3-a456-426614174000"
  }'
200
400
401
403
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "orderId": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "milestoneDate": "2025-03-24T23:57:44.041Z",
  "plannedDate": "2025-03-24T23:57:44.041Z"
}

Success

Edit and create OrderDiscounts

post

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

Authorizations
Path parameters
idstring · uuidrequired
Header parameters
api-versionstringoptional
younium-idempotency-keystringoptional
younium-idempotency-durationInHoursintegeroptional
Body
all ofoptional

Responses
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --request POST \
  --url 'https://api.younium.com/Subscriptions/{id}/OrderDiscounts' \
  --header 'Content-Type: application/json' \
  --data '{
    "effectiveChangeDate": "2025-03-24T23:57:44.041Z",
    "orderDiscounts": [
      {
        "operation": "Change",
        "OrderDiscountId": "GUID",
        "startOn": "AlignToOrder",
        "endOn": "AlignToOrder",
        "startDate": "2025-03-24T23:57:44.041Z",
        "endDate": "2025-03-24T23:57:44.041Z",
        "percent": 1,
        "onSpecificCharges": true,
        "orderProductCharges": [
          {
            "charge": "OPC-000001",
            "operation": "Remove"
          }
        ],
        "chargeMappingKey": "text"
      }
    ]
  }'
200
400
401
403
No body

Success