feat: credit balances final (#4559)

Author: GAlexIHU

api/spec/packages/aip-client-javascript/src/models/schemas.ts

@@ -2910,8 +2910,9 @@ export const creditAdjustment = z
 export const creditBalance = z
   .object({
     currency: billingCurrencyCode,
+    live: numeric,
+    settled: numeric,
     pending: numeric,
-    available: numeric,
   })
   .describe('The credit balance by currency.')
 
@@ -3968,6 +3969,7 @@ export const createCreditGrantRequest = z
       .describe(
         'Draw-down priority of the grant. Lower values have higher priority.',
       ),
+    effective_at: dateTime.optional(),
     expires_after: iso8601Duration.optional(),
     key: externalResourceKey.optional(),
   })
@@ -4011,6 +4013,7 @@ export const creditGrant = z
       .describe(
         'Draw-down priority of the grant. Lower values have higher priority.',
       ),
+    effective_at: dateTime.optional(),
     expires_after: iso8601Duration.optional(),
     key: externalResourceKey.optional(),
     expires_at: dateTime.optional(),

api/spec/packages/aip-client-javascript/src/models/types.ts

@@ -2176,16 +2176,15 @@ export interface CreditAdjustment {
 /** The credit balance by currency. */
 export interface CreditBalance {
   currency: string
+  /** Credits available after applying currently live charge impacts. */
+  live: string
+  /** Credits that have been booked on the ledger as of the balance timestamp. */
+  settled: string
   /**
-   * Credits that have been granted but cannot yet be consumed. Includes grants
-   * awaiting payment clearance or with a future effective date.
+   * Credits that have been granted but are not yet written to the ledger, or are
+   * written to the ledger with a future booked time.
    */
   pending: string
-  /**
-   * Credits that can be consumed right now. Derived from cleared grants after
-   * applying eligibility and restriction rules.
-   */
-  available: string
 }
 
 /** CreditAdjustment create request. */
@@ -3563,6 +3562,12 @@ export interface CreateCreditGrantRequest {
   filters?: CreateCreditGrantFilters
   /** Draw-down priority of the grant. Lower values have higher priority. */
   priority: number
+  /**
+   * The timestamp when the credit grant becomes effective.
+   *
+   * Defaults to the current date and time.
+   */
+  effective_at?: string
   /**
    * The duration after which the credit grant expires.
    *
@@ -3627,6 +3632,12 @@ export interface CreditGrant {
   filters?: CreditGrantFilters
   /** Draw-down priority of the grant. Lower values have higher priority. */
   priority: number
+  /**
+   * The timestamp when the credit grant becomes effective.
+   *
+   * Defaults to the current date and time.
+   */
+  effective_at?: string
   /**
    * The duration after which the credit grant expires.
    *
@@ -5440,6 +5451,12 @@ export interface CreateCreditGrantRequestInput {
   filters?: CreateCreditGrantFilters
   /** Draw-down priority of the grant. Lower values have higher priority. */
   priority?: number
+  /**
+   * The timestamp when the credit grant becomes effective.
+   *
+   * Defaults to the current date and time.
+   */
+  effective_at?: string
   /**
    * The duration after which the credit grant expires.
    *
@@ -5498,6 +5515,12 @@ export interface CreditGrantInput {
   filters?: CreditGrantFilters
   /** Draw-down priority of the grant. Lower values have higher priority. */
   priority?: number
+  /**
+   * The timestamp when the credit grant becomes effective.
+   *
+   * Defaults to the current date and time.
+   */
+  effective_at?: string
   /**
    * The duration after which the credit grant expires.
    *

api/spec/packages/aip/src/customers/credits/balance.tsp

@@ -33,18 +33,24 @@ model CreditBalance {
   currency: Currencies.CurrencyCode;
 
   /**
-   * Credits that have been granted but cannot yet be consumed. Includes grants
-   * awaiting payment clearance or with a future effective date.
+   * Credits available after applying currently live charge impacts.
    */
   @visibility(Lifecycle.Read)
   @example("200.00")
-  pending: Shared.Numeric;
+  live: Shared.Numeric;
 
   /**
-   * Credits that can be consumed right now. Derived from cleared grants after
-   * applying eligibility and restriction rules.
+   * Credits that have been booked on the ledger as of the balance timestamp.
    */
   @visibility(Lifecycle.Read)
   @example("150.00")
-  available: Shared.Numeric;
+  settled: Shared.Numeric;
+
+  /**
+   * Credits that have been granted but are not yet written to the ledger, or are
+   * written to the ledger with a future booked time.
+   */
+  @visibility(Lifecycle.Read)
+  @example("50.00")
+  pending: Shared.Numeric;
 }

api/spec/packages/aip/src/customers/credits/grant.tsp

@@ -177,13 +177,13 @@ model CreditGrant {
   @maxValue(1000)
   priority?: int16 = 10;
 
-  // /**
-  //  * The timestamp when the credit grant becomes effective.
-  //  *
-  //  * Defaults to the current date and time.
-  //  */
-  // @visibility(Lifecycle.Create, Lifecycle.Read)
-  // effective_at?: Shared.DateTime;
+  /**
+   * The timestamp when the credit grant becomes effective.
+   *
+   * Defaults to the current date and time.
+   */
+  @visibility(Lifecycle.Create, Lifecycle.Read)
+  effective_at?: Shared.DateTime;
 
   /**
    * The duration after which the credit grant expires.