@flexprice/sdk 2.1.48-dev.1 → 2.1.48-dev.10

package/src/funcs/commitments-terminate-commitment.ts

@@ -30,7 +30,7 @@ import { Result } from "../types/fp.js";
  * Terminate commitment
  *
  * @remarks
- * Ends a commitment immediately. effective_at defaults to now and cannot be in the future. Under billing terms, its scheduled instalments are cancelled and any amount it earned beyond what is already invoiced is billed as a settlement. The settlement and a fixed cancellation fee, when given, are billed together on one one-off invoice.
+ * Ends a commitment immediately. effective_at defaults to now and cannot be in the future. Under billing terms, its scheduled instalments are cancelled, and those already due by effective_at are billed together as one settlement; later instalments are not billed and nothing is refunded. The settlement and a fixed cancellation fee, when given, are billed together on one one-off invoice.
  */
 export function commitmentsTerminateCommitment(
   client: FlexpriceCore,

package/src/funcs/commitments-trigger-commitment-instalment.ts

@@ -30,7 +30,7 @@ import { Result } from "../types/fp.js";
  * Trigger instalment
  *
  * @remarks
- * Bills a manual instalment of an active commitment on bill_on, now by default, which must fall within the commitment term. The instalment goes on the first subscription invoice at or after that date, or on its own invoice once due when the commitment's instalment_invoicing is separate_invoice. Either way it waits while the subscription is trialing or paused. Until it is triggered, a manual instalment waits at the end of the term, and bill_on can only move earlier; edit the billing terms to bill it later.
+ * Bills a manual instalment of an active commitment on bill_on, now by default, which must fall within the commitment term. The instalment goes on the first subscription invoice at or after that date, or on its own invoice once due when its instalment_invoicing, the term's or else the commitment's, is separate_invoice. Either way it waits while the subscription is trialing or paused. Until it is triggered, a manual instalment waits at the end of the term, and bill_on can only move earlier; edit the billing terms to bill it later.
  */
 export function commitmentsTriggerCommitmentInstalment(
   client: FlexpriceCore,

package/src/funcs/webhook-events-post-webhook-events-billing-instalment-created.ts

@@ -27,7 +27,7 @@ import { Result } from "../types/fp.js";
  * billing_instalment.created
  *
  * @remarks
- * Fired when a billing instalment is added to a commitment. Doc-only for parsing.
+ * Fired when a billing instalment is scheduled for an entity (like a commitment). Doc-only for parsing.
  */
 export function webhookEventsPostWebhookEventsBillingInstalmentCreated(
   client: FlexpriceCore,

package/src/funcs/webhook-events-post-webhook-events-billing-terms-created.ts

@@ -27,7 +27,7 @@ import { Result } from "../types/fp.js";
  * billing_terms.created
  *
  * @remarks
- * Fired when billing terms are saved with a new commitment. Doc-only for parsing.
+ * Fired when billing terms are saved against an entity (like a commitment). Doc-only for parsing.
  */
 export function webhookEventsPostWebhookEventsBillingTermsCreated(
   client: FlexpriceCore,

package/src/funcs/webhook-events-post-webhook-events-billing-terms-updated.ts

@@ -27,7 +27,7 @@ import { Result } from "../types/fp.js";
  * billing_terms.updated
  *
  * @remarks
- * Fired when an edit replaces a commitment's billing terms. Doc-only for parsing.
+ * Fired when an entity's (like a commitment's) billing terms are replaced. Doc-only for parsing.
  */
 export function webhookEventsPostWebhookEventsBillingTermsUpdated(
   client: FlexpriceCore,

package/src/lib/config.ts

@@ -77,7 +77,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "1.0",
-  sdkVersion: "2.1.48-dev.1",
+  sdkVersion: "2.1.48-dev.10",
   genVersion: "2.956.1",
-  userAgent: "speakeasy-sdk/typescript 2.1.48-dev.1 2.956.1 1.0 @flexprice/sdk",
+  userAgent:
+    "speakeasy-sdk/typescript 2.1.48-dev.10 2.956.1 1.0 @flexprice/sdk",
 } as const;

package/src/sdk/commitments.ts

@@ -183,7 +183,7 @@ export class Commitments extends ClientSDK {
    * Trigger instalment
    *
    * @remarks
-   * Bills a manual instalment of an active commitment on bill_on, now by default, which must fall within the commitment term. The instalment goes on the first subscription invoice at or after that date, or on its own invoice once due when the commitment's instalment_invoicing is separate_invoice. Either way it waits while the subscription is trialing or paused. Until it is triggered, a manual instalment waits at the end of the term, and bill_on can only move earlier; edit the billing terms to bill it later.
+   * Bills a manual instalment of an active commitment on bill_on, now by default, which must fall within the commitment term. The instalment goes on the first subscription invoice at or after that date, or on its own invoice once due when its instalment_invoicing, the term's or else the commitment's, is separate_invoice. Either way it waits while the subscription is trialing or paused. Until it is triggered, a manual instalment waits at the end of the term, and bill_on can only move earlier; edit the billing terms to bill it later.
    */
   async triggerCommitmentInstalment(
     id: string,
@@ -204,7 +204,7 @@ export class Commitments extends ClientSDK {
    * Terminate commitment
    *
    * @remarks
-   * Ends a commitment immediately. effective_at defaults to now and cannot be in the future. Under billing terms, its scheduled instalments are cancelled and any amount it earned beyond what is already invoiced is billed as a settlement. The settlement and a fixed cancellation fee, when given, are billed together on one one-off invoice.
+   * Ends a commitment immediately. effective_at defaults to now and cannot be in the future. Under billing terms, its scheduled instalments are cancelled, and those already due by effective_at are billed together as one settlement; later instalments are not billed and nothing is refunded. The settlement and a fixed cancellation fee, when given, are billed together on one one-off invoice.
    */
   async terminateCommitment(
     id: string,

package/src/sdk/models/billing-term-input.ts

@@ -20,6 +20,10 @@ import {
   InstalmentBillTrigger,
   InstalmentBillTrigger$outboundSchema,
 } from "./instalment-bill-trigger.js";
+import {
+  InstalmentDelivery,
+  InstalmentDelivery$outboundSchema,
+} from "./instalment-delivery.js";
 import {
   InvoiceCadence,
   InvoiceCadence$outboundSchema,
@@ -27,20 +31,21 @@ import {
 
 export type BillingTermInput = {
   /**
-   * BillOn is a whole second, the commitment start by default. On an edit it defaults to the start of the billing
+   * BillOn defaults to the commitment start, or on an edit to the start of the billing period holding now (the
    *
    * @remarks
-   * period holding now, or to the commitment start once the term has ended.
+   * commitment start once its term has ended). A manual term omits it and waits at the commitment end.
    */
   billOn?: string | undefined;
   billTrigger?: InstalmentBillTrigger | undefined;
   endDate?: Date | undefined;
+  instalmentInvoicing?: InstalmentDelivery | undefined;
   invoiceCadence?: InvoiceCadence | undefined;
   /**
-   * InvoiceLabel names the term's instalments on the invoice, "Instalment {n} of {of}" by default. {n} and {of} are
+   * InvoiceLabel names the term's instalments, "Instalment {n} of {of}" by default. {n} and {of} count only the
    *
    * @remarks
-   * filled with each instalment's place among all of the commitment's instalments and their count.
+   * commitment's instalments whose labels use them.
    */
   invoiceLabel?: string | undefined;
   kind: BillingTermKind;
@@ -48,7 +53,10 @@ export type BillingTermInput = {
   periodCount?: number | undefined;
   split?: BillingTermSplit | undefined;
   /**
-   * StartDate defaults like BillOn; EndDate defaults to the commitment end. Both are whole seconds.
+   * StartDate and EndDate are edges of the periods the term steps on: billing periods, or anniversary ones when it is
+   *
+   * @remarks
+   * invoiced separately; by default, the period holding the commitment start (now, on an edit) to the commitment end.
    */
   startDate?: Date | undefined;
   value?: string | undefined;
@@ -63,6 +71,7 @@ export type BillingTermInput$Outbound = {
   bill_on?: string | undefined;
   bill_trigger?: string | undefined;
   end_date?: string | undefined;
+  instalment_invoicing?: string | undefined;
   invoice_cadence?: string | undefined;
   invoice_label?: string | undefined;
   kind: string;
@@ -83,6 +92,7 @@ export const BillingTermInput$outboundSchema: z.ZodMiniType<
     billOn: z.optional(z.string()),
     billTrigger: z.optional(InstalmentBillTrigger$outboundSchema),
     endDate: z.optional(z.pipe(z.date(), z.transform(v => v.toISOString()))),
+    instalmentInvoicing: z.optional(InstalmentDelivery$outboundSchema),
     invoiceCadence: z.optional(InvoiceCadence$outboundSchema),
     invoiceLabel: z.optional(z.string()),
     kind: BillingTermKind$outboundSchema,
@@ -98,6 +108,7 @@ export const BillingTermInput$outboundSchema: z.ZodMiniType<
       billOn: "bill_on",
       billTrigger: "bill_trigger",
       endDate: "end_date",
+      instalmentInvoicing: "instalment_invoicing",
       invoiceCadence: "invoice_cadence",
       invoiceLabel: "invoice_label",
       periodCount: "period_count",

package/src/sdk/models/billingterm-term.ts

@@ -27,6 +27,10 @@ import {
   InstalmentBillTrigger,
   InstalmentBillTrigger$inboundSchema,
 } from "./instalment-bill-trigger.js";
+import {
+  InstalmentDelivery,
+  InstalmentDelivery$inboundSchema,
+} from "./instalment-delivery.js";
 import {
   InvoiceCadence,
   InvoiceCadence$inboundSchema,
@@ -42,12 +46,13 @@ export type BillingtermTerm = {
   endDate?: Date | undefined;
   environmentId?: string | undefined;
   id?: string | undefined;
+  instalmentInvoicing?: InstalmentDelivery | undefined;
   invoiceCadence?: InvoiceCadence | undefined;
   /**
    * InvoiceLabel names its instalments on the invoice, after the owner's label. It may use {n} and {of}, which number
    *
    * @remarks
-   * all of the owner's instalments together.
+   * the owner's instalments whose labels use them.
    */
   invoiceLabel?: string | undefined;
   kind?: BillingTermKind | undefined;
@@ -87,6 +92,7 @@ export const BillingtermTerm$inboundSchema: z.ZodMiniType<
     end_date: types.optional(types.date()),
     environment_id: types.optional(types.string()),
     id: types.optional(types.string()),
+    instalment_invoicing: types.optional(InstalmentDelivery$inboundSchema),
     invoice_cadence: types.optional(InvoiceCadence$inboundSchema),
     invoice_label: types.optional(types.string()),
     kind: types.optional(BillingTermKind$inboundSchema),
@@ -111,6 +117,7 @@ export const BillingtermTerm$inboundSchema: z.ZodMiniType<
       "created_by": "createdBy",
       "end_date": "endDate",
       "environment_id": "environmentId",
+      "instalment_invoicing": "instalmentInvoicing",
       "invoice_cadence": "invoiceCadence",
       "invoice_label": "invoiceLabel",
       "owner_id": "ownerId",

package/src/sdk/models/create-commitment-request.ts

@@ -68,7 +68,7 @@ export type CreateCommitmentRequest = {
   priority?: number | undefined;
   scope: CommitmentScopeInput;
   /**
-   * StartDate and EndDate must be whole seconds.
+   * StartDate and EndDate within a second after a billing period edge are taken as that edge.
    */
   startDate: Date;
   /**

package/src/sdk/models/get-subscription-v2-op.ts

@@ -10,7 +10,7 @@ export type GetSubscriptionV2Request = {
    */
   id: string;
   /**
-   * Comma-separated list of fields to expand (e.g., 'subscription_line_items,prices,plan')
+   * Comma-separated list of fields to expand (e.g., 'subscription_line_items,prices,plan,commitments')
    */
   expand?: string | undefined;
 };

package/src/sdk/models/invoice-billing-reason.ts

@@ -18,6 +18,7 @@ export const InvoiceBillingReason = {
   SubscriptionPaused: "SUBSCRIPTION_PAUSED",
   SubscriptionResume: "SUBSCRIPTION_RESUME",
   BillingTerms: "BILLING_TERMS",
+  CommitmentTermination: "COMMITMENT_TERMINATION",
 } as const;
 export type InvoiceBillingReason = ClosedEnum<typeof InvoiceBillingReason>;
 

package/src/sdk/models/subscription-response-v2.ts

@@ -16,6 +16,10 @@ import {
   BillingPeriod,
   BillingPeriod$inboundSchema,
 } from "./billing-period.js";
+import {
+  CommitmentResponse,
+  CommitmentResponse$inboundSchema,
+} from "./commitment-response.js";
 import {
   CouponAssociationResponse,
   CouponAssociationResponse$inboundSchema,
@@ -114,6 +118,10 @@ export type SubscriptionResponseV2 = {
    */
   commitmentAmount?: string | undefined;
   commitmentDuration?: BillingPeriod | undefined;
+  /**
+   * Commitments are included when "commitments" is in expand parameter
+   */
+  commitments?: Array<CommitmentResponse> | undefined;
   /**
    * CouponAssociations are included when "coupon_associations" is in expand parameter
    */
@@ -275,6 +283,7 @@ export const SubscriptionResponseV2$inboundSchema: z.ZodMiniType<
     collection_method: types.optional(types.string()),
     commitment_amount: types.optional(types.string()),
     commitment_duration: types.optional(BillingPeriod$inboundSchema),
+    commitments: types.optional(z.array(CommitmentResponse$inboundSchema)),
     coupon_associations: types.optional(
       z.array(CouponAssociationResponse$inboundSchema),
     ),

package/src/sdk/models/subscription-response.ts

@@ -24,6 +24,10 @@ import {
   CheckoutSessionResponse,
   CheckoutSessionResponse$inboundSchema,
 } from "./checkout-session-response.js";
+import {
+  CommitmentResponse,
+  CommitmentResponse$inboundSchema,
+} from "./commitment-response.js";
 import {
   CouponAssociationResponse,
   CouponAssociationResponse$inboundSchema,
@@ -127,6 +131,10 @@ export type SubscriptionResponse = {
    */
   commitmentAmount?: string | undefined;
   commitmentDuration?: BillingPeriod | undefined;
+  /**
+   * Commitments are the commitments created with the subscription; set on create only.
+   */
+  commitments?: Array<CommitmentResponse> | undefined;
   /**
    * CouponAssociations are the coupon associations for this subscription
    */
@@ -281,6 +289,7 @@ export const SubscriptionResponse$inboundSchema: z.ZodMiniType<
     collection_method: types.optional(types.string()),
     commitment_amount: types.optional(types.string()),
     commitment_duration: types.optional(BillingPeriod$inboundSchema),
+    commitments: types.optional(z.array(CommitmentResponse$inboundSchema)),
     coupon_associations: types.optional(
       z.array(CouponAssociationResponse$inboundSchema),
     ),

package/src/sdk/models/terminate-commitment-request.ts

@@ -13,7 +13,7 @@ import {
 export type TerminateCommitmentRequest = {
   cancellationFee?: CancellationFeeInput | undefined;
   /**
-   * EffectiveAt defaults to now; a given one must be a whole second.
+   * EffectiveAt defaults to now; within a second after a billing period edge it is taken as that edge.
    */
   effectiveAt?: Date | undefined;
 };

package/src/sdk/models/trigger-instalment-request.ts

@@ -7,7 +7,7 @@ import { remap as remap$ } from "../../lib/primitives.js";
 
 export type TriggerInstalmentRequest = {
   /**
-   * BillOn must be a whole second.
+   * BillOn within a second after a billing period edge is taken as that edge.
    */
   billOn?: string | undefined;
 };

package/src/sdk/models/update-commitment-request.ts

@@ -6,6 +6,10 @@ import * as z from "zod/v4-mini";
 import { remap as remap$ } from "../../lib/primitives.js";
 
 export type UpdateCommitmentRequest = {
+  /**
+   * EndDate can't be changed yet; terminate the commitment to end it.
+   */
+  endDate?: Date | undefined;
   invoiceDescription?: string | undefined;
   invoiceLabel?: string | undefined;
   metadata?: { [k: string]: string } | undefined;
@@ -14,6 +18,7 @@ export type UpdateCommitmentRequest = {
 
 /** @internal */
 export type UpdateCommitmentRequest$Outbound = {
+  end_date?: string | undefined;
   invoice_description?: string | undefined;
   invoice_label?: string | undefined;
   metadata?: { [k: string]: string } | undefined;
@@ -26,6 +31,7 @@ export const UpdateCommitmentRequest$outboundSchema: z.ZodMiniType<
   UpdateCommitmentRequest
 > = z.pipe(
   z.object({
+    endDate: z.optional(z.pipe(z.date(), z.transform(v => v.toISOString()))),
     invoiceDescription: z.optional(z.string()),
     invoiceLabel: z.optional(z.string()),
     metadata: z.optional(z.record(z.string(), z.string())),
@@ -33,6 +39,7 @@ export const UpdateCommitmentRequest$outboundSchema: z.ZodMiniType<
   }),
   z.transform((v) => {
     return remap$(v, {
+      endDate: "end_date",
       invoiceDescription: "invoice_description",
       invoiceLabel: "invoice_label",
     });

package/src/sdk/webhook-events.ts

@@ -98,7 +98,7 @@ export class WebhookEvents extends ClientSDK {
    * billing_instalment.created
    *
    * @remarks
-   * Fired when a billing instalment is added to a commitment. Doc-only for parsing.
+   * Fired when a billing instalment is scheduled for an entity (like a commitment). Doc-only for parsing.
    */
   async postWebhookEventsBillingInstalmentCreated(
     options?: RequestOptions,
@@ -143,7 +143,7 @@ export class WebhookEvents extends ClientSDK {
    * billing_terms.created
    *
    * @remarks
-   * Fired when billing terms are saved with a new commitment. Doc-only for parsing.
+   * Fired when billing terms are saved against an entity (like a commitment). Doc-only for parsing.
    */
   async postWebhookEventsBillingTermsCreated(
     options?: RequestOptions,
@@ -158,7 +158,7 @@ export class WebhookEvents extends ClientSDK {
    * billing_terms.updated
    *
    * @remarks
-   * Fired when an edit replaces a commitment's billing terms. Doc-only for parsing.
+   * Fired when an entity's (like a commitment's) billing terms are replaced. Doc-only for parsing.
    */
   async postWebhookEventsBillingTermsUpdated(
     options?: RequestOptions,