Subscriptions
get
Get subscription by id
Path parameters
idstring · uuidRequired
Header parameters
AuthorizationanyRequired
Legal-EntityanyRequired
Responses
200
OK
application/json
400
Bad Request
application/problem+json
403
Forbidden
application/problem+json
404
Not Found
application/problem+json
500
Internal Server Error
application/problem+json
get
GET /subscriptions/{id} HTTP/1.1
Host:
Accept: */*
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"created": "2025-10-08T19:36:33.858Z",
"modified": "2025-10-08T19:36:33.858Z",
"modifiedWithChildren": "2025-10-08T19:36:33.858Z",
"orderNumber": "text",
"version": 1,
"lastVersion": true,
"remarks": "text",
"status": "Draft",
"description": "text",
"effectiveStartDate": "2025-10-08",
"effectiveEndDate": "2025-10-08",
"effectiveChangeDate": "2025-10-08",
"cancellationDate": "2025-10-08",
"orderDate": "2025-10-08",
"noticePeriodDate": "2025-10-08",
"noticePeriod": 1,
"lastRenewalDate": "2025-10-08",
"term": 1,
"renewalTerm": 1,
"autoRenewed": true,
"termType": "Termed",
"paymentMethod": "Invoice",
"yourReference": "text",
"invoiceSeparately": true,
"ourReference": "text",
"yourOrderNumber": "text",
"buyerReference": "text",
"billingPeriod": "Monthly",
"setBillingPeriod": true,
"paymentTerm": "text",
"useAccountInvoiceBatchGroup": true,
"currency": "text",
"externalCRMId": "text",
"externalERPId": "text",
"invoiceCurrency": "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"
},
"account": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"accountNumber": "text",
"externalERPId": "text",
"externalCRMId": "text"
},
"invoiceAccount": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"accountNumber": "text",
"externalERPId": "text",
"externalCRMId": "text"
},
"invoiceBatchGroup": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"code": "text",
"description": "text"
},
"customFields": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"products": "text",
"milestones": "text",
"discounts": "text",
"metrics": "text"
}
get
Get subscription by order number
Path parameters
orderNumberstringRequired
Header parameters
AuthorizationanyRequired
Legal-EntityanyRequired
Responses
200
OK
application/json
400
Bad Request
application/problem+json
403
Forbidden
application/problem+json
404
Not Found
application/problem+json
500
Internal Server Error
application/problem+json
get
GET /subscriptions/{orderNumber} HTTP/1.1
Host:
Accept: */*
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"created": "2025-10-08T19:36:33.858Z",
"modified": "2025-10-08T19:36:33.858Z",
"modifiedWithChildren": "2025-10-08T19:36:33.858Z",
"orderNumber": "text",
"version": 1,
"lastVersion": true,
"remarks": "text",
"status": "Draft",
"description": "text",
"effectiveStartDate": "2025-10-08",
"effectiveEndDate": "2025-10-08",
"effectiveChangeDate": "2025-10-08",
"cancellationDate": "2025-10-08",
"orderDate": "2025-10-08",
"noticePeriodDate": "2025-10-08",
"noticePeriod": 1,
"lastRenewalDate": "2025-10-08",
"term": 1,
"renewalTerm": 1,
"autoRenewed": true,
"termType": "Termed",
"paymentMethod": "Invoice",
"yourReference": "text",
"invoiceSeparately": true,
"ourReference": "text",
"yourOrderNumber": "text",
"buyerReference": "text",
"billingPeriod": "Monthly",
"setBillingPeriod": true,
"paymentTerm": "text",
"useAccountInvoiceBatchGroup": true,
"currency": "text",
"externalCRMId": "text",
"externalERPId": "text",
"invoiceCurrency": "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"
},
"account": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"accountNumber": "text",
"externalERPId": "text",
"externalCRMId": "text"
},
"invoiceAccount": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"accountNumber": "text",
"externalERPId": "text",
"externalCRMId": "text"
},
"invoiceBatchGroup": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"code": "text",
"description": "text"
},
"customFields": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"products": "text",
"milestones": "text",
"discounts": "text",
"metrics": "text"
}
get
Get metrics by subscription id
Path parameters
idstring · uuidRequired
Header parameters
AuthorizationanyRequired
Legal-EntityanyRequired
Responses
200
OK
application/json
400
Bad Request
application/problem+json
403
Forbidden
application/problem+json
404
Not Found
application/problem+json
500
Internal Server Error
application/problem+json
get
GET /subscriptions/{id}/metrics HTTP/1.1
Host:
Accept: */*
{
"baseCurrencyCode": "text",
"currencyConversionDate": "2025-10-08T19:36:33.858Z",
"cmrr": {
"amount": 1,
"currency": "text",
"baseCurrencyAmount": 1
},
"emrr": {
"amount": 1,
"currency": "text",
"baseCurrencyAmount": 1
},
"carr": {
"amount": 1,
"currency": "text",
"baseCurrencyAmount": 1
},
"oneTimeFees": {
"amount": 1,
"currency": "text",
"baseCurrencyAmount": 1
},
"tcv": {
"amount": 1,
"currency": "text",
"baseCurrencyAmount": 1
}
}
get
Get subscriptions
Query parameters
subscriptionModifiedAfterstring · date-timeRequired
subscriptionModifiedBeforestring · date-timeRequired
pageSizeinteger · int32Optional
pageNumberinteger · int32Optional
statusstring · enumOptionalPossible values:
Header parameters
AuthorizationanyRequired
Legal-EntityanyRequired
Responses
200
OK
application/json
400
Bad Request
application/problem+json
403
Forbidden
application/problem+json
500
Internal Server Error
application/problem+json
get
GET /subscriptions?subscriptionModifiedAfter=2025-10-08T19%3A36%3A33.858Z&subscriptionModifiedBefore=2025-10-08T19%3A36%3A33.858Z HTTP/1.1
Host:
Accept: */*
{
"items": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"created": "2025-10-08T19:36:33.858Z",
"modified": "2025-10-08T19:36:33.858Z",
"modifiedWithChildren": "2025-10-08T19:36:33.858Z",
"orderNumber": "text",
"version": 1,
"lastVersion": true,
"remarks": "text",
"status": "Draft",
"description": "text",
"effectiveStartDate": "2025-10-08",
"effectiveEndDate": "2025-10-08",
"effectiveChangeDate": "2025-10-08",
"cancellationDate": "2025-10-08",
"orderDate": "2025-10-08",
"noticePeriodDate": "2025-10-08",
"noticePeriod": 1,
"lastRenewalDate": "2025-10-08",
"term": 1,
"renewalTerm": 1,
"autoRenewed": true,
"termType": "Termed",
"paymentMethod": "Invoice",
"yourReference": "text",
"invoiceSeparately": true,
"ourReference": "text",
"yourOrderNumber": "text",
"buyerReference": "text",
"billingPeriod": "Monthly",
"setBillingPeriod": true,
"paymentTerm": "text",
"useAccountInvoiceBatchGroup": true,
"currency": "text",
"externalCRMId": "text",
"externalERPId": "text",
"invoiceCurrency": "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"
},
"account": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"accountNumber": "text",
"externalERPId": "text",
"externalCRMId": "text"
},
"invoiceAccount": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"accountNumber": "text",
"externalERPId": "text",
"externalCRMId": "text"
},
"invoiceBatchGroup": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"code": "text",
"description": "text"
},
"customFields": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"products": "text",
"milestones": "text",
"discounts": "text",
"metrics": "text"
}
],
"nextPage": "text"
}
get
Get subscription products by subscription id
Path parameters
idstring · uuidRequired
Header parameters
AuthorizationanyRequired
Legal-EntityanyRequired
Responses
200
OK
application/json
400
Bad Request
application/problem+json
403
Forbidden
application/problem+json
404
Not Found
application/problem+json
500
Internal Server Error
application/problem+json
get
GET /subscriptions/{id}/subscription-products HTTP/1.1
Host:
Accept: */*
[
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"created": "2025-10-08T19:36:33.858Z",
"modified": "2025-10-08T19:36:33.858Z",
"modifiedWithChildren": "2025-10-08T19:36:33.858Z",
"orderId": "123e4567-e89b-12d3-a456-426614174000",
"productNumber": "text",
"chargePlanId": "123e4567-e89b-12d3-a456-426614174000",
"chargePlanName": "text",
"chargePlanNumber": "text",
"lineNumber": 1,
"name": "text",
"externalERPId": "text",
"externalCRMId": "text",
"customFields": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"charges": "text",
"metrics": "text"
}
]
get
Get milestones by subscription id
Path parameters
idstring · uuidRequired
Header parameters
AuthorizationanyRequired
Legal-EntityanyRequired
Responses
200
OK
application/json
400
Bad Request
application/problem+json
403
Forbidden
application/problem+json
404
Not Found
application/problem+json
500
Internal Server Error
application/problem+json
get
GET /subscriptions/{id}/milestones HTTP/1.1
Host:
Accept: */*
[
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"description": "text",
"milestoneDate": "2025-10-08",
"plannedDate": "2025-10-08"
}
]
get
Get discounts by subscription id
Path parameters
idstring · uuidRequired
Header parameters
AuthorizationanyRequired
Legal-EntityanyRequired
Responses
200
OK
application/json
400
Bad Request
application/problem+json
403
Forbidden
application/problem+json
404
Not Found
application/problem+json
500
Internal Server Error
application/problem+json
get
GET /subscriptions/{id}/discounts HTTP/1.1
Host:
Accept: */*
[
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"startOn": "AlignToOrder",
"endOn": "AlignToOrder",
"startDate": "2025-10-08",
"endDate": "2025-10-08",
"percent": 1,
"discountType": "Percent",
"onlySelectedCharges": true
}
]
Last updated
Was this helpful?