@paygentic/sdk 0.7.7 → 0.7.9

package/src/models/operations/createsubscription.ts

@@ -3,6 +3,7 @@
  */
 
 import * as z from "zod/v3";
+import * as models from "../index.js";
 
 /**
  * Address is required for tax calculation. Must include: country (ISO 3166-1 alpha-2) and zipCode. The state/region field is required and validated for US/CA addresses only (custom validation in API logic). Postal code format is not validated but will be normalized.
@@ -104,10 +105,18 @@ export type CreateSubscriptionRequest = {
    * Override plan setting for number of days before renewal to send the reminder. Only used if renewalReminderEnabled is true (or inherited from plan). Set to null to use plan default.
    */
   renewalReminderDays?: number | null | undefined;
+  /**
+   * Payment term in days ("Net X") applied to every invoice the subscription generates: invoice dueAt = invoice issue date + paymentTermDays. Defaults to 0 ("due on issue"). A non-zero value is only valid alongside bankTransferOnly=true.
+   */
+  paymentTermDays?: number | undefined;
   /**
    * Number of minutes until the payment session expires. Defaults to 240 minutes (4 hours) if not provided.
    */
   sessionExpiryMinutes?: number | undefined;
+  /**
+   * Free-form merchant metadata to attach to the subscription. Values must be strings, numbers, or booleans.
+   */
+  metadata?: { [k: string]: models.SubscriptionMetadata } | undefined;
 };
 
 /** @internal */
@@ -200,7 +209,9 @@ export type CreateSubscriptionRequest$Outbound = {
   testClockId?: string | undefined;
   renewalReminderEnabled?: boolean | null | undefined;
   renewalReminderDays?: number | null | undefined;
+  paymentTermDays?: number | undefined;
   sessionExpiryMinutes?: number | undefined;
+  metadata?: { [k: string]: models.SubscriptionMetadata$Outbound } | undefined;
 };
 
 /** @internal */
@@ -223,7 +234,9 @@ export const CreateSubscriptionRequest$outboundSchema: z.ZodType<
   testClockId: z.string().optional(),
   renewalReminderEnabled: z.nullable(z.boolean()).optional(),
   renewalReminderDays: z.nullable(z.number().int()).optional(),
+  paymentTermDays: z.number().int().optional(),
   sessionExpiryMinutes: z.number().optional(),
+  metadata: z.record(models.SubscriptionMetadata$outboundSchema).optional(),
 });
 
 export function createSubscriptionRequestToJSON(

package/src/models/operations/listsubscriptions.ts

@@ -30,12 +30,21 @@ export const Include = {
 export type Include = ClosedEnum<typeof Include>;
 
 export type ListSubscriptionsRequest = {
+  /**
+   * Return subscriptions for this consumer organization. May be combined with `merchantId` to scope to a single consumer/merchant pair. Cannot be combined with `customerId`.
+   */
   consumerId?: string | undefined;
+  /**
+   * Return subscriptions for this customer. Cannot be combined with `consumerId` or `merchantId`.
+   */
   customerId?: string | undefined;
   /**
    * Number of subscriptions to return
    */
   limit?: string | undefined;
+  /**
+   * Return subscriptions for this merchant organization. May be combined with `consumerId` to scope to a single consumer/merchant pair. Cannot be combined with `customerId`.
+   */
   merchantId?: string | undefined;
   /**
    * Number of subscriptions to skip

package/src/models/operations/updatesubscription.ts

@@ -46,6 +46,10 @@ export type UpdateSubscriptionRequestBody = {
    * Override plan setting for number of days before renewal to send the reminder. Set to null to use plan default.
    */
   renewalReminderDays?: number | null | undefined;
+  /**
+   * Payment term in days ("Net X") applied to subsequently generated invoices: invoice dueAt = invoice issue date + paymentTermDays. A non-zero value is only valid alongside bankTransferOnly=true. Set 0 for "due on issue". Already-issued invoices keep their snapshotted dueAt.
+   */
+  paymentTermDays?: number | undefined;
 };
 
 export type UpdateSubscriptionRequest = {
@@ -70,6 +74,7 @@ export type UpdateSubscriptionRequestBody$Outbound = {
   minimumAccountBalance?: string | undefined;
   renewalReminderEnabled?: boolean | null | undefined;
   renewalReminderDays?: number | null | undefined;
+  paymentTermDays?: number | undefined;
 };
 
 /** @internal */
@@ -88,6 +93,7 @@ export const UpdateSubscriptionRequestBody$outboundSchema: z.ZodType<
   minimumAccountBalance: z.string().optional(),
   renewalReminderEnabled: z.nullable(z.boolean()).optional(),
   renewalReminderDays: z.nullable(z.number().int()).optional(),
+  paymentTermDays: z.number().int().optional(),
 });
 
 export function updateSubscriptionRequestBodyToJSON(

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",
@@ -193,10 +197,18 @@ export type Subscription = {
    * Number of days before renewal to send the reminder. Null means use plan default.
    */
   renewalReminderDays?: number | null | undefined;
+  /**
+   * Payment term in days ("Net X") snapshotted onto every invoice the subscription generates (invoice dueAt = invoice issue date + paymentTermDays). Defaults to 0 ("due on issue"); a non-zero value is only set on bankTransferOnly subscriptions.
+   */
+  paymentTermDays: number;
   /**
    * 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.
    */
@@ -420,7 +432,9 @@ export const Subscription$inboundSchema: z.ZodType<
   walletId: z.string().optional(),
   renewalReminderEnabled: z.nullable(z.boolean()).optional(),
   renewalReminderDays: z.nullable(z.number().int()).optional(),
+  paymentTermDays: z.number().int(),
   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/grants.ts

@@ -53,7 +53,7 @@ export class Grants extends ClientSDK {
    * @remarks
    * Create an ad-hoc invoice with a payment session for a grant purchase. The customer pays via the returned payment URL; the grant is created automatically on payment completion. If payment expires, the invoice is cancelled and no grant is created.
    *
-   * After the consumer completes payment, the grant is created automatically. To confirm payment completion, poll `GET /v2/invoices/{invoiceId}` using the `invoiceId` from the response and check for `status === "PAID"`. Recommended polling interval: 2 seconds, timeout: 60 seconds.
+   * To confirm payment completion, subscribe to the `invoice.paid.v0` webhook. The payload includes the original `invoiceId` and the created `grantId`, so you can correlate the purchase response with downstream fulfilment without an extra fetch. As a fallback if you cannot consume webhooks, poll `GET /v2/invoices/{invoiceId}` (interval 2s, timeout 60s) and check for `status === "PAID"`.
    */
   async purchase(
     request: operations.PurchaseEntitlementGrantRequest,