Documentation Index

Fetch the complete documentation index at: https://learn.servitly.com/llms.txt

Use this file to discover all available pages before exploring further.

Get a subscription set

Prev Next
Get
/v2/identity/users/me/subscriptionSet

Returns the subscription set for a specific customer or partner.
Required permissions: READ_SUBSCRIPTION.

Security
HTTP
Type bearer
Header parameters
X-Servitly-Tenant
stringRequired

The name of the target tenant (e.g. acme).

Query parameters
customerId
string

Condition on customer id.

Exampleabcd1234
partnerId
string

Condition on partner id.

Exampleabcd1234
Responses
200

Successful operation.

Expand All
object
id
string

Unique identifier of the subscription.

Example68de40fc2f33393e618e5a57
type
string

Type of subscription owner entity.

Valid values[ "CUSTOMER", "PARTNER" ]
ExampleCUSTOMER
customerId
string

ID of the customer associated with the subscription.

Example661fa918281ccf25619dc5cc
partnerId
string

ID of the partner associated with the subscription (null for customer subscriptions).

Example661fa918281ccf25619dc5cc
activationTimestamp
integer (int64)

Unix timestamp (milliseconds) when the subscription was activated.

Example1759396092423
renewalTimestamp
integer (int64)

Unix timestamp (milliseconds) when the subscription is due for renewal.

Example1790932092423
duration
string

Duration of the subscription period.

Valid values[ "YEAR_1" ]
ExampleYEAR_1
subscriptionThings
Array of object (SubscriptionThing)

List of things (devices/assets) included in this subscription.

object
thingId
string

Unique identifier of the thing (device/asset).

Example6620e4a542541977c406b921
subscriptionPlan
object (SubscriptionPlan)
digitalServiceId
string

Identifier of the digital service representing the plan.

Example69b983f6162d293e457ba931
deactivating
boolean

Whether this plan is scheduled for deactivation.

ExampleFalse
subscriptionAddOns
Array of object (SubscriptionAddOn)

Add-ons applied to this specific thing.

object
digitalServiceId
string

Identifier of the digital service representing the add-on.

Example68de40642f33393e618e5a26
deactivating
boolean

Whether this add-on is scheduled for deactivation.

ExampleFalse
trialUnavailable
boolean

Whether a trial is unavailable for this thing.

ExampleTrue
subscriptionPlan
object (SubscriptionPlan)
digitalServiceId
string

Identifier of the digital service representing the plan.

Example69b983f6162d293e457ba931
deactivating
boolean

Whether this plan is scheduled for deactivation.

ExampleFalse
subscriptionAddOns
Array of object (SubscriptionAddOn)

Add-ons applied at the subscription level (null when activation mode is per-thing).

object
digitalServiceId
string

Identifier of the digital service representing the add-on.

Example68de40642f33393e618e5a26
deactivating
boolean

Whether this add-on is scheduled for deactivation.

ExampleFalse
status
string

Current status of the subscription.

Valid values[ "ACTIVE", "SUSPENDED" ]
ExampleACTIVE
renewalFee
number

Renewal fee amount.

Example0100-06-01T00:00:00Z
undiscountedRenewalFee
number

Renewal fee before any discount is applied.

Example120
paymentStatus
string

Current payment status.

Valid values[ "PENDING", "PAID" ]
ExamplePENDING
pendingPaymentCount
integer

Number of pending payments.

Example3
paymentMethod
object

Payment method identifier.

customerName
string

The name of the customer.

ExampleAbon Metal
partnerName
string

The name of the partner.

ExampleAllServices
expiringNotified
boolean

Whether an expiry notification has been sent.

trialUnavailable
boolean

Whether a trial is unavailable for this subscription.

discountPercentage
number

Discount percentage applied to the prices (0–100).

Example20
401

User not authenticated.

object
message
string

The error response.

ExampleUser not authenticated
403

User not authorized.

object
message
string

The error response.

ExampleUser not authorized
404

Resource was not found.

object
message
string

The error response.

ExampleResource not found
429

API call rate limit exeeded.

object
message
string

The error response.

ExampleAPI call rate limit exeeded
500

Internal server error.

object
message
string

The error response.

ExampleInternal Server Error