@polar-sh/sdk 0.36.0 → 0.36.2

package/src/models/components/checkout.ts

@@ -140,6 +140,10 @@ export type Checkout = {
    * URL where the customer will be redirected after a successful payment.
    */
   successUrl: string;
+  /**
+   * When set, a back button will be shown in the checkout to return to this URL.
+   */
+  returnUrl: string | null;
   /**
    * When checkout is embedded, represents the Origin of the page embedding the checkout. Used as a security measure to send messages only to the embedding page.
    */
@@ -152,6 +156,10 @@ export type Checkout = {
    * Number of seats for seat-based pricing.
    */
   seats?: number | null | undefined;
+  /**
+   * Price per seat in cents for the current seat count, based on the applicable tier. Only relevant for seat-based pricing.
+   */
+  pricePerSeat?: number | null | undefined;
   /**
    * Discount amount in cents.
    */
@@ -586,9 +594,11 @@ export const Checkout$inboundSchema: z.ZodType<
   url: z.string(),
   expires_at: z.string().datetime({ offset: true }).transform(v => new Date(v)),
   success_url: z.string(),
+  return_url: z.nullable(z.string()),
   embed_origin: z.nullable(z.string()),
   amount: z.number().int(),
   seats: z.nullable(z.number().int()).optional(),
+  price_per_seat: z.nullable(z.number().int()).optional(),
   discount_amount: z.number().int(),
   net_amount: z.number().int(),
   tax_amount: z.nullable(z.number().int()),
@@ -654,7 +664,9 @@ export const Checkout$inboundSchema: z.ZodType<
     "client_secret": "clientSecret",
     "expires_at": "expiresAt",
     "success_url": "successUrl",
+    "return_url": "returnUrl",
     "embed_origin": "embedOrigin",
+    "price_per_seat": "pricePerSeat",
     "discount_amount": "discountAmount",
     "net_amount": "netAmount",
     "tax_amount": "taxAmount",
@@ -707,9 +719,11 @@ export type Checkout$Outbound = {
   url: string;
   expires_at: string;
   success_url: string;
+  return_url: string | null;
   embed_origin: string | null;
   amount: number;
   seats?: number | null | undefined;
+  price_per_seat?: number | null | undefined;
   discount_amount: number;
   net_amount: number;
   tax_amount: number | null;
@@ -782,9 +796,11 @@ export const Checkout$outboundSchema: z.ZodType<
   url: z.string(),
   expiresAt: z.date().transform(v => v.toISOString()),
   successUrl: z.string(),
+  returnUrl: z.nullable(z.string()),
   embedOrigin: z.nullable(z.string()),
   amount: z.number().int(),
   seats: z.nullable(z.number().int()).optional(),
+  pricePerSeat: z.nullable(z.number().int()).optional(),
   discountAmount: z.number().int(),
   netAmount: z.number().int(),
   taxAmount: z.nullable(z.number().int()),
@@ -848,7 +864,9 @@ export const Checkout$outboundSchema: z.ZodType<
     clientSecret: "client_secret",
     expiresAt: "expires_at",
     successUrl: "success_url",
+    returnUrl: "return_url",
     embedOrigin: "embed_origin",
+    pricePerSeat: "price_per_seat",
     discountAmount: "discount_amount",
     netAmount: "net_amount",
     taxAmount: "tax_amount",

package/src/models/components/checkoutcreate.ts

@@ -126,6 +126,10 @@ export type CheckoutCreate = {
    * URL where the customer will be redirected after a successful payment.You can add the `checkout_id={CHECKOUT_ID}` query parameter to retrieve the checkout session id.
    */
   successUrl?: string | null | undefined;
+  /**
+   * When set, a back button will be shown in the checkout to return to this URL.
+   */
+  returnUrl?: string | null | undefined;
   /**
    * If you plan to embed the checkout session, set this to the Origin of the embedding page. It'll allow the Polar iframe to communicate with the parent page.
    */
@@ -346,6 +350,7 @@ export const CheckoutCreate$inboundSchema: z.ZodType<
   ).optional(),
   subscription_id: z.nullable(z.string()).optional(),
   success_url: z.nullable(z.string()).optional(),
+  return_url: z.nullable(z.string()).optional(),
   embed_origin: z.nullable(z.string()).optional(),
   products: z.array(z.string()),
 }).transform((v) => {
@@ -368,6 +373,7 @@ export const CheckoutCreate$inboundSchema: z.ZodType<
     "customer_metadata": "customerMetadata",
     "subscription_id": "subscriptionId",
     "success_url": "successUrl",
+    "return_url": "returnUrl",
     "embed_origin": "embedOrigin",
   });
 });
