@paygentic/sdk 0.6.29 → 0.6.34

package/src/models/operations/updatecost.ts

@@ -0,0 +1,136 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * Updated aggregation method (metered costs only).
+ */
+export const UpdateCostAggregation = {
+  Sum: "SUM",
+  Count: "COUNT",
+  Avg: "AVG",
+  Min: "MIN",
+  Max: "MAX",
+  UniqueCount: "UNIQUE_COUNT",
+  Latest: "LATEST",
+} as const;
+/**
+ * Updated aggregation method (metered costs only).
+ */
+export type UpdateCostAggregation = ClosedEnum<typeof UpdateCostAggregation>;
+
+export type UpdateCostRequestBody = {
+  /**
+   * Updated name for the cost.
+   */
+  name?: string | undefined;
+  /**
+   * Updated unit cost.
+   */
+  unitCost?: number | undefined;
+  /**
+   * Updated ISO 4217 currency code.
+   */
+  currency?: string | undefined;
+  /**
+   * Updated unit label (metered costs only).
+   */
+  unit?: string | null | undefined;
+  /**
+   * Updated aggregation method (metered costs only).
+   */
+  aggregation?: UpdateCostAggregation | null | undefined;
+  /**
+   * Updated CloudEvents type (metered costs only).
+   */
+  eventType?: string | null | undefined;
+  /**
+   * Updated JSONPath for value extraction (metered costs only).
+   */
+  valueProperty?: string | null | undefined;
+  /**
+   * Updated group-by dimension map (metered costs only).
+   */
+  groupBy?: { [k: string]: string } | null | undefined;
+};
+
+export type UpdateCostRequest = {
+  /**
+   * The unique identifier of the cost
+   */
+  id: string;
+  requestBody: UpdateCostRequestBody;
+};
+
+/** @internal */
+export const UpdateCostAggregation$outboundSchema: z.ZodNativeEnum<
+  typeof UpdateCostAggregation
+> = z.nativeEnum(UpdateCostAggregation);
+
+/** @internal */
+export type UpdateCostRequestBody$Outbound = {
+  name?: string | undefined;
+  unitCost?: number | undefined;
+  currency?: string | undefined;
+  unit?: string | null | undefined;
+  aggregation?: string | null | undefined;
+  eventType?: string | null | undefined;
+  valueProperty?: string | null | undefined;
+  groupBy?: { [k: string]: string } | null | undefined;
+};
+
+/** @internal */
+export const UpdateCostRequestBody$outboundSchema: z.ZodType<
+  UpdateCostRequestBody$Outbound,
+  z.ZodTypeDef,
+  UpdateCostRequestBody
+> = z.object({
+  name: z.string().optional(),
+  unitCost: z.number().optional(),
+  currency: z.string().optional(),
+  unit: z.nullable(z.string()).optional(),
+  aggregation: z.nullable(UpdateCostAggregation$outboundSchema).optional(),
+  eventType: z.nullable(z.string()).optional(),
+  valueProperty: z.nullable(z.string()).optional(),
+  groupBy: z.nullable(z.record(z.string())).optional(),
+});
+
+export function updateCostRequestBodyToJSON(
+  updateCostRequestBody: UpdateCostRequestBody,
+): string {
+  return JSON.stringify(
+    UpdateCostRequestBody$outboundSchema.parse(updateCostRequestBody),
+  );
+}
+
+/** @internal */
+export type UpdateCostRequest$Outbound = {
+  id: string;
+  RequestBody: UpdateCostRequestBody$Outbound;
+};
+
+/** @internal */
+export const UpdateCostRequest$outboundSchema: z.ZodType<
+  UpdateCostRequest$Outbound,
+  z.ZodTypeDef,
+  UpdateCostRequest
+> = z.object({
+  id: z.string(),
+  requestBody: z.lazy(() => UpdateCostRequestBody$outboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    requestBody: "RequestBody",
+  });
+});
+
+export function updateCostRequestToJSON(
+  updateCostRequest: UpdateCostRequest,
+): string {
+  return JSON.stringify(
+    UpdateCostRequest$outboundSchema.parse(updateCostRequest),
+  );
+}

package/src/models/operations/updateplan.ts

