Subscriptions

Get Subscription by Id

Requires permission Order View

GEThttps://api.sandbox.younium.com/Subscriptions/{id}

Authorization

oauth2

Path parameters

id*string (uuid)

The subscription identifier

Header parameters

Response

200400401403404

Success

Body

application/json

idstring (uuid)

orderNumbernullable string

versioninteger (int32)

isLastVersionboolean

statusall of

descriptionnullable string

remarksnullable string

effectiveStartDatestring (date-time)

effectiveEndDatenullable string (date-time)

cancellationDatenullable string (date-time)

effectiveChangeDatenullable string (date-time)

orderDatenullable string (date-time)

noticePeriodDatenullable string (date-time)

lastRenewalDatenullable string (date-time)

createdstring (date-time)

modifiedstring (date-time)

lastUpdatednullable string (date-time)

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

Example: "2024-07-01"

noticePeriodinteger (int32)

terminteger (int32)

renewalTerminteger (int32)

isAutoRenewedboolean

orderTypeall of

termTypeall of

orderPaymentMethodall of

invoiceSeparatlyboolean

yourReferencenullable string

ourReferencenullable string

yourOrderNumbernullable string

buyerReferencenullable string

invoiceAddressnullable all of

deliveryAddressnullable all of

orderBillingPeriodall of

setOrderBillingPeriodboolean

invoiceBatchGroupnullable all of

paymentTermnullable string

useAccountInvoiceBatchGroupboolean

accountnullable all of

invoiceAccountnullable all of

productsnullable array of OrderProductResponse (object)

milestonesnullable array of SubscriptionMilestoneResponse (object)

orderDiscountsnullable array of OrderDiscountsResponse (object)

currencynullable string

externalERPIdnullable string

externalCRMIdnullable string

currencyCodeToUseWhenInvoicenullable string

customFieldsnullable object

cmrrnullable all of

acvnullable all of

emrrnullable all of

oneTimeFeesnullable all of

tcvnullable all of

Request

JavaScriptCurlPython

const response = await fetch('https://api.sandbox.younium.com/Subscriptions/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400404

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "orderNumber": "text",
  "version": 0,
  "isLastVersion": false,
  "status": {},
  "description": "text",
  "remarks": "text",
  "effectiveStartDate": "2024-12-22T11:31:27.644Z",
  "effectiveEndDate": "2024-12-22T11:31:27.644Z",
  "cancellationDate": "2024-12-22T11:31:27.644Z",
  "effectiveChangeDate": "2024-12-22T11:31:27.644Z",
  "orderDate": "2024-12-22T11:31:27.644Z",
  "noticePeriodDate": "2024-12-22T11:31:27.644Z",
  "lastRenewalDate": "2024-12-22T11:31:27.644Z",
  "created": "2024-12-22T11:31:27.644Z",
  "modified": "2024-12-22T11:31:27.644Z",
  "lastUpdated": "2024-07-01",
  "noticePeriod": 0,
  "term": 0,
  "renewalTerm": 0,
  "isAutoRenewed": false,
  "orderType": {},
  "termType": {},
  "orderPaymentMethod": {},
  "invoiceSeparatly": false,
  "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": {},
  "setOrderBillingPeriod": false,
  "invoiceBatchGroup": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "code": "text",
    "description": "text"
  },
  "paymentTerm": "text",
  "useAccountInvoiceBatchGroup": false,
  "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": 0,
      "name": "text",
      "charges": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "chargeNumber": "OPC-000001",
          "version": 0,
          "isLastVersion": false,
          "name": "text",
          "chargeType": {},
          "priceModel": {},
          "effectiveStartDate": "2024-12-22T11:31:27.644Z",
          "effectiveEndDate": "2024-12-22T11:31:27.644Z",
          "quantity": 0,
          "unitCode": "text",
          "startOn": {},
          "endOn": {},
          "chargedThroughDate": "2024-12-22T11:31:27.644Z",
          "lastRenewalDate": "2024-12-22T11:31:27.644Z",
          "lastPriceAdjustmentDate": "2024-12-22T11:31:27.644Z",
          "pricePeriod": {},
          "usageRating": {},
          "revenueRecognitionRule": "text",
          "billingDay": {},
          "specificBillingDay": 0,
          "billingPeriod": {},
          "billingTiming": {},
          "periodAlignment": {},
          "alignmentDate": "2024-12-22T11:31:27.644Z",
          "taxTemplate": "text",
          "taxIncluded": false,
          "createInvoiceLinesPerTier": false,
          "estimatedUsage": 0,
          "estimatedQuantity": 0,
          "remainingQuantity": 0,
          "orderedQuantity": 0,
          "remarks": "text",
          "accountsReceivableAccount": "text",
          "deferredRevenueAccount": "text",
          "recognizedRevenueAccount": "text",
          "changeState": {},
          "displayPrice": 0,
          "priceDetails": [
            {
              "tier": 0,
              "price": 0,
              "listPrice": 0,
              "description": "text",
              "fromQuantity": 0,
              "toQuantity": 0,
              "priceBase": {},
              "lineDiscountPercent": 0,
              "lineDiscountAmount": 0
            }
          ],
          "recurringMonthlyAmount": 0,
          "recurringMonthlyAmountBase": 0,
          "features": [
            {
              "code": "text",
              "description": "text"
            }
          ],
          "orderDiscounts": [
            {
              "orderDiscountId": "123e4567-e89b-12d3-a456-426614174000",
              "chargeId": "123e4567-e89b-12d3-a456-426614174000"
            }
          ],
          "externalERPId": "text",
          "externalCRMId": "text",
          "cmrr": {
            "amount": 0,
            "currencyCode": "text",
            "currencyConversionDate": "2024-12-22T11:31:27.644Z",
            "baseCurrencyAmount": 0,
            "baseCurrencyCode": "text"
          },
          "acv": {
            "amount": 0,
            "currencyCode": "text",
            "currencyConversionDate": "2024-12-22T11:31:27.644Z",
            "baseCurrencyAmount": 0,
            "baseCurrencyCode": "text"
          },
          "tcv": {
            "amount": 0,
            "currencyCode": "text",
            "currencyConversionDate": "2024-12-22T11:31:27.644Z",
            "baseCurrencyAmount": 0,
            "baseCurrencyCode": "text"
          },
          "emrr": {
            "amount": 0,
            "currencyCode": "text",
            "currencyConversionDate": "2024-12-22T11:31:27.644Z",
            "baseCurrencyAmount": 0,
            "baseCurrencyCode": "text"
          },
          "oneTimeFees": {
            "amount": 0,
            "currencyCode": "text",
            "currencyConversionDate": "2024-12-22T11:31:27.644Z",
            "baseCurrencyAmount": 0,
            "baseCurrencyCode": "text"
          },
          "orderProductId": "123e4567-e89b-12d3-a456-426614174000",
          "orderId": "123e4567-e89b-12d3-a456-426614174000",
          "chargeId": "123e4567-e89b-12d3-a456-426614174000",
          "created": "2024-12-22T11:31:27.644Z",
          "modified": "2024-12-22T11:31:27.644Z"
        }
      ],
      "externalERPId": "text",
      "externalCRMId": "text",
      "cmrr": {
        "amount": 0,
        "currencyCode": "text",
        "currencyConversionDate": "2024-12-22T11:31:27.644Z",
        "baseCurrencyAmount": 0,
        "baseCurrencyCode": "text"
      },
      "acv": {
        "amount": 0,
        "currencyCode": "text",
        "currencyConversionDate": "2024-12-22T11:31:27.644Z",
        "baseCurrencyAmount": 0,
        "baseCurrencyCode": "text"
      },
      "emrr": {
        "amount": 0,
        "currencyCode": "text",
        "currencyConversionDate": "2024-12-22T11:31:27.644Z",
        "baseCurrencyAmount": 0,
        "baseCurrencyCode": "text"
      },
      "oneTimeFees": {
        "amount": 0,
        "currencyCode": "text",
        "currencyConversionDate": "2024-12-22T11:31:27.644Z",
        "baseCurrencyAmount": 0,
        "baseCurrencyCode": "text"
      },
      "tcv": {
        "amount": 0,
        "currencyCode": "text",
        "currencyConversionDate": "2024-12-22T11:31:27.644Z",
        "baseCurrencyAmount": 0,
        "baseCurrencyCode": "text"
      },
      "created": "2024-12-22T11:31:27.644Z",
      "modified": "2024-12-22T11:31:27.644Z"
    }
  ],
  "milestones": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "orderId": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "milestoneDate": "2024-12-22T11:31:27.644Z",
      "plannedDate": "2024-12-22T11:31:27.644Z"
    }
  ],
  "orderDiscounts": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "orderId": "123e4567-e89b-12d3-a456-426614174000",
      "startOn": {},
      "endOn": {},
      "startDate": "2024-12-22T11:31:27.644Z",
      "endDate": "2024-12-22T11:31:27.644Z",
      "percent": 0,
      "discountType": {},
      "orderProductCharges": [
        {
          "orderDiscountId": "123e4567-e89b-12d3-a456-426614174000",
          "chargeId": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "onSpecificCharges": false
    }
  ],
  "currency": "text",
  "externalERPId": "text",
  "externalCRMId": "text",
  "currencyCodeToUseWhenInvoice": "text",
  "cmrr": {
    "amount": 0,
    "currencyCode": "text",
    "currencyConversionDate": "2024-12-22T11:31:27.644Z",
    "baseCurrencyAmount": 0,
    "baseCurrencyCode": "text"
  },
  "acv": {
    "amount": 0,
    "currencyCode": "text",
    "currencyConversionDate": "2024-12-22T11:31:27.644Z",
    "baseCurrencyAmount": 0,
    "baseCurrencyCode": "text"
  },
  "emrr": {
    "amount": 0,
    "currencyCode": "text",
    "currencyConversionDate": "2024-12-22T11:31:27.644Z",
    "baseCurrencyAmount": 0,
    "baseCurrencyCode": "text"
  },
  "oneTimeFees": {
    "amount": 0,
    "currencyCode": "text",
    "currencyConversionDate": "2024-12-22T11:31:27.644Z",
    "baseCurrencyAmount": 0,
    "baseCurrencyCode": "text"
  },
  "tcv": {
    "amount": 0,
    "currencyCode": "text",
    "currencyConversionDate": "2024-12-22T11:31:27.644Z",
    "baseCurrencyAmount": 0,
    "baseCurrencyCode": "text"
  }
}

