List subscriptions

GET

/api/tenant/{tenantId}/Subscriptions

curl --request GET \
  --url https://api.nimles.com/e-commerce/api/tenant/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/Subscriptions \
  --header 'Authorization: Bearer <token>'

• Production

Authorizations

• bearerAuth

Parameters

Path Parameters

tenantId

required

string format: uuid

Your tenant id.

Query Parameters

ids

Array<string>

workspaceId

string format: uuid

organizationId

string format: uuid

Responses

200

OK

Media typeapplication/json

object

fields

object

key

additional properties

string

data

Array<object>

nullable

object

fields

object

key

additional properties

object

value

required

nullable

valueType

string

nullable

accessibility

string

nullable

id

string format: uuid

relations

Array<object>

nullable

object

fields

object

key

additional properties

object

value

required

nullable

valueType

string

nullable

accessibility

string

nullable

id

string format: uuid

name

string

nullable

entityId

required

string format: uuid

entityType

required

string

>= 1 characters

relationType

required

string

>= 1 characters

tenantId

string format: uuid

nullable

resourceGroupId

string format: uuid

nullable

creatorId

string format: uuid

nullable

createdDate

string format: date-time

nullable

version

integer format: int32

nullable

lastModified

string format: date-time

nullable

workspaceId

string format: uuid

organizationId

string format: uuid

nullable

plan

string

nullable

status

string

nullable

seatCount

integer format: int32

billingOwnerId

string format: uuid

stripeSubscriptionId

string

nullable

stripeCustomerId

string

nullable

trialEndsAt

string format: date-time

nullable

currentPeriodEnd

string format: date-time

nullable

canceledAt

string format: date-time

nullable

cancelAtPeriodEnd

boolean

Example ^generated

{
  "data": [
    {
      "fields": {
        "additionalProperty": {
          "value": "example",
          "valueType": "example"
        }
      },
      "accessibility": "example",
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "relations": [
        {
          "fields": {
            "additionalProperty": {
              "value": "example",
              "valueType": "example"
            }
          },
          "accessibility": "example",
          "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
          "name": "example",
          "entityId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
          "entityType": "example",
          "relationType": "example"
        }
      ],
      "tenantId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "resourceGroupId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "creatorId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "createdDate": "2026-04-15T12:00:00Z",
      "version": 1,
      "lastModified": "2026-04-15T12:00:00Z",
      "workspaceId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "organizationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "plan": "example",
      "status": "example",
      "seatCount": 1,
      "billingOwnerId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "stripeSubscriptionId": "example",
      "stripeCustomerId": "example",
      "trialEndsAt": "2026-04-15T12:00:00Z",
      "currentPeriodEnd": "2026-04-15T12:00:00Z",
      "canceledAt": "2026-04-15T12:00:00Z",
      "cancelAtPeriodEnd": true
    }
  ]
}

401

Unauthorized: no bearer token, or one that is expired or not for this API.

403

Forbidden: the caller holds no role that allows this action at this scope. The body is empty, or a problem whose detail names the action.

Media typeapplication/json

An RFC 9457 problem.

object

detail

string

nullable

instance

string

nullable

status

integer format: int32

nullable

title

string

nullable

type

string

nullable

key

additional properties

Example ^generated

{
  "detail": "example",
  "instance": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}