@@ -6,6 +6,37 @@ import * as z from "zod/v3";
 import { remap as remap$ } from "../../lib/primitives.js";
 import { ClosedEnum } from "../../types/enums.js";
 
+/**
+ * ISO 8601 duration for the billing period. Takes precedence over billingInterval when both are provided.
+ */
+export const UpdatePlanBillingCadence = {
+  P1M: "P1M",
+  P3M: "P3M",
+  P1Y: "P1Y",
+} as const;
+/**
+ * ISO 8601 duration for the billing period. Takes precedence over billingInterval when both are provided.
+ */
+export type UpdatePlanBillingCadence = ClosedEnum<
+  typeof UpdatePlanBillingCadence
+>;
+
+/**
+ * Recurring billing period frequency. Sample values: 'monthly' for monthly billing, 'quarterly' for quarterly billing, 'yearly' for annual billing
+ */
+export const UpdatePlanBillingInterval = {
+  Monthly: "monthly",
+  Quarterly: "quarterly",
+  Yearly: "yearly",
+  Annual: "annual",
+} as const;
+/**
+ * Recurring billing period frequency. Sample values: 'monthly' for monthly billing, 'quarterly' for quarterly billing, 'yearly' for annual billing
+ */
+export type UpdatePlanBillingInterval = ClosedEnum<
+  typeof UpdatePlanBillingInterval
+>;
+
 /**
  * Whether tax is added on top of the price (exclusive) or included in the price (inclusive)
  */
