dodopayments 2.47.0 → 2.48.0

package/src/client.ts

@@ -166,6 +166,7 @@ import {
   ScheduledPlanChange,
   Subscription,
   SubscriptionChangePlanParams,
+  SubscriptionChangePlanResponse,
   SubscriptionChargeParams,
   SubscriptionChargeResponse,
   SubscriptionCreateParams,
@@ -1226,6 +1227,7 @@ export declare namespace DodoPayments {
     type UpdateSubscriptionPlanReq as UpdateSubscriptionPlanReq,
     type SubscriptionCreateResponse as SubscriptionCreateResponse,
     type SubscriptionListResponse as SubscriptionListResponse,
+    type SubscriptionChangePlanResponse as SubscriptionChangePlanResponse,
     type SubscriptionChargeResponse as SubscriptionChargeResponse,
     type SubscriptionPreviewChangePlanResponse as SubscriptionPreviewChangePlanResponse,
     type SubscriptionRetrieveCreditUsageResponse as SubscriptionRetrieveCreditUsageResponse,

package/src/resources/entitlements/grants.ts

@@ -1,6 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../core/resource';
+import * as LicenseKeysAPI from '../license-keys';
 import * as MiscAPI from '../misc';
 import * as EntitlementsAPI from './entitlements';
 import * as ProductsAPI from '../products/products';
@@ -210,7 +211,13 @@ export interface EntitlementGrant {
  */
 export interface LicenseKeyGrant {
   /**
-   * Number of activations consumed so far.
+   * Identifier of the issued license key.
+   */
+  id: string;
+
+  /**
+   * Number of instances currently active. Activation increments it and deactivation
+   * decrements it, so it is a live count and not a total.
    */
   activations_used: number;
 
@@ -219,6 +226,12 @@ export interface LicenseKeyGrant {
    */
   key: string;
 
+  /**
+   * Current status of the license key. Activation fails unless it is `active`, so a
+   * client can warn before the customer tries.
+   */
+  status: LicenseKeysAPI.LicenseKeyStatus;
+
   /**
    * Maximum activations allowed by the entitlement, when set.
    */

package/src/resources/index.ts

@@ -230,6 +230,7 @@ export {
   type UpdateSubscriptionPlanReq,
   type SubscriptionCreateResponse,
   type SubscriptionListResponse,
+  type SubscriptionChangePlanResponse,
   type SubscriptionChargeResponse,
   type SubscriptionPreviewChangePlanResponse,
   type SubscriptionRetrieveCreditUsageResponse,

package/src/resources/products/products.ts

@@ -71,7 +71,6 @@ export class Products extends APIResource {
    *     currency: 'AED',
    *     discount: 0,
    *     price: 0,
-   *     purchasing_power_parity: true,
    *     type: 'one_time_price',
    *   },
    *   tax_category: 'digital_products',
@@ -501,12 +500,6 @@ export namespace Price {
      */
     price: number;
 
-    /**
-     * Indicates if purchasing power parity adjustments are applied to the price.
-     * Purchasing power parity feature is not available as of now.
-     */
-    purchasing_power_parity: boolean;
-
     type: 'one_time_price';
 
     /**
@@ -515,6 +508,13 @@ export namespace Price {
      */
     pay_what_you_want?: boolean;
 
+    /**
+     * Opts this price in to purchasing power parity. The business must also enable
+     * purchasing power parity. The discount percentage per country is always
+     * business-wide. Defaults to `false`.
+     */
+    purchasing_power_parity?: boolean;
+
     /**
      * A suggested price for the user to pay. This value is only considered if
      * [`pay_what_you_want`](Self::pay_what_you_want) is `true`. Otherwise, it is
@@ -559,12 +559,6 @@ export namespace Price {
      */
     price: number;
 
-    /**
-     * Indicates if purchasing power parity adjustments are applied to the price.
-     * Purchasing power parity feature is not available as of now
-     */
-    purchasing_power_parity: boolean;
-
     /**
      * Number of units for the subscription period. For example, a value of `12` with a
      * `subscription_period_interval` of `month` represents a one-year subscription.
@@ -578,6 +572,13 @@ export namespace Price {
 
     type: 'recurring_price';
 
+    /**
+     * Opts this price in to purchasing power parity. The business must also enable
+     * purchasing power parity. The discount percentage per country is always
+     * business-wide. Defaults to `false`.
+     */
+    purchasing_power_parity?: boolean;
+
     /**
      * Indicates if the price is tax inclusive
      */
@@ -632,12 +633,6 @@ export namespace Price {
      */
     payment_frequency_interval: SubscriptionsAPI.TimeInterval;
 
-    /**
-     * Indicates if purchasing power parity adjustments are applied to the price.
-     * Purchasing power parity feature is not available as of now
-     */
-    purchasing_power_parity: boolean;
-
     /**
      * Number of units for the subscription period. For example, a value of `12` with a
      * `subscription_period_interval` of `month` represents a one-year subscription.
@@ -653,6 +648,14 @@ export namespace Price {
 
     meters?: Array<ProductsAPI.AddMeterToPrice> | null;
 
+    /**
+     * Opts this price in to purchasing power parity. The business must also enable
+     * purchasing power parity. The discount percentage per country is always
+     * business-wide. Applies to the fixed fee only, never to metered usage. Defaults
+     * to `false`.
+     */
+    purchasing_power_parity?: boolean;
+
     /**
      * Indicates if the price is tax inclusive
      */

package/src/resources/subscriptions.ts

@@ -91,7 +91,7 @@ export class Subscriptions extends APIResource {
   /**
    * @example
    * ```ts
-   * await client.subscriptions.changePlan(
+   * const response = await client.subscriptions.changePlan(
    *   'sub_Iuaq622bbmmfOGrVTqdXv',
    *   {
    *     product_id: 'product_id',
@@ -105,12 +105,8 @@ export class Subscriptions extends APIResource {
     subscriptionID: string,
     body: SubscriptionChangePlanParams,
     options?: RequestOptions,
-  ): APIPromise<void> {
-    return this._client.post(path`/subscriptions/${subscriptionID}/change-plan`, {
-      body,
-      ...options,
-      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
-    });
+  ): APIPromise<SubscriptionChangePlanResponse> {
+    return this._client.post(path`/subscriptions/${subscriptionID}/change-plan`, { body, ...options });
   }
 
   /**
@@ -738,6 +734,34 @@ export interface UpdateSubscriptionPlanReq {
    */
   addons?: Array<AttachAddon> | null;
 
+  /**
+   * Replace a scheduled plan change with this one.
+   *
+   * The scheduled change is cancelled by the transaction that applies this change. A
+   * change that never applies leaves the schedule in place.
+   *
+   * `effective_at: next_billing_date` is allowed. The new schedule then replaces the
+   * old one in the request transaction.
+   *
+   * A pending plan change still gets a `409`. This field does not affect it.
+   *
+   * The preview route shares this request body, so a preview that sets this field
+   * also passes the scheduled-change `409`.
+   */
+  cancel_scheduled_change_plan?: boolean;
+
+  /**
+   * Collect the plan-change amount with a payment link. The customer then pays on a
+   * checkout page.
+   *
+   * The business needs the `allow_plan_change_via_payment_link` capability. The
+   * request needs `effective_at: immediately`. The request also needs
+   * `on_payment_failure: prevent_change`.
+   *
+   * The preview route shares this request body and ignores this field.
+   */
+  collect_via_payment_link?: boolean;
+
   /**
    * @deprecated Use `discount_id` instead.
    */
@@ -1039,6 +1063,35 @@ export namespace SubscriptionListResponse {
   }
 }
 
+/**
+ * Handles for a hosted checkout page that settles a plan change.
+ *
+ * The four fields repeat `UpdatePaymentMethodResponse` and a subset of
+ * `CreateSubscriptionResponse`. A shared type would rename the generated SDK types
+ * for all three routes, so each route keeps its own.
+ */
+export interface SubscriptionChangePlanResponse {
+  /**
+   * Client secret for an embedded checkout.
+   */
+  client_secret?: string | null;
+
+  /**
+   * When the link stops working.
+   */
+  expires_on?: string | null;
+
+  /**
+   * Id of the payment that settles the plan change.
+   */
+  payment_id?: string | null;
+
+  /**
+   * Checkout page URL. Give this to the customer.
+   */
+  payment_link?: string | null;
+}
+
 export interface SubscriptionChargeResponse {
   payment_id: string;
 }
@@ -1535,11 +1588,25 @@ export interface SubscriptionUpdateParams {
   next_billing_date?: string | null;
 
   /**
-   * `Some(true)` pauses an active subscription; `Some(false)` unpauses a `Paused`
-   * (or abandoned `OnHold`) subscription. Exclusive of every other field.
+   * Removed. Use `status: paused` to pause and `status: active` to resume. This
+   * field always fails with 422, so a caller still on it gets a loud error instead
+   * of a silent no-op.
    */
   pause?: boolean | null;
 
+  /**
+   * Set to `cancelled` to cancel the subscription. See `cancel_reason`,
+   * `cancellation_feedback`, `cancellation_comment`, and
+   * `cancel_at_next_billing_date` for cancellation options.
+   *
+   * Set to `paused` to pause an active subscription. Set to `active` to resume a
+   * `paused` subscription. `active` also resumes an `on_hold` subscription that has
+   * an unpaid pause invoice. This voids that invoice.
+   *
+   * Send `paused` or `active` alone. A request that combines either with any other
+   * field fails with 422. `cancelled` is not exclusive this way — see
+   * `cancel_reason` and friends below.
+   */
   status?: SubscriptionStatus | null;
 
   /**
@@ -1680,6 +1747,34 @@ export interface SubscriptionChangePlanParams {
    */
   addons?: Array<AttachAddon> | null;
 
+  /**
+   * Replace a scheduled plan change with this one.
+   *
+   * The scheduled change is cancelled by the transaction that applies this change. A
+   * change that never applies leaves the schedule in place.
+   *
+   * `effective_at: next_billing_date` is allowed. The new schedule then replaces the
+   * old one in the request transaction.
+   *
+   * A pending plan change still gets a `409`. This field does not affect it.
+   *
+   * The preview route shares this request body, so a preview that sets this field
+   * also passes the scheduled-change `409`.
+   */
+  cancel_scheduled_change_plan?: boolean;
+
+  /**
+   * Collect the plan-change amount with a payment link. The customer then pays on a
+   * checkout page.
+   *
+   * The business needs the `allow_plan_change_via_payment_link` capability. The
+   * request needs `effective_at: immediately`. The request also needs
+   * `on_payment_failure: prevent_change`.
+   *
+   * The preview route shares this request body and ignores this field.
+   */
+  collect_via_payment_link?: boolean;
+
   /**
    * @deprecated Use `discount_id` instead.
    */
@@ -1796,6 +1891,34 @@ export interface SubscriptionPreviewChangePlanParams {
    */
   addons?: Array<AttachAddon> | null;
 
+  /**
+   * Replace a scheduled plan change with this one.
+   *
+   * The scheduled change is cancelled by the transaction that applies this change. A
+   * change that never applies leaves the schedule in place.
+   *
+   * `effective_at: next_billing_date` is allowed. The new schedule then replaces the
+   * old one in the request transaction.
+   *
+   * A pending plan change still gets a `409`. This field does not affect it.
+   *
+   * The preview route shares this request body, so a preview that sets this field
+   * also passes the scheduled-change `409`.
+   */
+  cancel_scheduled_change_plan?: boolean;
+
+  /**
+   * Collect the plan-change amount with a payment link. The customer then pays on a
+   * checkout page.
+   *
+   * The business needs the `allow_plan_change_via_payment_link` capability. The
+   * request needs `effective_at: immediately`. The request also needs
+   * `on_payment_failure: prevent_change`.
+   *
+   * The preview route shares this request body and ignores this field.
+   */
+  collect_via_payment_link?: boolean;
+
   /**
    * @deprecated Use `discount_id` instead.
    */
@@ -1851,6 +1974,7 @@ export declare namespace Subscriptions {
     type UpdateSubscriptionPlanReq as UpdateSubscriptionPlanReq,
     type SubscriptionCreateResponse as SubscriptionCreateResponse,
     type SubscriptionListResponse as SubscriptionListResponse,
+    type SubscriptionChangePlanResponse as SubscriptionChangePlanResponse,
     type SubscriptionChargeResponse as SubscriptionChargeResponse,
     type SubscriptionPreviewChangePlanResponse as SubscriptionPreviewChangePlanResponse,
     type SubscriptionRetrieveCreditUsageResponse as SubscriptionRetrieveCreditUsageResponse,

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '2.47.0'; // x-release-please-version
+export const VERSION = '2.48.0'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "2.47.0";
+export declare const VERSION = "2.48.0";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "2.47.0";
+export declare const VERSION = "2.48.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '2.47.0'; // x-release-please-version
+exports.VERSION = '2.48.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '2.47.0'; // x-release-please-version
+export const VERSION = '2.48.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map