Patch Subscription

PATCHhttps://api.sandbox.younium.com/Subscriptions/{id}

Authorization

oauth2

Path parameters

id*string (uuid)

Header parameters

Body

application/merge-patch+json

descriptionnullable string

remarksnullable string

noticePeriodnullable integer (int32)

invoiceSeparatlyboolean

useAccountInvoiceBatchGroupboolean

invoiceBatchGroupnullable all of

invoiceTemplateIdnullable string (uuid)

customFieldsnullable object

externalERPIdnullable string

externalCRMIdnullable string

buyerReferencenullable string

Response

200400401403

Success

Request

JavaScriptCurlPython

const response = await fetch('https://api.sandbox.younium.com/Subscriptions/{id}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/merge-patch+json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

400

{
  "type": "text",
  "title": "text",
  "status": 0,
  "detail": "text",
  "instance": "text"
}

Delete Subscription

DELETEhttps://api.sandbox.younium.com/Subscriptions/{id}

Authorization

oauth2

Path parameters

id*string (uuid)

subscription id

Header parameters

Response

200400401403404

Success

Request

JavaScriptCurlPython

const response = await fetch('https://api.sandbox.younium.com/Subscriptions/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

400404

{
  "type": "text",
  "title": "text",
  "status": 0,
  "detail": "text",
  "instance": "text"
}

Get Subscription versions

GEThttps://api.sandbox.younium.com/Subscriptions/{orderNumber}/versions

Authorization

oauth2

Path parameters

orderNumber*string

Query parameters

Header parameters

Response

200400401403

Success

Body

application/json

idstring (uuid)

orderNumbernullable string

versioninteger (int32)

isLastVersionboolean

statusall of

descriptionnullable string

remarksnullable string

effectiveStartDatestring (date-time)

effectiveEndDatenullable string (date-time)

cancellationDatenullable string (date-time)

effectiveChangeDatenullable string (date-time)

orderDatenullable string (date-time)

noticePeriodDatenullable string (date-time)

lastRenewalDatenullable string (date-time)

createdstring (date-time)

modifiedstring (date-time)

lastUpdatednullable string (date-time)

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

Example: "2024-07-01"

noticePeriodinteger (int32)

terminteger (int32)

renewalTerminteger (int32)

isAutoRenewedboolean

orderTypeall of

termTypeall of

orderPaymentMethodall of

invoiceSeparatlyboolean

yourReferencenullable string

ourReferencenullable string

yourOrderNumbernullable string

buyerReferencenullable string

invoiceAddressnullable all of

deliveryAddressnullable all of

orderBillingPeriodall of

setOrderBillingPeriodboolean

invoiceBatchGroupnullable all of

paymentTermnullable string

useAccountInvoiceBatchGroupboolean

accountnullable all of

invoiceAccountnullable all of

productsnullable array of OrderProductResponse (object)

milestonesnullable array of SubscriptionMilestoneResponse (object)

orderDiscountsnullable array of OrderDiscountsResponse (object)

currencynullable string

externalERPIdnullable string

externalCRMIdnullable string

currencyCodeToUseWhenInvoicenullable string

customFieldsnullable object

cmrrnullable all of

acvnullable all of

emrrnullable all of

oneTimeFeesnullable all of

tcvnullable all of

Request

JavaScriptCurlPython

const response = await fetch('https://api.sandbox.younium.com/Subscriptions/{orderNumber}/versions', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "orderNumber": "text",
    "version": 0,
    "isLastVersion": false,
    "status": {},
    "description": "text",
    "remarks": "text",
    "effectiveStartDate": "2024-12-22T11:31:27.644Z",
    "effectiveEndDate": "2024-12-22T11:31:27.644Z",
    "cancellationDate": "2024-12-22T11:31:27.644Z",
    "effectiveChangeDate": "2024-12-22T11:31:27.644Z",
    "orderDate": "2024-12-22T11:31:27.644Z",
    "noticePeriodDate": "2024-12-22T11:31:27.644Z",
    "lastRenewalDate": "2024-12-22T11:31:27.644Z",
    "created": "2024-12-22T11:31:27.644Z",
    "modified": "2024-12-22T11:31:27.644Z",
    "lastUpdated": "2024-07-01",
    "noticePeriod": 0,
    "term": 0,
    "renewalTerm": 0,
    "isAutoRenewed": false,
    "orderType": {},
    "termType": {},
    "orderPaymentMethod": {},
    "invoiceSeparatly": false,
    "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": {},
    "setOrderBillingPeriod": false,
    "invoiceBatchGroup": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "code": "text",
      "description": "text"
    },
    "paymentTerm": "text",
    "useAccountInvoiceBatchGroup": false,
    "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": 0,
        "name": "text",
        "charges": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "chargeNumber": "OPC-000001",
            "version": 0,
            "isLastVersion": false,
            "name": "text",
            "chargeType": {},
            "priceModel": {},
            "effectiveStartDate": "2024-12-22T11:31:27.644Z",
            "effectiveEndDate": "2024-12-22T11:31:27.644Z",
            "quantity": 0,
            "unitCode": "text",
            "startOn": {},
            "endOn": {},
            "chargedThroughDate": "2024-12-22T11:31:27.644Z",
            "lastRenewalDate": "2024-12-22T11:31:27.644Z",
            "lastPriceAdjustmentDate": "2024-12-22T11:31:27.644Z",
            "pricePeriod": {},
            "usageRating": {},
            "revenueRecognitionRule": "text",
            "billingDay": {},
            "specificBillingDay": 0,
            "billingPeriod": {},
            "billingTiming": {},
            "periodAlignment": {},
            "alignmentDate": "2024-12-22T11:31:27.644Z",
            "taxTemplate": "text",
            "taxIncluded": false,
            "createInvoiceLinesPerTier": false,
            "estimatedUsage": 0,
            "estimatedQuantity": 0,
            "remainingQuantity": 0,
            "orderedQuantity": 0,
            "remarks": "text",
            "accountsReceivableAccount": "text",
            "deferredRevenueAccount": "text",
            "recognizedRevenueAccount": "text",
            "changeState": {},
            "displayPrice": 0,
            "priceDetails": [
              {
                "tier": 0,
                "price": 0,
                "listPrice": 0,
                "description": "text",
                "fromQuantity": 0,
                "toQuantity": 0,
                "priceBase": {},
                "lineDiscountPercent": 0,
                "lineDiscountAmount": 0
              }
            ],
            "recurringMonthlyAmount": 0,
            "recurringMonthlyAmountBase": 0,
            "features": [
              {
                "code": "text",
                "description": "text"
              }
            ],
            "orderDiscounts": [
              {
                "orderDiscountId": "123e4567-e89b-12d3-a456-426614174000",
                "chargeId": "123e4567-e89b-12d3-a456-426614174000"
              }
            ],
            "externalERPId": "text",
            "externalCRMId": "text",
            "cmrr": {
              "amount": 0,
              "currencyCode": "text",
              "currencyConversionDate": "2024-12-22T11:31:27.644Z",
              "baseCurrencyAmount": 0,
              "baseCurrencyCode": "text"
            },
            "acv": {
              "amount": 0,
              "currencyCode": "text",
              "currencyConversionDate": "2024-12-22T11:31:27.644Z",
              "baseCurrencyAmount": 0,
              "baseCurrencyCode": "text"
            },
            "tcv": {
              "amount": 0,
              "currencyCode": "text",
              "currencyConversionDate": "2024-12-22T11:31:27.644Z",
              "baseCurrencyAmount": 0,
              "baseCurrencyCode": "text"
            },
            "emrr": {
              "amount": 0,
              "currencyCode": "text",
              "currencyConversionDate": "2024-12-22T11:31:27.644Z",
              "baseCurrencyAmount": 0,
              "baseCurrencyCode": "text"
            },
            "oneTimeFees": {
              "amount": 0,
              "currencyCode": "text",
              "currencyConversionDate": "2024-12-22T11:31:27.644Z",
              "baseCurrencyAmount": 0,
              "baseCurrencyCode": "text"
            },
            "orderProductId": "123e4567-e89b-12d3-a456-426614174000",
            "orderId": "123e4567-e89b-12d3-a456-426614174000",
            "chargeId": "123e4567-e89b-12d3-a456-426614174000",
            "created": "2024-12-22T11:31:27.644Z",
            "modified": "2024-12-22T11:31:27.644Z"
          }
        ],
        "externalERPId": "text",
        "externalCRMId": "text",
        "cmrr": {
          "amount": 0,
          "currencyCode": "text",
          "currencyConversionDate": "2024-12-22T11:31:27.644Z",
          "baseCurrencyAmount": 0,
          "baseCurrencyCode": "text"
        },
        "acv": {
          "amount": 0,
          "currencyCode": "text",
          "currencyConversionDate": "2024-12-22T11:31:27.644Z",
          "baseCurrencyAmount": 0,
          "baseCurrencyCode": "text"
        },
        "emrr": {
          "amount": 0,
          "currencyCode": "text",
          "currencyConversionDate": "2024-12-22T11:31:27.644Z",
          "baseCurrencyAmount": 0,
          "baseCurrencyCode": "text"
        },
        "oneTimeFees": {
          "amount": 0,
          "currencyCode": "text",
          "currencyConversionDate": "2024-12-22T11:31:27.644Z",
          "baseCurrencyAmount": 0,
          "baseCurrencyCode": "text"
        },
        "tcv": {
          "amount": 0,
          "currencyCode": "text",
          "currencyConversionDate": "2024-12-22T11:31:27.644Z",
          "baseCurrencyAmount": 0,
          "baseCurrencyCode": "text"
        },
        "created": "2024-12-22T11:31:27.644Z",
        "modified": "2024-12-22T11:31:27.644Z"
      }
    ],
    "milestones": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "orderId": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "description": "text",
        "milestoneDate": "2024-12-22T11:31:27.644Z",
        "plannedDate": "2024-12-22T11:31:27.644Z"
      }
    ],
    "orderDiscounts": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "orderId": "123e4567-e89b-12d3-a456-426614174000",
        "startOn": {},
        "endOn": {},
        "startDate": "2024-12-22T11:31:27.644Z",
        "endDate": "2024-12-22T11:31:27.644Z",
        "percent": 0,
        "discountType": {},
        "orderProductCharges": [
          {
            "orderDiscountId": "123e4567-e89b-12d3-a456-426614174000",
            "chargeId": "123e4567-e89b-12d3-a456-426614174000"
          }
        ],
        "onSpecificCharges": false
      }
    ],
    "currency": "text",
    "externalERPId": "text",
    "externalCRMId": "text",
    "currencyCodeToUseWhenInvoice": "text",
    "cmrr": {
      "amount": 0,
      "currencyCode": "text",
      "currencyConversionDate": "2024-12-22T11:31:27.644Z",
      "baseCurrencyAmount": 0,
      "baseCurrencyCode": "text"
    },
    "acv": {
      "amount": 0,
      "currencyCode": "text",
      "currencyConversionDate": "2024-12-22T11:31:27.644Z",
      "baseCurrencyAmount": 0,
      "baseCurrencyCode": "text"
    },
    "emrr": {
      "amount": 0,
      "currencyCode": "text",
      "currencyConversionDate": "2024-12-22T11:31:27.644Z",
      "baseCurrencyAmount": 0,
      "baseCurrencyCode": "text"
    },
    "oneTimeFees": {
      "amount": 0,
      "currencyCode": "text",
      "currencyConversionDate": "2024-12-22T11:31:27.644Z",
      "baseCurrencyAmount": 0,
      "baseCurrencyCode": "text"
    },
    "tcv": {
      "amount": 0,
      "currencyCode": "text",
      "currencyConversionDate": "2024-12-22T11:31:27.644Z",
      "baseCurrencyAmount": 0,
      "baseCurrencyCode": "text"
    }
  }
]

