Organizations

Get the organization's subscription

Returns the active plan with its name, status, billing period, and the plan features it includes. Admin or owner only — every other role gets a permission error and should read plan usage from /organization/meters/{eventName} instead.

get/organization/subscription

Request

  • Base URL: https://viral.app/api/v1
  • URL: https://viral.app/api/v1/organization/subscription
  • Auth: API key in header x-api-key

Response

OK

idstring required
createdAtstring date-time required
modifiedAtstring date-time nullable required
amountnumber required
currencystring required
currentPeriodStartstring date-time required
currentPeriodEndstring date-time nullable required
cancelAtPeriodEndboolean required
canceledAtstring date-time nullable required
startedAtstring date-time nullable required
endsAtstring date-time nullable required
endedAtstring date-time nullable required
customerIdstring required
productIdstring required
discountIdstring nullable required
checkoutIdstring nullable required
planNamestring nullable required

The subscribed plan's name.

featuresstring[] required

Plan features this subscription includes, out of dataRetention, apiAccess, customSyncSchedule, unlimitedVideoTracking. A feature not listed is not included.

Changes

No recorded changes to this operation across all 1 revision of this API.