Subscriptions
Last updated
Last updated
Requires permission Order View
/Subscriptions/{id}
The subscription identifier
curl -L \
--url 'https://api.sandbox.younium.com/Subscriptions/{id}'
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"orderNumber": "text",
"version": 1,
"isLastVersion": true,
"status": "Draft",
"description": "text",
"remarks": "text",
"effectiveStartDate": "2025-02-07T10:17:37.522Z",
"effectiveEndDate": "2025-02-07T10:17:37.522Z",
"cancellationDate": "2025-02-07T10:17:37.522Z",
"effectiveChangeDate": "2025-02-07T10:17:37.522Z",
"orderDate": "2025-02-07T10:17:37.522Z",
"noticePeriodDate": "2025-02-07T10:17:37.522Z",
"lastRenewalDate": "2025-02-07T10:17:37.522Z",
"created": "2025-02-07T10:17:37.522Z",
"modified": "2025-02-07T10:17:37.522Z",
"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-02-07T10:17:37.522Z",
"effectiveEndDate": "2025-02-07T10:17:37.522Z",
"quantity": 1,
"unitCode": "text",
"startOn": "AlignToSubscription",
"endOn": "AlignToSubscription",
"chargedThroughDate": "2025-02-07T10:17:37.522Z",
"lastRenewalDate": "2025-02-07T10:17:37.522Z",
"lastPriceAdjustmentDate": "2025-02-07T10:17:37.522Z",
"pricePeriod": "Monthly",
"usageRating": "Sum",
"revenueRecognitionRule": "text",
"billingDay": "None",
"specificBillingDay": 1,
"billingPeriod": "Monthly",
"billingTiming": "InAdvance",
"periodAlignment": "None",
"alignmentDate": "2025-02-07T10:17:37.522Z",
"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-02-07T10:17:37.522Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"acv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-07T10:17:37.522Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"tcv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-07T10:17:37.522Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"emrr": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-07T10:17:37.522Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"oneTimeFees": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-07T10:17:37.522Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"orderProductId": "123e4567-e89b-12d3-a456-426614174000",
"orderId": "123e4567-e89b-12d3-a456-426614174000",
"chargeId": "123e4567-e89b-12d3-a456-426614174000",
"created": "2025-02-07T10:17:37.522Z",
"modified": "2025-02-07T10:17:37.522Z"
}
],
"customFields": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"externalERPId": "text",
"externalCRMId": "text",
"cmrr": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-07T10:17:37.522Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"acv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-07T10:17:37.522Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"emrr": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-07T10:17:37.522Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"oneTimeFees": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-07T10:17:37.522Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"tcv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-07T10:17:37.522Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"created": "2025-02-07T10:17:37.522Z",
"modified": "2025-02-07T10:17:37.522Z"
}
],
"milestones": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"orderId": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"description": "text",
"milestoneDate": "2025-02-07T10:17:37.522Z",
"plannedDate": "2025-02-07T10:17:37.522Z"
}
],
"orderDiscounts": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"orderId": "123e4567-e89b-12d3-a456-426614174000",
"startOn": "AlignToOrder",
"endOn": "AlignToOrder",
"startDate": "2025-02-07T10:17:37.522Z",
"endDate": "2025-02-07T10:17:37.522Z",
"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-02-07T10:17:37.522Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"acv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-07T10:17:37.522Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"emrr": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-07T10:17:37.522Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"oneTimeFees": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-07T10:17:37.522Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"tcv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-07T10:17:37.522Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
}
}
Success
/Subscriptions/{id}
curl -L \
--request PATCH \
--url 'https://api.sandbox.younium.com/Subscriptions/{id}' \
--header 'Content-Type: application/merge-patch+json' \
--data '{"invoiceBatchGroup":{},"customFields":{"ANY_ADDITIONAL_PROPERTY":"anything"}}'
No body
Success