@@ -20,9 +51,13 @@ export type UpdatePlanTaxBehavior = ClosedEnum<typeof UpdatePlanTaxBehavior>;
 
 export type UpdatePlanRequestBody = {
   /**
-   * Recurring billing period frequency. Sample values: 'monthly' for monthly billing, 'yearly' for annual billing, 'weekly' for weekly billing
+   * ISO 8601 duration for the billing period. Takes precedence over billingInterval when both are provided.
    */
-  billingInterval?: string | undefined;
+  billingCadence?: UpdatePlanBillingCadence | undefined;
+  /**
+   * Recurring billing period frequency. Sample values: 'monthly' for monthly billing, 'quarterly' for quarterly billing, 'yearly' for annual billing
+   */
+  billingInterval?: UpdatePlanBillingInterval | undefined;
   /**
    * Default tax code for plan line items. Common values: 'eservice' (electronically supplied services), 'saas' (software as a service), 'consulting', 'ebook', 'standard', 'reduced', 'exempt'. Full list available via GET /tax/codes endpoint.
    */
@@ -69,6 +104,16 @@ export type UpdatePlanRequest = {
   requestBody: UpdatePlanRequestBody;
 };
 
+/** @internal */
+export const UpdatePlanBillingCadence$outboundSchema: z.ZodNativeEnum<
+  typeof UpdatePlanBillingCadence
+> = z.nativeEnum(UpdatePlanBillingCadence);
+
+/** @internal */
+export const UpdatePlanBillingInterval$outboundSchema: z.ZodNativeEnum<
+  typeof UpdatePlanBillingInterval
+> = z.nativeEnum(UpdatePlanBillingInterval);
+
 /** @internal */
 export const UpdatePlanTaxBehavior$outboundSchema: z.ZodNativeEnum<
   typeof UpdatePlanTaxBehavior
@@ -76,6 +121,7 @@ export const UpdatePlanTaxBehavior$outboundSchema: z.ZodNativeEnum<
 
 /** @internal */
 export type UpdatePlanRequestBody$Outbound = {
+  billingCadence?: string | undefined;
   billingInterval?: string | undefined;
   defaultTaxCode?: string | undefined;
   defaultTaxRate?: number | undefined;
@@ -94,7 +140,8 @@ export const UpdatePlanRequestBody$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   UpdatePlanRequestBody
 > = z.object({
-  billingInterval: z.string().optional(),
+  billingCadence: UpdatePlanBillingCadence$outboundSchema.optional(),
+  billingInterval: UpdatePlanBillingInterval$outboundSchema.optional(),
   defaultTaxCode: z.string().optional(),
   defaultTaxRate: z.number().optional(),
   description: z.string().optional(),

package/src/models/operations/updateprice.ts

@@ -60,6 +60,10 @@ export type UpdatePriceRequestBody = {
    * Feature to associate. Set to null to remove existing feature. Omit to leave unchanged.
    */
   feature?: models.PriceFeatureInput | null | undefined;
+  /**
+   * When true, grants applied to a subscription will discount usage charged by this price. Only supported for standard metered prices.
+   */
+  grantDiscountEnabled?: boolean | undefined;
 };
 
 export type UpdatePriceRequest = {
@@ -89,6 +93,7 @@ export type UpdatePriceRequestBody$Outbound = {
   paymentTerm?: string | undefined;
   billingCadence?: string | null | undefined;
   feature?: models.PriceFeatureInput$Outbound | null | undefined;
+  grantDiscountEnabled?: boolean | undefined;
 };
 
 /** @internal */
@@ -104,6 +109,7 @@ export const UpdatePriceRequestBody$outboundSchema: z.ZodType<
   paymentTerm: UpdatePricePaymentTerm$outboundSchema.optional(),
   billingCadence: z.nullable(z.string()).optional(),
   feature: z.nullable(models.PriceFeatureInput$outboundSchema).optional(),
+  grantDiscountEnabled: z.boolean().optional(),
 });
 
 export function updatePriceRequestBodyToJSON(

package/src/models/plan.ts

@@ -15,6 +15,19 @@ export const PlanObject = {
 } as const;
 export type PlanObject = ClosedEnum<typeof PlanObject>;
 
+/**
+ * ISO 8601 duration for the billing period.
+ */
+export const BillingCadence = {
+  P1M: "P1M",
+  P3M: "P3M",
+  P1Y: "P1Y",
+} as const;
+/**
+ * ISO 8601 duration for the billing period.
+ */
+export type BillingCadence = ClosedEnum<typeof BillingCadence>;
+
 export type PlanPaymentTerm = {
   inArrears?: boolean | undefined;
   instant?: boolean | undefined;
@@ -38,6 +51,15 @@ export type Plan = {
    */
   id: string;
   object: PlanObject;
+  /**
+   * ISO 8601 duration for the billing period.
+   */
+  billingCadence: BillingCadence;
+  /**
+   * Deprecated. Human-readable billing period derived from billingCadence. Use billingCadence instead.
+   *
+   * @deprecated field: Use billingCadence (ISO 8601 duration: P1M, P3M, P1Y) instead..
+   */
   billingInterval: string;
   createdAt: Date;
   currency: string;
@@ -90,6 +112,11 @@ export type Plan = {
 export const PlanObject$inboundSchema: z.ZodNativeEnum<typeof PlanObject> = z
   .nativeEnum(PlanObject);
 
+/** @internal */
+export const BillingCadence$inboundSchema: z.ZodNativeEnum<
+  typeof BillingCadence
+> = z.nativeEnum(BillingCadence);
+
 /** @internal */
 export const PlanPaymentTerm$inboundSchema: z.ZodType<
   PlanPaymentTerm,
@@ -123,6 +150,7 @@ export const Plan$inboundSchema: z.ZodType<Plan, z.ZodTypeDef, unknown> = z
   .object({
     id: z.string(),
     object: PlanObject$inboundSchema,
+    billingCadence: BillingCadence$inboundSchema.default("P1M"),
     billingInterval: z.string(),
     createdAt: z.string().datetime({ offset: true }).transform(v =>
       new Date(v)

package/src/models/price.ts

@@ -57,6 +57,10 @@ export type Price = {
    * Features associated with this price
    */
   features?: Array<PriceFeature> | undefined;
+  /**
+   * When true, grants applied to a subscription will discount usage charged by this price. Only supported for standard metered prices.
+   */
+  grantDiscountEnabled: boolean;
 };
 
 /** @internal */
@@ -94,6 +98,7 @@ export const Price$inboundSchema: z.ZodType<Price, z.ZodTypeDef, unknown> = z
       new Date(v)
     ),
     features: z.array(PriceFeature$inboundSchema).optional(),
+    grantDiscountEnabled: z.boolean().default(false),
   });
 
 export function priceFromJSON(

package/src/models/schemasprice.ts

@@ -63,6 +63,10 @@ export type SchemasPrice = {
    * Features associated with this price
    */
   features?: Array<PriceFeature> | undefined;
+  /**
+   * When true, grants applied to a subscription will discount usage charged by this price. Only supported for standard metered prices.
+   */
+  grantDiscountEnabled: boolean;
 };
 
 /** @internal */
@@ -98,6 +102,7 @@ export const SchemasPrice$inboundSchema: z.ZodType<
   properties: PricePropertiesUnion$inboundSchema,
   updatedAt: z.string().datetime({ offset: true }).transform(v => new Date(v)),
   features: z.array(PriceFeature$inboundSchema).optional(),
+  grantDiscountEnabled: z.boolean().default(false),
 });
 
 export function schemasPriceFromJSON(

package/src/models/subscription.ts

@@ -13,6 +13,24 @@ export const SubscriptionObject = {
 } as const;
 export type SubscriptionObject = ClosedEnum<typeof SubscriptionObject>;
 
+/**
+ * Invoice 0 awaiting merchant approval before payment can proceed. The invoice is in DRAFT status with totals calculated. Approval is currently platform-only — do not call PATCH /v2/invoices/{id} with {"trigger": "APPROVE"} from merchant credentials (it will return 403). A merchant-accessible approval endpoint is planned for PAYG-754.
+ */
+export type PaymentAwaitingApproval = {
+  /**
+   * The Invoice 0 id awaiting approval
+   */
+  invoiceId: string;
+  /**
+   * Total payment amount in decimal dollar format
+   */
+  amount: string;
+  /**
+   * Payment status
+   */
+  status: "awaiting_approval";
+};
+
 /**
  * Zero-amount Invoice 0 that completed synchronously to PAID
  */
@@ -75,7 +93,10 @@ export type PaymentPending = {
 /**
  * Payment session details when upfront payment is required, or confirmation of a zero-amount paid invoice
  */
-export type PaymentUnion = PaymentPending | PaymentPaid;
+export type PaymentUnion =
+  | PaymentPending
+  | PaymentPaid
+  | PaymentAwaitingApproval;
 
 export const SubscriptionStatusEnum = {
   PendingPayment: "pending_payment",
@@ -134,7 +155,7 @@ export type Subscription = {
   /**
    * Payment session details when upfront payment is required, or confirmation of a zero-amount paid invoice
    */
-  payment?: PaymentPending | PaymentPaid | undefined;
+  payment?: PaymentPending | PaymentPaid | PaymentAwaitingApproval | undefined;
   planId: string;
   /**
    * @deprecated Use minimumAccountBalance instead. Minimum required wallet balance in atomic units. Sample values: '200000000000' equals $200.00 minimum, '1000000000000' equals $1000.00 minimum
@@ -183,6 +204,27 @@ export const SubscriptionObject$inboundSchema: z.ZodNativeEnum<
   typeof SubscriptionObject
 > = z.nativeEnum(SubscriptionObject);
 
+/** @internal */
+export const PaymentAwaitingApproval$inboundSchema: z.ZodType<
+  PaymentAwaitingApproval,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  invoiceId: z.string(),
+  amount: z.string(),
+  status: z.literal("awaiting_approval"),
+});
+
+export function paymentAwaitingApprovalFromJSON(
+  jsonString: string,
+): SafeParseResult<PaymentAwaitingApproval, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PaymentAwaitingApproval$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PaymentAwaitingApproval' from JSON`,
+  );
+}
+
 /** @internal */
 export const PaymentPaid$inboundSchema: z.ZodType<
   PaymentPaid,
@@ -256,6 +298,7 @@ export const PaymentUnion$inboundSchema: z.ZodType<
 > = z.union([
   z.lazy(() => PaymentPending$inboundSchema),
   z.lazy(() => PaymentPaid$inboundSchema),
+  z.lazy(() => PaymentAwaitingApproval$inboundSchema),
 ]);
 
 export function paymentUnionFromJSON(
@@ -356,6 +399,7 @@ export const Subscription$inboundSchema: z.ZodType<
   payment: z.union([
     z.lazy(() => PaymentPending$inboundSchema),
     z.lazy(() => PaymentPaid$inboundSchema),
+    z.lazy(() => PaymentAwaitingApproval$inboundSchema),
   ]).optional(),
   planId: z.string(),
   prefundAmount: z.string().optional(),

package/src/sdk/billablemetrics.ts

@@ -5,6 +5,7 @@
 import { billableMetricsCreate } from "../funcs/billableMetricsCreate.js";
 import { billableMetricsGet } from "../funcs/billableMetricsGet.js";
 import { billableMetricsList } from "../funcs/billableMetricsList.js";
+import { billableMetricsListEvents } from "../funcs/billableMetricsListEvents.js";
 import { billableMetricsMeter } from "../funcs/billableMetricsMeter.js";
 import { billableMetricsUpdate } from "../funcs/billableMetricsUpdate.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
@@ -88,4 +89,21 @@ export class BillableMetrics extends ClientSDK {
       options,
     ));
   }
+
+  /**
+   * List Meter Events
+   *
+   * @remarks
+   * List raw underlying events for a billable metric from the metering service. Returns events ordered by time descending.
+   */
+  async listEvents(
+    request: operations.ListBillableMetricEventsRequest,
+    options?: RequestOptions,
+  ): Promise<models.MeterEventList> {
+    return unwrapAsync(billableMetricsListEvents(
+      this,
+      request,
+      options,
+    ));
+  }
 }

package/src/sdk/costs.ts

@@ -0,0 +1,106 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { costsCreateCost } from "../funcs/costsCreateCost.js";
+import { costsDeleteCost } from "../funcs/costsDeleteCost.js";
+import { costsGetCost } from "../funcs/costsGetCost.js";
+import { costsGetCostSummary } from "../funcs/costsGetCostSummary.js";
+import { costsListCosts } from "../funcs/costsListCosts.js";
+import { costsUpdateCost } from "../funcs/costsUpdateCost.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as models from "../models/index.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Costs extends ClientSDK {
+  /**
+   * Create
+   *
+   * @remarks
+   * Create a new metered cost for a product.
+   */
+  async createCost(
+    request: operations.CreateCostRequest,
+    options?: RequestOptions,
+  ): Promise<models.Cost> {
+    return unwrapAsync(costsCreateCost(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * List
+   */
+  async listCosts(
+    request?: operations.ListCostsRequest | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.ListCostsResponse> {
+    return unwrapAsync(costsListCosts(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get
+   */
+  async getCost(
+    request: operations.GetCostRequest,
+    options?: RequestOptions,
+  ): Promise<models.Cost> {
+    return unwrapAsync(costsGetCost(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Update
+   */
+  async updateCost(
+    request: operations.UpdateCostRequest,
+    options?: RequestOptions,
+  ): Promise<models.Cost> {
+    return unwrapAsync(costsUpdateCost(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Delete
+   */
+  async deleteCost(
+    request: operations.DeleteCostRequest,
+    options?: RequestOptions,
+  ): Promise<void> {
+    return unwrapAsync(costsDeleteCost(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Query Summary
+   *
+   * @remarks
+   * Query usage data and compute cost for a specific cost configuration. To retrieve summaries for all costs belonging to a merchant, first call listCosts to obtain cost IDs, then call this endpoint in parallel for each ID.
+   */
+  async getCostSummary(
+    request: operations.GetCostSummaryRequest,
+    options?: RequestOptions,
+  ): Promise<models.CostUsageResponse> {
+    return unwrapAsync(costsGetCostSummary(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/sdk.ts

@@ -4,6 +4,7 @@
 
 import { ClientSDK } from "../lib/sdks.js";
 import { BillableMetrics } from "./billablemetrics.js";
+import { Costs } from "./costs.js";
 import { Customers } from "./customers.js";
 import { Disputes } from "./disputes.js";
 import { Entitlements } from "./entitlements.js";
@@ -109,6 +110,11 @@ export class Paygentic extends ClientSDK {
     return (this._events ??= new Events(this._options));
   }
 
+  private _costs?: Costs;
+  get costs(): Costs {
+    return (this._costs ??= new Costs(this._options));
+  }
+
   private _revenue?: Revenue;
   get revenue(): Revenue {
     return (this._revenue ??= new Revenue(this._options));