@usebillow/sdk 0.5.0

package/dist/credits-C3Fe3TO0.d.cts

@@ -0,0 +1,315 @@
+/**
+ * Public SDK types for prepaid credits. Re-exported by ../types.ts.
+ *
+ * Every credit quantity is a `string` of whole microcredits (1 credit = 1,000,000), e.g.
+ * `"5000000"` for 5 credits - never a `number`, which would silently round past 2^53. Parse one
+ * with `BigInt(value)` to do arithmetic. Money (prices, charges) stays a number of minor units.
+ */
+/** A Credit Grant's kind. Spending draws `included` first and `purchased` last, among equals. */
+type CreditGrantKind = "included" | "promotional" | "adjustment" | "purchased";
+/**
+ * Where a credit balance stands: `exhausted` when nothing is spendable, else `critical` or `low`
+ * at or below the project's percentages of its reference, else `normal`.
+ */
+type CreditThresholdLevel = "normal" | "low" | "critical" | "exhausted";
+/** A lot of credits on a Customer's Credit Account. */
+interface CreditGrant {
+    id: string;
+    /** The Customer's external id. */
+    customerId: string;
+    kind: CreditGrantKind;
+    /** Microcredits issued. */
+    amount: string;
+    /** Microcredits still spendable (not held by a reservation, not expired), as issued. */
+    available: string;
+    /** Microcredits held by open reservations, as issued. */
+    held: string;
+    /** When its unheld credits expire (ISO 8601); null = never. */
+    expiresAt: string | null;
+    /** Credit Action categories it may pay for; null = every category. */
+    eligibility: string[] | null;
+    /** Your reason for issuing it, as given; cleared when the customer is erased. */
+    reason: string | null;
+    metadata: Record<string, string> | null;
+    createdAt: string;
+}
+/** What `credits.grants.create` answers: the grant its idempotency key stands for. */
+interface CreditGrantRequestResult extends CreditGrant {
+    /**
+     * `true` when the idempotency key was already used: this is the grant that earlier request
+     * made, as it was issued, and nothing new was granted. `false` when this call made it.
+     */
+    replayed: boolean;
+}
+/**
+ * Grant credits to a Customer. Only `promotional` and `adjustment` grants are issued here:
+ * purchased credits come from top-ups, included ones from subscriptions.
+ */
+interface CreateCreditGrantInput {
+    /** The Customer's external id. */
+    customerId: string;
+    kind: "promotional" | "adjustment";
+    /** Positive whole microcredits as a decimal string, at most 19 digits. */
+    amount: string;
+    /** When its unheld credits expire (ISO 8601 with a timezone, in the future); omit = never. */
+    expiresAt?: string;
+    /**
+     * Credit Action categories it may pay for (lowercase, e.g. `"messaging"`). Omit for the
+     * Project's default for the kind; `null` for every category.
+     */
+    eligibility?: string[] | null;
+    /** Why it was issued, kept on the grant and cleared on erasure. Required for an `adjustment`. */
+    reason?: string;
+    /** At most 20 keys (40 characters) and values (500 characters). Never personal data. */
+    metadata?: Record<string, string>;
+}
+/** A Credit Account's status: `frozen` takes no new reservations; `closed` (erased) takes nothing. */
+type CreditAccountStatus = "active" | "frozen" | "closed";
+/**
+ * A customer's credit balance, true at `asOf`. A balance never grants spending authority - only a
+ * reservation does. A customer with no credit account yet reads as zeros, `active`, `exhausted`.
+ */
+interface CreditBalance {
+    /** The customer's external id. */
+    customerId: string;
+    status: CreditAccountStatus;
+    /** Unheld credits of grants that have not expired: what reservations could hold now. */
+    spendable: string;
+    /** Credits held by open reservations. */
+    held: string;
+    /** Credits consumed since `periodStart`, net of reversals. */
+    consumedThisPeriod: string;
+    /** The current included period's start, else the first instant of the current UTC month. */
+    periodStart: string;
+    /** Unheld credits expiring within the next 7 days, and the earliest of those expiries. */
+    expiringSoon: {
+        amount: string;
+        earliestAt: string | null;
+    };
+    byBucket: {
+        /** Spendable credits per grant kind; they sum to `spendable`. */
+        kinds: Record<CreditGrantKind, string>;
+        /**
+         * Spendable credits per category some grant is limited to, counting the grants that pay for
+         * every category too: the figures overlap and need not sum to `spendable`.
+         */
+        categories: Record<string, string>;
+        /** Spendable on a category not listed: the grants that pay for every category. */
+        otherCategories: string;
+    };
+    /** The active included grants (a subscription's period allowance); null when there are none. */
+    currentPeriod: {
+        granted: string;
+        /** Consumed from them, net of reversals. */
+        used: string;
+        held: string;
+        /** Unheld and spendable. */
+        remaining: string;
+        start: string;
+        /** When they expire (the period end); null if one never does. */
+        end: string | null;
+    } | null;
+    thresholds: {
+        lowPercent: number;
+        criticalPercent: number;
+        /** What the percentages apply to: the current period's credits, else the last top-up's. */
+        reference: string | null;
+        level: CreditThresholdLevel;
+    };
+    /** The server time the whole read was true at (ISO 8601). */
+    asOf: string;
+}
+/** A ledger transaction's type: one per balance change. */
+type CreditTransactionType = "grant" | "hold" | "release" | "consume" | "expire" | "reverse" | "revoke" | "adjust";
+/** One balance change on a customer's credit ledger, with its effect on the account's totals. */
+interface CreditLedgerEntry {
+    id: string;
+    type: CreditTransactionType;
+    /** Why Billow posted it, as a system code (`api_grant`, `grant_expired`, ...); never free text. */
+    reason: string | null;
+    /** How it moved the account's unheld credits (signed). */
+    availableDelta: string;
+    /** How it moved the account's held credits (signed). */
+    heldDelta: string;
+    availableAfter: string;
+    heldAfter: string;
+    grantId: string | null;
+    reservationId: string | null;
+    topUpId: string | null;
+    /** On a reversal: the consumption (its `consume` transaction) it gives back. */
+    consumptionId: string | null;
+    /** Your own reason on the resource it belongs to (a grant's or reversal's); cleared on erasure. */
+    callerReason: string | null;
+    /** The metadata of the resource it belongs to: its reservation, reversal or top-up, else its grant. */
+    metadata: Record<string, string> | null;
+    createdAt: string;
+}
+/** What `credits.usage.get` totals each row by. */
+type CreditUsageGroupBy = "action" | "category";
+interface CreditUsageParams {
+    /** The first UTC day (`YYYY-MM-DD`); defaults to 29 days before `to`. */
+    from?: string;
+    /** The last UTC day (`YYYY-MM-DD`), included; defaults to today (UTC). At most 92 days in all. */
+    to?: string;
+    /** A Credit Action (default) or a category. */
+    groupBy?: CreditUsageGroupBy;
+}
+/** A customer's credit consumption per UTC day; days with none have no row. */
+interface CreditUsage {
+    /** The customer's external id. */
+    customerId: string;
+    from: string;
+    to: string;
+    groupBy: CreditUsageGroupBy;
+    data: Array<{
+        /** The UTC day, `YYYY-MM-DD`. */
+        date: string;
+        /** The Credit Action, or the category. */
+        key: string;
+        units: string;
+        amount: string;
+    }>;
+}
+/** Money: whole minor units of a currency (e.g. piasters), with its ISO-4217 code. */
+interface CreditMoney {
+    amount: number;
+    currency: string;
+}
+/** A Credit Pack's configuration: a one-time catalog Price sold as credits, plus a bonus. */
+interface CreditPack {
+    id: string;
+    name: string;
+    priceId: string;
+    /** The Price's amount and currency as they are now (a top-up keeps what it was bought at). */
+    price: CreditMoney;
+    /** Microcredits the purchased grant issues. */
+    credits: string;
+    /** Microcredits the bonus grant issues (a separate `promotional` grant); "0" for no bonus. */
+    bonusCredits: string;
+    /** How long after a top-up succeeds its bonus expires, in seconds; null = never. */
+    bonusExpiresInSeconds: number | null;
+    /** Categories the bonus may pay for; null = every category. */
+    bonusEligibility: string[] | null;
+    /** An archived pack is never sold again. */
+    archived: boolean;
+    createdAt: string;
+    updatedAt: string;
+}
+/**
+ * Configure a Credit Pack on a one-time catalog Price that costs something (free credits are
+ * promotional grants, never a pack). A pack must issue something.
+ */
+interface CreateCreditPackInput {
+    /** A `one_time` catalog Price: what the pack costs, and in which currency. */
+    priceId: string;
+    name: string;
+    /** Whole microcredits as a decimal string; may be "0" when the pack is all bonus. */
+    credits: string;
+    /** Whole microcredits as a decimal string; omit for no bonus. */
+    bonusCredits?: string;
+    /** Seconds after the top-up succeeds that the bonus expires; omit or null = never. */
+    bonusExpiresInSeconds?: number | null;
+    /** Categories the bonus may pay for; omit or null = every category. */
+    bonusEligibility?: string[] | null;
+}
+/** Edit a Credit Pack: any of its terms, its Price, or `archived`. Top-ups keep their terms. */
+type UpdateCreditPackInput = Partial<CreateCreditPackInput> & {
+    archived?: boolean;
+};
+/** A pack a customer can buy, with its derived price per credit and savings. */
+interface CreditPackListItem {
+    id: string;
+    name: string;
+    credits: string;
+    bonusCredits: string;
+    /** The catalog Price: what `pricePerCredit` and `savingsBps` are measured on. */
+    price: CreditMoney;
+    /**
+     * The tax a top-up of the pack charges (the Price's treatment, else your project's default):
+     * added on top when exclusive, already inside `price` when inclusive; 0 when none applies.
+     */
+    tax: CreditMoney;
+    /** What a top-up of the pack charges: `price` plus any exclusive `tax`. For display only. */
+    total: CreditMoney;
+    /** When the bonus expires after purchase, in seconds; null without a bonus or when it never does. */
+    bonusExpiresInSeconds: number | null;
+    /** The categories the bonus may pay for; null without a bonus or when it pays for every one. */
+    bonusEligibility: string[] | null;
+    /**
+     * Minor units of `price` per credit (credits plus bonus), rounded half-up to 6 decimal places,
+     * as a decimal string - for display only, never used to charge.
+     */
+    pricePerCredit: string;
+    /**
+     * Basis points cheaper per credit than the currency's base pack (its highest per-credit price),
+     * rounded down; 0 for the base pack itself.
+     */
+    savingsBps: number;
+}
+/** The packs a customer can buy in one currency, cheapest first. */
+interface CreditPacks {
+    currency: string;
+    data: CreditPackListItem[];
+}
+/**
+ * A top-up's state: `pending` until its payment settles; `succeeded` (credits granted) or
+ * `failed` (a later payment on the same checkout still succeeds it); `unfulfilled` - paid after
+ * the customer was erased, nothing granted; `binding_mismatch` - the payment did not match the
+ * top-up, nothing granted. The last two wait for a refund.
+ */
+type CreditTopUpStatus = "pending" | "succeeded" | "failed" | "unfulfilled" | "binding_mismatch";
+/** One purchase of a Credit Pack, as it now stands. */
+interface CreditTopUp {
+    id: string;
+    /** The customer's external id. */
+    customerId: string;
+    packId: string;
+    status: CreditTopUpStatus;
+    /** The terms bought: what success grants. */
+    credits: string;
+    bonusCredits: string;
+    bonusExpiresInSeconds: number | null;
+    bonusEligibility: string[] | null;
+    /** What the payment collects (the Price plus any exclusive tax), in minor units. */
+    amount: number;
+    currency: string;
+    /** The charge collecting it; null until it exists. */
+    chargeId: string | null;
+    /** The hosted checkout to send the buyer to, while it can still take the payment. */
+    checkoutUrl: string | null;
+    purchasedGrantId: string | null;
+    bonusGrantId: string | null;
+    /** Microcredits refunds and lost chargebacks of the payment have revoked so far. */
+    revoked: string;
+    /** Of the revoked credits, those already spent and not paid back since. */
+    shortfall: string;
+    metadata: Record<string, string> | null;
+    settledAt: string | null;
+    createdAt: string;
+}
+/** Buy a Credit Pack for a customer. */
+interface CreateCreditTopUpInput {
+    /** The customer's external id. */
+    customerId: string;
+    packId: string;
+    /** Where the hosted checkout sends the buyer when they are done. */
+    redirectionUrl?: string;
+    /** At most 20 keys (40 characters) and values (500 characters). Never personal data. */
+    metadata?: Record<string, string>;
+}
+/** What `credits.topUps.create` answers: the top-up its idempotency key stands for. */
+interface CreditTopUpRequestResult extends CreditTopUp {
+    /**
+     * `true` when the idempotency key was already used: this is that request's top-up as it now
+     * stands, and nothing new was bought. `false` when this call made it.
+     */
+    replayed: boolean;
+}
+/** Narrow a customer's top-ups list. */
+interface CreditTopUpListParams {
+    limit?: number;
+    cursor?: string;
+    status?: CreditTopUpStatus;
+}
+
+export type { CreditGrantKind as C, UpdateCreditPackInput as U, CreditThresholdLevel as a, CreditGrant as b, CreditTopUp as c, CreateCreditGrantInput as d, CreditGrantRequestResult as e, CreditPacks as f, CreateCreditPackInput as g, CreditPack as h, CreateCreditTopUpInput as i, CreditTopUpRequestResult as j, CreditTopUpListParams as k, CreditBalance as l, CreditLedgerEntry as m, CreditUsageParams as n, CreditUsage as o, CreditAccountStatus as p, CreditMoney as q, CreditPackListItem as r, CreditTopUpStatus as s, CreditTransactionType as t, CreditUsageGroupBy as u };

