@ale-rainbow/web-sdk 5.1.0

package/lib/models/subscription.model.d.ts

@@ -0,0 +1,592 @@
+/**
+ * @module Subscription
+ */
+/** Billing cycle for a subscription. Pending backend field — will be added. */
+export type ProductSubscriptionBillingCycle = "annual" | "monthly";
+/**
+ * Lifecycle status of a company subscription.
+ *
+ * `creating` | `active` | `alerting` (running, flagged by billing) | `hold` | `terminated` come
+ * from the backend. `trial` and `terminating` are the interface's own and are never sent — read
+ * {@link CompanySubscription.effectiveStatus} rather than `status` to see them.
+ */
+export type CompanySubscriptionStatus = "trial" | "creating" | "active" | "alerting" | "hold" | "terminating" | "terminated";
+/**
+ * A company subscription, as `GET .../companies/:companyId/subscriptions` (list) and
+ * `.../subscriptions/:subscriptionId` (single) return it — one shape for both.
+ *
+ * Field names mirror the payload 1:1, so the getters are what earns this a class: they carry what
+ * the raw fields mean once combined ({@link isCancelled}, {@link isRenewable}, …), so every screen
+ * answers those questions the same way. Writes go through the service.
+ */
+export declare class CompanySubscription {
+    /** Unique subscription identifier. */
+    readonly id: string;
+    /** Group/category name from the backend, e.g. "Webinar", "Collaboration". Shown in the UI and used for icon/category. */
+    readonly groupName: string;
+    /** Offer name from the backend, e.g. "Essential", "Business". */
+    readonly offerName: string;
+    /** Offer reference code from the backend, e.g. "RB-Essential", "RB-Webinar-Freemium". */
+    readonly offerReference: string;
+    /** Current lifecycle status. */
+    readonly status: CompanySubscriptionStatus;
+    /** Whether this subscription is a freemium (free trial) subscription. */
+    readonly isFreemium: boolean;
+    /** Whether this is the company's default subscription (e.g. the Essential base offer). */
+    readonly isDefault: boolean;
+    /** Product type for a freemium subscription, e.g. "collaboration", "webinar". Absent for non-freemium. */
+    readonly freemiumType?: string;
+    /** Backend billing model: `"none"`, `"nb_users"`, `"nb_services"`, `"usage"`, … */
+    readonly businessModel: string;
+    /** ISO-8601 — date the subscription was first created. Never changes. */
+    readonly startDate: string;
+    /** ISO-8601 — start of the current billing period. Updated on each renewal. */
+    readonly currentPeriodStart: string;
+    /** ISO-8601 — expiration / end date of the current period as returned by the backend. Absent for open-ended subscriptions. */
+    readonly expirationDate?: string;
+    /** Duration of one billing period in months. 1 = monthly, 12 = annual, 36 = 3-year. Absent on offers with no term. */
+    readonly durationMonths?: number;
+    /**
+     * Whether the subscription auto-renews. Only set by the backend on prepaid subscriptions,
+     * where `false` is what a cancellation leaves behind — see {@link isCancelled}. Written
+     * through `SubscriptionService.updateSubscription`.
+     */
+    autoRenew?: boolean;
+    /** Total number of licences purchased. */
+    readonly licensesTotal: number;
+    /** Number of licences currently assigned to users. */
+    readonly licensesUsed: number;
+    /** Amount (excl. tax, EUR) due at next renewal. Optional — not yet from the billing API. */
+    readonly nextBillingAmountHt?: number;
+    private constructor();
+    /** Builds a {@link CompanySubscription} from the backend payload. */
+    static createFromData(data: Partial<CompanySubscription>): CompanySubscription;
+    /**
+     * End date of the current billing period (ISO-8601, date only).
+     *
+     * Uses the backend {@link expirationDate} when present; otherwise derives it
+     * as `currentPeriodStart + durationMonths` (fallback for offers the backend
+     * does not yet date). Empty when neither is available.
+     */
+    get endDate(): string;
+    /**
+     * Whether the subscription has run past its end date.
+     *
+     * The single answer to "is this over?" — read it rather than comparing dates again, so every
+     * screen agrees on the same instant. It matters because the backend leaves a spent trial at
+     * `status: "trial"`: the date is what says it ended, not the status.
+     *
+     * Read live rather than resolved once, so a subscription that runs out while the app is open
+     * turns expired on its own.
+     *
+     * A subscription with no end date — the Essential base tier — never expires.
+     */
+    isExpired(): boolean;
+    /**
+     * Whether this subscription is billed monthly rather than on a prepaid term.
+     *
+     * A one-month period is the monthly plan; twelve months or more is a prepaid one. An absent
+     * duration reads as monthly, which is what the backend leaves on the offers carrying no term.
+     */
+    get isMonthly(): boolean;
+    /**
+     * Whether the subscription has been cancelled and is running out the period already paid for.
+     *
+     * The backend has no status for this, and the mark left behind differs by billing cycle
+     * because the two are cancelled through different calls:
+     * - **monthly** — deleting it leaves it `active` and stamps an {@link expirationDate} on it; a
+     *   cron terminates it once that date is reached. That date is the only mark, and it only reads
+     *   as one here, where a live monthly subscription otherwise carries none. A prepaid one always
+     *   has an expiration date — the end of its term, not a cancellation — so it cannot be read
+     *   the same way.
+     * - **prepaid** — cannot be deleted at all; it is cancelled by switching its renewal off, so
+     *   {@link autoRenew} at `false` *is* the cancellation. Absent, the subscription is assumed to
+     *   roll over, which is the standard contract — only an explicit `false` counts.
+     */
+    get isCancelled(): boolean;
+    /**
+     * Status as it should read, rather than as the backend spells it.
+     *
+     * A trial past its end date keeps `status: "trial"` server-side, so anything echoing the raw
+     * status claims the offer is still running. A cancelled monthly subscription stays `active`
+     * until the cron catches up, so it claims nothing happened at all. Every screen showing a
+     * status should read this.
+     */
+    get effectiveStatus(): CompanySubscriptionStatus;
+    /**
+     * Offer name as it should be shown, rather than as the catalog spells it.
+     *
+     * Free offers are named "<product> Freemium" server-side — billing vocabulary the interface
+     * never uses, where the word is "trial". The suffix is swapped rather than dropped, so the
+     * offer still reads as a free one wherever no badge says it.
+     */
+    get displayName(): string;
+    /**
+     * Whether this subscription's licences are seats, assigned one per user.
+     *
+     * Only these count towards "how many users can this company have": the `nb_services` offers
+     * (Webinar, and any other service-metered product) hold licences attached to the company
+     * itself, never assigned to anyone, so counting them would credit the company with seats no
+     * user can ever take. The base tier carries no business model of its own and is always a
+     * user tier.
+     *
+     * Mirrors the rule the legacy admin has always applied — `isDefault || nb_users || usage`.
+     */
+    get isUserLicense(): boolean;
+    /**
+     * Whether this is an internal offer granted for feature testing rather than sold.
+     *
+     * Today that is Beta alone. It is `nb_users` and carries a licence, so nothing but its
+     * reference tells it apart from a purchase — and counted as one it credits the company with a
+     * seat that exists for the tester, not for the company to hand out.
+     */
+    get isInternal(): boolean;
+    /**
+     * Whether the subscription is still serving its licences.
+     *
+     * A cancelled one counts until its last paid day: it is still billed and its seats are still
+     * assigned, so dropping it the moment it is cancelled would understate what the company has
+     * and could revoke seats users still hold.
+     */
+    get isServingLicenses(): boolean;
+    /**
+     * Whether the end date is a renewal or an ending.
+     *
+     * Only a live paid subscription rolls over. A trial is granted once, the Essential base tier
+     * has no term at all, a cancelled subscription runs to its date and stops, and an expired one
+     * is already over. Drives the wording around the end date — "renewal" promises a next period,
+     * and must not be said of a subscription that has none.
+     */
+    get isRenewable(): boolean;
+}
+/**
+ * How many user seats the company holds and how many are taken — the single answer to "can we
+ * still add a user?".
+ *
+ * Counts only the subscriptions whose licences are seats
+ * ({@link CompanySubscription.isUserLicense}): a service-metered offer such as Webinar holds its
+ * licences against the company, never against a user, so they grant nobody a place.
+ */
+export interface SeatUsage {
+    /** Seats assigned to users across every seat-based subscription still serving licences. */
+    readonly used: number;
+    /** Seats purchased across those same subscriptions. */
+    readonly total: number;
+    /** Seats left to assign — `total - used`, never negative. */
+    readonly available: number;
+    /** `used / total` as a rounded percentage; `0` when the company holds no seat at all. */
+    readonly occupancyPercent: number;
+}
+/**
+ * {@link SeatUsage} net of the invitations already sent — what may still be handed out right now.
+ *
+ * A pending invitation has not taken its seat yet ({@link SeatUsage.used} does not count it), but
+ * it will the moment it is accepted. Inviting on the seats it stands to take is how a company ends
+ * up with more accepted invitations than licences, each of them failing at acceptance time, long
+ * after the admin has left the screen.
+ */
+export interface SeatAvailability extends SeatUsage {
+    /** Invitations sent and not yet answered — each one holds a seat in reserve. */
+    readonly pendingInvitations: number;
+    /**
+     * Seats that may still be offered — `total - used - pendingInvitations`, never negative.
+     *
+     * Narrower than {@link SeatUsage.available}, which this shadows: that one answers "how many
+     * seats are unassigned", this one "how many people may I still invite".
+     */
+    readonly available: number;
+}
+/**
+ * Where the account stands commercially: what it runs, and whether it can be sold anything.
+ *
+ * Read from the subscriptions, never from the trial roles — those are rebuilt from the
+ * never-cleared `freemiumTypes` and survive both the trial's end and a purchase.
+ *
+ * Says nothing about which features are unlocked: `webinar_host`, the capabilities and
+ * `Company.hasWebinarAccess()` already answer that, and a paid customer has no trial role at all.
+ */
+export interface CommercialState {
+    /** Where the trial stands. `none` covers "never had one" and "no longer returned". */
+    readonly trial: "none" | "running" | "expired";
+    /** A paid subscription is live — nothing left for the offer catalog to sell. */
+    readonly hasPaid: boolean;
+    /** Whether this user may buy: a company admin, or a standalone buying for themselves. */
+    readonly canBuy: boolean;
+}
+/**
+ * The company's trial, as the interface needs to talk about it: how long is left, whether it is
+ * over, and whether there is still anything to upsell.
+ *
+ * Exists so that "should we show the trial banner?" is answered once, here, rather than by each
+ * screen re-combining the trial, the paid subscriptions and the user's own flags its own way — the
+ * banner is shown in several places and they must all agree.
+ *
+ * The getters read the clock on each access, so a status held by a screen left open overnight
+ * answers for the day it is read. Callers still re-render for the number on screen to change.
+ */
+export declare class TrialStatus {
+    /** The trial this status describes — the running one, or the last to have ended. */
+    readonly subscription: CompanySubscription;
+    /** When the trial ends, or ended. */
+    readonly endDate: Date;
+    /**
+     * Whether the company runs a live paid subscription alongside the trial. Resolved with the
+     * trial so the two cannot disagree.
+     */
+    readonly hasLivePaidSubscription: boolean;
+    /**
+     * Whether the user may act on an upsell: only a company administrator can subscribe.
+     * Site, organization and support admins carry the ADMIN role too but must not get the CTA.
+     *
+     * Deliberately narrower than {@link CommercialState.canBuy}, which also counts the
+     * standalone users of the default company. Widening it would hand the banner's CTA to a
+     * population that does not have it today.
+     */
+    readonly canSubscribe: boolean;
+    constructor(
+    /** The trial this status describes — the running one, or the last to have ended. */
+    subscription: CompanySubscription, 
+    /** When the trial ends, or ended. */
+    endDate: Date, 
+    /**
+     * Whether the company runs a live paid subscription alongside the trial. Resolved with the
+     * trial so the two cannot disagree.
+     */
+    hasLivePaidSubscription: boolean, 
+    /**
+     * Whether the user may act on an upsell: only a company administrator can subscribe.
+     * Site, organization and support admins carry the ADMIN role too but must not get the CTA.
+     *
+     * Deliberately narrower than {@link CommercialState.canBuy}, which also counts the
+     * standalone users of the default company. Widening it would hand the banner's CTA to a
+     * population that does not have it today.
+     */
+    canSubscribe: boolean);
+    /** Whether the trial has run past its end date. Delegated, so every screen agrees. */
+    get isExpired(): boolean;
+    /**
+     * Which product the trial is for — `"webinar"`, `"collaboration"`, … — so the interface names it
+     * rather than saying "your trial offer" while the company runs two. It is this trial's product,
+     * never the company's as a whole, which is what makes the day count readable.
+     *
+     * `undefined` when the backend omits `freemiumType`: fall back to the unnamed wording.
+     */
+    get productType(): string | undefined;
+    /**
+     * Whole days left before the trial ends, floored at 0 once it has.
+     *
+     * Rounded up, so the last partial day still reads as one day left rather than none.
+     */
+    get remainingDays(): number;
+    /**
+     * Whether there is still an upsell worth showing.
+     *
+     * A running trial always is — it has an end date the user needs to see coming — whatever else
+     * the company bought. Once expired, it only is while the company has no live paid subscription:
+     * an expired trial next to a purchase is a finished story.
+     *
+     * Says nothing about who is looking — read {@link canSubscribe} for the CTA.
+     */
+    get shouldPromptUpsell(): boolean;
+}
+/**
+ * A subscription offer from the catalog, as returned by `GET /offers?format=full` — the single
+ * catalog type for the whole tunnel, freemium self-subscribe and paid checkout alike.
+ *
+ * Fields come straight from the payload; only {@link cycle} and the two price fields are derived,
+ * by the service's offer mapper.
+ */
+export interface SubscriptionOffer {
+    /** The unique identifier of the offer. */
+    readonly id: string;
+    /** Whether this offer is a freemium (free trial) offer. */
+    readonly isFreemium: boolean;
+    /** The freemium product type from the backend, e.g. `"webinar"`, `"collaboration"`. */
+    readonly freemiumType: string;
+    /**
+     * Product group this offer belongs to (e.g. "Collaboration", "Webinar",
+     * "Enterprise"). Offers sharing a group are the same product in different
+     * billing cycles and collapse into one card.
+     */
+    readonly groupName?: string;
+    /**
+     * Billing cycle derived from `isMonthly`: `"monthly"` or `"annual"`
+     * (1-year prepaid). Undefined for freemium offers (no billing).
+     */
+    readonly cycle?: ProductSubscriptionBillingCycle;
+    /** Display name. */
+    readonly name?: string;
+    /** Monthly price (HT), flattened from the backend `prices[].unitPricePerMonth`. */
+    readonly monthlyPriceHt?: number;
+    /** Annual/total price (HT), flattened from the backend `prices[].unitPriceTotal` (prepaid offers). */
+    readonly annualPriceHt?: number;
+    [key: string]: unknown;
+}
+/**
+ * One product variant within a group — one card. A variant always carries at least one of
+ * `monthly` or `annual`; {@link trial} is an additional property of that same variant, not a
+ * variant of its own. At most one variant per group carries a trial, and it is the cheapest one.
+ *
+ * @example
+ * // Webinar 120, the cheapest of its group: monthly = RB-Webinar-120,
+ * // annual = RB-Webinar-120-1Y, trial = RB-Webinar-Freemium
+ * // Webinar 500: monthly = RB-Webinar-500, annual = RB-Webinar-500-1Y
+ */
+export interface OfferVariant {
+    /**
+     * Stable identity of the variant within its group — the offer reference stripped of its
+     * billing-cycle suffix (e.g. `"RB-Webinar-120"`, `"RB-Webinar-Freemium"`).
+     *
+     * Use it as the tracking key when rendering a list: {@link label} is derived from the offer
+     * name and can collide across groups, the offer reference cannot.
+     */
+    readonly key: string;
+    /**
+     * Human-readable variant label (e.g. "Webinar Pro", "Enterprise") — the catalog's offer name
+     * less its billing-cycle suffix; a trial shows its group name instead. Owned by the backend,
+     * so never derive anything from its shape.
+     */
+    readonly label: string;
+    /** Monthly billing offer, if available. */
+    readonly monthly?: SubscriptionOffer;
+    /** Annual (prepaid) billing offer, if available. */
+    readonly annual?: SubscriptionOffer;
+    /**
+     * Free-trial offer attached to this variant — the same product, free for a month. Set on the
+     * cheapest paid variant of the group, which is precisely what the trial gives away, so the two
+     * are one card rather than two. Absent means the trial is spent or unavailable.
+     *
+     * Carries no price and no billing cycle: read it only for what the call to action subscribes to.
+     */
+    readonly trial?: SubscriptionOffer;
+    /**
+     * Whether the company already runs a live subscription to {@link monthly}.
+     *
+     * Set per billing cycle rather than per variant: owning the monthly offer does not
+     * prevent buying the annual prepaid one of the same product, so the UI must be able
+     * to disable one cycle while keeping the other purchasable.
+     */
+    readonly ownedMonthly?: boolean;
+    /** Whether the company already runs a live subscription to {@link annual}. See {@link ownedMonthly}. */
+    readonly ownedAnnual?: boolean;
+}
+/**
+ * A product group (e.g. "Webinar", "Collaboration") with all its purchasable variants.
+ * The UI renders one card per variant; the billing-cycle switch selects which offer to subscribe to.
+ */
+export interface OfferGroup {
+    /** Group name as returned by the backend (e.g. `"Webinar"`, `"Collaboration"`). */
+    readonly groupName: string;
+    /** All purchasable variants in this group (e.g. Webinar 120, Webinar 500…). */
+    readonly variants: OfferVariant[];
+}
+/** The result returned after subscribing to an offer. */
+export interface SubscriptionResult {
+    /** The current status of the subscription. */
+    readonly status: CompanySubscriptionStatus;
+    /** Whether Business Store / Zuora provisioning is still running. */
+    readonly syncOngoing?: boolean;
+    /** Whether this subscription includes webinar capabilities. */
+    readonly hasWebinar: boolean;
+    [key: string]: unknown;
+}
+/**
+ * Purchase options required when subscribing to a paid offer.
+ * Not used for freemium offers (which are free and have no billing).
+ */
+export interface PurchaseOptions {
+    readonly cycle: ProductSubscriptionBillingCycle;
+    readonly seats: number;
+    /**
+     * Zuora payment method id, routing the purchase to `POST .../subscriptions/purchase` — the
+     * only endpoint that converts the company to direct-sell, which the backend requires before
+     * it accepts any subscription. Send it even when the Zuora account exists: the endpoint reuses
+     * the account rather than creating a second one.
+     *
+     * Omit it only for a company already sold direct, where `POST .../subscriptions` is enough.
+     */
+    readonly paymentMethodId?: string;
+    /** Company VAT number, when eligible. Forwarded to the atomic purchase endpoint. */
+    readonly vatNumber?: string;
+    /** French SIRET, when applicable. Forwarded to the atomic purchase endpoint. */
+    readonly siret?: string;
+    /** Electronic billing address. Forwarded to the atomic purchase endpoint. */
+    readonly electronicAddress?: string;
+    /**
+     * Buyer's purchase order number, printed on the invoice so their accounting can match it
+     * against an internal commitment.
+     *
+     * Per-order and optional, unlike the fields above: it is captured at checkout rather than
+     * read back from the company billing info, and is therefore forwarded to **both**
+     * subscription-creation endpoints — the atomic purchase and the existing-account one.
+     */
+    readonly purchaseOrderNumber?: string;
+}
+/**
+ * Fields accepted by `PUT .../companies/:companyId/subscriptions/:subscriptionId`. Only the keys
+ * present are sent; the backend leaves the rest untouched.
+ *
+ * No payment field on purpose: the billing consequence (pro-rata charge now, or adjustment at
+ * renewal) is decided server-side.
+ */
+export interface UpdateSubscriptionPatch {
+    /** New **absolute total** number of licences, not a delta: 10 → 15 seats sends `15`. */
+    readonly maxNumberUsers?: number;
+    /** Enables or disables auto-renewal at the end of the current period. */
+    readonly autoRenew?: boolean;
+    /**
+     * Buyer's purchase order number, printed on the invoice. Optional, and per-order like the one
+     * on {@link PurchaseOptions}: adding seats raises a charge of its own, which the buyer's
+     * accounting has to match just the same.
+     */
+    readonly purchaseOrderNumber?: string;
+}
+/**
+ * Options accepted by `POST .../companies/:companyId/quotations` when pricing a
+ * change to an **existing** subscription.
+ *
+ * {@link SubscriptionService.getOfferQuotation} prices a catalog offer on the same endpoint.
+ *
+ * Prepaid-specific options (`prepaidDuration`, `prepaidRenewalOption`,
+ * `renewalVolume`, `renewalTerm`, `autoRenewToMonthly`) exist in the API but are
+ * not modelled here — the seat-change flow only quotes monthly subscriptions.
+ */
+export interface SubscriptionQuotationOptions {
+    /** New absolute total number of licences to price. */
+    readonly maxNumberUsers: number;
+}
+/**
+ * One charge of a quotation's invoice.
+ *
+ * Only the fields a screen reads are declared; the rest of the Zuora item (`chargeName`,
+ * `productName`, `productRatePlanChargeId`, `unitOfMeasure`…) reaches the caller through the
+ * index signature.
+ */
+export interface SubscriptionQuotationInvoiceItem {
+    /** Amount charged, excluding tax. */
+    readonly chargeAmount?: number;
+    /** Tax on this charge. */
+    readonly taxAmount?: number;
+    /** Number of units billed. */
+    readonly quantity?: number;
+    /** First day of the period this charge covers, `yyyy-mm-dd`. */
+    readonly serviceStartDate?: string;
+    /** Last day of the period this charge covers, `yyyy-mm-dd`. The renewal falls the day after. */
+    readonly serviceEndDate?: string;
+    readonly [key: string]: unknown;
+}
+/**
+ * A price quote returned by `POST .../companies/:companyId/quotations`.
+ *
+ * Every field is optional: the backend answers a different subset per offer, so treat an absent
+ * one as "do not show that row" rather than as licence to compute a stand-in.
+ *
+ * **Read the amount that matches the cycle, and never `contractedMrr` alone.** An annual offer
+ * answers *both* families, and its `contractedMrr` is the equivalent monthly rate, not what is
+ * charged: quoting one seat of a 588 €/year offer returns `contractedMrr: 49` alongside
+ * `totalContractedValue: 588`. Showing the 49 as the price is a factor-12 error. A monthly offer
+ * answers `contractedMrr` with `totalContractedValue: null`, which is how the two are told apart.
+ *
+ * `amountWithoutTax` / `amount` are what is actually charged now, tax excluded and included.
+ * On a first purchase they equal the recurring figure, there being no proration to apply.
+ *
+ * Tax-inclusive amounts come from the backend (`contractedMrrWithTax`,
+ * `totalContractedValueWithTax`, `amount`): never derive one from {@link taxRate}, which is wrong
+ * outside France and for reverse-charge accounts.
+ *
+ * The index signature stays: it remains the contract for anything not declared here — see the
+ * subscription API doc, and declare whatever a screen starts reading.
+ */
+export interface SubscriptionQuotation {
+    /** ISO 4217 currency code, e.g. `"EUR"`. Absent on some backends — default to `"EUR"`. */
+    readonly currency?: string;
+    /**
+     * Monthly recurring amount.
+     *
+     * The figure to show on a monthly offer. On an annual one it is the *equivalent* monthly rate
+     * — 49 against a 588 €/year contract — never the amount charged; show
+     * {@link totalContractedValue} there and keep this for a "x €/month, billed yearly" caption.
+     */
+    readonly contractedMrr?: number;
+    /** Monthly public price, before any discount. */
+    readonly contractedWpl?: number;
+    /**
+     * Monthly recurring amount after the change, tax included.
+     *
+     * Backend-computed: never derive it from {@link taxRate}, which is wrong outside France and
+     * for reverse-charge accounts. Absent means "show no tax-inclusive line".
+     *
+     * Answered on both monthly and annual offers; mirrors {@link contractedMrr}, so on an annual
+     * offer it is likewise an equivalent monthly rate.
+     */
+    readonly contractedMrrWithTax?: number;
+    /** Signed change in the monthly recurring amount. Not rendered by the legacy UI. */
+    readonly totalDeltaMrr?: number;
+    /**
+     * Total contracted value — the figure to show on an annual or prepaid offer.
+     *
+     * `null` on a monthly one, which is how a payload is told apart from an annual one.
+     */
+    readonly totalContractedValue?: number;
+    /** Total public price of the contract, before any discount. */
+    readonly totalWplValue?: number;
+    /**
+     * Total contracted value, tax included. Backend-computed, same caveat as
+     * {@link contractedMrrWithTax}: never derive it from {@link taxRate}.
+     */
+    readonly totalContractedValueWithTax?: number;
+    /** Signed change in the total contracted value. Rendered with an explicit `+` when positive. */
+    readonly totalDeltaTcv?: number;
+    /**
+     * When the contract ends. Answered on annual and prepaid offers, absent on monthly ones.
+     *
+     * A full ISO timestamp (`2027-09-14T00:00:00.000Z`), unlike the other dates here.
+     */
+    readonly expirationDate?: string;
+    /** Discount applied: per month on a monthly subscription, total on a prepaid one. */
+    readonly totalDiscountedValue?: number;
+    /** Date the discounted price stops applying, `yyyy-mm-dd`. */
+    readonly discountEndDate?: string;
+    /** What is charged now, tax included. */
+    readonly amount?: number;
+    /** What is charged now, excluding tax. */
+    readonly amountWithoutTax?: number;
+    /**
+     * Tax on the invoice. The only trustworthy tax figure: never derive one from a rate, which is
+     * wrong outside France and for reverse-charge accounts. Absent means "show no tax row".
+     */
+    readonly taxAmount?: number;
+    /**
+     * Tax rate applied, as a percentage — `20` for 20%.
+     *
+     * Informative only: never compute a tax or a gross amount from it, for the reason given on
+     * {@link taxAmount}. Read the backend's own tax-inclusive figures instead.
+     */
+    readonly taxRate?: number;
+    /** Date through which charges are calculated on the invoice, `yyyy-mm-dd`. */
+    readonly invoiceTargetDate?: string;
+    /**
+     * The charges making up the invoice — **the charge being raised now, not a future schedule**.
+     *
+     * A new subscription answers a single item whose `chargeAmount` equals
+     * {@link amountWithoutTax}; its `serviceStartDate`/`serviceEndDate` are the period that
+     * payment covers, and the renewal falls the day after `serviceEndDate`.
+     */
+    readonly invoiceItems?: readonly SubscriptionQuotationInvoiceItem[];
+    readonly [key: string]: unknown;
+}
+/**
+ * Outcome of a purchase, as the checkout screen needs to read it: did provisioning settle, and in
+ * what state did the subscription land.
+ *
+ * Deliberately not a receipt. The creation endpoints answer the subscription, not a total, and the
+ * checkout prices the order itself from the offer and the seat count — anything computed here would
+ * be a second, unreconciled source of truth.
+ */
+export interface SubscriptionPurchaseOrder {
+    /** Status at creation time; `creating` until provisioning completes. */
+    readonly status: CompanySubscriptionStatus;
+    /** `true` while Business Store / Zuora provisioning runs: the purchase is not settled yet. */
+    readonly syncOngoing: boolean;
+}
+//# sourceMappingURL=subscription.model.d.ts.map