Get Subscription Version by Id

GEThttps://api.sandbox.younium.com/Subscriptions/{id}/version

Authorization

oauth2

Path parameters

id*string (uuid)

Header parameters

Response

200400401403404

Success

Body

application/json

idstring (uuid)

orderNumbernullable string

versioninteger (int32)

isLastVersionboolean

statusall of

descriptionnullable string

remarksnullable string

effectiveStartDatestring (date-time)

effectiveEndDatenullable string (date-time)

cancellationDatenullable string (date-time)

effectiveChangeDatenullable string (date-time)

orderDatenullable string (date-time)

noticePeriodDatenullable string (date-time)

lastRenewalDatenullable string (date-time)

createdstring (date-time)

modifiedstring (date-time)

lastUpdatednullable string (date-time)

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

Example: "2024-07-01"

noticePeriodinteger (int32)

terminteger (int32)

renewalTerminteger (int32)

isAutoRenewedboolean

orderTypeall of

termTypeall of

orderPaymentMethodall of

invoiceSeparatlyboolean

yourReferencenullable string

ourReferencenullable string

yourOrderNumbernullable string

buyerReferencenullable string

invoiceAddressnullable all of

deliveryAddressnullable all of

orderBillingPeriodall of

setOrderBillingPeriodboolean

invoiceBatchGroupnullable all of

