@paygentic/sdk 0.7.6 → 0.7.8

package/src/models/operations/updatesubscription.ts

@@ -0,0 +1,129 @@
+/*
+ * 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";
+
+export const UpdateSubscriptionStatus = {
+  Active: "active",
+  Terminated: "terminated",
+} as const;
+export type UpdateSubscriptionStatus = ClosedEnum<
+  typeof UpdateSubscriptionStatus
+>;
+
+export type UpdateSubscriptionRequestBody = {
+  endingAt?: Date | undefined;
+  status?: UpdateSubscriptionStatus | undefined;
+  terminatedAt?: Date | undefined;
+  /**
+   * Identifier of entity that cancelled the subscription. Sample values: 'cust_abc123' for customer-initiated cancellation, 'org_xyz789' for merchant-initiated cancellation
+   */
+  terminatedBy?: string | undefined;
+  /**
+   * Explanation for subscription cancellation. Sample values: 'Customer requested cancellation', 'Payment failure', 'Service migration', 'Contract expiration'
+   */
+  terminationReason?: string | undefined;
+  /**
+   * Enable or disable automatic charging of invoices using stored payment methods.
+   */
+  autoCharge?: boolean | undefined;
+  /**
+   * When true, forces tax rate to 0%.
+   */
+  taxExempt?: boolean | undefined;
+  /**
+   * Minimum wallet balance requirement in decimal dollars (e.g., '100.00'). Can be set to '0' to disable. Maximum allowed is $5,000. Contact support for higher limits. Note: If the calculated charge amount at renewal is below payment processor minimums (typically $1.00), it will be automatically adjusted upward to meet the minimum requirement. Changes apply at next renewal.
+   */
+  minimumAccountBalance?: string | undefined;
+  /**
+   * Override plan setting for renewal reminder emails. Set to true to enable, false to disable, or null to use plan default.
+   */
+  renewalReminderEnabled?: boolean | null | undefined;
+  /**
+   * Override plan setting for number of days before renewal to send the reminder. Set to null to use plan default.
+   */
+  renewalReminderDays?: number | null | undefined;
+};
+
+export type UpdateSubscriptionRequest = {
+  id: string;
+  requestBody: UpdateSubscriptionRequestBody;
+};
+
+/** @internal */
+export const UpdateSubscriptionStatus$outboundSchema: z.ZodNativeEnum<
+  typeof UpdateSubscriptionStatus
+> = z.nativeEnum(UpdateSubscriptionStatus);
+
+/** @internal */
+export type UpdateSubscriptionRequestBody$Outbound = {
+  endingAt?: string | undefined;
+  status?: string | undefined;
+  terminatedAt?: string | undefined;
+  terminatedBy?: string | undefined;
+  terminationReason?: string | undefined;
+  autoCharge?: boolean | undefined;
+  taxExempt?: boolean | undefined;
+  minimumAccountBalance?: string | undefined;
+  renewalReminderEnabled?: boolean | null | undefined;
+  renewalReminderDays?: number | null | undefined;
+};
+
+/** @internal */
+export const UpdateSubscriptionRequestBody$outboundSchema: z.ZodType<
+  UpdateSubscriptionRequestBody$Outbound,
+  z.ZodTypeDef,
+  UpdateSubscriptionRequestBody
+> = z.object({
+  endingAt: z.date().transform(v => v.toISOString()).optional(),
+  status: UpdateSubscriptionStatus$outboundSchema.optional(),
+  terminatedAt: z.date().transform(v => v.toISOString()).optional(),
+  terminatedBy: z.string().optional(),
+  terminationReason: z.string().optional(),
+  autoCharge: z.boolean().optional(),
+  taxExempt: z.boolean().optional(),
+  minimumAccountBalance: z.string().optional(),
+  renewalReminderEnabled: z.nullable(z.boolean()).optional(),
+  renewalReminderDays: z.nullable(z.number().int()).optional(),
+});
+
+export function updateSubscriptionRequestBodyToJSON(
+  updateSubscriptionRequestBody: UpdateSubscriptionRequestBody,
+): string {
+  return JSON.stringify(
+    UpdateSubscriptionRequestBody$outboundSchema.parse(
+      updateSubscriptionRequestBody,
+    ),
+  );
+}
+
+/** @internal */
+export type UpdateSubscriptionRequest$Outbound = {
+  id: string;
+  RequestBody: UpdateSubscriptionRequestBody$Outbound;
+};
+
+/** @internal */
+export const UpdateSubscriptionRequest$outboundSchema: z.ZodType<
+  UpdateSubscriptionRequest$Outbound,
+  z.ZodTypeDef,
+  UpdateSubscriptionRequest
+> = z.object({
+  id: z.string(),
+  requestBody: z.lazy(() => UpdateSubscriptionRequestBody$outboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    requestBody: "RequestBody",
+  });
+});
+
+export function updateSubscriptionRequestToJSON(
+  updateSubscriptionRequest: UpdateSubscriptionRequest,
+): string {
+  return JSON.stringify(
+    UpdateSubscriptionRequest$outboundSchema.parse(updateSubscriptionRequest),
+  );
+}

package/src/models/price.ts

@@ -61,6 +61,10 @@ export type Price = {
    * When true, grants applied to a subscription will discount usage charged by this price. Only supported for standard metered prices.
    */
   grantDiscountEnabled: boolean;
+  /**
+   * Quantity used when generating invoice line items for this price. Total per period = quantity × unitPrice. Only supported for fee prices; metered prices derive quantity from usage. Defaults to 1.
+   */
+  quantity: number;
 };
 
 /** @internal */