package/dist/credits-C3Fe3TO0.d.ts

@@ -0,0 +1,315 @@
+/**
+ * Public SDK types for prepaid credits. Re-exported by ../types.ts.
+ *
+ * Every credit quantity is a `string` of whole microcredits (1 credit = 1,000,000), e.g.
+ * `"5000000"` for 5 credits - never a `number`, which would silently round past 2^53. Parse one
+ * with `BigInt(value)` to do arithmetic. Money (prices, charges) stays a number of minor units.
+ */
+/** A Credit Grant's kind. Spending draws `included` first and `purchased` last, among equals. */
+type CreditGrantKind = "included" | "promotional" | "adjustment" | "purchased";
+/**
+ * Where a credit balance stands: `exhausted` when nothing is spendable, else `critical` or `low`
+ * at or below the project's percentages of its reference, else `normal`.
+ */
+type CreditThresholdLevel = "normal" | "low" | "critical" | "exhausted";
+/** A lot of credits on a Customer's Credit Account. */
+interface CreditGrant {
+    id: string;
+    /** The Customer's external id. */
+    customerId: string;
+    kind: CreditGrantKind;
+    /** Microcredits issued. */
+    amount: string;
+    /** Microcredits still spendable (not held by a reservation, not expired), as issued. */
+    available: string;
+    /** Microcredits held by open reservations, as issued. */
+    held: string;
+    /** When its unheld credits expire (ISO 8601); null = never. */
+    expiresAt: string | null;
+    /** Credit Action categories it may pay for; null = every category. */
+    eligibility: string[] | null;
+    /** Your reason for issuing it, as given; cleared when the customer is erased. */
+    reason: string | null;
+    metadata: Record<string, string> | null;
+    createdAt: string;
+}
+/** What `credits.grants.create` answers: the grant its idempotency key stands for. */
+interface CreditGrantRequestResult extends CreditGrant {
+    /**
+     * `true` when the idempotency key was already used: this is the grant that earlier request
+     * made, as it was issued, and nothing new was granted. `false` when this call made it.
+     */
+    replayed: boolean;
+}
+/**
+ * Grant credits to a Customer. Only `promotional` and `adjustment` grants are issued here:
+ * purchased credits come from top-ups, included ones from subscriptions.
+ */
+interface CreateCreditGrantInput {
+    /** The Customer's external id. */
+    customerId: string;
+    kind: "promotional" | "adjustment";
+    /** Positive whole microcredits as a decimal string, at most 19 digits. */
+    amount: string;
+    /** When its unheld credits expire (ISO 8601 with a timezone, in the future); omit = never. */
+    expiresAt?: string;
+    /**
+     * Credit Action categories it may pay for (lowercase, e.g. `"messaging"`). Omit for the
+     * Project's default for the kind; `null` for every category.
+     */
+    eligibility?: string[] | null;
+    /** Why it was issued, kept on the grant and cleared on erasure. Required for an `adjustment`. */
+    reason?: string;
+    /** At most 20 keys (40 characters) and values (500 characters). Never personal data. */
+    metadata?: Record<string, string>;
+}
+/** A Credit Account's status: `frozen` takes no new reservations; `closed` (erased) takes nothing. */
+type CreditAccountStatus = "active" | "frozen" | "closed";
+/**
+ * A customer's credit balance, true at `asOf`. A balance never grants spending authority - only a
+ * reservation does. A customer with no credit account yet reads as zeros, `active`, `exhausted`.
+ */
+interface CreditBalance {
+    /** The customer's external id. */
+    customerId: string;
+    status: CreditAccountStatus;
+    /** Unheld credits of grants that have not expired: what reservations could hold now. */
+    spendable: string;
+    /** Credits held by open reservations. */
+    held: string;
+    /** Credits consumed since `periodStart`, net of reversals. */
+    consumedThisPeriod: string;
+    /** The current included period's start, else the first instant of the current UTC month. */
+    periodStart: string;
+    /** Unheld credits expiring within the next 7 days, and the earliest of those expiries. */
+    expiringSoon: {
+        amount: string;
+        earliestAt: string | null;
+    };
+    byBucket: {
+        /** Spendable credits per grant kind; they sum to `spendable`. */
+        kinds: Record<CreditGrantKind, string>;
+        /**
+         * Spendable credits per category some grant is limited to, counting the grants that pay for
+         * every category too: the figures overlap and need not sum to `spendable`.
+         */
+        categories: Record<string, string>;
+        /** Spendable on a category not listed: the grants that pay for every category. */
+        otherCategories: string;
+    };
+    /** The active included grants (a subscription's period allowance); null when there are none. */
+    currentPeriod: {
+        granted: string;
+        /** Consumed from them, net of reversals. */
+        used: string;
+        held: string;
+        /** Unheld and spendable. */
+        remaining: string;
+        start: string;
+        /** When they expire (the period end); null if one never does. */
+        end: string | null;
+    } | null;
+    thresholds: {
+        lowPercent: number;
+        criticalPercent: number;
+        /** What the percentages apply to: the current period's credits, else the last top-up's. */
+        reference: string | null;
+        level: CreditThresholdLevel;
+    };
+    /** The server time the whole read was true at (ISO 8601). */
+    asOf: string;
+}
+/** A ledger transaction's type: one per balance change. */
+type CreditTransactionType = "grant" | "hold" | "release" | "consume" | "expire" | "reverse" | "revoke" | "adjust";
+/** One balance change on a customer's credit ledger, with its effect on the account's totals. */
+interface CreditLedgerEntry {
+    id: string;
+    type: CreditTransactionType;
+    /** Why Billow posted it, as a system code (`api_grant`, `grant_expired`, ...); never free text. */
+    reason: string | null;
+    /** How it moved the account's unheld credits (signed). */
+    availableDelta: string;
+    /** How it moved the account's held credits (signed). */
+    heldDelta: string;
+    availableAfter: string;
+    heldAfter: string;
+    grantId: string | null;
+    reservationId: string | null;
+    topUpId: string | null;
+    /** On a reversal: the consumption (its `consume` transaction) it gives back. */
+    consumptionId: string | null;
+    /** Your own reason on the resource it belongs to (a grant's or reversal's); cleared on erasure. */
+    callerReason: string | null;
+    /** The metadata of the resource it belongs to: its reservation, reversal or top-up, else its grant. */
+    metadata: Record<string, string> | null;
+    createdAt: string;
+}
+/** What `credits.usage.get` totals each row by. */
+type CreditUsageGroupBy = "action" | "category";
+interface CreditUsageParams {
+    /** The first UTC day (`YYYY-MM-DD`); defaults to 29 days before `to`. */
+    from?: string;
+    /** The last UTC day (`YYYY-MM-DD`), included; defaults to today (UTC). At most 92 days in all. */
+    to?: string;
+    /** A Credit Action (default) or a category. */
+    groupBy?: CreditUsageGroupBy;
+}
+/** A customer's credit consumption per UTC day; days with none have no row. */
+interface CreditUsage {
+    /** The customer's external id. */
+    customerId: string;
+    from: string;
+    to: string;
+    groupBy: CreditUsageGroupBy;
+    data: Array<{
+        /** The UTC day, `YYYY-MM-DD`. */
+        date: string;
+        /** The Credit Action, or the category. */
+        key: string;
+        units: string;
+        amount: string;
+    }>;
+}
+/** Money: whole minor units of a currency (e.g. piasters), with its ISO-4217 code. */
+interface CreditMoney {
+    amount: number;
+    currency: string;
+}
+/** A Credit Pack's configuration: a one-time catalog Price sold as credits, plus a bonus. */
+interface CreditPack {
+    id: string;
+    name: string;
+    priceId: string;
+    /** The Price's amount and currency as they are now (a top-up keeps what it was bought at). */
+    price: CreditMoney;
+    /** Microcredits the purchased grant issues. */
+    credits: string;
+    /** Microcredits the bonus grant issues (a separate `promotional` grant); "0" for no bonus. */
+    bonusCredits: string;
+    /** How long after a top-up succeeds its bonus expires, in seconds; null = never. */
+    bonusExpiresInSeconds: number | null;
+    /** Categories the bonus may pay for; null = every category. */
+    bonusEligibility: string[] | null;
+    /** An archived pack is never sold again. */
+    archived: boolean;
+    createdAt: string;
+    updatedAt: string;
+}
+/**
+ * Configure a Credit Pack on a one-time catalog Price that costs something (free credits are
+ * promotional grants, never a pack). A pack must issue something.
+ */
+interface CreateCreditPackInput {
+    /** A `one_time` catalog Price: what the pack costs, and in which currency. */
+    priceId: string;
+    name: string;
+    /** Whole microcredits as a decimal string; may be "0" when the pack is all bonus. */
+    credits: string;
+    /** Whole microcredits as a decimal string; omit for no bonus. */
+    bonusCredits?: string;
+    /** Seconds after the top-up succeeds that the bonus expires; omit or null = never. */
+    bonusExpiresInSeconds?: number | null;
+    /** Categories the bonus may pay for; omit or null = every category. */
+    bonusEligibility?: string[] | null;
+}
+/** Edit a Credit Pack: any of its terms, its Price, or `archived`. Top-ups keep their terms. */
+type UpdateCreditPackInput = Partial<CreateCreditPackInput> & {
+    archived?: boolean;
+};
+/** A pack a customer can buy, with its derived price per credit and savings. */
+interface CreditPackListItem {
+    id: string;
+    name: string;
+    credits: string;
+    bonusCredits: string;
+    /** The catalog Price: what `pricePerCredit` and `savingsBps` are measured on. */
+    price: CreditMoney;
+    /**
+     * The tax a top-up of the pack charges (the Price's treatment, else your project's default):
+     * added on top when exclusive, already inside `price` when inclusive; 0 when none applies.
+     */
+    tax: CreditMoney;
+    /** What a top-up of the pack charges: `price` plus any exclusive `tax`. For display only. */
+    total: CreditMoney;
+    /** When the bonus expires after purchase, in seconds; null without a bonus or when it never does. */
+    bonusExpiresInSeconds: number | null;
+    /** The categories the bonus may pay for; null without a bonus or when it pays for every one. */
+    bonusEligibility: string[] | null;
+    /**
+     * Minor units of `price` per credit (credits plus bonus), rounded half-up to 6 decimal places,
+     * as a decimal string - for display only, never used to charge.
+     */
+    pricePerCredit: string;
+    /**
+     * Basis points cheaper per credit than the currency's base pack (its highest per-credit price),
+     * rounded down; 0 for the base pack itself.
+     */
+    savingsBps: number;
+}
+/** The packs a customer can buy in one currency, cheapest first. */
+interface CreditPacks {
+    currency: string;
+    data: CreditPackListItem[];
+}
+/**
+ * A top-up's state: `pending` until its payment settles; `succeeded` (credits granted) or
+ * `failed` (a later payment on the same checkout still succeeds it); `unfulfilled` - paid after
+ * the customer was erased, nothing granted; `binding_mismatch` - the payment did not match the
+ * top-up, nothing granted. The last two wait for a refund.
+ */
+type CreditTopUpStatus = "pending" | "succeeded" | "failed" | "unfulfilled" | "binding_mismatch";
+/** One purchase of a Credit Pack, as it now stands. */
+interface CreditTopUp {
+    id: string;
+    /** The customer's external id. */
+    customerId: string;
+    packId: string;
+    status: CreditTopUpStatus;
+    /** The terms bought: what success grants. */
+    credits: string;
+    bonusCredits: string;
+    bonusExpiresInSeconds: number | null;
+    bonusEligibility: string[] | null;
+    /** What the payment collects (the Price plus any exclusive tax), in minor units. */
+    amount: number;
+    currency: string;
+    /** The charge collecting it; null until it exists. */
+    chargeId: string | null;
+    /** The hosted checkout to send the buyer to, while it can still take the payment. */
+    checkoutUrl: string | null;
+    purchasedGrantId: string | null;
+    bonusGrantId: string | null;
+    /** Microcredits refunds and lost chargebacks of the payment have revoked so far. */
+    revoked: string;
+    /** Of the revoked credits, those already spent and not paid back since. */
+    shortfall: string;
+    metadata: Record<string, string> | null;
+    settledAt: string | null;
+    createdAt: string;
+}
+/** Buy a Credit Pack for a customer. */
+interface CreateCreditTopUpInput {
+    /** The customer's external id. */
+    customerId: string;
+    packId: string;
+    /** Where the hosted checkout sends the buyer when they are done. */
+    redirectionUrl?: string;
+    /** At most 20 keys (40 characters) and values (500 characters). Never personal data. */
+    metadata?: Record<string, string>;
+}
+/** What `credits.topUps.create` answers: the top-up its idempotency key stands for. */
+interface CreditTopUpRequestResult extends CreditTopUp {
+    /**
+     * `true` when the idempotency key was already used: this is that request's top-up as it now
+     * stands, and nothing new was bought. `false` when this call made it.
+     */
+    replayed: boolean;
+}
+/** Narrow a customer's top-ups list. */
+interface CreditTopUpListParams {
+    limit?: number;
+    cursor?: string;
+    status?: CreditTopUpStatus;
+}
+
+export type { CreditGrantKind as C, UpdateCreditPackInput as U, CreditThresholdLevel as a, CreditGrant as b, CreditTopUp as c, CreateCreditGrantInput as d, CreditGrantRequestResult as e, CreditPacks as f, CreateCreditPackInput as g, CreditPack as h, CreateCreditTopUpInput as i, CreditTopUpRequestResult as j, CreditTopUpListParams as k, CreditBalance as l, CreditLedgerEntry as m, CreditUsageParams as n, CreditUsage as o, CreditAccountStatus as p, CreditMoney as q, CreditPackListItem as r, CreditTopUpStatus as s, CreditTransactionType as t, CreditUsageGroupBy as u };