paymentTermnullable string

useAccountInvoiceBatchGroupboolean

accountnullable all of

invoiceAccountnullable all of

productsnullable array of OrderProductResponse (object)

milestonesnullable array of SubscriptionMilestoneResponse (object)

orderDiscountsnullable array of OrderDiscountsResponse (object)

currencynullable string

externalERPIdnullable string

externalCRMIdnullable string

currencyCodeToUseWhenInvoicenullable string

customFieldsnullable object

cmrrnullable all of

acvnullable all of

emrrnullable all of

oneTimeFeesnullable all of

tcvnullable all of

Request

JavaScriptCurlPython

const response = await fetch('https://api.sandbox.younium.com/Subscriptions/{id}/version', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400404

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "orderNumber": "text",
  "version": 0,
  "isLastVersion": false,
  "status": {},
  "description": "text",
  "remarks": "text",
  "effectiveStartDate": "2024-12-22T11:31:27.644Z",
  "effectiveEndDate": "2024-12-22T11:31:27.644Z",
  "cancellationDate": "2024-12-22T11:31:27.644Z",
  "effectiveChangeDate": "2024-12-22T11:31:27.644Z",
  "orderDate": "2024-12-22T11:31:27.644Z",
  "noticePeriodDate": "2024-12-22T11:31:27.644Z",
  "lastRenewalDate": "2024-12-22T11:31:27.644Z",
  "created": "2024-12-22T11:31:27.644Z",
  "modified": "2024-12-22T11:31:27.644Z",
  "lastUpdated": "2024-07-01",
  "noticePeriod": 0,
  "term": 0,
  "renewalTerm": 0,
  "isAutoRenewed": false,
  "orderType": {},
  "termType": {},
  "orderPaymentMethod": {},
  "invoiceSeparatly": false,
  "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": {},
  "setOrderBillingPeriod": false,
  "invoiceBatchGroup": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "code": "text",
    "description": "text"
  },
  "paymentTerm": "text",
  "useAccountInvoiceBatchGroup": false,
  "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": 0,
      "name": "text",
      "charges": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "chargeNumber": "OPC-000001",
          "version": 0,
          "isLastVersion": false,
          "name": "text",
          "chargeType": {},
          "priceModel": {},
          "effectiveStartDate": "2024-12-22T11:31:27.644Z",
          "effectiveEndDate": "2024-12-22T11:31:27.644Z",
          "quantity": 0,
          "unitCode": "text",
          "startOn": {},
          "endOn": {},
          "chargedThroughDate": "2024-12-22T11:31:27.644Z",
          "lastRenewalDate": "2024-12-22T11:31:27.644Z",
          "lastPriceAdjustmentDate": "2024-12-22T11:31:27.644Z",
          "pricePeriod": {},
          "usageRating": {},
          "revenueRecognitionRule": "text",
          "billingDay": {},
          "specificBillingDay": 0,
          "billingPeriod": {},
          "billingTiming": {},
          "periodAlignment": {},
          "alignmentDate": "2024-12-22T11:31:27.644Z",
          "taxTemplate": "text",
          "taxIncluded": false,
          "createInvoiceLinesPerTier": false,
          "estimatedUsage": 0,
          "estimatedQuantity": 0,
          "remainingQuantity": 0,
          "orderedQuantity": 0,
          "remarks": "text",
          "accountsReceivableAccount": "text",
          "deferredRevenueAccount": "text",
          "recognizedRevenueAccount": "text",
          "changeState": {},
          "displayPrice": 0,
          "priceDetails": [
            {
              "tier": 0,
              "price": 0,
              "listPrice": 0,
              "description": "text",
              "fromQuantity": 0,
              "toQuantity": 0,
              "priceBase": {},
              "lineDiscountPercent": 0,
              "lineDiscountAmount": 0
            }
          ],
          "recurringMonthlyAmount": 0,
          "recurringMonthlyAmountBase": 0,
          "features": [
            {
              "code": "text",
              "description": "text"
            }
          ],
          "orderDiscounts": [
            {
              "orderDiscountId": "123e4567-e89b-12d3-a456-426614174000",
              "chargeId": "123e4567-e89b-12d3-a456-426614174000"
            }
          ],
          "externalERPId": "text",
          "externalCRMId": "text",
          "cmrr": {
            "amount": 0,
            "currencyCode": "text",
            "currencyConversionDate": "2024-12-22T11:31:27.644Z",
            "baseCurrencyAmount": 0,
            "baseCurrencyCode": "text"
          },
          "acv": {
            "amount": 0,
            "currencyCode": "text",
            "currencyConversionDate": "2024-12-22T11:31:27.644Z",
            "baseCurrencyAmount": 0,
            "baseCurrencyCode": "text"
          },
          "tcv": {
            "amount": 0,
            "currencyCode": "text",
            "currencyConversionDate": "2024-12-22T11:31:27.644Z",
            "baseCurrencyAmount": 0,
            "baseCurrencyCode": "text"
          },
          "emrr": {
            "amount": 0,
            "currencyCode": "text",
            "currencyConversionDate": "2024-12-22T11:31:27.644Z",
            "baseCurrencyAmount": 0,
            "baseCurrencyCode": "text"
          },
          "oneTimeFees": {
            "amount": 0,
            "currencyCode": "text",
            "currencyConversionDate": "2024-12-22T11:31:27.644Z",
            "baseCurrencyAmount": 0,
            "baseCurrencyCode": "text"
          },
          "orderProductId": "123e4567-e89b-12d3-a456-426614174000",
          "orderId": "123e4567-e89b-12d3-a456-426614174000",
          "chargeId": "123e4567-e89b-12d3-a456-426614174000",
          "created": "2024-12-22T11:31:27.644Z",
          "modified": "2024-12-22T11:31:27.644Z"
        }
      ],
      "externalERPId": "text",
      "externalCRMId": "text",
      "cmrr": {
        "amount": 0,
        "currencyCode": "text",
        "currencyConversionDate": "2024-12-22T11:31:27.644Z",
        "baseCurrencyAmount": 0,
        "baseCurrencyCode": "text"
      },
      "acv": {
        "amount": 0,
        "currencyCode": "text",
        "currencyConversionDate": "2024-12-22T11:31:27.644Z",
        "baseCurrencyAmount": 0,
        "baseCurrencyCode": "text"
      },
      "emrr": {
        "amount": 0,
        "currencyCode": "text",
        "currencyConversionDate": "2024-12-22T11:31:27.644Z",
        "baseCurrencyAmount": 0,
        "baseCurrencyCode": "text"
      },
      "oneTimeFees": {
        "amount": 0,
        "currencyCode": "text",
        "currencyConversionDate": "2024-12-22T11:31:27.644Z",
        "baseCurrencyAmount": 0,
        "baseCurrencyCode": "text"
      },
      "tcv": {
        "amount": 0,
        "currencyCode": "text",
        "currencyConversionDate": "2024-12-22T11:31:27.644Z",
        "baseCurrencyAmount": 0,
        "baseCurrencyCode": "text"
      },
      "created": "2024-12-22T11:31:27.644Z",
      "modified": "2024-12-22T11:31:27.644Z"
    }
  ],
  "milestones": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "orderId": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "milestoneDate": "2024-12-22T11:31:27.644Z",
      "plannedDate": "2024-12-22T11:31:27.644Z"
    }
  ],
  "orderDiscounts": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "orderId": "123e4567-e89b-12d3-a456-426614174000",
      "startOn": {},
      "endOn": {},
      "startDate": "2024-12-22T11:31:27.644Z",
      "endDate": "2024-12-22T11:31:27.644Z",
      "percent": 0,
      "discountType": {},
      "orderProductCharges": [
        {
          "orderDiscountId": "123e4567-e89b-12d3-a456-426614174000",
          "chargeId": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "onSpecificCharges": false
    }
  ],
  "currency": "text",
  "externalERPId": "text",
  "externalCRMId": "text",
  "currencyCodeToUseWhenInvoice": "text",
  "cmrr": {
    "amount": 0,
    "currencyCode": "text",
    "currencyConversionDate": "2024-12-22T11:31:27.644Z",
    "baseCurrencyAmount": 0,
    "baseCurrencyCode": "text"
  },
  "acv": {
    "amount": 0,
    "currencyCode": "text",
    "currencyConversionDate": "2024-12-22T11:31:27.644Z",
    "baseCurrencyAmount": 0,
    "baseCurrencyCode": "text"
  },
  "emrr": {
    "amount": 0,
    "currencyCode": "text",
    "currencyConversionDate": "2024-12-22T11:31:27.644Z",
    "baseCurrencyAmount": 0,
    "baseCurrencyCode": "text"
  },
  "oneTimeFees": {
    "amount": 0,
    "currencyCode": "text",
    "currencyConversionDate": "2024-12-22T11:31:27.644Z",
    "baseCurrencyAmount": 0,
    "baseCurrencyCode": "text"
  },
  "tcv": {
    "amount": 0,
    "currencyCode": "text",
    "currencyConversionDate": "2024-12-22T11:31:27.644Z",
    "baseCurrencyAmount": 0,
    "baseCurrencyCode": "text"
  }
}

