dodopayments 2.48.0 → 2.50.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/checkout-sessions.ts

@@ -678,6 +678,12 @@ export interface CheckoutSessionPreviewResponse {
    */
   is_byop: boolean;
 
+  /**
+   * False when the customer can confirm this session with no card. True for every
+   * other cart, including a one-time cart.
+   */
+  payment_method_required: boolean;
+
   /**
    * The total product cart
    */

package/src/resources/credit-entitlements/balances.ts

@@ -216,6 +216,7 @@ export class Balances extends APIResource {
    * - `reason` - Optional human-readable reason
    * - `expires_at` - Optional expiration for credited amount (only for credit type)
    * - `idempotency_key` - Optional key to prevent duplicate entries
+   * - `metadata` - Optional key-value pairs
    *
    * # Responses
    *
@@ -287,9 +288,7 @@ export interface CreditLedgerEntry {
   is_credit: boolean;
 
   /**
-   * Metadata associated with the credit grant's source (the subscription or payment
-   * created at checkout). Empty when the grant has no resolvable source (e.g.
-   * credits granted directly via the API).
+   * Metadata associated with this entry.
    */
   metadata: MiscAPI.Metadata;
 
@@ -363,6 +362,11 @@ export interface BalanceCreateLedgerEntryResponse {
 
   is_credit: boolean;
 
+  /**
+   * Metadata stored on this entry.
+   */
+  metadata: MiscAPI.Metadata;
+
   overage_after: string;
 
   overage_before: string;
@@ -489,7 +493,7 @@ export interface BalanceCreateLedgerEntryParams {
 
   /**
    * Body param: Optional metadata (max 50 key-value pairs, key max 40 chars, value
-   * max 500 chars)
+   * max 500 chars).
    */
   metadata?: MiscAPI.Metadata | null;
 

package/src/resources/customers/customers.ts

@@ -5,6 +5,18 @@ import * as MiscAPI from '../misc';
 import * as PaymentsAPI from '../payments';
 import * as CustomerPortalAPI from './customer-portal';
 import { CustomerPortal, CustomerPortalCreateParams } from './customer-portal';
+import * as EmailsAPI from './emails';
+import {
+  EmailBody,
+  EmailFailureCode,
+  EmailListParams,
+  EmailLogItem,
+  EmailLogItemsDefaultPageNumberPagination,
+  EmailLogStatus,
+  EmailPolicies,
+  EmailRetrieveBodyParams,
+  Emails,
+} from './emails';
 import * as EntitlementsAPI from '../entitlements/entitlements';
 import * as GrantsAPI from '../entitlements/grants';
 import { EntitlementGrantsDefaultPageNumberPagination } from '../entitlements/grants';
@@ -23,6 +35,7 @@ import { path } from '../../internal/utils/path';
 export class Customers extends APIResource {
   customerPortal: CustomerPortalAPI.CustomerPortal = new CustomerPortalAPI.CustomerPortal(this._client);
   wallets: WalletsAPI.Wallets = new WalletsAPI.Wallets(this._client);
+  emails: EmailsAPI.Emails = new EmailsAPI.Emails(this._client);
 
   /**
    * @example
@@ -192,6 +205,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
    */
@@ -418,6 +443,7 @@ export interface CustomerListEntitlementGrantsParams extends DefaultPageNumberPa
 
 Customers.CustomerPortal = CustomerPortal;
 Customers.Wallets = Wallets;
+Customers.Emails = Emails;
 
 export declare namespace Customers {
   export {
@@ -441,6 +467,18 @@ export declare namespace Customers {
     type CustomerWallet as CustomerWallet,
     type WalletListResponse as WalletListResponse,
   };
+
+  export {
+    Emails as Emails,
+    type EmailBody as EmailBody,
+    type EmailFailureCode as EmailFailureCode,
+    type EmailLogItem as EmailLogItem,
+    type EmailLogStatus as EmailLogStatus,
+    type EmailPolicies as EmailPolicies,
+    type EmailLogItemsDefaultPageNumberPagination as EmailLogItemsDefaultPageNumberPagination,
+    type EmailListParams as EmailListParams,
+    type EmailRetrieveBodyParams as EmailRetrieveBodyParams,
+  };
 }
 
 export { type EntitlementGrantsDefaultPageNumberPagination };

package/src/resources/customers/emails.ts

@@ -0,0 +1,238 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import { APIPromise } from '../../core/api-promise';
+import {
+  DefaultPageNumberPagination,
+  type DefaultPageNumberPaginationParams,
+  PagePromise,
+} from '../../core/pagination';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class Emails extends APIResource {
+  /**
+   * Returns every transactional email sent to this customer in the last 180 days,
+   * newest first, with its delivery outcome. Delivery status comes from the email
+   * provider and is as fresh as replication, typically seconds.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const emailLogItem of client.customers.emails.list(
+   *   'customer_id',
+   * )) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    customerID: string,
+    query: EmailListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<EmailLogItemsDefaultPageNumberPagination, EmailLogItem> {
+    return this._client.getAPIList(
+      path`/customers/${customerID}/emails`,
+      DefaultPageNumberPagination<EmailLogItem>,
+      { query, ...options },
+    );
+  }
+
+  /**
+   * Returns the email exactly as it was sent, plus the reason it failed when it did.
+   * Some emails have no body to show: an authentication email carries a live login
+   * token, a blocked email never reached the provider, and the provider clears
+   * bodies at 180 days.
+   *
+   * @example
+   * ```ts
+   * const emailBody =
+   *   await client.customers.emails.retrieveBody(
+   *     'email_log_id',
+   *     { customer_id: 'customer_id' },
+   *   );
+   * ```
+   */
+  retrieveBody(
+    emailLogID: string,
+    params: EmailRetrieveBodyParams,
+    options?: RequestOptions,
+  ): APIPromise<EmailBody> {
+    const { customer_id } = params;
+    return this._client.get(path`/customers/${customer_id}/emails/${emailLogID}/body`, options);
+  }
+}
+
+export type EmailLogItemsDefaultPageNumberPagination = DefaultPageNumberPagination<EmailLogItem>;
+
+export interface EmailBody {
+  /**
+   * Whether the merchant wrote this content. It is true for the recovery and dunning
+   * emails, which the merchant writes.
+   *
+   * The content is email HTML. Render it in a sandbox, whatever this value is.
+   */
+  merchant_authored: boolean;
+
+  /**
+   * Why the email did not arrive. It is null unless the email failed.
+   */
+  failure_code?: EmailFailureCode | null;
+
+  /**
+   * A sentence that explains `failure_code`. It is null unless the email failed.
+   */
+  failure_reason?: string | null;
+
+  /**
+   * The stored HTML. It is null on a text-only email.
+   */
+  html?: string | null;
+
+  /**
+   * The stored plain text.
+   */
+  text?: string | null;
+}
+
+/**
+ * Why an email did not reach the recipient.
+ *
+ * The code is stable. `send_failed` is the catch-all: it covers every failure that
+ * the other codes do not name.
+ */
+export type EmailFailureCode =
+  | 'mailbox_not_found'
+  | 'address_rejected'
+  | 'address_suppressed'
+  | 'mailbox_full'
+  | 'temporary_failure'
+  | 'message_too_large'
+  | 'marked_as_spam'
+  | 'send_failed';
+
+export interface EmailLogItem {
+  /**
+   * The group this email belongs to: payments, refunds, subscriptions,
+   * dunning_recovery, entitlements or auth.
+   */
+  category: string;
+
+  /**
+   * When this email was sent.
+   */
+  created_at: string;
+
+  /**
+   * Identifies this email. Use it to read the body or to send it again.
+   */
+  email_log_id: string;
+
+  /**
+   * What kind of email this is, for example `payment_successful`.
+   */
+  email_type: string;
+
+  /**
+   * Whether this email has content to show. The content endpoint can still refuse,
+   * because the content is removed after 180 days.
+   */
+  has_preview: boolean;
+
+  /**
+   * What you may do with this email.
+   */
+  policies: EmailPolicies;
+
+  /**
+   * Where the email got to: sent, delivered, failed, complained or blocked.
+   */
+  status: EmailLogStatus;
+
+  /**
+   * Why the email did not arrive. It is null unless the email failed.
+   */
+  failure_code?: EmailFailureCode | null;
+
+  /**
+   * A sentence that explains `failure_code`. It is null unless the email failed.
+   */
+  failure_reason?: string | null;
+
+  /**
+   * The address the email was sent from.
+   */
+  from?: string | null;
+
+  /**
+   * What the merchant typed, when test mode redirected the send to the business
+   * owner.
+   */
+  intended_recipient?: string | null;
+
+  /**
+   * The address the email reached.
+   */
+  recipient?: string | null;
+
+  /**
+   * The subject line as it was sent. Empty until the provider replicates.
+   */
+  subject?: string | null;
+}
+
+/**
+ * The delivery status of one email.
+ *
+ * `sent` also covers an email that is still on its way. A status only becomes
+ * `delivered`, `failed` or `complained` when the mail server answers.
+ */
+export type EmailLogStatus = 'sent' | 'delivered' | 'failed' | 'complained' | 'blocked';
+
+/**
+ * What the merchant may do with one row. The server decides; the client never
+ * derives eligibility itself.
+ */
+export interface EmailPolicies {
+  /**
+   * A permanent failure was recorded, so the same address would be a no-op.
+   */
+  requires_different_address: boolean;
+
+  /**
+   * The row was delivered and may be sent again.
+   */
+  resend_allowed: boolean;
+
+  /**
+   * How many sends are left in this email's chain.
+   */
+  resends_remaining: number;
+
+  /**
+   * The row failed and may be sent again.
+   */
+  retry_allowed: boolean;
+}
+
+export interface EmailListParams extends DefaultPageNumberPaginationParams {}
+
+export interface EmailRetrieveBodyParams {
+  /**
+   * The customer's id
+   */
+  customer_id: string;
+}
+
+export declare namespace Emails {
+  export {
+    type EmailBody as EmailBody,
+    type EmailFailureCode as EmailFailureCode,
+    type EmailLogItem as EmailLogItem,
+    type EmailLogStatus as EmailLogStatus,
+    type EmailPolicies as EmailPolicies,
+    type EmailLogItemsDefaultPageNumberPagination as EmailLogItemsDefaultPageNumberPagination,
+    type EmailListParams as EmailListParams,
+    type EmailRetrieveBodyParams as EmailRetrieveBodyParams,
+  };
+}

package/src/resources/customers/index.ts

@@ -15,4 +15,15 @@ export {
   type CustomerListEntitlementGrantsParams,
   type CustomersDefaultPageNumberPagination,
 } from './customers';
+export {
+  Emails,
+  type EmailBody,
+  type EmailFailureCode,
+  type EmailLogItem,
+  type EmailLogStatus,
+  type EmailPolicies,
+  type EmailListParams,
+  type EmailRetrieveBodyParams,
+  type EmailLogItemsDefaultPageNumberPagination,
+} from './emails';
 export { Wallets, type CustomerWallet, type WalletListResponse } from './wallets/index';

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,
@@ -302,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

@@ -69,7 +69,6 @@ export class Products extends APIResource {
    *   name: 'name',
    *   price: {
    *     currency: 'AED',
-   *     discount: 0,
    *     price: 0,
    *     type: 'one_time_price',
    *   },
@@ -486,11 +485,6 @@ export namespace Price {
      */
     currency: MiscAPI.Currency;
 
-    /**
-     * Discount applied to the price, represented as a percentage (0 to 100).
-     */
-    discount: number;
-
     /**
      * The payment amount, in the smallest denomination of the currency (e.g., cents
      * for USD). For example, to charge $1.00, pass `100`.
@@ -502,6 +496,23 @@ export namespace Price {
 
     type: 'one_time_price';
 
+    /**
+     * @deprecated Deprecated: use `discount_bps` instead.
+     *
+     * Discount applied to the price, represented as a percentage (0 to 100). A
+     * response rounds this value to the nearest whole percent. Defaults to `0`.
+     */
+    discount?: number;
+
+    /**
+     * Discount applied to the price, in basis points. 100 basis points make one
+     * percent, so `1250` is a discount of 12.5%.
+     *
+     * Use this field for a discount with a fraction of a percent. A request that sends
+     * this field ignores `discount`. A value of `0` gives no discount.
+     */
+    discount_bps?: number | null;
+
     /**
      * Indicates whether the customer can pay any amount they choose. If set to `true`,
      * the [`price`](Self::price) field is the minimum amount.
@@ -537,11 +548,6 @@ export namespace Price {
      */
     currency: MiscAPI.Currency;
 
-    /**
-     * Discount applied to the price, represented as a percentage (0 to 100).
-     */
-    discount: number;
-
     /**
      * Number of units for the payment frequency. For example, a value of `1` with a
      * `payment_frequency_interval` of `month` represents monthly payments.
@@ -572,6 +578,23 @@ export namespace Price {
 
     type: 'recurring_price';
 
+    /**
+     * @deprecated Deprecated: use `discount_bps` instead.
+     *
+     * Discount applied to the price, represented as a percentage (0 to 100). A
+     * response rounds this value to the nearest whole percent. Defaults to `0`.
+     */
+    discount?: number;
+
+    /**
+     * Discount applied to the price, in basis points. 100 basis points make one
+     * percent, so `1250` is a discount of 12.5%.
+     *
+     * Use this field for a discount with a fraction of a percent. A request that sends
+     * this field ignores `discount`. A value of `0` gives no discount.
+     */
+    discount_bps?: number | null;
+
     /**
      * Opts this price in to purchasing power parity. The business must also enable
      * purchasing power parity. The discount percentage per country is always
@@ -596,10 +619,21 @@ export namespace Price {
      */
     trial_apply_discounts?: boolean | null;
 
+    /**
+     * Let a customer start a free trial with no card. Defaults to false.
+     */
+    trial_payment_method_optional?: boolean;
+
     /**
      * Number of days for the trial period. A value of `0` indicates no trial period.
      */
     trial_period_days?: number;
+
+    /**
+     * Let a customer start a subscription with no card, when the amount due today is
+     * `0` (a native `0` price, or a 100% discount). Defaults to false.
+     */
+    zero_amount_payment_method_optional?: boolean;
   }
 
   /**
@@ -611,11 +645,6 @@ export namespace Price {
      */
     currency: MiscAPI.Currency;
 
-    /**
-     * Discount applied to the price, represented as a percentage (0 to 100).
-     */
-    discount: number;
-
     /**
      * The fixed payment amount. Represented in the lowest denomination of the currency
      * (e.g., cents for USD). For example, to charge $1.00, pass `100`.
@@ -646,6 +675,23 @@ export namespace Price {
 
     type: 'usage_based_price';
 
+    /**
+     * @deprecated Deprecated: use `discount_bps` instead.
+     *
+     * Discount applied to the price, represented as a percentage (0 to 100). A
+     * response rounds this value to the nearest whole percent. Defaults to `0`.
+     */
+    discount?: number;
+
+    /**
+     * Discount applied to the price, in basis points. 100 basis points make one
+     * percent, so `1250` is a discount of 12.5%.
+     *
+     * Use this field for a discount with a fraction of a percent. A request that sends
+     * this field ignores `discount`. A value of `0` gives no discount.
+     */
+    discount_bps?: number | null;
+
     meters?: Array<ProductsAPI.AddMeterToPrice> | null;
 
     /**