dodopayments 2.47.1 → 2.49.0

package/src/resources/blocklist/customers.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './customers/index';

package/src/resources/blocklist/index.ts

@@ -0,0 +1,15 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { Blocklist } from './blocklist';
+export {
+  Customers,
+  type BlockByCustomerID,
+  type BlockByEmail,
+  type BlockIdentifier,
+  type BlockedCustomer,
+  type BlockedCustomerSource,
+  type CreateBlockedCustomerRequest,
+  type CustomerListParams,
+  type CustomerCreateParams,
+  type BlockedCustomersDefaultPageNumberPagination,
+} from './customers/index';

package/src/resources/blocklist.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './blocklist/index';

package/src/resources/customers/customers.ts

@@ -192,6 +192,18 @@ export interface Customer {
 
   name: string;
 
+  /**
+   * When the merchant blocked this customer. The dashboard shows the "Blocked" badge
+   * and the unblock action from it. The list route leaves it empty; only the
+   * single-customer route resolves it.
+   */
+  blocked_at?: string | null;
+
+  /**
+   * Blocklist entry behind `blocked_at`, so the dashboard can link to it.
+   */
+  blocklist_entry_id?: string | null;
+
   /**
    * Additional metadata for the customer
    */

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

@@ -15,6 +15,7 @@ export {
   type BalanceRetrieveLedgerParams,
   type BalanceLedgerEntriesDefaultPageNumberPagination,
 } from './balances';
+export { Blocklist } from './blocklist/blocklist';
 export {
   Brands,
   type Brand,
@@ -154,6 +155,8 @@ export {
   type CustomerLimitedDetails,
   type CustomerRequest,
   type IntentStatus,
+  type ManualRetry,
+  type ManualRetryState,
   type NewCustomer,
   type OneTimeProductCartItem,
   type Payment,
@@ -230,6 +233,7 @@ export {
   type UpdateSubscriptionPlanReq,
   type SubscriptionCreateResponse,
   type SubscriptionListResponse,
+  type SubscriptionChangePlanResponse,
   type SubscriptionChargeResponse,
   type SubscriptionPreviewChangePlanResponse,
   type SubscriptionRetrieveCreditUsageResponse,
@@ -301,6 +305,7 @@ export {
   type SubscriptionExpiredWebhookEvent,
   type SubscriptionFailedWebhookEvent,
   type SubscriptionOnHoldWebhookEvent,
+  type SubscriptionPastDueWebhookEvent,
   type SubscriptionPausedWebhookEvent,
   type SubscriptionPlanChangedWebhookEvent,
   type SubscriptionRenewedWebhookEvent,

package/src/resources/payments.ts

@@ -67,6 +67,29 @@ export class Payments extends APIResource {
   ): APIPromise<PaymentRetrieveLineItemsResponse> {
     return this._client.get(path`/payments/${paymentID}/line-items`, options);
   }
+
+  /**
+   * @example
+   * ```ts
+   * const manualRetry = await client.payments.retry(
+   *   'payment_id',
+   * );
+   * ```
+   */
+  retry(paymentID: string, options?: RequestOptions): APIPromise<ManualRetry> {
+    return this._client.post(path`/payments/${paymentID}/retry`, options);
+  }
+
+  /**
+   * @example
+   * ```ts
+   * const manualRetryState =
+   *   await client.payments.retrieveRetryState('payment_id');
+   * ```
+   */
+  retrieveRetryState(paymentID: string, options?: RequestOptions): APIPromise<ManualRetryState> {
+    return this._client.get(path`/payments/${paymentID}/retry`, options);
+  }
 }
 
 export type PaymentListResponsesDefaultPageNumberPagination =
@@ -177,6 +200,65 @@ export type IntentStatus =
   | 'partially_captured'
   | 'partially_captured_and_capturable';
 
+export interface ManualRetry {
+  /**
+   * The invoice the send charged.
+   */
+  invoice_id: string;
+
+  /**
+   * Always true on this route. Tells the row apart from an automatic attempt.
+   */
+  is_manual_retry: boolean;
+
+  /**
+   * The payment row this send created.
+   */
+  payment_id: string;
+
+  /**
+   * Which attempt this send is, counting manual sends on the invoice.
+   */
+  retry_attempt: number;
+
+  sends_allowed: number;
+
+  /**
+   * Manual sends spent on this invoice, including this one.
+   */
+  sends_used: number;
+
+  /**
+   * When the next send becomes available. Null when no send is left.
+   */
+  retry_available_at?: string | null;
+
+  /**
+   * Outcome of the charge. `processing` means the processor has not settled it yet,
+   * and the payment webhooks report the result.
+   */
+  status?: IntentStatus | null;
+}
+
+export interface ManualRetryState {
+  can_retry: boolean;
+
+  sends_allowed: number;
+
+  sends_used: number;
+
+  /**
+   * The code `POST` would fail with. Null when `can_retry` is true.
+   */
+  reason?: string | null;
+
+  /**
+   * When the next send becomes available. Null when no send is left, or when the
+   * block has nothing to do with the cooldown.
+   */
+  retry_available_at?: string | null;
+}
+
 export interface NewCustomer {
   /**
    * Email is required for creating a new customer
@@ -1065,6 +1147,8 @@ export declare namespace Payments {
     type CustomerLimitedDetails as CustomerLimitedDetails,
     type CustomerRequest as CustomerRequest,
     type IntentStatus as IntentStatus,
+    type ManualRetry as ManualRetry,
+    type ManualRetryState as ManualRetryState,
     type NewCustomer as NewCustomer,
     type OneTimeProductCartItem as OneTimeProductCartItem,
     type Payment as Payment,

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 });
   }
 
   /**
@@ -699,7 +695,8 @@ export type SubscriptionStatus =
   | 'paused'
   | 'cancelled'
   | 'failed'
-  | 'expired';
+  | 'expired'
+  | 'past_due';
 
 /**
  * Unit of a duration count (e.g. license-key validity period).
@@ -738,6 +735,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 +1064,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;
 }
@@ -1339,7 +1393,7 @@ export interface SubscriptionListParams extends DefaultPageNumberPaginationParam
   /**
    * Filter by status
    */
-  status?: 'pending' | 'active' | 'on_hold' | 'paused' | 'cancelled' | 'failed' | 'expired';
+  status?: 'pending' | 'active' | 'on_hold' | 'paused' | 'cancelled' | 'failed' | 'expired' | 'past_due';
 }
 
 export interface SubscriptionCreateParams {
@@ -1495,6 +1549,7 @@ export interface SubscriptionUpdateParams {
     | 'cancelled_by_customer'
     | 'cancelled_by_merchant'
     | 'cancelled_by_merchant_send_dunning'
+    | 'cancelled_by_merchant_grace_period_expired'
     | 'dodo_team'
     | null;
 
@@ -1535,11 +1590,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 +1749,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 +1893,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 +1976,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/resources/webhook-events.ts

@@ -32,6 +32,7 @@ export type WebhookEventType =
   | 'subscription.active'
   | 'subscription.renewed'
   | 'subscription.on_hold'
+  | 'subscription.past_due'
   | 'subscription.paused'
   | 'subscription.unpaused'
   | 'subscription.cancelled'
@@ -105,6 +106,17 @@ export namespace WebhookPayload {
    */
   export interface Subscription extends SubscriptionsAPI.Subscription {
     payload_type: 'Subscription';
+
+    /**
+     * Time when the grace period ends. The subscription moves to `on_hold` or to
+     * `cancelled` at this time.
+     *
+     * Read in the same query as the rest of the payload, so it always comes from the
+     * row snapshot that produced `status`. It is set whenever the subscription sits in
+     * a window at that moment. A delayed event of another type therefore carries the
+     * deadline too, next to a `past_due` status.
+     */
+    past_due_ends_at?: string | null;
   }
 
   export interface Refund extends RefundsAPI.Refund {
@@ -270,7 +282,7 @@ export namespace WebhookPayload {
 
     subscription_id: string;
 
-    trigger_state: 'on_hold' | 'cancelled';
+    trigger_state: 'on_hold' | 'cancelled' | 'past_due';
 
     payment_id?: string | null;
   }

package/src/resources/webhooks/index.ts

@@ -46,6 +46,7 @@ export {
   type SubscriptionExpiredWebhookEvent,
   type SubscriptionFailedWebhookEvent,
   type SubscriptionOnHoldWebhookEvent,
+  type SubscriptionPastDueWebhookEvent,
   type SubscriptionPausedWebhookEvent,
   type SubscriptionPlanChangedWebhookEvent,
   type SubscriptionRenewedWebhookEvent,