Get all subscriptions

  • 1 minute(s) read
Prev Next
Get
/inventory/subscriptions

Returns the list of subscriptions.
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
thingId
string

Condition on thing id.

Exampleabcd1234
Responses
200

Successful operation.

Array of object
object
id
string

The subscription object identifier.

customerId
string

The customer identifier.

thingId
string

The thing identifier.

activationTimestamp
integer (int64)

The timestamp this subscription has been activated.

nextPaymentTimestamp
integer (int64)

The timestamp indicating how long the subscription is valid.

serviceLevelId
string

The identifier of the subscribed service-level in case of type equal to THING_SERVICE_LEVEL or CUSTOMER_SERVICE_LEVEL.

serviceId
string

The identifier of the subscribed service in case of type equal to THING_SERVICE, or CUSTOMER_SERVICE.

state
string

The subscription status.

freePeriodAlreadyUsed
boolean

The flag indicating whether the free period has already used.

type
string

The subscription type (THING_SERVICE_LEVEL, CUSTOMER_SERVICE_LEVEL, THING_SERVICE, CUSTOMER_SERVICE).

stripeSubscriptionId
string

The identifier of the Stripe subscription associated to this Subscription for automatic payment.

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