Views:
Last updated: 12/5/2024 1:56:56 PM
This API is used to retrieve customer subscriptions which are under a specific partner (the API caller).
You can use the Customers :: Subscription :: Get API to get more information on the specified subscription, such as license seats.

Request

HTTP Request

[GET] /LMPI/v2.5/customers/subscriptions

Parameters

Name
Type
Description
Validation
Optional Parameters
created_start
date
The start date of the period you want to query.
Note
Note
If the created date of subscription is larger than created_start, and less than created_end, that record will be returned.
Exactly one of the date range [created_start, created_end] or [modified_start, modified_end] must be provided.
ISO 8601 standard with format "YYYY-MM-DDThh:mm:ssZ"
created_end
date
The end date of the period you want to query.
Note
Note
If the created date of subscription is larger than created_start, and less than created_end, that record will be returned.
Exactly one of the date range [created_start, created_end] or [modified_start, modified_end] must be provided.
ISO 8601 standard with format "YYYY-MM-DDThh:mm:ssZ"
modified_start
date
The modified start date of the period you want to query.
Note
Note
If the modified date of subscription is larger than modified_start, and less than modified_end, that record will be returned.
Exactly one of the date range [created_start, created_end] or [modified_start, modified_end] must be provided.
ISO 8601 standard with format "YYYY-MM-DDThh:mm:ssZ"
modified_end
date
The modified end date of the period you want to query.
Note
Note
If the modified date of subscription is larger than modified_start, and less than modified_end, that record will be returned.
Exactly one of the date range [created_start, created_end] or [modified_start, modified_end] must be provided.
ISO 8601 standard with format "YYYY-MM-DDThh:mm:ssZ"
page
integer
The page number you want to query.
Positive integer, default value: 1
limit
integer
The number of records per page.
Positive integer (1-100), default value: 25.

HTTP Request Example

[GET] https://{lmpi-fqdn}/LMPI/v2.5/customers/subscriptions?created_start=2021-12-03T10:13:00Z&created_end=2021-12-31T00:00:00Z

or

[GET] https://{lmpi-fqdn}/LMPI/v2.5/customers/subscriptions?modified_start=2021-12-03T10:13:00Z&modified_end=2021-12-31T00:00:00Z
Do not supply a request body with this method.

Response

Response

If successful, this method returns an HTTP 200 OK status code and a response body with the following structure:
{
    "paging": {
        "total": 2,
        "limit": 25,
        "page": 1
    },
    "subscriptions": [
        {
            "subscription_id": "XXXXX33-0372-4e05-8455-db84be2XXXX",
            "name": "Worry Free Monthly XXX",
            "enabled": true,
            "is_auto_renewal": true,
            "auto_renewal_month": 1,
            "service_plan_id": "XXXXXa91-c9a9-4b71-95db-fd95c2cbXXXX",
            "customer_id": "XXXXX538-b66c-40cd-bd60-1d3afa53XXXX"
        },
        {
            "subscription_id": "XXXXX1ee-8c5f-4309-aee7-fe525634XXXX",
            "name": "Worry Free Yearly XXX",
            "enabled": true,
            "is_auto_renewal": true,
            "auto_renewal_month": 24,
            "service_plan_id": "XXXXX20a-760a-4be7-b2fa-9c3c99ebXXXX",
            "customer_id": "XXXXX13d-e544-4fb6-91aa-60ec5c46XXXX"
        },
    ]
}
Name
Type
Description
Length
paging.total
integer
The total number of records.
Positive integer
paging.limit
integer
The number of records per page.
Positive integer
paging.page
integer
The current page number (1-max).
Positive integer
subscriptions[].subscription_id
string
The unique identifier of the subscription.
GUID format
subscriptions[].name
string
The display name of the service plan bound to the current subscription.
1-150 characters
subscriptions[].enabled
boolean
The status of the current subscription.
true/false
subscriptions[].is_auto_renewal
boolean
The status of automatic renewal.
Possible values include:
  • true: The current subscription will be renewed automatically when the license expires
  • false: Automatic renewal is disabled
true/false
subscriptions[].auto_renewal_month
integer
The number of month(s) that the current subscription has enabled automatic renewal for.
Positive integer (0-36)
subscriptions[].service_plan_id
string
The unique identifier of the service plan.
GUID format
subscriptions[].customer_id
string
The unique identifier of the customer company.
GUID format