Get Subscription Version by OrderNumber

GEThttps://api.sandbox.younium.com/Subscriptions/{orderNumber}/versions/{version}

Authorization

oauth2

Path parameters

orderNumber*string

version*integer (int32)

Header parameters

Response

200400401403

Success

Body

application/json

idstring (uuid)

orderNumbernullable string

versioninteger (int32)

isLastVersionboolean

statusall of

descriptionnullable string

remarksnullable string

effectiveStartDatestring (date-time)

effectiveEndDatenullable string (date-time)

cancellationDatenullable string (date-time)

effectiveChangeDatenullable string (date-time)

orderDatenullable string (date-time)

noticePeriodDatenullable string (date-time)

lastRenewalDatenullable string (date-time)

createdstring (date-time)

modifiedstring (date-time)

lastUpdatednullable string (date-time)

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

Example: "2024-07-01"

noticePeriodinteger (int32)

terminteger (int32)

renewalTerminteger (int32)

isAutoRenewedboolean

orderTypeall of

termTypeall of

orderPaymentMethodall of

invoiceSeparatlyboolean

yourReferencenullable string

ourReferencenullable string

yourOrderNumbernullable string

buyerReferencenullable string

invoiceAddressnullable all of

deliveryAddressnullable all of

orderBillingPeriodall of

setOrderBillingPeriodboolean

invoiceBatchGroupnullable all of

paymentTermnullable string

useAccountInvoiceBatchGroupboolean

accountnullable all of

invoiceAccountnullable all of

productsnullable array of OrderProductResponse (object)

milestonesnullable array of SubscriptionMilestoneResponse (object)

orderDiscountsnullable array of OrderDiscountsResponse (object)

currencynullable string

externalERPIdnullable string

externalCRMIdnullable string

currencyCodeToUseWhenInvoicenullable string

customFieldsnullable object

cmrrnullable all of

acvnullable all of

emrrnullable all of

oneTimeFeesnullable all of

tcvnullable all of

Request

JavaScriptCurlPython

