Get Subscription

Request

Retrieve tenant subscription information

Security

bearerToken

Path

tenantstringrequired

curl -i -X GET \
  'https://docs.exolink.com/_mock/apis/exolink_api/tenant/{tenant}/subscription' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Subscription information

Bodyapplication/json

idinteger

Subscription ID

tenantIdinteger

Tenant ID

productIdinteger

Product ID

productNamestring

Product name

productDisplayNamestring

Product name as shown on receipts

productMetadataobject

Additional information for the product

statusstring

Subscription status

Enum:"active""canceled""expired"

quantityinteger

Subscription quantity

stripeSubscriptionIdstring

Stripe subscription ID

createdAtstring, (date-time)

updatedAtstring, (date-time)

Response

{
  "id": 0,
  "tenantId": 0,
  "productId": 0,
  "productName": "string",
  "productDisplayName": "string",
  "productMetadata": {},
  "status": "active",
  "quantity": 0,
  "stripeSubscriptionId": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}