Organizations

Request billing settings

get/organizations/{organizationId}/billing-settings

Request

  • Base URL: https://api.xfa.tech
  • URL: https://api.xfa.tech/organizations/{organizationId}/billing-settings
  • Auth: HTTP bearer

Path parameters

organizationIdstring required

ID of Organization

Response

Returns the billing settings

OrganizationIDstring required

ID of the organization

InsightPricenumber double

Monthly price for insight

ConnectPricenumber double

Monthly price for connect

FreeDevicesinteger

Number of free devices

FreeUsersinteger

Number of free users for monthly invoices

TrialUserLimitinteger

Maximum number of distinct users visible during the trial. Defaults to 10 when omitted.

TrialEndDatestring

End date of the trial period (format: YYYYMMDD)

EndDatestring

End date (format: YYYYMMDD)

PerUserPricenumber double nullable

Monthly price per user

BlockedAccessboolean nullable

Whether access is blocked

TotalYearlyPricenumber double nullable

Total yearly price

NrOfYearlyLicensesinteger

Number of yearly licenses

BillExtraLicensesboolean

Whether to bill extra licenses

StartDatestring

Start date

Partnerstring

Partner name

PayingCustomerboolean

Whether the organization is a paying customer

Currency'EUR' | 'USD' | 'GBP'

Supported currencies

PaymentTermInDaysinteger

Payment term in days

PONumberstring

Purchase order number

MinimumMonthlyLicensesinteger

Minimum number of licenses to bill for monthly invoices

NrOfMonthlyLicensesinteger

Fixed number of licenses for monthly billing (enables fixed-license monthly billing instead of usage-based)

PerUserYearlyPricenumber double nullable

Annual price per user (alternative to TotalYearlyPrice for per-user yearly billing)

Changes

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