const response = await fetch('https://api.sandbox.younium.com/Subscriptions/{orderNumber}/versions/{version}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "orderNumber": "text",
  "version": 0,
  "isLastVersion": false,
  "status": {},
  "description": "text",
  "remarks": "text",
  "effectiveStartDate": "2024-12-22T11:31:27.644Z",
  "effectiveEndDate": "2024-12-22T11:31:27.644Z",
  "cancellationDate": "2024-12-22T11:31:27.644Z",
  "effectiveChangeDate": "2024-12-22T11:31:27.644Z",
  "orderDate": "2024-12-22T11:31:27.644Z",
  "noticePeriodDate": "2024-12-22T11:31:27.644Z",
  "lastRenewalDate": "2024-12-22T11:31:27.644Z",
  "created": "2024-12-22T11:31:27.644Z",
  "modified": "2024-12-22T11:31:27.644Z",
  "lastUpdated": "2024-07-01",
  "noticePeriod": 0,
  "term": 0,
  "renewalTerm": 0,
  "isAutoRenewed": false,
  "orderType": {},
  "termType": {},
  "orderPaymentMethod": {},
  "invoiceSeparatly": false,
  "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": {},
  "setOrderBillingPeriod": false,
  "invoiceBatchGroup": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "code": "text",
    "description": "text"
  },
  "paymentTerm": "text",
  "useAccountInvoiceBatchGroup": false,
  "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": 0,
      "name": "text",
      "charges": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "chargeNumber": "OPC-000001",
          "version": 0,
          "isLastVersion": false,
          "name": "text",
          "chargeType": {},
          "priceModel": {},
          "effectiveStartDate": "2024-12-22T11:31:27.644Z",
          "effectiveEndDate": "2024-12-22T11:31:27.644Z",
          "quantity": 0,
          "unitCode": "text",
          "startOn": {},
          "endOn": {},
          "chargedThroughDate": "2024-12-22T11:31:27.644Z",
          "lastRenewalDate": "2024-12-22T11:31:27.644Z",
          "lastPriceAdjustmentDate": "2024-12-22T11:31:27.644Z",
          "pricePeriod": {},
          "usageRating": {},
          "revenueRecognitionRule": "text",
          "billingDay": {},
          "specificBillingDay": 0,
          "billingPeriod": {},
          "billingTiming": {},
          "periodAlignment": {},
          "alignmentDate": "2024-12-22T11:31:27.644Z",
          "taxTemplate": "text",
          "taxIncluded": false,
          "createInvoiceLinesPerTier": false,
          "estimatedUsage": 0,
          "estimatedQuantity": 0,
          "remainingQuantity": 0,
          "orderedQuantity": 0,
          "remarks": "text",
          "accountsReceivableAccount": "text",
          "deferredRevenueAccount": "text",
          "recognizedRevenueAccount": "text",
          "changeState": {},
          "displayPrice": 0,
          "priceDetails": [
            {
              "tier": 0,
              "price": 0,
              "listPrice": 0,
              "description": "text",
              "fromQuantity": 0,
              "toQuantity": 0,
              "priceBase": {},
              "lineDiscountPercent": 0,
              "lineDiscountAmount": 0
            }
          ],
          "recurringMonthlyAmount": 0,
          "recurringMonthlyAmountBase": 0,
          "features": [
            {
              "code": "text",
              "description": "text"
            }
          ],
          "orderDiscounts": [
            {
              "orderDiscountId": "123e4567-e89b-12d3-a456-426614174000",
              "chargeId": "123e4567-e89b-12d3-a456-426614174000"
            }
          ],
          "externalERPId": "text",
          "externalCRMId": "text",
          "cmrr": {
            "amount": 0,
            "currencyCode": "text",
            "currencyConversionDate": "2024-12-22T11:31:27.644Z",
            "baseCurrencyAmount": 0,
            "baseCurrencyCode": "text"
          },
          "acv": {
            "amount": 0,
            "currencyCode": "text",
            "currencyConversionDate": "2024-12-22T11:31:27.644Z",
            "baseCurrencyAmount": 0,
            "baseCurrencyCode": "text"
          },
          "tcv": {
            "amount": 0,
            "currencyCode": "text",
            "currencyConversionDate": "2024-12-22T11:31:27.644Z",
            "baseCurrencyAmount": 0,
            "baseCurrencyCode": "text"
          },
          "emrr": {
            "amount": 0,
            "currencyCode": "text",
            "currencyConversionDate": "2024-12-22T11:31:27.644Z",
            "baseCurrencyAmount": 0,
            "baseCurrencyCode": "text"
          },
          "oneTimeFees": {
            "amount": 0,
            "currencyCode": "text",
            "currencyConversionDate": "2024-12-22T11:31:27.644Z",
            "baseCurrencyAmount": 0,
            "baseCurrencyCode": "text"
          },
          "orderProductId": "123e4567-e89b-12d3-a456-426614174000",
          "orderId": "123e4567-e89b-12d3-a456-426614174000",
          "chargeId": "123e4567-e89b-12d3-a456-426614174000",
          "created": "2024-12-22T11:31:27.644Z",
          "modified": "2024-12-22T11:31:27.644Z"
        }
      ],
      "externalERPId": "text",
      "externalCRMId": "text",
      "cmrr": {
        "amount": 0,
        "currencyCode": "text",
        "currencyConversionDate": "2024-12-22T11:31:27.644Z",
        "baseCurrencyAmount": 0,
        "baseCurrencyCode": "text"
      },
      "acv": {
        "amount": 0,
        "currencyCode": "text",
        "currencyConversionDate": "2024-12-22T11:31:27.644Z",
        "baseCurrencyAmount": 0,
        "baseCurrencyCode": "text"
      },
      "emrr": {
        "amount": 0,
        "currencyCode": "text",
        "currencyConversionDate": "2024-12-22T11:31:27.644Z",
        "baseCurrencyAmount": 0,
        "baseCurrencyCode": "text"
      },
      "oneTimeFees": {
        "amount": 0,
        "currencyCode": "text",
        "currencyConversionDate": "2024-12-22T11:31:27.644Z",
        "baseCurrencyAmount": 0,
        "baseCurrencyCode": "text"
      },
      "tcv": {
        "amount": 0,
        "currencyCode": "text",
        "currencyConversionDate": "2024-12-22T11:31:27.644Z",
        "baseCurrencyAmount": 0,
        "baseCurrencyCode": "text"
      },
      "created": "2024-12-22T11:31:27.644Z",
      "modified": "2024-12-22T11:31:27.644Z"
    }
  ],
  "milestones": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "orderId": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "milestoneDate": "2024-12-22T11:31:27.644Z",
      "plannedDate": "2024-12-22T11:31:27.644Z"
    }
  ],
  "orderDiscounts": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "orderId": "123e4567-e89b-12d3-a456-426614174000",
      "startOn": {},
      "endOn": {},
      "startDate": "2024-12-22T11:31:27.644Z",
      "endDate": "2024-12-22T11:31:27.644Z",
      "percent": 0,
      "discountType": {},
      "orderProductCharges": [
        {
          "orderDiscountId": "123e4567-e89b-12d3-a456-426614174000",
          "chargeId": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "onSpecificCharges": false
    }
  ],
  "currency": "text",
  "externalERPId": "text",
  "externalCRMId": "text",
  "currencyCodeToUseWhenInvoice": "text",
  "cmrr": {
    "amount": 0,
    "currencyCode": "text",
    "currencyConversionDate": "2024-12-22T11:31:27.644Z",
    "baseCurrencyAmount": 0,
    "baseCurrencyCode": "text"
  },
  "acv": {
    "amount": 0,
    "currencyCode": "text",
    "currencyConversionDate": "2024-12-22T11:31:27.644Z",
    "baseCurrencyAmount": 0,
    "baseCurrencyCode": "text"
  },
  "emrr": {
    "amount": 0,
    "currencyCode": "text",
    "currencyConversionDate": "2024-12-22T11:31:27.644Z",
    "baseCurrencyAmount": 0,
    "baseCurrencyCode": "text"
  },
  "oneTimeFees": {
    "amount": 0,
    "currencyCode": "text",
    "currencyConversionDate": "2024-12-22T11:31:27.644Z",
    "baseCurrencyAmount": 0,
    "baseCurrencyCode": "text"
  },
  "tcv": {
    "amount": 0,
    "currencyCode": "text",
    "currencyConversionDate": "2024-12-22T11:31:27.644Z",
    "baseCurrencyAmount": 0,
    "baseCurrencyCode": "text"
  }
}

Create subscription

POSThttps://api.sandbox.younium.com/Subscriptions

Authorization

oauth2

Header parameters

Body

application/json

status*all of

descriptionnullable string

remarksnullable string

effectiveStartDatenullable string (date-time)

orderDatenullable string (date-time)

noticePeriodDatenullable string (date-time)

lastRenewalDatenullable string (date-time)

noticePeriodnullable integer (int32)

termnullable integer (int32)

renewalTermnullable integer (int32)

isAutoRenewednullable boolean

orderTypenullable all of

subscriptionTypenullable all of

orderPaymentMethodall of

invoiceSeparatlynullable boolean

yourReferencenullable string

ourReferencenullable string

yourOrderNumbernullable string

buyerReferencenullable string

invoiceAddressIdnullable string (uuid)

deliveryAddressIdnullable string (uuid)

externalERPIdnullable string

externalCRMIdnullable string

paymentTermnullable all of

Allowed as string input: Name, PaymentTerm-Id.

Example: "NET30"

useAccountInvoiceBatchGroupnullable boolean

account*all of

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

Example: "A-000001"

invoiceAccountnullable all of

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

Example: "A-000001"

currencynullable all of

Allowed as string input: Code, Currency-Id.

Example: "SEK"

invoicingCurrencynullable string

productsnullable array of CreateOrderProductRequest (object)

milestonesnullable array of SubscriptionMilestoneRequest (object)

orderDiscountsnullable array of OrderDiscountsRequest (object)

invoiceTemplateIdnullable string (uuid)

invoiceBatchGroupnullable all of

orderBillingPeriodnullable all of

setOrderBillingPeriodnullable boolean

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

customFieldsnullable object

Response

201400401403

Subscription created.

Request

JavaScriptCurlPython

const response = await fetch('https://api.sandbox.younium.com/Subscriptions', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "account": "A-000001",
      "status": {}
    }),
});
const data = await response.json();

Response

400

{
  "type": "text",
  "title": "text",
  "status": 0,
  "detail": "text",
  "instance": "text"
}

GEThttps://api.sandbox.younium.com/Subscriptions

Authorization

oauth2

Query parameters

Header parameters

Response

200400401403

Success

Body

application/json

idstring (uuid)

orderNumbernullable string

versioninteger (int32)

isLastVersionboolean

statusall of

descriptionnullable string

remarksnullable string

effectiveStartDatestring (date-time)

effectiveEndDatenullable string (date-time)

cancellationDatenullable string (date-time)

effectiveChangeDatenullable string (date-time)

orderDatenullable string (date-time)

noticePeriodDatenullable string (date-time)

lastRenewalDatenullable string (date-time)

createdstring (date-time)

modifiedstring (date-time)

lastUpdatednullable string (date-time)

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

Example: "2024-07-01"

noticePeriodinteger (int32)

terminteger (int32)

renewalTerminteger (int32)

isAutoRenewedboolean

orderTypeall of

termTypeall of

orderPaymentMethodall of

invoiceSeparatlyboolean

yourReferencenullable string

ourReferencenullable string

yourOrderNumbernullable string

buyerReferencenullable string

invoiceAddressnullable all of

deliveryAddressnullable all of

orderBillingPeriodall of

setOrderBillingPeriodboolean

invoiceBatchGroupnullable all of

paymentTermnullable string

useAccountInvoiceBatchGroupboolean

accountnullable all of

invoiceAccountnullable all of

productsnullable array of OrderProductResponse (object)

milestonesnullable array of SubscriptionMilestoneResponse (object)

