---
title: "Request billing settings"
method: GET
path: "/organizations/{organizationId}/billing-settings"
tags: ["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

- `organizationId` string, required

## Response `200`

Returns the billing settings

- BillingSettings
  - `OrganizationID` string, required: ID of the organization
  - `InsightPrice` number, double: Monthly price for insight
  - `ConnectPrice` number, double: Monthly price for connect
  - `FreeDevices` integer: Number of free devices
  - `FreeUsers` integer: Number of free users for monthly invoices
  - `TrialUserLimit` integer: Maximum number of distinct users visible during the trial. Defaults to 10 when omitted.
  - `TrialEndDate` string: End date of the trial period (format: YYYYMMDD)
  - `EndDate` string: End date (format: YYYYMMDD)
  - `PerUserPrice` number, double, nullable: Monthly price per user
  - `BlockedAccess` boolean, nullable: Whether access is blocked
  - `TotalYearlyPrice` number, double, nullable: Total yearly price
  - `NrOfYearlyLicenses` integer: Number of yearly licenses
  - `BillExtraLicenses` boolean: Whether to bill extra licenses
  - `StartDate` string: Start date
  - `Partner` string: Partner name
  - `PayingCustomer` boolean: Whether the organization is a paying customer
  - `PaymentPlan` PaymentPlan
    - `Name` string
    - `NrOfPolicies` integer
    - `NrOfDiscovery` integer
    - `AwarenessVerificationFrequency` 'daily' | 'weekly' | 'monthly' | 'quarterly' | 'none' | 'on-demand' | 'limited': Frequency interval
    - `AwarenessRiskFrequency` 'daily' | 'weekly' | 'monthly' | 'quarterly' | 'none' | 'on-demand' | 'limited': Frequency interval
    - `NrOfEnforcement` integer
    - `CustomIntegration` boolean
    - `AdminSecurityReports` 'daily' | 'weekly' | 'monthly' | 'quarterly' | 'none' | 'on-demand' | 'limited': Frequency interval
    - `Cves` boolean
    - `Mfa` boolean
    - `AdvancedMfa` boolean
    - `ExportToGRC` boolean
    - `ApplyDuringTrial` boolean
  - `Currency` 'EUR' | 'USD' | 'GBP': Supported currencies
  - `PaymentTermInDays` integer: Payment term in days
  - `PONumber` string: Purchase order number
  - `MinimumMonthlyLicenses` integer: Minimum number of licenses to bill for monthly invoices
  - `NrOfMonthlyLicenses` integer: Fixed number of licenses for monthly billing (enables fixed-license monthly billing instead of usage-based)
  - `PerUserYearlyPrice` number, double, nullable: Annual price per user (alternative to TotalYearlyPrice for per-user yearly billing)
  - `MidCycleLicenseAdditions` LicenseAddition[]: Unbilled or historical mid-cycle license additions
    - `AdditionID` string: Persisted billing-settings identifier for this license addition; add-license responses expose the same value as addition_id
    - `RequestID` string: Persisted client idempotency key for this license addition; add-license responses expose the same value as request_id
    - `AddedDate` string: Date when licenses were requested in legacy 20060102 or current 20060102T150405 format
    - `Quantity` integer: Number of licenses added
    - `PricePerLicense` number, double: Price per added license for the selected billing cycle
    - `Billed` boolean: Whether the addition has been invoiced
    - `SeatsApplied` boolean: Whether the added seats have been applied to the billing settings
    - `BillingCycle` 'monthly' | 'yearly'
    - `RequestedByEmail` string: Trusted email of the actor that requested the addition
    - `RequestedByUserID` string: Trusted user ID of the actor that requested the addition
  - `ScheduledSeatChange` SeatChange: A seat decrease scheduled for the next renewal (ScheduledSeatChange) or the last one that ended (LastSeatChange). seats_removed is what the renewal applies; target_seats is the target as of the request.
    - `requested_at` string
    - `request_id` string
    - `change_id` string
    - `requested_by_email` string
    - `requested_by_user_id` string
    - `effective_date` string
    - `status` string: One of scheduled, applied, canceled, superseded (stored) or blocked (only reported by a preview or a refused confirmation). billing_seat_change events also use warning.
    - `billing_cycle` 'monthly' | 'yearly'
    - `current_seats` integer
    - `seats_removed` integer
    - `target_seats` integer
    - `users_at_request` integer
    - `users_at_warning` integer
    - `warning_sent_at` string
    - `users_at_apply` integer
    - `seats_before_apply` integer
    - `seats_after_apply` integer
    - `ended_at` string
    - `pricing` SeatChangePricing: Per billing cycle: billed seats (seats less free users) times the unit price of the current cycle, before discounts and VAT.
      - `currency` 'EUR' | 'USD' | 'GBP': Supported currencies
      - `unit_price` number, float
      - `recurring_amount_now` number, float
      - `recurring_amount_after` number, float
  - `LastSeatChange` SeatChange: A seat decrease scheduled for the next renewal (ScheduledSeatChange) or the last one that ended (LastSeatChange). seats_removed is what the renewal applies; target_seats is the target as of the request.
    - `requested_at` string
    - `request_id` string
    - `change_id` string
    - `requested_by_email` string
    - `requested_by_user_id` string
    - `effective_date` string
    - `status` string: One of scheduled, applied, canceled, superseded (stored) or blocked (only reported by a preview or a refused confirmation). billing_seat_change events also use warning.
    - `billing_cycle` 'monthly' | 'yearly'
    - `current_seats` integer
    - `seats_removed` integer
    - `target_seats` integer
    - `users_at_request` integer
    - `users_at_warning` integer
    - `warning_sent_at` string
    - `users_at_apply` integer
    - `seats_before_apply` integer
    - `seats_after_apply` integer
    - `ended_at` string
    - `pricing` SeatChangePricing: Per billing cycle: billed seats (seats less free users) times the unit price of the current cycle, before discounts and VAT.
      - `currency` 'EUR' | 'USD' | 'GBP': Supported currencies
      - `unit_price` number, float
      - `recurring_amount_now` number, float
      - `recurring_amount_after` number, float

---

[API](https://skmtc.dev/xfa/apis/xfa-api.md) · [All operations](https://skmtc.dev/xfa/apis/xfa-api/llms.txt) · [OpenAPI document](https://skmtc.dev/xfa/apis/xfa-api/revisions/1a1be0e8972b?raw)