@delopay/sdk 0.30.0 → 0.32.0

package/dist/index.d.cts

@@ -185,6 +185,8 @@ interface PaymentCreateRequest {
     allowed_payment_method_types?: PaymentMethodType[] | null;
     /** Browser metadata for 3-D Secure fingerprinting. */
     browser_info?: Record<string, unknown> | null;
+    /** Set to `true` to generate a hosted payment link for this payment. */
+    payment_link?: boolean | null;
 }
 interface PaymentUpdateRequest {
     amount?: number | null;
@@ -217,6 +219,8 @@ interface PaymentUpdateRequest {
     phone_country_code?: string | null;
 }
 interface PaymentConfirmRequest {
+    /** Client secret from the created payment, required for client-side confirmation with a publishable key. */
+    client_secret?: string | null;
     payment_method?: PaymentMethod | null;
     payment_method_type?: PaymentMethodType | null;
     payment_method_data?: Record<string, unknown> | null;
@@ -323,6 +327,8 @@ interface PaymentResponse {
     disputes?: DisputeResponse[] | null;
     /** Instructions for completing additional customer actions (3DS redirect, etc.). */
     next_action?: Record<string, unknown> | null;
+    /** Hosted payment link details, present when the payment was created with `payment_link: true`. */
+    payment_link?: PaymentLinkResponse | null;
     /** Reason provided when the payment was cancelled. */
     cancellation_reason?: string | null;
     /** Bank statement descriptor (name portion). */
@@ -541,6 +547,8 @@ interface PaymentMethodResponse {
     client_secret?: string | null;
     status?: string | null;
     billing?: Address | null;
+    /** Token used to charge this saved method on a later payment (pass as `payment_token` to `payments.create`). */
+    payment_token?: string | null;
 }
 interface PaymentMethodListParams {
     client_secret?: string | null;
@@ -668,6 +676,8 @@ interface ShopUpdateRequest {
     return_url?: string | null;
     webhook_url?: string | null;
     is_active?: boolean | null;
+    /** Webhook signing secret for this shop. Outgoing webhooks are HMAC-SHA512 signed with this key. */
+    payment_response_hash_key?: string | null;
     payment_link_config?: BusinessPaymentLinkConfig | null;
     /**
      * Origins permitted to embed this shop's hosted checkout in an iframe.
@@ -1597,6 +1607,11 @@ interface ProfileCreateRequest {
      * clickjacking defense.
      */
     iframe_allowed_origins?: string[] | null;
+    /**
+     * Merchant connector account ID of the billing processor (e.g. Stripe
+     * Billing / PayPal) that owns this profile's native subscriptions.
+     */
+    billing_processor_id?: string | null;
 }
 interface ProfileUpdateRequest {
     profile_name?: string | null;
@@ -1612,6 +1627,11 @@ interface ProfileUpdateRequest {
      * iframe. See {@link ProfileCreateRequest.iframe_allowed_origins}.
      */
     iframe_allowed_origins?: string[] | null;
+    /**
+     * Merchant connector account ID of the billing processor (e.g. Stripe
+     * Billing / PayPal) that owns this profile's native subscriptions.
+     */
+    billing_processor_id?: string | null;
 }
 interface ProfileResponse {
     merchant_id: string;
@@ -1635,6 +1655,11 @@ interface ProfileResponse {
      * iframe. See {@link ProfileCreateRequest.iframe_allowed_origins}.
      */
     iframe_allowed_origins?: string[] | null;
+    /**
+     * Merchant connector account ID of the billing processor (e.g. Stripe
+     * Billing / PayPal) that owns this profile's native subscriptions.
+     */
+    billing_processor_id?: string | null;
     [key: string]: unknown;
 }
 type BlocklistAddRequest = {
@@ -1825,40 +1850,289 @@ interface ThreeDsRuleExecuteRequest {
 interface ThreeDsRuleResponse {
     decision: ThreeDSDecision;
 }
-interface SubscriptionCreateRequest {
-    customer_id?: string;
-    payment_method_id?: string;
+/** Lifecycle status of a subscription. */
+type SubscriptionStatus = 'active' | 'created' | 'in_active' | 'pending' | 'trial' | 'paused' | 'unpaid' | 'onetime' | 'cancelled' | 'failed';
+/** Status of an invoice raised for one subscription billing cycle. */
+type InvoiceStatus = 'invoice_created' | 'payment_pending' | 'payment_pending_timeout' | 'payment_succeeded' | 'payment_failed' | 'payment_canceled' | 'invoice_paid' | 'manual_review' | 'voided';
+/** Billing interval unit for a subscription item price. */
+type SubscriptionPeriodUnit = 'Day' | 'Week' | 'Month' | 'Year';
+/** How the customer's saved payment method may be used for future payments. */
+type FutureUsage = 'off_session' | 'on_session';
+/** Item-type filter for `GET /subscriptions/items`. */
+type SubscriptionItemType = 'plan' | 'addon';
+/**
+ * Payment leg attached to a subscription invoice. Present once a charge has
+ * been attempted for the current billing cycle.
+ */
+interface SubscriptionPaymentData {
+    payment_id: string;
+    status: IntentStatus;
     amount: number;
     currency: Currency;
-    recurring_details?: Record<string, unknown>;
-    metadata?: Record<string, unknown>;
-    [key: string]: unknown;
-}
-interface SubscriptionUpdateRequest {
-    amount?: number;
-    currency?: Currency;
-    metadata?: Record<string, unknown>;
-    [key: string]: unknown;
+    profile_id?: string | null;
+    connector?: string | null;
+    payment_method_id?: string | null;
+    return_url?: string | null;
+    /** Next action to drive on the client (redirect, render QR, etc.). */
+    next_action?: Record<string, unknown> | null;
+    payment_experience?: string | null;
+    error_code?: string | null;
+    error_message?: string | null;
+    payment_method_type?: PaymentMethodType | null;
+    client_secret?: string | null;
+    billing?: Address | null;
+    shipping?: Address | null;
+    payment_type?: string | null;
+    payment_token?: string | null;
 }
-interface SubscriptionResponse {
+/** A single invoice raised for one billing cycle of a subscription. */
+interface SubscriptionInvoice {
+    id: string;
     subscription_id: string;
-    customer_id?: string;
-    status: string;
+    merchant_id: string;
+    profile_id: string;
+    merchant_connector_id: string;
+    payment_intent_id?: string | null;
+    payment_method_id?: string | null;
+    customer_id: string;
     amount: number;
     currency: Currency;
-    created_at: string;
-    metadata?: Record<string, unknown>;
-    [key: string]: unknown;
+    status: InvoiceStatus;
+    /** ID of this invoice on the billing processor (Stripe Billing / PayPal). */
+    billing_processor_invoice_id?: string | null;
+}
+/** A purchasable price option for a subscription item (plan or addon). */
+interface SubscriptionItemPrice {
+    price_id: string;
+    /** Plan or addon ID this price belongs to. */
+    item_id?: string | null;
+    amount: number;
+    currency: Currency;
+    interval: SubscriptionPeriodUnit;
+    interval_count: number;
+    trial_period?: number | null;
+    trial_period_unit?: SubscriptionPeriodUnit | null;
+}
+/** A subscription item (plan or addon) with its available prices. */
+interface SubscriptionItem {
+    item_id: string;
+    name: string;
+    description?: string | null;
+    /** Available prices for this item. */
+    price_id: SubscriptionItemPrice[];
+}
+/** A single line of a subscription cost estimate. */
+interface SubscriptionLineItem {
+    item_id: string;
+    item_type: string;
+    description: string;
+    amount: number;
+    currency: Currency;
+    quantity: number;
+}
+/** Payment options for `POST /subscriptions/create` (create without confirming). */
+interface CreateSubscriptionPaymentDetails {
+    /** URL the customer is returned to after completing the purchase. */
+    return_url: string;
+    setup_future_usage?: FutureUsage | null;
+    capture_method?: CaptureMethod | null;
+    authentication_type?: AuthenticationType | null;
+    payment_type?: string | null;
+}
+/** Body for `POST /subscriptions/create`. */
+interface CreateSubscriptionRequest {
+    merchant_reference_id?: string | null;
+    item_price_id: string;
+    plan_id?: string | null;
+    coupon_code?: string | null;
+    customer_id: string;
+    payment_details: CreateSubscriptionPaymentDetails;
+    billing?: Address | null;
+    shipping?: Address | null;
+}
+/** Payment options for `POST /subscriptions` (create + confirm in one call). */
+interface SubscriptionPaymentDetails {
+    payment_method?: PaymentMethod | null;
+    payment_method_type?: PaymentMethodType | null;
+    payment_method_data?: Record<string, unknown> | null;
+    setup_future_usage?: FutureUsage | null;
+    customer_acceptance?: Record<string, unknown> | null;
+    /** URL the customer is returned to after completing the purchase. */
+    return_url?: string | null;
+    capture_method?: CaptureMethod | null;
+    authentication_type?: AuthenticationType | null;
+    payment_type?: string | null;
+    payment_method_id?: string | null;
+}
+/** Body for `POST /subscriptions` (create and immediately confirm). */
+interface CreateAndConfirmSubscriptionRequest {
+    plan_id?: string | null;
+    item_price_id: string;
+    coupon_code?: string | null;
+    customer_id: string;
+    billing?: Address | null;
+    shipping?: Address | null;
+    payment_details: SubscriptionPaymentDetails;
+    merchant_reference_id?: string | null;
 }
+/** Payment options for `POST /subscriptions/{id}/confirm`. */
+interface ConfirmSubscriptionPaymentDetails {
+    shipping?: Address | null;
+    billing?: Address | null;
+    payment_method: PaymentMethod;
+    payment_method_type?: PaymentMethodType | null;
+    payment_method_data?: Record<string, unknown> | null;
+    customer_acceptance?: Record<string, unknown> | null;
+    payment_type?: string | null;
+    payment_token?: string | null;
+}
+/** Body for `POST /subscriptions/{id}/confirm`. */
+interface ConfirmSubscriptionRequest {
+    /** Client secret minted at create time; required for client-side confirm. */
+    client_secret?: string | null;
+    payment_details: ConfirmSubscriptionPaymentDetails;
+}
+/** Body for `PUT /subscriptions/{id}/update`. */
+interface UpdateSubscriptionRequest {
+    plan_id: string;
+    item_price_id: string;
+}
+/** Body for `POST /subscriptions/{id}/pause`. */
+interface PauseSubscriptionRequest {
+    pause_option?: 'immediately' | 'end_of_term' | 'specific_date' | null;
+    /** ISO-8601 timestamp; honoured when `pause_option` is `specific_date`. */
+    pause_at?: string | null;
+}
+/** Body for `POST /subscriptions/{id}/resume`. */
+interface ResumeSubscriptionRequest {
+    resume_option?: 'immediately' | 'specific_date' | null;
+    resume_date?: string | null;
+    charges_handling?: 'invoice_immediately' | 'add_to_unbilled_charges' | null;
+    unpaid_invoices_handling?: 'no_action' | 'schedule_payment_collection' | null;
+}
+/** Body for `POST /subscriptions/{id}/cancel`. */
+interface CancelSubscriptionRequest {
+    cancel_option?: 'immediately' | 'end_of_term' | 'specific_date' | null;
+    cancel_at?: string | null;
+    unbilled_charges_option?: 'invoice' | 'delete' | null;
+    credit_option_for_current_term_charges?: 'none' | 'prorate' | 'full' | null;
+    account_receivables_handling?: 'no_action' | 'schedule_payment_collection' | 'write_off' | null;
+    refundable_credits_handling?: 'no_action' | 'schedule_refund' | null;
+    cancel_reason_code?: string | null;
+}
+/** Query for `GET /subscriptions/list`. */
 interface SubscriptionListParams {
     limit?: number;
     offset?: number;
-    customer_id?: string;
-    status?: string;
 }
-interface SubscriptionListResponse {
-    count: number;
-    data: SubscriptionResponse[];
+/** Query for `GET /subscriptions/items`. */
+interface GetSubscriptionItemsParams {
+    client_secret?: string;
+    limit?: number;
+    offset?: number;
+    item_type: SubscriptionItemType;
+}
+/** Query for `GET /subscriptions/estimate`. */
+interface SubscriptionEstimateParams {
+    plan_id?: string;
+    item_price_id: string;
+    coupon_code?: string;
+}
+/**
+ * A subscription, as returned by create / retrieve / update / list. The
+ * confirm and create-and-confirm flows return {@link ConfirmSubscriptionResponse}
+ * instead, which additionally carries the billing-processor subscription ID and
+ * the approval `redirect_url`.
+ */
+interface SubscriptionResponse {
+    id: string;
+    merchant_reference_id?: string | null;
+    status: SubscriptionStatus;
+    plan_id?: string | null;
+    item_price_id?: string | null;
+    profile_id: string;
+    /** Token (15-min TTL) used by the client SDK to authenticate confirm/session calls. */
+    client_secret?: string | null;
+    merchant_id: string;
+    coupon_code?: string | null;
+    customer_id: string;
+    payment?: SubscriptionPaymentData | null;
+    invoice?: SubscriptionInvoice | null;
+}
+/**
+ * Returned by `POST /subscriptions` (create + confirm) and
+ * `POST /subscriptions/{id}/confirm`.
+ */
+interface ConfirmSubscriptionResponse {
+    id: string;
+    merchant_reference_id?: string | null;
+    status: SubscriptionStatus;
+    plan_id?: string | null;
+    item_price_id?: string | null;
+    coupon?: string | null;
+    profile_id: string;
+    payment?: SubscriptionPaymentData | null;
+    customer_id?: string | null;
+    invoice?: SubscriptionInvoice | null;
+    /** Subscription ID on the billing processor (Stripe Billing / PayPal). */
+    billing_processor_subscription_id?: string | null;
+    /**
+     * URL the customer must be redirected to in order to approve the
+     * subscription, for billing processors that require buyer approval
+     * (e.g. PayPal `APPROVAL_PENDING`). `null` for processors that activate the
+     * subscription server-side (e.g. Stripe Billing with a saved payment method).
+     */
+    redirect_url?: string | null;
+}
+/** Returned by `POST /subscriptions/{id}/pause`. */
+interface PauseSubscriptionResponse {
+    id: string;
+    status: SubscriptionStatus;
+    merchant_reference_id?: string | null;
+    profile_id: string;
+    merchant_id: string;
+    customer_id: string;
+    /** ISO-8601 timestamp the subscription was paused at. */
+    paused_at?: string | null;
+}
+/** Returned by `POST /subscriptions/{id}/resume`. */
+interface ResumeSubscriptionResponse {
+    id: string;
+    status: SubscriptionStatus;
+    merchant_reference_id?: string | null;
+    profile_id: string;
+    merchant_id: string;
+    customer_id: string;
+    /** ISO-8601 timestamp of the next billing cycle. */
+    next_billing_at?: string | null;
+}
+/** Returned by `POST /subscriptions/{id}/cancel`. */
+interface CancelSubscriptionResponse {
+    id: string;
+    status: SubscriptionStatus;
+    merchant_reference_id?: string | null;
+    profile_id: string;
+    merchant_id: string;
+    customer_id: string;
+    /** ISO-8601 timestamp the subscription was cancelled at. */
+    cancelled_at?: string | null;
+}
+/** A subscription item with its prices, as returned by `GET /subscriptions/items`. */
+interface GetSubscriptionItemsResponse {
+    item_id: string;
+    name: string;
+    description?: string | null;
+    price_id: SubscriptionItemPrice[];
+}
+/** Returned by `GET /subscriptions/estimate`. */
+interface SubscriptionEstimateResponse {
+    amount: number;
+    currency: Currency;
+    plan_id?: string | null;
+    item_price_id?: string | null;
+    coupon_code?: string | null;
+    customer_id?: string | null;
+    line_items: SubscriptionLineItem[];
 }
 interface RegionCreateRequest {
     region_name: string;
@@ -2492,18 +2766,20 @@ declare class Payments {
      * Create a new payment intent.
      *
      * @param params - Payment creation parameters including amount and currency.
+     * @param options - Optional per-call extras: extra `headers` (e.g. an
+     *   `Idempotency-Key` to make the create safe to retry), a `timeout` override,
+     *   and an `AbortSignal`.
      * @returns The created payment intent.
      *
      * @example
      * ```typescript
-     * const payment = await delopay.payments.create({
-     *   amount: 5000,
-     *   currency: 'EUR',
-     *   customer_id: 'cus_123',
-     * });
+     * const payment = await delopay.payments.create(
+     *   { amount: 5000, currency: 'EUR', customer_id: 'cus_123' },
+     *   { headers: { 'Idempotency-Key': 'order_1001' } },
+     * );
      * ```
      */
-    create(params: PaymentCreateRequest): Promise<PaymentResponse>;
+    create(params: PaymentCreateRequest, options?: RequestExtras): Promise<PaymentResponse>;
     /**
      * Retrieve a payment by its ID.
      *
@@ -2562,6 +2838,8 @@ declare class Payments {
      * List payment intents, optionally filtered by customer or date range.
      *
      * @param params - Optional filter and pagination parameters.
+     * @param options - Optional per-call extras: extra `headers`, a `timeout`
+     *   override, and an `AbortSignal` for cancellation.
      * @returns Paginated list of payment intents.
      *
      * @example
@@ -2569,7 +2847,7 @@ declare class Payments {
      * const { data } = await delopay.payments.list({ customer_id: 'cus_123', limit: 25 });
      * ```
      */
-    list(params?: PaymentListParams): Promise<PaymentListResponse>;
+    list(params?: PaymentListParams, options?: RequestExtras): Promise<PaymentListResponse>;
     /** Generate session tokens. `POST /payments/session-tokens` */
     sessionTokens(params: Record<string, unknown>): Promise<Record<string, unknown>>;
     /** Retrieve payment with gateway credentials. `POST /payments/sync` */
@@ -3031,7 +3309,7 @@ declare class Shops {
      *
      * @example
      * ```typescript
-     * const shop = await delopay.shops.create('merch_123', { profile_name: 'EU Store' });
+     * const shop = await delopay.shops.create('merch_123', { shop_name: 'EU Store' });
      * ```
      */
     create(merchantId: string, params: ShopCreateRequest): Promise<ShopResponse>;
@@ -3430,28 +3708,38 @@ declare class Regions {
 declare class Subscriptions {
     private readonly request;
     constructor(request: RequestFn);
-    /** Create and immediately confirm a subscription. `POST /subscriptions` */
-    createAndConfirm(params: SubscriptionCreateRequest): Promise<SubscriptionResponse>;
-    /** Create a subscription (without confirming). `POST /subscriptions/create` */
-    create(params: SubscriptionCreateRequest): Promise<SubscriptionResponse>;
+    /**
+     * Create and immediately confirm a subscription. `POST /subscriptions`
+     *
+     * For billing processors that require buyer approval (e.g. PayPal), the
+     * response carries a `redirect_url` the customer must be sent to.
+     */
+    createAndConfirm(params: CreateAndConfirmSubscriptionRequest): Promise<ConfirmSubscriptionResponse>;
+    /** Create a subscription without confirming it. `POST /subscriptions/create` */
+    create(params: CreateSubscriptionRequest): Promise<SubscriptionResponse>;
     /** Retrieve a subscription by ID. `GET /subscriptions/{subscriptionId}` */
     retrieve(subscriptionId: string): Promise<SubscriptionResponse>;
-    /** Confirm a subscription. `POST /subscriptions/{subscriptionId}/confirm` */
-    confirm(subscriptionId: string, params?: Record<string, unknown>): Promise<SubscriptionResponse>;
-    /** Update a subscription. `PUT /subscriptions/{subscriptionId}/update` */
-    update(subscriptionId: string, params: SubscriptionUpdateRequest): Promise<SubscriptionResponse>;
-    /** List subscriptions. `GET /subscriptions/list` */
-    list(params?: SubscriptionListParams): Promise<SubscriptionListResponse>;
-    /** Get subscription estimate. `GET /subscriptions/estimate` */
-    getEstimate(params?: Record<string, string | number | undefined>): Promise<Record<string, unknown>>;
-    /** Get subscription items. `GET /subscriptions/items` */
-    getItems(params?: Record<string, string | number | undefined>): Promise<Record<string, unknown>>;
+    /**
+     * Confirm a previously created subscription. `POST /subscriptions/{subscriptionId}/confirm`
+     *
+     * Like {@link createAndConfirm}, the response may carry a `redirect_url` for
+     * processors that require buyer approval.
+     */
+    confirm(subscriptionId: string, params: ConfirmSubscriptionRequest): Promise<ConfirmSubscriptionResponse>;
+    /** Update a subscription's plan/price. `PUT /subscriptions/{subscriptionId}/update` */
+    update(subscriptionId: string, params: UpdateSubscriptionRequest): Promise<SubscriptionResponse>;
+    /** List subscriptions for the profile. `GET /subscriptions/list` */
+    list(params?: SubscriptionListParams): Promise<SubscriptionResponse[]>;
+    /** Estimate the cost of a subscription before creating it. `GET /subscriptions/estimate` */
+    getEstimate(params: SubscriptionEstimateParams): Promise<SubscriptionEstimateResponse>;
+    /** List purchasable subscription items (plans/addons). `GET /subscriptions/items` */
+    getItems(params: GetSubscriptionItemsParams): Promise<GetSubscriptionItemsResponse[]>;
     /** Pause a subscription. `POST /subscriptions/{subscriptionId}/pause` */
-    pause(subscriptionId: string): Promise<SubscriptionResponse>;
-    /** Resume a subscription. `POST /subscriptions/{subscriptionId}/resume` */
-    resume(subscriptionId: string): Promise<SubscriptionResponse>;
+    pause(subscriptionId: string, params?: PauseSubscriptionRequest): Promise<PauseSubscriptionResponse>;
+    /** Resume a paused subscription. `POST /subscriptions/{subscriptionId}/resume` */
+    resume(subscriptionId: string, params?: ResumeSubscriptionRequest): Promise<ResumeSubscriptionResponse>;
     /** Cancel a subscription. `POST /subscriptions/{subscriptionId}/cancel` */
-    cancel(subscriptionId: string): Promise<SubscriptionResponse>;
+    cancel(subscriptionId: string, params?: CancelSubscriptionRequest): Promise<CancelSubscriptionResponse>;
 }
 
 /**
@@ -3508,6 +3796,12 @@ interface RequestOptions {
     signal?: AbortSignal;
 }
 type RequestFn = <T>(method: string, path: string, options?: RequestOptions) => Promise<T>;
+/**
+ * Per-call options that resource methods accept as an optional final argument:
+ * extra HTTP headers (e.g. `Idempotency-Key`), a per-request timeout override,
+ * and an `AbortSignal` for cancellation.
+ */
+type RequestExtras = Pick<RequestOptions, 'headers' | 'timeout' | 'signal'>;
 /**
  * Delopay API client.
  *
@@ -3517,7 +3811,7 @@ type RequestFn = <T>(method: string, path: string, options?: RequestOptions) =>
  *
  * @example
  * ```typescript
- * const delopay = new Delopay('sk_live_...', { sandbox: false });
+ * const delopay = new Delopay('prd_...', { sandbox: false });
  * const payment = await delopay.payments.create({ amount: 5000, currency: 'EUR' });
  * ```
  */
@@ -3575,7 +3869,7 @@ declare class Delopay {
     /**
      * Create a new Delopay client.
      *
-     * @param apiKey - Your Delopay API key (e.g. `sk_live_...` or `sk_test_...`).
+     * @param apiKey - Your Delopay API key (e.g. `prd_...` or `snd_...`).
      *   Pass an empty string or omit for JWT-only usage (e.g. dashboard apps).
      * @param options - Optional configuration (sandbox mode, base URL override, timeout).
      */
@@ -3608,14 +3902,32 @@ declare class Delopay {
      * Auto-paginate a list endpoint. Yields items one by one, fetching
      * the next page automatically when the current one is exhausted.
      *
-     * @param listFn - A function that takes `{ limit, offset }` and returns `{ data: T[] }` or `T[]`.
+     * Delopay list endpoints use one of two pagination styles, so this helper
+     * supports both:
+     * - **Offset** (default) — for endpoints like `customers.list` that accept
+     *   `offset`/`limit`. Each page advances `offset` by the number of items returned.
+     * - **Cursor** — for endpoints like `payments.list` and `payouts.list` that page
+     *   with `starting_after`/`limit` (they ignore `offset`). Pass a `cursor` extractor
+     *   that returns the id of an item; the next page is requested with
+     *   `starting_after` set to the last item's id.
+     *
+     * @param listFn - A function that takes the paging params and returns `{ data: T[] }` or `T[]`.
      * @param params - Additional parameters to pass to every page request.
-     * @param pageSize - Number of items per page. Defaults to `50`.
+     * @param options - Page size (number) for offset mode, or `{ pageSize?, cursor? }`.
+     *   Provide `cursor` to switch to cursor pagination.
      *
      * @example
      * ```typescript
+     * // Offset endpoint (customers):
+     * for await (const c of delopay.paginate((p) => delopay.customers.list(p))) {
+     *   console.log(c.customer_id);
+     * }
+     *
+     * // Cursor endpoint (payments): extract the id used as the next cursor.
      * for await (const payment of delopay.paginate(
      *   (p) => delopay.payments.list(p),
+     *   undefined,
+     *   { cursor: (p) => p.payment_id },
      * )) {
      *   console.log(payment.payment_id);
      * }
@@ -3623,10 +3935,14 @@ declare class Delopay {
      */
     paginate<T, P extends Record<string, unknown>>(listFn: (params: P & {
         limit: number;
-        offset: number;
+        offset?: number;
+        starting_after?: string;
     }) => Promise<{
         data: T[];
-    } | T[]>, params?: P, pageSize?: number): AsyncGenerator<T>;
+    } | T[]>, params?: P, options?: number | {
+        pageSize?: number;
+        cursor?: (item: T) => string | undefined;
+    }): AsyncGenerator<T>;
 }
 
 /**
@@ -3889,4 +4205,4 @@ declare function parseImportedBranding(raw: unknown): CheckoutBranding;
 declare function applyBrandingVariables(el: HTMLElement, b: CheckoutBranding): void;
 declare function shadowFor(style: SurfaceStyle): string;
 
-export { type Address, type AddressDetails, type AllocationListResponse, type AllocationResponse, type AllocationTransferRequest, type AllocationTransferResponse, Analytics, AnalyticsDashboard, type ApiKeyCreateRequest, type ApiKeyCreateResponse, type ApiKeyExpiration, type ApiKeyResponse, type ApiKeyRevokeResponse, type ApiKeyUpdateRequest, type ApplePayVerificationRequest, type ApplePayVerificationResponse, type ApplePayVerifiedDomainsResponse, type AuthResponse, type AuthenticationCreateRequest, type AuthenticationResponse, type AuthenticationStatus, type AuthenticationType, type AutoRechargeConfig, type AutoRechargeUpdateRequest, BRANDING_EXPORT_FORMAT, BRANDING_EXPORT_VERSION, type BillingCompleteSetupRequest, type BillingProfileResponse, type BillingSetupRequest, type BillingSetupResponse, type BlocklistAddRequest, type BlocklistDataKind, type BlocklistResponse, type BrandingExport, type BrandingSource, type BusinessPaymentLinkConfig, CUSTOM_CSS_MAX_LENGTH, type CaptureMethod, type CardDetail, type CardDetailFromLocker, Cards, type ChangePasswordRequest, type CheckoutBranding, type Connector, type ConnectorCreateRequest, type ConnectorListResponse, type ConnectorResponse, type ConnectorType, type ConnectorUpdateRequest, type ConnectorVolumeSplit, type ConnectorWebhookEntry, type ConnectorWebhookEventType, type ConnectorWebhookListResponse, type ConnectorWebhookRegisterRequest, type ConnectorWebhookRegisterResponse, type CornerRadius, type Currency, type CustomerCreateRequest, type CustomerListParams, type CustomerPaymentMethodsListParams, type CustomerPaymentMethodsListResponse, type CustomerResponse, type CustomerUpdateRequest, DEFAULT_BADGES, DEFAULT_BADGES_DARK, DEFAULT_BRANDING, DEFAULT_BRANDING_DARK, type DeleteAccountRequest, Delopay, DelopayAuthenticationError, DelopayError, type DelopayLogger, type DelopayOptions, type DisputeEvidenceRequest, type DisputeListParams, type DisputeResponse, type DisputeStage, type DisputeStatus, type EncodedBranding, type EphemeralKeyCreateRequest, type EphemeralKeyCreateResponse, type EventClass, type EventDeliveryAttemptResponse, type EventDetailResponse, type EventListParams, type EventListResponse, type EventResponse, type EventType, Export, FeatureMatrix, type FeeOwner, type FeeScheduleCreateRequest, type FeeScheduleResponse, type FeeScheduleUpdateRequest, type FeeType, Files, type FontFamily, type FontWeight, Forex, type ForgotPasswordRequest, type FromEmailRequest, type GatewayConnectRequest, type GatewayResponse, type GlobalSearchRequest, type IntentStatus, type InviteUsersRequest, type InviteUsersResponse, type LabelStyle, type LayoutStyle, type LedgerEntry, type LedgerListParams, type LedgerResponse, type LinkedRoutingConfigRetrieveResponse, type ListInvitableRolesParams, type LoginHistoryEntry, type LoginHistoryParams, type LoginHistoryResponse, type LogoShape, type LogoSize, type MandateListParams, type MandateResponse, type MandateRevokedResponse, type MandateStatus, type MandateType, type MerchantAccountCreateRequest, type MerchantAccountResponse, type MerchantAccountType, type MerchantAccountUpdateRequest, type MerchantOverviewResponse, type MerchantOverviewStat, type MerchantRoutingAlgorithm, type NonPillRadius, type ParentGroup, type ParentGroupInfo, type PaymentCancelRequest, type PaymentCaptureRequest, type PaymentConfirmRequest, type PaymentCreateRequest, type PaymentLayout, type PaymentLinkBackgroundImageConfig, type PaymentLinkConfigRequest, type PaymentLinkListParams, type PaymentLinkListResponse, type PaymentLinkResponse, type PaymentLinkTransactionDetails, type PaymentListParams, type PaymentListResponse, type PaymentMethod, type PaymentMethodCreateRequest, type PaymentMethodDeleteResponse, type PaymentMethodListParams, type PaymentMethodResponse, type PaymentMethodType, type PaymentMethodUpdateRequest, type PaymentResponse, type PaymentRetrieveOptions, type PaymentUpdateRequest, type PayoutCreateRequest, type PayoutListParams, type PayoutListResponse, type PayoutResponse, type PayoutStatus, type PayoutType, type PayoutUpdateRequest, type PermissionScope, type PhoneDetails, type PhoneOtpRequest, type PhoneOtpResponse, type PhoneOtpVerifyRequest, type PhoneOtpVerifyResponse, type PollStatus, type PollStatusResponse, type ProfileAcquirerCreateRequest, type ProfileAcquirerResponse, type ProfileAcquirerUpdateRequest, type ProfileCreateRequest, type ProfileDefaultRoutingConfig, type ProfileLogoUploadResponse, type ProfileResponse, type ProfileUpdateRequest, type ProjectCreateRequest, type ProjectResponse, type ProjectStats, type ProjectStatsResponse, type ProjectUpdateRequest, type RecoveryCodesResponse, type RefundCreateRequest, type RefundListParams, type RefundListResponse, type RefundResponse, type RefundStatus, type RefundType, type RefundUpdateRequest, type RegionCreateRequest, type RegionResponse, type RegionUpdateRequest, Regions, type RelayRequest, type RelayResponse, type RelayStatus, type RelayType, type RequestFn, type RequestOptions, type ResetPasswordRequest, type RoutableConnectorChoice, type RoutingActivatePayload, type RoutingConfigCreateRequest, type RoutingConfigResponse, type RoutingDeactivateRequest, type RoutingDictionary, type RoutingDictionaryRecord, Search, type SearchGroupResponse, type SearchIndex, type SearchStatus, type ShopCreateRequest, type ShopResponse, type ShopStats, type ShopUpdateRequest, type SignInRequest, type SignUpRequest, type SignUpWithMerchantIdRequest, type SignUpWithMerchantRequest, type SizeScale, type SpacingScale, type StaticRoutingAlgorithm, type StripeConnectAccountRequest, type StripeConnectAccountResponse, type StripeConnectLinkRequest, type StripeConnectLinkResponse, type SubscriptionCreateRequest, type SubscriptionListParams, type SubscriptionListResponse, type SubscriptionResponse, type SubscriptionUpdateRequest, Subscriptions, type SummaryPosition, type SurfaceStyle, type SwitchMerchantRequest, type SwitchProfileRequest, type Terminate2faQueryParams, type ThreeDSDecision, type ThreeDsRuleExecuteRequest, type ThreeDsRuleResponse, type TierSummary, type TokenPurpose, type TokenResponse, type TopupRequest, type TopupResponse, type TotpResponse, type TransactionType, type TrustBadge, type UpdateUserDetailsRequest, type UserResponse, type UserSessionEntry, type UserSessionListResponse, type UserSessionRevokeResponse, type VerifyTotpRequest, type WebhookDeliveryAttempt, type WebhookEvent, Webhooks, applyBrandingVariables, buildBrandingExport, buttonPadValue, cloneBranding, decodeBadges, decodeBranding, defaultBranding, encodeBadges, encodeBranding, fontStack, fontWeightValue, inputPadValue, isDarkSurface, isHexColor, logoDimensions, parseImportedBranding, radiusValue, sanitizeCustomCss, shadowFor, surfacePadValue, verticalGapValue };
+export { type Address, type AddressDetails, type AllocationListResponse, type AllocationResponse, type AllocationTransferRequest, type AllocationTransferResponse, Analytics, AnalyticsDashboard, type ApiKeyCreateRequest, type ApiKeyCreateResponse, type ApiKeyExpiration, type ApiKeyResponse, type ApiKeyRevokeResponse, type ApiKeyUpdateRequest, type ApplePayVerificationRequest, type ApplePayVerificationResponse, type ApplePayVerifiedDomainsResponse, type AuthResponse, type AuthenticationCreateRequest, type AuthenticationResponse, type AuthenticationStatus, type AuthenticationType, type AutoRechargeConfig, type AutoRechargeUpdateRequest, BRANDING_EXPORT_FORMAT, BRANDING_EXPORT_VERSION, type BillingCompleteSetupRequest, type BillingProfileResponse, type BillingSetupRequest, type BillingSetupResponse, type BlocklistAddRequest, type BlocklistDataKind, type BlocklistResponse, type BrandingExport, type BrandingSource, type BusinessPaymentLinkConfig, CUSTOM_CSS_MAX_LENGTH, type CancelSubscriptionRequest, type CancelSubscriptionResponse, type CaptureMethod, type CardDetail, type CardDetailFromLocker, Cards, type ChangePasswordRequest, type CheckoutBranding, type ConfirmSubscriptionPaymentDetails, type ConfirmSubscriptionRequest, type ConfirmSubscriptionResponse, type Connector, type ConnectorCreateRequest, type ConnectorListResponse, type ConnectorResponse, type ConnectorType, type ConnectorUpdateRequest, type ConnectorVolumeSplit, type ConnectorWebhookEntry, type ConnectorWebhookEventType, type ConnectorWebhookListResponse, type ConnectorWebhookRegisterRequest, type ConnectorWebhookRegisterResponse, type CornerRadius, type CreateAndConfirmSubscriptionRequest, type CreateSubscriptionPaymentDetails, type CreateSubscriptionRequest, type Currency, type CustomerCreateRequest, type CustomerListParams, type CustomerPaymentMethodsListParams, type CustomerPaymentMethodsListResponse, type CustomerResponse, type CustomerUpdateRequest, DEFAULT_BADGES, DEFAULT_BADGES_DARK, DEFAULT_BRANDING, DEFAULT_BRANDING_DARK, type DeleteAccountRequest, Delopay, DelopayAuthenticationError, DelopayError, type DelopayLogger, type DelopayOptions, type DisputeEvidenceRequest, type DisputeListParams, type DisputeResponse, type DisputeStage, type DisputeStatus, type EncodedBranding, type EphemeralKeyCreateRequest, type EphemeralKeyCreateResponse, type EventClass, type EventDeliveryAttemptResponse, type EventDetailResponse, type EventListParams, type EventListResponse, type EventResponse, type EventType, Export, FeatureMatrix, type FeeOwner, type FeeScheduleCreateRequest, type FeeScheduleResponse, type FeeScheduleUpdateRequest, type FeeType, Files, type FontFamily, type FontWeight, Forex, type ForgotPasswordRequest, type FromEmailRequest, type FutureUsage, type GatewayConnectRequest, type GatewayResponse, type GetSubscriptionItemsParams, type GetSubscriptionItemsResponse, type GlobalSearchRequest, type IntentStatus, type InviteUsersRequest, type InviteUsersResponse, type InvoiceStatus, type LabelStyle, type LayoutStyle, type LedgerEntry, type LedgerListParams, type LedgerResponse, type LinkedRoutingConfigRetrieveResponse, type ListInvitableRolesParams, type LoginHistoryEntry, type LoginHistoryParams, type LoginHistoryResponse, type LogoShape, type LogoSize, type MandateListParams, type MandateResponse, type MandateRevokedResponse, type MandateStatus, type MandateType, type MerchantAccountCreateRequest, type MerchantAccountResponse, type MerchantAccountType, type MerchantAccountUpdateRequest, type MerchantOverviewResponse, type MerchantOverviewStat, type MerchantRoutingAlgorithm, type NonPillRadius, type ParentGroup, type ParentGroupInfo, type PauseSubscriptionRequest, type PauseSubscriptionResponse, type PaymentCancelRequest, type PaymentCaptureRequest, type PaymentConfirmRequest, type PaymentCreateRequest, type PaymentLayout, type PaymentLinkBackgroundImageConfig, type PaymentLinkConfigRequest, type PaymentLinkListParams, type PaymentLinkListResponse, type PaymentLinkResponse, type PaymentLinkTransactionDetails, type PaymentListParams, type PaymentListResponse, type PaymentMethod, type PaymentMethodCreateRequest, type PaymentMethodDeleteResponse, type PaymentMethodListParams, type PaymentMethodResponse, type PaymentMethodType, type PaymentMethodUpdateRequest, type PaymentResponse, type PaymentRetrieveOptions, type PaymentUpdateRequest, type PayoutCreateRequest, type PayoutListParams, type PayoutListResponse, type PayoutResponse, type PayoutStatus, type PayoutType, type PayoutUpdateRequest, type PermissionScope, type PhoneDetails, type PhoneOtpRequest, type PhoneOtpResponse, type PhoneOtpVerifyRequest, type PhoneOtpVerifyResponse, type PollStatus, type PollStatusResponse, type ProfileAcquirerCreateRequest, type ProfileAcquirerResponse, type ProfileAcquirerUpdateRequest, type ProfileCreateRequest, type ProfileDefaultRoutingConfig, type ProfileLogoUploadResponse, type ProfileResponse, type ProfileUpdateRequest, type ProjectCreateRequest, type ProjectResponse, type ProjectStats, type ProjectStatsResponse, type ProjectUpdateRequest, type RecoveryCodesResponse, type RefundCreateRequest, type RefundListParams, type RefundListResponse, type RefundResponse, type RefundStatus, type RefundType, type RefundUpdateRequest, type RegionCreateRequest, type RegionResponse, type RegionUpdateRequest, Regions, type RelayRequest, type RelayResponse, type RelayStatus, type RelayType, type RequestFn, type RequestOptions, type ResetPasswordRequest, type ResumeSubscriptionRequest, type ResumeSubscriptionResponse, type RoutableConnectorChoice, type RoutingActivatePayload, type RoutingConfigCreateRequest, type RoutingConfigResponse, type RoutingDeactivateRequest, type RoutingDictionary, type RoutingDictionaryRecord, Search, type SearchGroupResponse, type SearchIndex, type SearchStatus, type ShopCreateRequest, type ShopResponse, type ShopStats, type ShopUpdateRequest, type SignInRequest, type SignUpRequest, type SignUpWithMerchantIdRequest, type SignUpWithMerchantRequest, type SizeScale, type SpacingScale, type StaticRoutingAlgorithm, type StripeConnectAccountRequest, type StripeConnectAccountResponse, type StripeConnectLinkRequest, type StripeConnectLinkResponse, type SubscriptionEstimateParams, type SubscriptionEstimateResponse, type SubscriptionInvoice, type SubscriptionItem, type SubscriptionItemPrice, type SubscriptionItemType, type SubscriptionLineItem, type SubscriptionListParams, type SubscriptionPaymentData, type SubscriptionPaymentDetails, type SubscriptionPeriodUnit, type SubscriptionResponse, type SubscriptionStatus, Subscriptions, type SummaryPosition, type SurfaceStyle, type SwitchMerchantRequest, type SwitchProfileRequest, type Terminate2faQueryParams, type ThreeDSDecision, type ThreeDsRuleExecuteRequest, type ThreeDsRuleResponse, type TierSummary, type TokenPurpose, type TokenResponse, type TopupRequest, type TopupResponse, type TotpResponse, type TransactionType, type TrustBadge, type UpdateSubscriptionRequest, type UpdateUserDetailsRequest, type UserResponse, type UserSessionEntry, type UserSessionListResponse, type UserSessionRevokeResponse, type VerifyTotpRequest, type WebhookDeliveryAttempt, type WebhookEvent, Webhooks, applyBrandingVariables, buildBrandingExport, buttonPadValue, cloneBranding, decodeBadges, decodeBranding, defaultBranding, encodeBadges, encodeBranding, fontStack, fontWeightValue, inputPadValue, isDarkSurface, isHexColor, logoDimensions, parseImportedBranding, radiusValue, sanitizeCustomCss, shadowFor, surfacePadValue, verticalGapValue };