orderDiscountsnullable array of OrderDiscountsResponse (object)

currencynullable string

externalERPIdnullable string

externalCRMIdnullable string

currencyCodeToUseWhenInvoicenullable string

customFieldsnullable object

cmrrnullable all of

acvnullable all of

emrrnullable all of

oneTimeFeesnullable all of

tcvnullable all of

Request

JavaScriptCurlPython

const response = await fetch('https://api.sandbox.younium.com/Subscriptions', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "orderNumber": "text",
    "version": 0,
    "isLastVersion": false,
    "status": {},
    "description": "text",
    "remarks": "text",
    "effectiveStartDate": "2024-12-22T11:31:27.644Z",
    "effectiveEndDate": "2024-12-22T11:31:27.644Z",
    "cancellationDate": "2024-12-22T11:31:27.644Z",
    "effectiveChangeDate": "2024-12-22T11:31:27.644Z",
    "orderDate": "2024-12-22T11:31:27.644Z",
    "noticePeriodDate": "2024-12-22T11:31:27.644Z",
    "lastRenewalDate": "2024-12-22T11:31:27.644Z",
    "created": "2024-12-22T11:31:27.644Z",
    "modified": "2024-12-22T11:31:27.644Z",
    "lastUpdated": "2024-07-01",
    "noticePeriod": 0,
    "term": 0,
    "renewalTerm": 0,
    "isAutoRenewed": false,
    "orderType": {},
    "termType": {},
    "orderPaymentMethod": {},
    "invoiceSeparatly": false,
    "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": {},
    "setOrderBillingPeriod": false,
    "invoiceBatchGroup": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "code": "text",
      "description": "text"
    },
    "paymentTerm": "text",
    "useAccountInvoiceBatchGroup": false,
    "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": 0,
        "name": "text",
        "charges": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "chargeNumber": "OPC-000001",
            "version": 0,
            "isLastVersion": false,
            "name": "text",
            "chargeType": {},
            "priceModel": {},
            "effectiveStartDate": "2024-12-22T11:31:27.644Z",
            "effectiveEndDate": "2024-12-22T11:31:27.644Z",
            "quantity": 0,
            "unitCode": "text",
            "startOn": {},
            "endOn": {},
            "chargedThroughDate": "2024-12-22T11:31:27.644Z",
            "lastRenewalDate": "2024-12-22T11:31:27.644Z",
            "lastPriceAdjustmentDate": "2024-12-22T11:31:27.644Z",
            "pricePeriod": {},
            "usageRating": {},
            "revenueRecognitionRule": "text",
            "billingDay": {},
            "specificBillingDay": 0,
            "billingPeriod": {},
            "billingTiming": {},
            "periodAlignment": {},
            "alignmentDate": "2024-12-22T11:31:27.644Z",
            "taxTemplate": "text",
            "taxIncluded": false,
            "createInvoiceLinesPerTier": false,
            "estimatedUsage": 0,
            "estimatedQuantity": 0,
            "remainingQuantity": 0,
            "orderedQuantity": 0,
            "remarks": "text",
            "accountsReceivableAccount": "text",
            "deferredRevenueAccount": "text",
            "recognizedRevenueAccount": "text",
            "changeState": {},
            "displayPrice": 0,
            "priceDetails": [
              {
                "tier": 0,
                "price": 0,
                "listPrice": 0,
                "description": "text",
                "fromQuantity": 0,
                "toQuantity": 0,
                "priceBase": {},
                "lineDiscountPercent": 0,
                "lineDiscountAmount": 0
              }
            ],
            "recurringMonthlyAmount": 0,
            "recurringMonthlyAmountBase": 0,
            "features": [
              {
                "code": "text",
                "description": "text"
              }
            ],
            "orderDiscounts": [
              {
                "orderDiscountId": "123e4567-e89b-12d3-a456-426614174000",
                "chargeId": "123e4567-e89b-12d3-a456-426614174000"
              }
            ],
            "externalERPId": "text",
            "externalCRMId": "text",
            "cmrr": {
              "amount": 0,
              "currencyCode": "text",
              "currencyConversionDate": "2024-12-22T11:31:27.644Z",
              "baseCurrencyAmount": 0,
              "baseCurrencyCode": "text"
            },
            "acv": {
              "amount": 0,
              "currencyCode": "text",
              "currencyConversionDate": "2024-12-22T11:31:27.644Z",
              "baseCurrencyAmount": 0,
              "baseCurrencyCode": "text"
            },
            "tcv": {
              "amount": 0,
              "currencyCode": "text",
              "currencyConversionDate": "2024-12-22T11:31:27.644Z",
              "baseCurrencyAmount": 0,
              "baseCurrencyCode": "text"
            },
            "emrr": {
              "amount": 0,
              "currencyCode": "text",
              "currencyConversionDate": "2024-12-22T11:31:27.644Z",
              "baseCurrencyAmount": 0,
              "baseCurrencyCode": "text"
            },
            "oneTimeFees": {
              "amount": 0,
              "currencyCode": "text",
              "currencyConversionDate": "2024-12-22T11:31:27.644Z",
              "baseCurrencyAmount": 0,
              "baseCurrencyCode": "text"
            },
            "orderProductId": "123e4567-e89b-12d3-a456-426614174000",
            "orderId": "123e4567-e89b-12d3-a456-426614174000",
            "chargeId": "123e4567-e89b-12d3-a456-426614174000",
            "created": "2024-12-22T11:31:27.644Z",
            "modified": "2024-12-22T11:31:27.644Z"
          }
        ],
        "externalERPId": "text",
        "externalCRMId": "text",
        "cmrr": {
          "amount": 0,
          "currencyCode": "text",
          "currencyConversionDate": "2024-12-22T11:31:27.644Z",
          "baseCurrencyAmount": 0,
          "baseCurrencyCode": "text"
        },
        "acv": {
          "amount": 0,
          "currencyCode": "text",
          "currencyConversionDate": "2024-12-22T11:31:27.644Z",
          "baseCurrencyAmount": 0,
          "baseCurrencyCode": "text"
        },
        "emrr": {
          "amount": 0,
          "currencyCode": "text",
          "currencyConversionDate": "2024-12-22T11:31:27.644Z",
          "baseCurrencyAmount": 0,
          "baseCurrencyCode": "text"
        },
        "oneTimeFees": {
          "amount": 0,
          "currencyCode": "text",
          "currencyConversionDate": "2024-12-22T11:31:27.644Z",
          "baseCurrencyAmount": 0,
          "baseCurrencyCode": "text"
        },
        "tcv": {
          "amount": 0,
          "currencyCode": "text",
          "currencyConversionDate": "2024-12-22T11:31:27.644Z",
          "baseCurrencyAmount": 0,
          "baseCurrencyCode": "text"
        },
        "created": "2024-12-22T11:31:27.644Z",
        "modified": "2024-12-22T11:31:27.644Z"
      }
    ],
    "milestones": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "orderId": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "description": "text",
        "milestoneDate": "2024-12-22T11:31:27.644Z",
        "plannedDate": "2024-12-22T11:31:27.644Z"
      }
    ],
    "orderDiscounts": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "orderId": "123e4567-e89b-12d3-a456-426614174000",
        "startOn": {},
        "endOn": {},
        "startDate": "2024-12-22T11:31:27.644Z",
        "endDate": "2024-12-22T11:31:27.644Z",
        "percent": 0,
        "discountType": {},
        "orderProductCharges": [
          {
            "orderDiscountId": "123e4567-e89b-12d3-a456-426614174000",
            "chargeId": "123e4567-e89b-12d3-a456-426614174000"
          }
        ],
        "onSpecificCharges": false
      }
    ],
    "currency": "text",
    "externalERPId": "text",
    "externalCRMId": "text",
    "currencyCodeToUseWhenInvoice": "text",
    "cmrr": {
      "amount": 0,
      "currencyCode": "text",
      "currencyConversionDate": "2024-12-22T11:31:27.644Z",
      "baseCurrencyAmount": 0,
      "baseCurrencyCode": "text"
    },
    "acv": {
      "amount": 0,
      "currencyCode": "text",
      "currencyConversionDate": "2024-12-22T11:31:27.644Z",
      "baseCurrencyAmount": 0,
      "baseCurrencyCode": "text"
    },
    "emrr": {
      "amount": 0,
      "currencyCode": "text",
      "currencyConversionDate": "2024-12-22T11:31:27.644Z",
      "baseCurrencyAmount": 0,
      "baseCurrencyCode": "text"
    },
    "oneTimeFees": {
      "amount": 0,
      "currencyCode": "text",
      "currencyConversionDate": "2024-12-22T11:31:27.644Z",
      "baseCurrencyAmount": 0,
      "baseCurrencyCode": "text"
    },
    "tcv": {
      "amount": 0,
      "currencyCode": "text",
      "currencyConversionDate": "2024-12-22T11:31:27.644Z",
      "baseCurrencyAmount": 0,
      "baseCurrencyCode": "text"
    }
  }
]

