Skip to main content
GET
/
organisations
/
{organisation_id}
/
billing
Get Billing
curl --request GET \
  --url https://platform.versori.com/api/organisations/v1/organisations/{organisation_id}/billing
{
  "platformId": "<string>",
  "platformType": "<string>",
  "customerId": "<string>",
  "subscriptionId": "<string>",
  "billingEmail": "<string>",
  "recentSubscriptions": [
    {
      "id": "<string>",
      "status": "active",
      "rawData": "<any>"
    }
  ],
  "isSubscriptionActive": 123,
  "hasMoreSubscriptions": true,
  "freeTrialEndDate": "2023-12-25",
  "billingPeriodStart": "2023-12-25",
  "billingPeriodEnd": "2023-12-25",
  "isBespoke": true,
  "boardQuota": 123,
  "hubBoardQuota": 123
}

Path Parameters

​
organisation_id
string
required

Response

OK

Billing contains information about the billing status of an Organisation.

​
platformId
string
required

PlatformID is an internal identifier to link the Billing profile to Versori's underlying billing platform.

​
customerId
string
required

CustomerID is the identifier for the customer in the billing platform.

​
billingEmail
string
required

BillingEmail is the email address used for billing purposes, i.e. sending invoices. This does not take up a seat in the Organisation plan.

​
isSubscriptionActive
integer
required

IsSubscriptionActive is true if the Organisation has an active subscription, otherwise false. An active subscription is a valid subscription on a free trial or one that has up-to-date payment methods. A value of 1 means the subscription is active.

​
billingPeriodStart
string<date>
required

BillingPeriodStart is the start date of the current billing period. This is the date at which the current billing period started. This time should always be in UTC.

​
billingPeriodEnd
string<date>
required

BillingPeriodEnd is the end date of the current billing period. This is the date at which the current billing period ends. This time should always be in UTC.

​
platformType
string

PlatformType denotes which billing platform is used for this billing profile. Currently only "stripe" is supported, and can be used to infer data type of other objects which are not documented as part of this API. See Subscription#raw for an example.

​
subscriptionId
string

SubscriptionID is the identifier for the subscription in the billing platform. This is used to manage the subscription, i.e. update the subscription, cancel the subscription, etc.

​
recentSubscriptions
object[]

RecentSubscriptions is a list of subscriptions for the Organisation. This will only include the first 10 subscriptions, if there are more then the GetSubscriptions operation (to be implemented) should be used.

​
hasMoreSubscriptions
boolean

HasMoreSubscriptions is true if there are more subscriptions than the ones returned in RecentSubscriptions. These may only be retrieved using the GetSubscriptions operation (to be implemented).

​
freeTrialEndDate
string<date>

FreeTrialEndDate is the date at which the Organisation's free trial will end. This is only populated if the Organisation is currently on the free trial. This time should always be in UTC.

​
isBespoke
boolean

IsBespoke is true if the Organisation is on a bespoke plan, i.e. not using Stripe for billing.

​
boardQuota
integer

BoardQuota is the maximum number of Switchboard boards (NOT including hub boards) the Organisation is allowed to have. This is determined by the quantity of boards that are on the Organisation's subscription. It is also used to determine the amount of free executions and users that an organisation is allowed.

​
hubBoardQuota
integer

HubBoardQuota is the maximum number of Hub boards the Organisation is allowed to have. This is determined by the quantity of hub boards that are on the Organisation's subscription. It is also used to determine the amount of free executions and users that an organisation is allowed.

⌘I