Get Subscription

GET

/tenant/{tenant}/subscription

const url = 'https://api.exolink.cloud/tenant/example/subscription';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.exolink.cloud/tenant/example/subscription \
  --header 'Authorization: Bearer <token>'

Retrieve tenant subscription information

Authorizations

bearerToken

Parameters

Path Parameters

tenant

required

string

Responses

200

Subscription information

application/json

Tenant subscription information

object

Subscription ID

integer

tenantId

Tenant ID

integer

productId

Product ID

integer

productName

Product name

string

productDisplayName

Product name as shown on receipts

string

productMetadata

Additional information for the product

object

status

Subscription status

string

Allowed values: active canceled expired

quantity

Subscription quantity

integer

stripeSubscriptionId

Stripe subscription ID

string

createdAt

string format: date-time

updatedAt

string format: date-time

Example

{
  "status": "active"
}