package/lib/models/subscription.model.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"subscription.model.d.ts","sourceRoot":"","sources":["../../src/models/subscription.model.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,+EAA+E;AAC/E,MAAM,MAAM,+BAA+B,GAAG,QAAQ,GAAG,SAAS,CAAC;AAEnE;;;;;;GAMG;AACH,MAAM,MAAM,yBAAyB,GAAG,OAAO,GAAG,UAAU,GAAG,QAAQ,GAAG,UAAU,GAAG,MAAM,GAAG,aAAa,GAAG,YAAY,CAAC;AAS7H;;;;;;;GAOG;AACH,qBAAa,mBAAmB;IAC5B,sCAAsC;IACtC,SAAgB,EAAE,EAAE,MAAM,CAAM;IAChC,yHAAyH;IACzH,SAAgB,SAAS,EAAE,MAAM,CAAM;IACvC,iEAAiE;IACjE,SAAgB,SAAS,EAAE,MAAM,CAAM;IACvC,yFAAyF;IACzF,SAAgB,cAAc,EAAE,MAAM,CAAM;IAC5C,gCAAgC;IAChC,SAAgB,MAAM,EAAE,yBAAyB,CAAY;IAC7D,yEAAyE;IACzE,SAAgB,UAAU,EAAE,OAAO,CAAS;IAC5C,0FAA0F;IAC1F,SAAgB,SAAS,EAAE,OAAO,CAAS;IAC3C,0GAA0G;IAC1G,SAAgB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtC,mFAAmF;IACnF,SAAgB,aAAa,EAAE,MAAM,CAAU;IAC/C,yEAAyE;IACzE,SAAgB,SAAS,EAAE,MAAM,CAAM;IACvC,+EAA+E;IAC/E,SAAgB,kBAAkB,EAAE,MAAM,CAAM;IAChD,8HAA8H;IAC9H,SAAgB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxC,sHAAsH;IACtH,SAAgB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxC;;;;OAIG;IACI,SAAS,CAAC,EAAE,OAAO,CAAC;IAC3B,0CAA0C;IAC1C,SAAgB,aAAa,EAAE,MAAM,CAAK;IAC1C,sDAAsD;IACtD,SAAgB,YAAY,EAAE,MAAM,CAAK;IACzC,4FAA4F;IAC5F,SAAgB,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7C,OAAO;IAYP,qEAAqE;WACvD,cAAc,CAAC,IAAI,EAAE,OAAO,CAAC,mBAAmB,CAAC,GAAG,mBAAmB;IAIrF;;;;;;OAMG;IACH,IAAW,OAAO,IAAI,MAAM,CAQ3B;IAED;;;;;;;;;;;OAWG;IACI,SAAS,IAAI,OAAO;IAc3B;;;;;OAKG;IACH,IAAW,SAAS,IAAI,OAAO,CAE9B;IAED;;;;;;;;;;;;;OAaG;IACH,IAAW,WAAW,IAAI,OAAO,CAQhC;IAED;;;;;;;OAOG;IACH,IAAW,eAAe,IAAI,yBAAyB,CAMtD;IAED;;;;;;OAMG;IACH,IAAW,WAAW,IAAI,MAAM,CAG/B;IAED;;;;;;;;;;OAUG;IACH,IAAW,aAAa,IAAI,OAAO,CAIlC;IAED;;;;;;OAMG;IACH,IAAW,UAAU,IAAI,OAAO,CAE/B;IAED;;;;;;OAMG;IACH,IAAW,iBAAiB,IAAI,OAAO,CAEtC;IAED;;;;;;;OAOG;IACH,IAAW,WAAW,IAAI,OAAO,CAYhC;CACJ;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,SAAS;IACtB,2FAA2F;IAC3F,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,uDAAuD;IACvD,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,6DAA6D;IAC7D,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,yFAAyF;IACzF,QAAQ,CAAC,gBAAgB,EAAE,MAAM,CAAC;CACrC;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,gBAAiB,SAAQ,SAAS;IAC/C,gFAAgF;IAChF,QAAQ,CAAC,kBAAkB,EAAE,MAAM,CAAC;IACpC;;;;;OAKG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;CAC9B;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,eAAe;IAC5B,sFAAsF;IACtF,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,GAAG,SAAS,CAAC;IAC/C,gFAAgF;IAChF,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,yFAAyF;IACzF,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;CAC5B;AAED;;;;;;;;;;GAUG;AACH,qBAAa,WAAW;IAEhB,oFAAoF;aACpE,YAAY,EAAE,mBAAmB;IACjD,qCAAqC;aACrB,OAAO,EAAE,IAAI;IAC7B;;;OAGG;aACa,uBAAuB,EAAE,OAAO;IAChD;;;;;;;OAOG;aACa,YAAY,EAAE,OAAO;;IAjBrC,oFAAoF;IACpE,YAAY,EAAE,mBAAmB;IACjD,qCAAqC;IACrB,OAAO,EAAE,IAAI;IAC7B;;;OAGG;IACa,uBAAuB,EAAE,OAAO;IAChD;;;;;;;OAOG;IACa,YAAY,EAAE,OAAO;IAGzC,sFAAsF;IACtF,IAAW,SAAS,IAAI,OAAO,CAE9B;IAED;;;;;;OAMG;IACH,IAAW,WAAW,IAAI,MAAM,GAAG,SAAS,CAE3C;IAED;;;;OAIG;IACH,IAAW,aAAa,IAAI,MAAM,CAGjC;IAED;;;;;;;;OAQG;IACH,IAAW,kBAAkB,IAAI,OAAO,CAIvC;CACJ;AAED;;;;;;GAMG;AACH,MAAM,WAAW,iBAAiB;IAC9B,0CAA0C;IAC1C,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,2DAA2D;IAC3D,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC;IAC7B,uFAAuF;IACvF,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B;;;;OAIG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B;;;OAGG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,+BAA+B,CAAC;IACjD,oBAAoB;IACpB,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB,mFAAmF;IACnF,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC;IACjC,sGAAsG;IACtG,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;IAChC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CAC1B;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,YAAY;IACzB;;;;;;OAMG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB;;;;OAIG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,2CAA2C;IAC3C,QAAQ,CAAC,OAAO,CAAC,EAAE,iBAAiB,CAAC;IACrC,oDAAoD;IACpD,QAAQ,CAAC,MAAM,CAAC,EAAE,iBAAiB,CAAC;IACpC;;;;;;OAMG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,iBAAiB,CAAC;IACnC;;;;;;OAMG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,OAAO,CAAC;IAChC,wGAAwG;IACxG,QAAQ,CAAC,WAAW,CAAC,EAAE,OAAO,CAAC;CAClC;AAED;;;GAGG;AACH,MAAM,WAAW,UAAU;IACvB,mFAAmF;IACnF,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,+EAA+E;IAC/E,QAAQ,CAAC,QAAQ,EAAE,YAAY,EAAE,CAAC;CACrC;AAED,yDAAyD;AACzD,MAAM,WAAW,kBAAkB;IAC/B,8CAA8C;IAC9C,QAAQ,CAAC,MAAM,EAAE,yBAAyB,CAAC;IAC3C,oEAAoE;IACpE,QAAQ,CAAC,WAAW,CAAC,EAAE,OAAO,CAAC;IAC/B,+DAA+D;IAC/D,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC;IAC7B,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CAC1B;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC5B,QAAQ,CAAC,KAAK,EAAE,+BAA+B,CAAC;IAChD,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB;;;;;;;OAOG;IACH,QAAQ,CAAC,eAAe,CAAC,EAAE,MAAM,CAAC;IAClC,oFAAoF;IACpF,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B,gFAAgF;IAChF,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB,6EAA6E;IAC7E,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IACpC;;;;;;;OAOG;IACH,QAAQ,CAAC,mBAAmB,CAAC,EAAE,MAAM,CAAC;CACzC;AAED;;;;;;GAMG;AACH,MAAM,WAAW,uBAAuB;IACpC,wFAAwF;IACxF,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC;IACjC,yEAAyE;IACzE,QAAQ,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC;IAC7B;;;;OAIG;IACH,QAAQ,CAAC,mBAAmB,CAAC,EAAE,MAAM,CAAC;CACzC;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,4BAA4B;IACzC,sDAAsD;IACtD,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;CACnC;AAED;;;;;;GAMG;AACH,MAAM,WAAW,gCAAgC;IAC7C,qCAAqC;IACrC,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;IAC/B,0BAA0B;IAC1B,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B,8BAA8B;IAC9B,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAC3B,gEAAgE;IAChE,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IACnC,gGAAgG;IAChG,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC;IACjC,QAAQ,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACnC;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,WAAW,qBAAqB;IAClC,0FAA0F;IAC1F,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAI3B;;;;;;OAMG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;IAChC,iDAAiD;IACjD,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;IAChC;;;;;;;;OAQG;IACH,QAAQ,CAAC,oBAAoB,CAAC,EAAE,MAAM,CAAC;IACvC,oFAAoF;IACpF,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;IAIhC;;;;OAIG;IACH,QAAQ,CAAC,oBAAoB,CAAC,EAAE,MAAM,CAAC;IACvC,+DAA+D;IAC/D,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;IAChC;;;OAGG;IACH,QAAQ,CAAC,2BAA2B,CAAC,EAAE,MAAM,CAAC;IAC9C,gGAAgG;IAChG,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;IAChC;;;;OAIG;IACH,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC;IAIjC,qFAAqF;IACrF,QAAQ,CAAC,oBAAoB,CAAC,EAAE,MAAM,CAAC;IACvC,8DAA8D;IAC9D,QAAQ,CAAC,eAAe,CAAC,EAAE,MAAM,CAAC;IAIlC,yCAAyC;IACzC,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,0CAA0C;IAC1C,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IACnC;;;OAGG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B;;;;;OAKG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,8EAA8E;IAC9E,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IACpC;;;;;;OAMG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,SAAS,gCAAgC,EAAE,CAAC;IAEpE,QAAQ,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACnC;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,yBAAyB;IACtC,wEAAwE;IACxE,QAAQ,CAAC,MAAM,EAAE,yBAAyB,CAAC;IAC3C,8FAA8F;IAC9F,QAAQ,CAAC,WAAW,EAAE,OAAO,CAAC;CACjC"}