Change Subscription

POSThttps://api.sandbox.younium.com/Subscriptions/{id}/change

Authorization

oauth2

Path parameters

id*string (uuid)

Header parameters

Body

application/json

accountnullable all of

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

Example: "A-000001"

invoiceAccountnullable all of

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

Example: "A-000001"

descriptionnullable string

remarksnullable string

effectiveStartDatenullable string (date-time)

effectiveChangeDatenullable string (date-time)

effectiveEndDatenullable string (date-time)

orderDatenullable string (date-time)

noticePeriodDatenullable string (date-time)

lastRenewalDatenullable string (date-time)

subscriptionTypenullable all of

termnullable integer (int32)

renewalTermnullable integer (int32)

noticePeriodnullable integer (int32)

isAutoRenewednullable boolean

currencynullable all of

Allowed as string input: Code, Currency-Id.

Example: "SEK"

invoiceSeparatlynullable boolean

paymentTermnullable all of

Allowed as string input: Name, PaymentTerm-Id.

Example: "NET30"

orderPaymentMethodall of

yourReferencenullable string

ourReferencenullable string

yourOrderNumbernullable string

buyerReferencenullable string

externalERPIdnullable string

externalCRMIdnullable string

useAccountInvoiceBatchGroupnullable boolean

invoiceBatchGroupnullable all of

invoicingCurrencynullable string

productsnullable array of ChangeOrderProductRequest (object)

milestonesnullable array of SubscriptionMilestoneRequest (object)

orderDiscountsnullable array of OrderDiscountsRequest (object)

invoiceTemplateIdnullable string (uuid)

orderBillingPeriodnullable all of

setOrderBillingPeriodnullable boolean

customFieldsnullable object

Response

201400401403

New version of Subscription created.

Request

JavaScriptCurlPython

const response = await fetch('https://api.sandbox.younium.com/Subscriptions/{id}/change', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

400

{
  "type": "text",
  "title": "text",
  "status": 0,
  "detail": "text",
  "instance": "text"
}

Cancel Subscription

POSThttps://api.sandbox.younium.com/Subscriptions/cancel/{id}

Authorization

oauth2

Path parameters

id*string (uuid)

subscription id

Header parameters

Body

application/json

endDatenullable string (date-time)

Subscription end date

Example: "2024-12-31"

cancellationDate*string (date-time)

cancellationMode*all of

cancellationDatePerChargesnullable object

List of order product charge numbers and cancellation dates

Response

200400401403

Success

Request

JavaScriptCurlPython

const response = await fetch('https://api.sandbox.younium.com/Subscriptions/cancel/{id}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "cancellationDate": "2024-12-22T11:31:27.644Z",
      "cancellationMode": {}
    }),
});
const data = await response.json();

Response

400

{
  "type": "text",
  "title": "text",
  "status": 0,
  "detail": "text",
  "instance": "text"
}

Renew Subscription

POSThttps://api.sandbox.younium.com/Subscriptions/renew/{id}

Authorization

oauth2

Path parameters

id*string (uuid)

subscription id

Header parameters

Body

application/json

renewalTerm*integer (int32)

nextRenewalTerm*integer (int32)

Response

200400401403

Success

Request

JavaScriptCurlPython

const response = await fetch('https://api.sandbox.younium.com/Subscriptions/renew/{id}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "nextRenewalTerm": 0,
      "renewalTerm": 0
    }),
});
const data = await response.json();

Response

400

{
  "type": "text",
  "title": "text",
  "status": 0,
  "detail": "text",
  "instance": "text"
}

Revert Subscription

POSThttps://api.sandbox.younium.com/Subscriptions/revert/{id}

Authorization

oauth2

Path parameters

id*string (uuid)

subscription id

Header parameters

Response

200400401403

Success

Body

application/json

idnullable string (uuid)

messagenullable string

Request

JavaScriptCurlPython

const response = await fetch('https://api.sandbox.younium.com/Subscriptions/revert/{id}', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

200400

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

Activate Subscription

POSThttps://api.sandbox.younium.com/Subscriptions/activate/{id}

Authorization

oauth2

Path parameters

id*string (uuid)

Header parameters

Response

200400401403

Success

Body

application/json

idnullable string (uuid)

messagenullable string

Request

JavaScriptCurlPython

const response = await fetch('https://api.sandbox.younium.com/Subscriptions/activate/{id}', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

200400

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

Get Subscription Milestones

GEThttps://api.sandbox.younium.com/Subscriptions/{id}/milestones

Authorization

oauth2

Path parameters

id*string (uuid)

subscription id

Header parameters

Response

200400401403404

Success

Body

application/json

idstring (uuid)

orderIdstring (uuid)

namenullable string

descriptionnullable string

milestoneDatenullable string (date-time)

plannedDatenullable string (date-time)

Request

JavaScriptCurlPython

const response = await fetch('https://api.sandbox.younium.com/Subscriptions/{id}/milestones', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400404

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "orderId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "milestoneDate": "2024-12-22T11:31:27.644Z",
    "plannedDate": "2024-12-22T11:31:27.644Z"
  }
]

Set Subscription Milestone date

POSThttps://api.sandbox.younium.com/Subscriptions/milestones/set/{id}

Authorization

oauth2

Path parameters

id*string (uuid)

Subscription Milestone Id

Header parameters

Body

application/json

milestoneDate*string (date-time)

milestoneIdstring (uuid)

Response

200400401403

Success

Body

application/json

idstring (uuid)

orderIdstring (uuid)

namenullable string

descriptionnullable string

milestoneDatenullable string (date-time)

plannedDatenullable string (date-time)

Request

JavaScriptCurlPython

const response = await fetch('https://api.sandbox.younium.com/Subscriptions/milestones/set/{id}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "milestoneDate": "2024-12-22T11:31:27.644Z"
    }),
});
const data = await response.json();

Response

200400

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "orderId": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "milestoneDate": "2024-12-22T11:31:27.644Z",
  "plannedDate": "2024-12-22T11:31:27.644Z"
}

Edit and create OrderDiscounts

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

POSThttps://api.sandbox.younium.com/Subscriptions/{id}/OrderDiscounts

Authorization

oauth2

Path parameters

id*string (uuid)

Header parameters

Body

application/json

effectiveChangeDatenullable string (date-time)

orderDiscountsnullable array of OrderDiscountsRequest (object)

Response

200400401403

Success

Request

JavaScriptCurlPython

const response = await fetch('https://api.sandbox.younium.com/Subscriptions/{id}/OrderDiscounts', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

400

{
  "type": "text",
  "title": "text",
  "status": 0,
  "detail": "text",
  "instance": "text"
}

---