@@ -99,6 +103,7 @@ export const Price$inboundSchema: z.ZodType<Price, z.ZodTypeDef, unknown> = z
     ),
     features: z.array(PriceFeature$inboundSchema).optional(),
     grantDiscountEnabled: z.boolean().default(false),
+    quantity: z.number().int().default(1),
   });
 
 export function priceFromJSON(

package/src/models/pricepropertiesunion.ts

@@ -86,7 +86,7 @@ export type PriceProperties2 = {
  */
 export type PriceProperties1 = {
   /**
-   * Per-unit cost in decimal format for fixed-rate pricing. Sample values: '0.00002' represents $0.00002 per token, '0.15' represents $0.15 per gigabyte stored, '0.05' represents $0.05 per API call
+   * Per-unit cost in decimal format for fixed-rate pricing. Sample values: '0.00002' represents $0.00002 per token, '0.15' represents $0.15 per gigabyte stored, '0.05' represents $0.05 per API call. Per unit. Total per period = quantity × unitPrice; see the `quantity` field.
    */
   unitPrice: string;
 };

package/src/models/schemasprice.ts

@@ -67,6 +67,10 @@ export type SchemasPrice = {
    * When true, grants applied to a subscription will discount usage charged by this price. Only supported for standard metered prices.
    */
   grantDiscountEnabled: boolean;
+  /**
+   * Quantity for invoice line items. Total per period = quantity × unitPrice. Only supported for fee prices; metered prices derive quantity from usage. Defaults to 1.
+   */
+  quantity: number;
 };
 
 /** @internal */
@@ -103,6 +107,7 @@ export const SchemasPrice$inboundSchema: z.ZodType<
   updatedAt: z.string().datetime({ offset: true }).transform(v => new Date(v)),
   features: z.array(PriceFeature$inboundSchema).optional(),
   grantDiscountEnabled: z.boolean().default(false),
+  quantity: z.number().int(),
 });
 
 export function schemasPriceFromJSON(

package/src/models/subscription.ts

@@ -7,6 +7,10 @@ import { safeParse } from "../lib/schemas.js";
 import { ClosedEnum } from "../types/enums.js";
 import { Result as SafeParseResult } from "../types/fp.js";
 import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+import {
+  SubscriptionMetadata,
+  SubscriptionMetadata$inboundSchema,
+} from "./subscriptionmetadata.js";
 
 export const SubscriptionObject = {
   Subscription: "subscription",
@@ -197,6 +201,10 @@ export type Subscription = {
    * Subscription-level auto-approval override. Null means plan default is used.
    */
   autoApprove?: boolean | null | undefined;
+  /**
+   * Free-form merchant metadata to attach to the subscription. Values must be strings, numbers, or booleans.
+   */
+  metadata?: { [k: string]: SubscriptionMetadata } | undefined;
   /**
    * Customer details with merchant and consumer information. Only included when include=customer is specified in the list query.
    */
@@ -421,6 +429,7 @@ export const Subscription$inboundSchema: z.ZodType<
   renewalReminderEnabled: z.nullable(z.boolean()).optional(),
   renewalReminderDays: z.nullable(z.number().int()).optional(),
   autoApprove: z.nullable(z.boolean()).optional(),
+  metadata: z.record(SubscriptionMetadata$inboundSchema).optional(),
   customer: z.lazy(() => SubscriptionCustomer$inboundSchema).optional(),
 });
 

package/src/models/subscriptionmetadata.ts

@@ -0,0 +1,43 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../lib/schemas.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+
+export type SubscriptionMetadata = string | number | boolean;
+
+/** @internal */
+export const SubscriptionMetadata$inboundSchema: z.ZodType<
+  SubscriptionMetadata,
+  z.ZodTypeDef,
+  unknown
+> = z.union([z.string(), z.number(), z.boolean()]);
+/** @internal */
+export type SubscriptionMetadata$Outbound = string | number | boolean;
+
+/** @internal */
+export const SubscriptionMetadata$outboundSchema: z.ZodType<
+  SubscriptionMetadata$Outbound,
+  z.ZodTypeDef,
+  SubscriptionMetadata
+> = z.union([z.string(), z.number(), z.boolean()]);
+
+export function subscriptionMetadataToJSON(
+  subscriptionMetadata: SubscriptionMetadata,
+): string {
+  return JSON.stringify(
+    SubscriptionMetadata$outboundSchema.parse(subscriptionMetadata),
+  );
+}
+export function subscriptionMetadataFromJSON(
+  jsonString: string,
+): SafeParseResult<SubscriptionMetadata, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SubscriptionMetadata$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SubscriptionMetadata' from JSON`,
+  );
+}

package/src/sdk/subscriptions.ts

@@ -7,6 +7,7 @@ import { subscriptionsGeneratePortalLink } from "../funcs/subscriptionsGenerateP
 import { subscriptionsGet } from "../funcs/subscriptionsGet.js";
 import { subscriptionsList } from "../funcs/subscriptionsList.js";
 import { subscriptionsTerminate } from "../funcs/subscriptionsTerminate.js";
+import { subscriptionsUpdateSubscription } from "../funcs/subscriptionsUpdateSubscription.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as models from "../models/index.js";
 import * as operations from "../models/operations/index.js";
@@ -58,6 +59,20 @@ export class Subscriptions extends ClientSDK {
     ));
   }
 
+  /**
+   * Update
+   */
+  async updateSubscription(
+    request: operations.UpdateSubscriptionRequest,
+    options?: RequestOptions,
+  ): Promise<models.Subscription> {
+    return unwrapAsync(subscriptionsUpdateSubscription(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Generate Portal Link
    *