orb-billing/resources/licenses/external-licenses.d.mts

The official TypeScript library for the Orb API

import { APIResource } from "../../core/resource.mjs";
import * as Shared from "../shared.mjs";
import { APIPromise } from "../../core/api-promise.mjs";
import { RequestOptions } from "../../internal/request-options.mjs";
export declare class ExternalLicenses extends APIResource {
    /**
     * Returns usage and remaining credits for a license identified by its external
     * license ID.
     *
     * Resolves the currently active license with this external ID, i.e. the license
     * whose active window contains the current time. An external license ID can map to
     * multiple licenses over time, so if none is currently active (deactivated, window
     * ended, or not yet started) this returns a 404. To fetch usage for a license
     * regardless of active state, use the endpoint that takes Orb's internal license
     * ID.
     *
     * Date range defaults to the current billing period if not specified.
     *
     * @example
     * ```ts
     * const response =
     *   await client.licenses.externalLicenses.getUsage(
     *     'external_license_id',
     *     {
     *       license_type_id: 'license_type_id',
     *       subscription_id: 'subscription_id',
     *     },
     *   );
     * ```
     */
    getUsage(externalLicenseID: string, query: ExternalLicenseGetUsageParams, options?: RequestOptions): APIPromise<ExternalLicenseGetUsageResponse>;
}
export interface ExternalLicenseGetUsageResponse {
    data: Array<ExternalLicenseGetUsageResponse.Data>;
    pagination_metadata: Shared.PaginationMetadata;
}
export declare namespace ExternalLicenseGetUsageResponse {
    /**
     * The LicenseUsage resource represents usage and remaining credits for a license
     * over a date range.
     *
     * When grouped by 'day' only, license_id and external_license_id will be null as
     * the data is aggregated across all licenses.
     */
    interface Data {
        /**
         * The total credits allocated to this license for the period.
         */
        allocated_credits: number;
        /**
         * The credits consumed by this license for the period.
         */
        consumed_credits: number;
        /**
         * The end date of the usage period.
         */
        end_date: string;
        /**
         * The unique identifier for the license type.
         */
        license_type_id: string;
        /**
         * The pricing unit for the credits (e.g., 'credits').
         */
        pricing_unit: string;
        /**
         * The remaining credits available for this license (allocated - consumed).
         */
        remaining_credits: number;
        /**
         * The start date of the usage period.
         */
        start_date: string;
        /**
         * The unique identifier for the subscription.
         */
        subscription_id: string;
        /**
         * Credits consumed while the license was active (eligible for individual
         * allocation deduction).
         */
        allocation_eligible_credits?: number | null;
        /**
         * The external identifier for the license. Null when grouped by day only.
         */
        external_license_id?: string | null;
        /**
         * The unique identifier for the license. Null when grouped by day only.
         */
        license_id?: string | null;
        /**
         * Credits consumed while the license was inactive (draws from shared pool, not
         * individual allocation).
         */
        shared_pool_credits?: number | null;
    }
}
export interface ExternalLicenseGetUsageParams {
    /**
     * The license type ID to filter licenses by.
     */
    license_type_id: string;
    /**
     * The subscription ID to get license usage for.
     */
    subscription_id: string;
    /**
     * Pagination cursor from a previous request.
     */
    cursor?: string | null;
    /**
     * End date for the usage period (YYYY-MM-DD). Defaults to end of current billing
     * period.
     */
    end_date?: string | null;
    /**
     * How to group the results. Valid values: 'license', 'day'. Can be combined (e.g.,
     * 'license,day').
     */
    group_by?: string | null;
    /**
     * Maximum number of rows in the response data (default 20, max 100).
     */
    limit?: number;
    /**
     * Start date for the usage period (YYYY-MM-DD). Defaults to start of current
     * billing period.
     */
    start_date?: string | null;
}
export declare namespace ExternalLicenses {
    export { type ExternalLicenseGetUsageResponse as ExternalLicenseGetUsageResponse, type ExternalLicenseGetUsageParams as ExternalLicenseGetUsageParams, };
}
//# sourceMappingURL=external-licenses.d.mts.map