@@ -399,6 +405,7 @@ export type CheckoutCreate$Outbound = {
     | undefined;
   subscription_id?: string | null | undefined;
   success_url?: string | null | undefined;
+  return_url?: string | null | undefined;
   embed_origin?: string | null | undefined;
   products: Array<string>;
 };
@@ -443,6 +450,7 @@ export const CheckoutCreate$outboundSchema: z.ZodType<
   ).optional(),
   subscriptionId: z.nullable(z.string()).optional(),
   successUrl: z.nullable(z.string()).optional(),
+  returnUrl: z.nullable(z.string()).optional(),
   embedOrigin: z.nullable(z.string()).optional(),
   products: z.array(z.string()),
 }).transform((v) => {
@@ -465,6 +473,7 @@ export const CheckoutCreate$outboundSchema: z.ZodType<
     customerMetadata: "customer_metadata",
     subscriptionId: "subscription_id",
     successUrl: "success_url",
+    returnUrl: "return_url",
     embedOrigin: "embed_origin",
   });
 });

package/src/models/components/checkoutpublic.ts

@@ -144,6 +144,10 @@ export type CheckoutPublic = {
    * URL where the customer will be redirected after a successful payment.
    */
   successUrl: string;
+  /**
+   * When set, a back button will be shown in the checkout to return to this URL.
+   */
+  returnUrl: string | null;
   /**
    * When checkout is embedded, represents the Origin of the page embedding the checkout. Used as a security measure to send messages only to the embedding page.
    */
@@ -156,6 +160,10 @@ export type CheckoutPublic = {
    * Number of seats for seat-based pricing.
    */
   seats?: number | null | undefined;
+  /**
+   * Price per seat in cents for the current seat count, based on the applicable tier. Only relevant for seat-based pricing.
+   */
+  pricePerSeat?: number | null | undefined;
   /**
    * Discount amount in cents.
    */
@@ -478,9 +486,11 @@ export const CheckoutPublic$inboundSchema: z.ZodType<
   url: z.string(),
   expires_at: z.string().datetime({ offset: true }).transform(v => new Date(v)),
   success_url: z.string(),
+  return_url: z.nullable(z.string()),
   embed_origin: z.nullable(z.string()),
   amount: z.number().int(),
   seats: z.nullable(z.number().int()).optional(),
+  price_per_seat: z.nullable(z.number().int()).optional(),
   discount_amount: z.number().int(),
   net_amount: z.number().int(),
   tax_amount: z.nullable(z.number().int()),
@@ -536,7 +546,9 @@ export const CheckoutPublic$inboundSchema: z.ZodType<
     "client_secret": "clientSecret",
     "expires_at": "expiresAt",
     "success_url": "successUrl",
+    "return_url": "returnUrl",
     "embed_origin": "embedOrigin",
+    "price_per_seat": "pricePerSeat",
     "discount_amount": "discountAmount",
     "net_amount": "netAmount",
     "tax_amount": "taxAmount",
@@ -583,9 +595,11 @@ export type CheckoutPublic$Outbound = {
   url: string;
   expires_at: string;
   success_url: string;
+  return_url: string | null;
   embed_origin: string | null;
   amount: number;
   seats?: number | null | undefined;
+  price_per_seat?: number | null | undefined;
   discount_amount: number;
   net_amount: number;
   tax_amount: number | null;
@@ -652,9 +666,11 @@ export const CheckoutPublic$outboundSchema: z.ZodType<
   url: z.string(),
   expiresAt: z.date().transform(v => v.toISOString()),
   successUrl: z.string(),
+  returnUrl: z.nullable(z.string()),
   embedOrigin: z.nullable(z.string()),
   amount: z.number().int(),
   seats: z.nullable(z.number().int()).optional(),
+  pricePerSeat: z.nullable(z.number().int()).optional(),
   discountAmount: z.number().int(),
   netAmount: z.number().int(),
   taxAmount: z.nullable(z.number().int()),
@@ -708,7 +724,9 @@ export const CheckoutPublic$outboundSchema: z.ZodType<
     clientSecret: "client_secret",
     expiresAt: "expires_at",
     successUrl: "success_url",
+    returnUrl: "return_url",
     embedOrigin: "embed_origin",
+    pricePerSeat: "price_per_seat",
     discountAmount: "discount_amount",
     netAmount: "net_amount",
     taxAmount: "tax_amount",

package/src/models/components/checkoutpublicconfirmed.ts

@@ -148,6 +148,10 @@ export type CheckoutPublicConfirmed = {
    * URL where the customer will be redirected after a successful payment.
    */
   successUrl: string;
+  /**
+   * When set, a back button will be shown in the checkout to return to this URL.
+   */
+  returnUrl: string | null;
   /**
    * When checkout is embedded, represents the Origin of the page embedding the checkout. Used as a security measure to send messages only to the embedding page.
    */
@@ -160,6 +164,10 @@ export type CheckoutPublicConfirmed = {
    * Number of seats for seat-based pricing.
    */
   seats?: number | null | undefined;
+  /**
+   * Price per seat in cents for the current seat count, based on the applicable tier. Only relevant for seat-based pricing.
+   */
+  pricePerSeat?: number | null | undefined;
   /**
    * Discount amount in cents.
    */
@@ -494,9 +502,11 @@ export const CheckoutPublicConfirmed$inboundSchema: z.ZodType<
   url: z.string(),
   expires_at: z.string().datetime({ offset: true }).transform(v => new Date(v)),
   success_url: z.string(),
+  return_url: z.nullable(z.string()),
   embed_origin: z.nullable(z.string()),
   amount: z.number().int(),
   seats: z.nullable(z.number().int()).optional(),
+  price_per_seat: z.nullable(z.number().int()).optional(),
   discount_amount: z.number().int(),
   net_amount: z.number().int(),
   tax_amount: z.nullable(z.number().int()),
@@ -553,7 +563,9 @@ export const CheckoutPublicConfirmed$inboundSchema: z.ZodType<
     "client_secret": "clientSecret",
     "expires_at": "expiresAt",
     "success_url": "successUrl",
+    "return_url": "returnUrl",
     "embed_origin": "embedOrigin",
+    "price_per_seat": "pricePerSeat",
     "discount_amount": "discountAmount",
     "net_amount": "netAmount",
     "tax_amount": "taxAmount",
@@ -601,9 +613,11 @@ export type CheckoutPublicConfirmed$Outbound = {
   url: string;
   expires_at: string;
   success_url: string;
+  return_url: string | null;
   embed_origin: string | null;
   amount: number;
   seats?: number | null | undefined;
+  price_per_seat?: number | null | undefined;
   discount_amount: number;
   net_amount: number;
   tax_amount: number | null;
@@ -671,9 +685,11 @@ export const CheckoutPublicConfirmed$outboundSchema: z.ZodType<
   url: z.string(),
   expiresAt: z.date().transform(v => v.toISOString()),
   successUrl: z.string(),
+  returnUrl: z.nullable(z.string()),
   embedOrigin: z.nullable(z.string()),
   amount: z.number().int(),
   seats: z.nullable(z.number().int()).optional(),
+  pricePerSeat: z.nullable(z.number().int()).optional(),
   discountAmount: z.number().int(),
   netAmount: z.number().int(),
   taxAmount: z.nullable(z.number().int()),
@@ -728,7 +744,9 @@ export const CheckoutPublicConfirmed$outboundSchema: z.ZodType<
     clientSecret: "client_secret",
     expiresAt: "expires_at",
     successUrl: "success_url",
+    returnUrl: "return_url",
     embedOrigin: "embed_origin",
+    pricePerSeat: "price_per_seat",
     discountAmount: "discount_amount",
     netAmount: "net_amount",
     taxAmount: "tax_amount",

package/src/models/components/checkoutupdate.ts

@@ -116,6 +116,10 @@ export type CheckoutUpdate = {
    * URL where the customer will be redirected after a successful payment.You can add the `checkout_id={CHECKOUT_ID}` query parameter to retrieve the checkout session id.
    */
   successUrl?: string | null | undefined;
+  /**
+   * When set, a back button will be shown in the checkout to return to this URL.
+   */
+  returnUrl?: string | null | undefined;
   /**
    * If you plan to embed the checkout session, set this to the Origin of the embedding page. It'll allow the Polar iframe to communicate with the parent page.
    */
@@ -331,6 +335,7 @@ export const CheckoutUpdate$inboundSchema: z.ZodType<
     z.record(z.union([z.string(), z.number().int(), z.number(), z.boolean()])),
   ).optional(),
   success_url: z.nullable(z.string()).optional(),
+  return_url: z.nullable(z.string()).optional(),
   embed_origin: z.nullable(z.string()).optional(),
 }).transform((v) => {
   return remap$(v, {
@@ -351,6 +356,7 @@ export const CheckoutUpdate$inboundSchema: z.ZodType<
     "customer_ip_address": "customerIpAddress",
     "customer_metadata": "customerMetadata",
     "success_url": "successUrl",
+    "return_url": "returnUrl",
     "embed_origin": "embedOrigin",
   });
 });
@@ -382,6 +388,7 @@ export type CheckoutUpdate$Outbound = {
     | null
     | undefined;
   success_url?: string | null | undefined;
+  return_url?: string | null | undefined;
   embed_origin?: string | null | undefined;
 };
 
@@ -424,6 +431,7 @@ export const CheckoutUpdate$outboundSchema: z.ZodType<
     z.record(z.union([z.string(), z.number().int(), z.number(), z.boolean()])),
   ).optional(),
   successUrl: z.nullable(z.string()).optional(),
+  returnUrl: z.nullable(z.string()).optional(),
   embedOrigin: z.nullable(z.string()).optional(),
 }).transform((v) => {
   return remap$(v, {
@@ -444,6 +452,7 @@ export const CheckoutUpdate$outboundSchema: z.ZodType<
     customerIpAddress: "customer_ip_address",
     customerMetadata: "customer_metadata",
     successUrl: "success_url",
+    returnUrl: "return_url",
     embedOrigin: "embed_origin",
   });
 });

package/src/models/components/customercustomersession.ts

@@ -0,0 +1,81 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type CustomerCustomerSession = {
+  expiresAt: Date;
+  returnUrl: string | null;
+};
+
+/** @internal */
+export const CustomerCustomerSession$inboundSchema: z.ZodType<
+  CustomerCustomerSession,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  expires_at: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  return_url: z.nullable(z.string()),
+}).transform((v) => {
+  return remap$(v, {
+    "expires_at": "expiresAt",
+    "return_url": "returnUrl",
+  });
+});
+
+/** @internal */
+export type CustomerCustomerSession$Outbound = {
+  expires_at: string;
+  return_url: string | null;
+};
+
+/** @internal */
+export const CustomerCustomerSession$outboundSchema: z.ZodType<
+  CustomerCustomerSession$Outbound,
+  z.ZodTypeDef,
+  CustomerCustomerSession
+> = z.object({
+  expiresAt: z.date().transform(v => v.toISOString()),
+  returnUrl: z.nullable(z.string()),
+}).transform((v) => {
+  return remap$(v, {
+    expiresAt: "expires_at",
+    returnUrl: "return_url",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CustomerCustomerSession$ {
+  /** @deprecated use `CustomerCustomerSession$inboundSchema` instead. */
+  export const inboundSchema = CustomerCustomerSession$inboundSchema;
+  /** @deprecated use `CustomerCustomerSession$outboundSchema` instead. */
+  export const outboundSchema = CustomerCustomerSession$outboundSchema;
+  /** @deprecated use `CustomerCustomerSession$Outbound` instead. */
+  export type Outbound = CustomerCustomerSession$Outbound;
+}
+
+export function customerCustomerSessionToJSON(
+  customerCustomerSession: CustomerCustomerSession,
+): string {
+  return JSON.stringify(
+    CustomerCustomerSession$outboundSchema.parse(customerCustomerSession),
+  );
+}
+
+export function customerCustomerSessionFromJSON(
+  jsonString: string,
+): SafeParseResult<CustomerCustomerSession, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CustomerCustomerSession$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CustomerCustomerSession' from JSON`,
+  );
+}

package/src/models/components/customersession.ts

@@ -32,6 +32,7 @@ export type CustomerSession = {
   id: string;
   token: string;
   expiresAt: Date;
+  returnUrl: string | null;
   customerPortalUrl: string;
   customerId: string;
   /**
@@ -53,6 +54,7 @@ export const CustomerSession$inboundSchema: z.ZodType<
   id: z.string(),
   token: z.string(),
   expires_at: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  return_url: z.nullable(z.string()),
   customer_portal_url: z.string(),
   customer_id: z.string(),
   customer: Customer$inboundSchema,
@@ -61,6 +63,7 @@ export const CustomerSession$inboundSchema: z.ZodType<
     "created_at": "createdAt",
     "modified_at": "modifiedAt",
     "expires_at": "expiresAt",
+    "return_url": "returnUrl",
     "customer_portal_url": "customerPortalUrl",
     "customer_id": "customerId",
   });
@@ -73,6 +76,7 @@ export type CustomerSession$Outbound = {
   id: string;
   token: string;
   expires_at: string;
+  return_url: string | null;
   customer_portal_url: string;
   customer_id: string;
   customer: Customer$Outbound;
@@ -89,6 +93,7 @@ export const CustomerSession$outboundSchema: z.ZodType<
   id: z.string(),
   token: z.string(),
   expiresAt: z.date().transform(v => v.toISOString()),
+  returnUrl: z.nullable(z.string()),
   customerPortalUrl: z.string(),
   customerId: z.string(),
   customer: Customer$outboundSchema,
@@ -97,6 +102,7 @@ export const CustomerSession$outboundSchema: z.ZodType<
     createdAt: "created_at",
     modifiedAt: "modified_at",
     expiresAt: "expires_at",
+    returnUrl: "return_url",
     customerPortalUrl: "customer_portal_url",
     customerId: "customer_id",
   });

package/src/models/components/customersessioncustomerexternalidcreate.ts

@@ -12,6 +12,10 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
  * Schema for creating a customer session using an external customer ID.
  */
 export type CustomerSessionCustomerExternalIDCreate = {
+  /**
+   * When set, a back button will be shown in the customer portal to return to this URL.
+   */
+  returnUrl?: string | null | undefined;
   /**
    * External ID of the customer to create a session for.
    */
@@ -24,15 +28,18 @@ export const CustomerSessionCustomerExternalIDCreate$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
+  return_url: z.nullable(z.string()).optional(),
   external_customer_id: z.string(),
 }).transform((v) => {
   return remap$(v, {
+    "return_url": "returnUrl",
     "external_customer_id": "externalCustomerId",
   });
 });
 
 /** @internal */
 export type CustomerSessionCustomerExternalIDCreate$Outbound = {
+  return_url?: string | null | undefined;
   external_customer_id: string;
 };
 
@@ -42,9 +49,11 @@ export const CustomerSessionCustomerExternalIDCreate$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   CustomerSessionCustomerExternalIDCreate
 > = z.object({
+  returnUrl: z.nullable(z.string()).optional(),
   externalCustomerId: z.string(),
 }).transform((v) => {
   return remap$(v, {
+    returnUrl: "return_url",
     externalCustomerId: "external_customer_id",
   });
 });

package/src/models/components/customersessioncustomeridcreate.ts

@@ -12,6 +12,10 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
  * Schema for creating a customer session using a customer ID.
  */
 export type CustomerSessionCustomerIDCreate = {
+  /**
+   * When set, a back button will be shown in the customer portal to return to this URL.
+   */
+  returnUrl?: string | null | undefined;
   /**
    * ID of the customer to create a session for.
    */
@@ -24,15 +28,18 @@ export const CustomerSessionCustomerIDCreate$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
+  return_url: z.nullable(z.string()).optional(),
   customer_id: z.string(),
 }).transform((v) => {
   return remap$(v, {
+    "return_url": "returnUrl",
     "customer_id": "customerId",
   });
 });
 
 /** @internal */
 export type CustomerSessionCustomerIDCreate$Outbound = {
+  return_url?: string | null | undefined;
   customer_id: string;
 };
 
@@ -42,9 +49,11 @@ export const CustomerSessionCustomerIDCreate$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   CustomerSessionCustomerIDCreate
 > = z.object({
+  returnUrl: z.nullable(z.string()).optional(),
   customerId: z.string(),
 }).transform((v) => {
   return remap$(v, {
+    returnUrl: "return_url",
     customerId: "customer_id",
   });
 });