@revkeen/sdk 1.20260419.901 → 1.20260420.907

package/dist/index.d.mts

@@ -3,7 +3,7 @@ export { OAuthTokenManager } from './auth.mjs';
 export { WEBHOOK_TOLERANCE_IN_SECONDS, WebhookHeaders, WebhookSignatureVerificationError, WebhookEvent as WebhookUtilityEvent, WebhookEventData as WebhookUtilityEventData, WebhookEventType as WebhookUtilityEventType, WebhookVerifyOptions, constructEvent, constructEventWithHeaders, extractWebhookHeaders, verifySignature, default as webhooks } from './webhooks.mjs';
 
 type ClientOptions$1 = {
-    baseUrl: 'https://sandbox-api.revkeen.com/v2' | 'https://api.revkeen.com/v2' | 'http://localhost:3001/v2' | 'http://localhost:4010/v2' | (string & {});
+    baseUrl: 'https://staging-api.revkeen.com/v2' | 'https://api.revkeen.com/v2' | 'https://mock-api.revkeen.com/v2' | (string & {});
 };
 /**
  * The envelope for all webhook event deliveries. Contains the event type, timestamp, and the affected object in the data field.
@@ -9538,138 +9538,575 @@ type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean
  * List invoices
  *
  * List invoices with pagination and filtering.
+ *
+ * ---
+ *
+ * **Related endpoints**
+ *
+ * - `PUT /invoices/external/batch` — Batch upsert invoices by external ID
+ * - `POST /invoices` — Create invoice
+ * - `GET /invoices/{id}` — Get invoice
+ * - `PATCH /invoices/{id}` — Update invoice
+ * - `DELETE /invoices/{id}` — Delete invoice
+ * - `POST /invoices/{id}/refund` — Refund invoice
+ * - `POST /invoices/{id}/reject` — Reject invoice
+ * - `GET /invoices/{id}/comments` — List invoice comments
+ *
+ * **Pagination**
+ *
+ * Offset-based with `limit` (default 25, max 100) and `offset`. The response `pagination` block includes `total` and `hasMore`. See [the pagination guide](/docs/fundamentals/pagination) for SDK auto-paging helpers.
  */
 declare const invoicesList: <ThrowOnError extends boolean = false>(options?: Options<InvoicesListData, ThrowOnError>) => RequestResult<InvoicesListResponses, unknown, ThrowOnError, "fields">;
 /**
  * Create invoice
  *
  * Create a new invoice.
+ *
+ * ---
+ *
+ * **Related endpoints**
+ *
+ * - `PUT /invoices/external/batch` — Batch upsert invoices by external ID
+ * - `GET /invoices` — List invoices
+ * - `GET /invoices/{id}` — Get invoice
+ * - `PATCH /invoices/{id}` — Update invoice
+ * - `DELETE /invoices/{id}` — Delete invoice
+ * - `POST /invoices/{id}/refund` — Refund invoice
+ * - `POST /invoices/{id}/reject` — Reject invoice
+ * - `GET /invoices/{id}/comments` — List invoice comments
+ *
+ * **Idempotency**
+ *
+ * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency).
  */
 declare const invoicesCreate: <ThrowOnError extends boolean = false>(options: Options<InvoicesCreateData, ThrowOnError>) => RequestResult<InvoicesCreateResponses, unknown, ThrowOnError, "fields">;
 /**
  * Get invoice
  *
  * Get a single invoice by ID.
+ *
+ * ---
+ *
+ * **Related endpoints**
+ *
+ * - `PUT /invoices/external/batch` — Batch upsert invoices by external ID
+ * - `GET /invoices` — List invoices
+ * - `POST /invoices` — Create invoice
+ * - `PATCH /invoices/{id}` — Update invoice
+ * - `DELETE /invoices/{id}` — Delete invoice
+ * - `POST /invoices/{id}/refund` — Refund invoice
+ * - `POST /invoices/{id}/reject` — Reject invoice
+ * - `GET /invoices/{id}/comments` — List invoice comments
  */
 declare const invoicesGet: <ThrowOnError extends boolean = false>(options: Options<InvoicesGetData, ThrowOnError>) => RequestResult<InvoicesGetResponses, unknown, ThrowOnError, "fields">;
 /**
  * Update invoice
  *
  * Update an existing invoice.
+ *
+ * ---
+ *
+ * **Related endpoints**
+ *
+ * - `PUT /invoices/external/batch` — Batch upsert invoices by external ID
+ * - `GET /invoices` — List invoices
+ * - `POST /invoices` — Create invoice
+ * - `GET /invoices/{id}` — Get invoice
+ * - `DELETE /invoices/{id}` — Delete invoice
+ * - `POST /invoices/{id}/refund` — Refund invoice
+ * - `POST /invoices/{id}/reject` — Reject invoice
+ * - `GET /invoices/{id}/comments` — List invoice comments
+ *
+ * **Idempotency**
+ *
+ * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency).
  */
 declare const invoicesUpdate: <ThrowOnError extends boolean = false>(options: Options<InvoicesUpdateData, ThrowOnError>) => RequestResult<InvoicesUpdateResponses, unknown, ThrowOnError, "fields">;
 /**
  * Finalize an invoice
  *
  * Finalizes a draft invoice, locking it for payment. Assigns invoice number and generates public token. After finalization, financial fields become immutable.
+ *
+ * ---
+ *
+ * **Related endpoints**
+ *
+ * - `PUT /invoices/external/batch` — Batch upsert invoices by external ID
+ * - `GET /invoices` — List invoices
+ * - `POST /invoices` — Create invoice
+ * - `GET /invoices/{id}` — Get invoice
+ * - `PATCH /invoices/{id}` — Update invoice
+ * - `DELETE /invoices/{id}` — Delete invoice
+ * - `POST /invoices/{id}/refund` — Refund invoice
+ * - `POST /invoices/{id}/reject` — Reject invoice
+ *
+ * **Common errors**
+ *
+ * - `400 invalid_request` — malformed payload or failed validation.
+ * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key.
+ *
+ * **Idempotency**
+ *
+ * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency).
  */
 declare const invoicesFinalize: <ThrowOnError extends boolean = false>(options: Options<InvoicesFinalizeData, ThrowOnError>) => RequestResult<InvoicesFinalizeResponses, InvoicesFinalizeErrors, ThrowOnError, "fields">;
 /**
  * Void an invoice
  *
  * Voids an invoice. Only invoices without recorded payments can be voided. Use refund instead for paid invoices.
+ *
+ * ---
+ *
+ * **Related endpoints**
+ *
+ * - `PUT /invoices/external/batch` — Batch upsert invoices by external ID
+ * - `GET /invoices` — List invoices
+ * - `POST /invoices` — Create invoice
+ * - `GET /invoices/{id}` — Get invoice
+ * - `PATCH /invoices/{id}` — Update invoice
+ * - `DELETE /invoices/{id}` — Delete invoice
+ * - `POST /invoices/{id}/refund` — Refund invoice
+ * - `POST /invoices/{id}/reject` — Reject invoice
+ *
+ * **Common errors**
+ *
+ * - `400 invalid_request` — malformed payload or failed validation.
+ * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key.
+ *
+ * **Idempotency**
+ *
+ * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency).
  */
 declare const invoicesVoid: <ThrowOnError extends boolean = false>(options: Options<InvoicesVoidData, ThrowOnError>) => RequestResult<InvoicesVoidResponses, InvoicesVoidErrors, ThrowOnError, "fields">;
 /**
  * Send an invoice
  *
  * Sends an invoice to the customer via the specified channel (email, SMS, or WhatsApp). Invoice must be approved first.
+ *
+ * ---
+ *
+ * **Related endpoints**
+ *
+ * - `PUT /invoices/external/batch` — Batch upsert invoices by external ID
+ * - `GET /invoices` — List invoices
+ * - `POST /invoices` — Create invoice
+ * - `GET /invoices/{id}` — Get invoice
+ * - `PATCH /invoices/{id}` — Update invoice
+ * - `DELETE /invoices/{id}` — Delete invoice
+ * - `POST /invoices/{id}/refund` — Refund invoice
+ * - `POST /invoices/{id}/reject` — Reject invoice
+ *
+ * **Common errors**
+ *
+ * - `400 invalid_request` — malformed payload or failed validation.
+ * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key.
+ *
+ * **Idempotency**
+ *
+ * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency).
  */
 declare const invoicesSend: <ThrowOnError extends boolean = false>(options: Options<InvoicesSendData, ThrowOnError>) => RequestResult<InvoicesSendResponses, InvoicesSendErrors, ThrowOnError, "fields">;
 /**
  * List products
  *
  * List products with pagination and optional search.
+ *
+ * ---
+ *
+ * **Related endpoints**
+ *
+ * - `POST /products` — Create product
+ * - `GET /products/{id}` — Get product by ID
+ * - `PATCH /products/{id}` — Update product
+ * - `PUT /products/external/{source}/{externalId}` — Upsert product by external ID
+ * - `PUT /products/external/batch` — Batch upsert products by external ID
+ *
+ * **Common errors**
+ *
+ * - `400 invalid_request` — malformed payload or failed validation.
+ * - `401 unauthenticated` — missing, malformed, or revoked API key.
+ *
+ * **Pagination**
+ *
+ * Offset-based with `limit` (default 25, max 100) and `offset`. The response `pagination` block includes `total` and `hasMore`. See [the pagination guide](/docs/fundamentals/pagination) for SDK auto-paging helpers.
  */
 declare const productsList: <ThrowOnError extends boolean = false>(options?: Options<ProductsListData, ThrowOnError>) => RequestResult<ProductsListResponses, ProductsListErrors, ThrowOnError, "fields">;
 /**
  * Create product
  *
  * Create a new product. Requires 'products:write' scope.
+ *
+ * ---
+ *
+ * **Related endpoints**
+ *
+ * - `GET /products` — List products
+ * - `GET /products/{id}` — Get product by ID
+ * - `PATCH /products/{id}` — Update product
+ * - `PUT /products/external/{source}/{externalId}` — Upsert product by external ID
+ * - `PUT /products/external/batch` — Batch upsert products by external ID
+ *
+ * **Common errors**
+ *
+ * - `400 invalid_request` — malformed payload or failed validation.
+ * - `401 unauthenticated` — missing, malformed, or revoked API key.
+ *
+ * **Idempotency**
+ *
+ * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency).
  */
 declare const productsCreate: <ThrowOnError extends boolean = false>(options: Options<ProductsCreateData, ThrowOnError>) => RequestResult<ProductsCreateResponses, ProductsCreateErrors, ThrowOnError, "fields">;
 /**
  * Get product by ID
  *
  * Get a product by its ID. Requires 'products:read' scope.
+ *
+ * ---
+ *
+ * **Related endpoints**
+ *
+ * - `GET /products` — List products
+ * - `POST /products` — Create product
+ * - `PATCH /products/{id}` — Update product
+ * - `PUT /products/external/{source}/{externalId}` — Upsert product by external ID
+ * - `PUT /products/external/batch` — Batch upsert products by external ID
+ *
+ * **Common errors**
+ *
+ * - `401 unauthenticated` — missing, malformed, or revoked API key.
+ * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key.
  */
 declare const productsGet: <ThrowOnError extends boolean = false>(options: Options<ProductsGetData, ThrowOnError>) => RequestResult<ProductsGetResponses, ProductsGetErrors, ThrowOnError, "fields">;
 /**
  * Update product
  *
  * Update an existing product. Requires 'products:write' scope.
+ *
+ * ---
+ *
+ * **Related endpoints**
+ *
+ * - `GET /products` — List products
+ * - `POST /products` — Create product
+ * - `GET /products/{id}` — Get product by ID
+ * - `PUT /products/external/{source}/{externalId}` — Upsert product by external ID
+ * - `PUT /products/external/batch` — Batch upsert products by external ID
+ *
+ * **Common errors**
+ *
+ * - `400 invalid_request` — malformed payload or failed validation.
+ * - `401 unauthenticated` — missing, malformed, or revoked API key.
+ * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key.
+ *
+ * **Idempotency**
+ *
+ * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency).
  */
 declare const productsUpdate: <ThrowOnError extends boolean = false>(options: Options<ProductsUpdateData, ThrowOnError>) => RequestResult<ProductsUpdateResponses, ProductsUpdateErrors, ThrowOnError, "fields">;
 /**
  * Create a checkout session
  *
  * Create a checkout session for an invoice or product.
+ *
+ * ---
+ *
+ * **Related endpoints**
+ *
+ * - `GET /checkout-sessions/{id}` — Retrieve a checkout session
+ * - `POST /checkout-sessions/{id}/expire` — Expire a checkout session
+ *
+ * **Common errors**
+ *
+ * - `400 invalid_request` — malformed payload or failed validation.
+ * - `401 unauthenticated` — missing, malformed, or revoked API key.
+ * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key.
+ *
+ * **Idempotency**
+ *
+ * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency).
  */
 declare const checkoutSessionsCreate: <ThrowOnError extends boolean = false>(options?: Options<CheckoutSessionsCreateData, ThrowOnError>) => RequestResult<CheckoutSessionsCreateResponses, CheckoutSessionsCreateErrors, ThrowOnError, "fields">;
 /**
  * Retrieve a checkout session
  *
  * Retrieve a checkout session by its ID.
+ *
+ * ---
+ *
+ * **Related endpoints**
+ *
+ * - `POST /checkout-sessions` — Create a checkout session
+ * - `POST /checkout-sessions/{id}/expire` — Expire a checkout session
+ *
+ * **Common errors**
+ *
+ * - `401 unauthenticated` — missing, malformed, or revoked API key.
+ * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key.
  */
 declare const checkoutSessionsGet: <ThrowOnError extends boolean = false>(options: Options<CheckoutSessionsGetData, ThrowOnError>) => RequestResult<CheckoutSessionsGetResponses, CheckoutSessionsGetErrors, ThrowOnError, "fields">;
 /**
  * Expire a checkout session
  *
  * Manually expire an open checkout session. Only sessions with status 'open' or 'pending' and no active payment attempt can be expired.
+ *
+ * ---
+ *
+ * **Related endpoints**
+ *
+ * - `POST /checkout-sessions` — Create a checkout session
+ * - `GET /checkout-sessions/{id}` — Retrieve a checkout session
+ *
+ * **Common errors**
+ *
+ * - `401 unauthenticated` — missing, malformed, or revoked API key.
+ * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key.
+ * - `409 conflict` — Idempotency-Key collision with a different body, or a concurrent state-transition conflict.
+ *
+ * **Idempotency**
+ *
+ * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency).
  */
 declare const checkoutSessionsExpire: <ThrowOnError extends boolean = false>(options: Options<CheckoutSessionsExpireData, ThrowOnError>) => RequestResult<CheckoutSessionsExpireResponses, CheckoutSessionsExpireErrors, ThrowOnError, "fields">;
 /**
  * List customers
  *
  * Retrieve a paginated list of customers for the merchant
+ *
+ * ---
+ *
+ * **Related endpoints**
+ *
+ * - `GET /customers/{customerId}/invoices` — List customer invoices
+ * - `GET /customers/{customerId}/subscriptions` — List customer subscriptions
+ * - `GET /customers/{customerId}/orders` — List customer orders
+ * - `GET /customers/{customerId}/payments` — List customer payments
+ * - `PUT /customers/external/batch` — Batch upsert customers by external ID
+ * - `POST /customers` — Create a new customer
+ * - `GET /customers/{id}` — Get customer by ID
+ * - `PATCH /customers/{id}` — Update customer details
+ *
+ * **Common errors**
+ *
+ * - `401 unauthenticated` — missing, malformed, or revoked API key.
+ *
+ * **Pagination**
+ *
+ * Offset-based with `limit` (default 25, max 100) and `offset`. The response `pagination` block includes `total` and `hasMore`. See [the pagination guide](/docs/fundamentals/pagination) for SDK auto-paging helpers.
  */
 declare const customersList: <ThrowOnError extends boolean = false>(options?: Options<CustomersListData, ThrowOnError>) => RequestResult<CustomersListResponses, CustomersListErrors, ThrowOnError, "fields">;
 /**
  * Create a new customer
  *
  * Create a new customer record in the merchant's account
+ *
+ * ---
+ *
+ * **Related endpoints**
+ *
+ * - `GET /customers/{customerId}/invoices` — List customer invoices
+ * - `GET /customers/{customerId}/subscriptions` — List customer subscriptions
+ * - `GET /customers/{customerId}/orders` — List customer orders
+ * - `GET /customers/{customerId}/payments` — List customer payments
+ * - `PUT /customers/external/batch` — Batch upsert customers by external ID
+ * - `GET /customers` — List customers
+ * - `GET /customers/{id}` — Get customer by ID
+ * - `PATCH /customers/{id}` — Update customer details
+ *
+ * **Common errors**
+ *
+ * - `400 invalid_request` — malformed payload or failed validation.
+ * - `401 unauthenticated` — missing, malformed, or revoked API key.
+ *
+ * **Idempotency**
+ *
+ * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency).
  */
 declare const customersCreate: <ThrowOnError extends boolean = false>(options?: Options<CustomersCreateData, ThrowOnError>) => RequestResult<CustomersCreateResponses, CustomersCreateErrors, ThrowOnError, "fields">;
 /**
  * Get customer by ID
  *
  * Retrieve detailed information about a specific customer
+ *
+ * ---
+ *
+ * **Related endpoints**
+ *
+ * - `GET /customers/{customerId}/invoices` — List customer invoices
+ * - `GET /customers/{customerId}/subscriptions` — List customer subscriptions
+ * - `GET /customers/{customerId}/orders` — List customer orders
+ * - `GET /customers/{customerId}/payments` — List customer payments
+ * - `PUT /customers/external/batch` — Batch upsert customers by external ID
+ * - `POST /customers` — Create a new customer
+ * - `GET /customers` — List customers
+ * - `PATCH /customers/{id}` — Update customer details
+ *
+ * **Common errors**
+ *
+ * - `401 unauthenticated` — missing, malformed, or revoked API key.
+ * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key.
  */
 declare const customersGet: <ThrowOnError extends boolean = false>(options: Options<CustomersGetData, ThrowOnError>) => RequestResult<CustomersGetResponses, CustomersGetErrors, ThrowOnError, "fields">;
 /**
  * Update customer details
  *
  * Update an existing customer's information
+ *
+ * ---
+ *
+ * **Related endpoints**
+ *
+ * - `GET /customers/{customerId}/invoices` — List customer invoices
+ * - `GET /customers/{customerId}/subscriptions` — List customer subscriptions
+ * - `GET /customers/{customerId}/orders` — List customer orders
+ * - `GET /customers/{customerId}/payments` — List customer payments
+ * - `PUT /customers/external/batch` — Batch upsert customers by external ID
+ * - `POST /customers` — Create a new customer
+ * - `GET /customers` — List customers
+ * - `GET /customers/{id}` — Get customer by ID
+ *
+ * **Common errors**
+ *
+ * - `401 unauthenticated` — missing, malformed, or revoked API key.
+ * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key.
+ *
+ * **Idempotency**
+ *
+ * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency).
  */
 declare const customersUpdate: <ThrowOnError extends boolean = false>(options: Options<CustomersUpdateData, ThrowOnError>) => RequestResult<CustomersUpdateResponses, CustomersUpdateErrors, ThrowOnError, "fields">;
 /**
  * Get customer payment methods
  *
  * Retrieve all payment methods for a customer
+ *
+ * ---
+ *
+ * **Related endpoints**
+ *
+ * - `GET /customers/{customerId}/invoices` — List customer invoices
+ * - `GET /customers/{customerId}/subscriptions` — List customer subscriptions
+ * - `GET /customers/{customerId}/orders` — List customer orders
+ * - `GET /customers/{customerId}/payments` — List customer payments
+ * - `PUT /customers/external/batch` — Batch upsert customers by external ID
+ * - `POST /customers` — Create a new customer
+ * - `GET /customers` — List customers
+ * - `GET /customers/{id}` — Get customer by ID
+ *
+ * **Common errors**
+ *
+ * - `401 unauthenticated` — missing, malformed, or revoked API key.
+ * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key.
+ *
+ * **Pagination**
+ *
+ * Offset-based with `limit` (default 25, max 100) and `offset`. The response `pagination` block includes `total` and `hasMore`. See [the pagination guide](/docs/fundamentals/pagination) for SDK auto-paging helpers.
  */
 declare const customersPaymentMethodsList: <ThrowOnError extends boolean = false>(options: Options<CustomersPaymentMethodsListData, ThrowOnError>) => RequestResult<CustomersPaymentMethodsListResponses, CustomersPaymentMethodsListErrors, ThrowOnError, "fields">;
 /**
  * List subscriptions
  *
  * Retrieve a paginated list of subscriptions with optional filters
+ *
+ * ---
+ *
+ * **Related endpoints**
+ *
+ * - `POST /subscriptions` — Create a new subscription
+ * - `GET /subscriptions/{id}` — Get subscription by ID
+ * - `PATCH /subscriptions/{id}` — Update subscription details
+ * - `DELETE /subscriptions/{id}` — Delete subscription
+ * - `POST /subscriptions/{id}/change-plan` — Change subscription plan
+ * - `POST /subscriptions/{id}/change-quantity` — Change subscription quantity
+ * - `POST /subscriptions/{id}/preview-renewal` — Preview subscription renewal
+ * - `POST /subscriptions/{id}/pause` — Pause subscription
+ *
+ * **Common errors**
+ *
+ * - `401 unauthenticated` — missing, malformed, or revoked API key.
+ *
+ * **Pagination**
+ *
+ * Offset-based with `limit` (default 25, max 100) and `offset`. The response `pagination` block includes `total` and `hasMore`. See [the pagination guide](/docs/fundamentals/pagination) for SDK auto-paging helpers.
  */
 declare const subscriptionsList: <ThrowOnError extends boolean = false>(options?: Options<SubscriptionsListData, ThrowOnError>) => RequestResult<SubscriptionsListResponses, SubscriptionsListErrors, ThrowOnError, "fields">;
 /**
  * Create a new subscription
  *
  * Create a new subscription for a customer
+ *
+ * ---
+ *
+ * **Related endpoints**
+ *
+ * - `GET /subscriptions` — List subscriptions
+ * - `GET /subscriptions/{id}` — Get subscription by ID
+ * - `PATCH /subscriptions/{id}` — Update subscription details
+ * - `DELETE /subscriptions/{id}` — Delete subscription
+ * - `POST /subscriptions/{id}/change-plan` — Change subscription plan
+ * - `POST /subscriptions/{id}/change-quantity` — Change subscription quantity
+ * - `POST /subscriptions/{id}/preview-renewal` — Preview subscription renewal
+ * - `POST /subscriptions/{id}/pause` — Pause subscription
+ *
+ * **Common errors**
+ *
+ * - `400 invalid_request` — malformed payload or failed validation.
+ * - `401 unauthenticated` — missing, malformed, or revoked API key.
+ *
+ * **Idempotency**
+ *
+ * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency).
  */
 declare const subscriptionsCreate: <ThrowOnError extends boolean = false>(options?: Options<SubscriptionsCreateData, ThrowOnError>) => RequestResult<SubscriptionsCreateResponses, SubscriptionsCreateErrors, ThrowOnError, "fields">;
 /**
  * Get subscription by ID
  *
  * Retrieve detailed information about a specific subscription
+ *
+ * ---
+ *
+ * **Related endpoints**
+ *
+ * - `POST /subscriptions` — Create a new subscription
+ * - `GET /subscriptions` — List subscriptions
+ * - `PATCH /subscriptions/{id}` — Update subscription details
+ * - `DELETE /subscriptions/{id}` — Delete subscription
+ * - `POST /subscriptions/{id}/change-plan` — Change subscription plan
+ * - `POST /subscriptions/{id}/change-quantity` — Change subscription quantity
+ * - `POST /subscriptions/{id}/preview-renewal` — Preview subscription renewal
+ * - `POST /subscriptions/{id}/pause` — Pause subscription
+ *
+ * **Common errors**
+ *
+ * - `401 unauthenticated` — missing, malformed, or revoked API key.
+ * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key.
  */
 declare const subscriptionsGet: <ThrowOnError extends boolean = false>(options: Options<SubscriptionsGetData, ThrowOnError>) => RequestResult<SubscriptionsGetResponses, SubscriptionsGetErrors, ThrowOnError, "fields">;
 /**
  * Update subscription details
  *
  * Update an existing subscription's properties
+ *
+ * ---
+ *
+ * **Related endpoints**
+ *
+ * - `POST /subscriptions` — Create a new subscription
+ * - `GET /subscriptions` — List subscriptions
+ * - `GET /subscriptions/{id}` — Get subscription by ID
+ * - `DELETE /subscriptions/{id}` — Delete subscription
+ * - `POST /subscriptions/{id}/change-plan` — Change subscription plan
+ * - `POST /subscriptions/{id}/change-quantity` — Change subscription quantity
+ * - `POST /subscriptions/{id}/preview-renewal` — Preview subscription renewal
+ * - `POST /subscriptions/{id}/pause` — Pause subscription
+ *
+ * **Common errors**
+ *
+ * - `401 unauthenticated` — missing, malformed, or revoked API key.
+ * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key.
+ *
+ * **Idempotency**
+ *
+ * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency).
  */
 declare const subscriptionsUpdate: <ThrowOnError extends boolean = false>(options: Options<SubscriptionsUpdateData, ThrowOnError>) => RequestResult<SubscriptionsUpdateResponses, SubscriptionsUpdateErrors, ThrowOnError, "fields">;
 /**
@@ -9680,90 +10117,366 @@ declare const subscriptionsUpdate: <ThrowOnError extends boolean = false>(option
  * **Modes:**
  * - `immediately`: Status set to "canceled", access revoked now
  * - `period_end`: cancelAtPeriodEnd flag set, access continues until period end
+ *
+ * ---
+ *
+ * **Related endpoints**
+ *
+ * - `POST /subscriptions` — Create a new subscription
+ * - `GET /subscriptions` — List subscriptions
+ * - `GET /subscriptions/{id}` — Get subscription by ID
+ * - `PATCH /subscriptions/{id}` — Update subscription details
+ * - `DELETE /subscriptions/{id}` — Delete subscription
+ * - `POST /subscriptions/{id}/change-plan` — Change subscription plan
+ * - `POST /subscriptions/{id}/change-quantity` — Change subscription quantity
+ * - `POST /subscriptions/{id}/preview-renewal` — Preview subscription renewal
+ *
+ * **Common errors**
+ *
+ * - `400 invalid_request` — malformed payload or failed validation.
+ * - `401 unauthenticated` — missing, malformed, or revoked API key.
+ * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key.
+ *
+ * **Idempotency**
+ *
+ * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency).
  */
 declare const subscriptionsCancel: <ThrowOnError extends boolean = false>(options: Options<SubscriptionsCancelData, ThrowOnError>) => RequestResult<SubscriptionsCancelResponses, SubscriptionsCancelErrors, ThrowOnError, "fields">;
 /**
  * MRR Summary
  *
  * Get Monthly Recurring Revenue metrics and growth
+ *
+ * ---
+ *
+ * **Related endpoints**
+ *
+ * - `GET /analytics/revenue/time-series` — Revenue Time Series
+ * - `GET /analytics/invoices/ar-aging` — A/R Aging Report
+ * - `GET /analytics/collections/dso` — Days Sales Outstanding
+ * - `GET /analytics/customers/ltv` — Customer LTV
+ * - `GET /analytics/customers/{customerId}` — Customer Analytics
+ * - `GET /analytics/payment-links/conversion` — Payment Link Conversion
+ * - `GET /analytics/checkout/funnel` — Checkout Funnel Analytics
+ * - `GET /analytics/checkout/abandonment/summary` — Abandonment Alert Summary
  */
 declare const analyticsRevenueMrrSummary: <ThrowOnError extends boolean = false>(options?: Options<AnalyticsRevenueMrrSummaryData, ThrowOnError>) => RequestResult<AnalyticsRevenueMrrSummaryResponses, unknown, ThrowOnError, "fields">;
 /**
  * Revenue Time Series
  *
  * Get revenue data over time with configurable granularity
+ *
+ * ---
+ *
+ * **Related endpoints**
+ *
+ * - `GET /analytics/revenue/mrr-summary` — MRR Summary
+ * - `GET /analytics/invoices/ar-aging` — A/R Aging Report
+ * - `GET /analytics/collections/dso` — Days Sales Outstanding
+ * - `GET /analytics/customers/ltv` — Customer LTV
+ * - `GET /analytics/customers/{customerId}` — Customer Analytics
+ * - `GET /analytics/payment-links/conversion` — Payment Link Conversion
+ * - `GET /analytics/checkout/funnel` — Checkout Funnel Analytics
+ * - `GET /analytics/checkout/abandonment/summary` — Abandonment Alert Summary
  */
 declare const analyticsRevenueTimeSeries: <ThrowOnError extends boolean = false>(options: Options<AnalyticsRevenueTimeSeriesData, ThrowOnError>) => RequestResult<AnalyticsRevenueTimeSeriesResponses, unknown, ThrowOnError, "fields">;
 /**
  * List refunds
  *
  * Retrieve a paginated list of refunds with optional filters. Results are ordered by creation date (newest first).
+ *
+ * ---
+ *
+ * **Related endpoints**
+ *
+ * - `POST /refunds` — Create a refund
+ * - `GET /refunds/{id}` — Get refund by ID
+ *
+ * **Common errors**
+ *
+ * - `401 unauthenticated` — missing, malformed, or revoked API key.
+ *
+ * **Pagination**
+ *
+ * Offset-based with `limit` (default 25, max 100) and `offset`. The response `pagination` block includes `total` and `hasMore`. See [the pagination guide](/docs/fundamentals/pagination) for SDK auto-paging helpers.
  */
 declare const refundsList: <ThrowOnError extends boolean = false>(options?: Options<RefundsListData, ThrowOnError>) => RequestResult<RefundsListResponses, RefundsListErrors, ThrowOnError, "fields">;
 /**
  * Create a refund
  *
  * Initiate a refund for a payment. The refund will be processed through the original payment gateway.
+ *
+ * ---
+ *
+ * **Related endpoints**
+ *
+ * - `GET /refunds` — List refunds
+ * - `GET /refunds/{id}` — Get refund by ID
+ *
+ * **Common errors**
+ *
+ * - `400 invalid_request` — malformed payload or failed validation.
+ * - `401 unauthenticated` — missing, malformed, or revoked API key.
+ *
+ * **Idempotency**
+ *
+ * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency).
  */
 declare const refundsCreate: <ThrowOnError extends boolean = false>(options?: Options<RefundsCreateData, ThrowOnError>) => RequestResult<RefundsCreateResponses, RefundsCreateErrors, ThrowOnError, "fields">;
 /**
  * Get refund by ID
  *
  * Retrieve a single refund by its public ID (ref_xxx) or internal UUID.
+ *
+ * ---
+ *
+ * **Related endpoints**
+ *
+ * - `GET /refunds` — List refunds
+ * - `POST /refunds` — Create a refund
+ *
+ * **Common errors**
+ *
+ * - `401 unauthenticated` — missing, malformed, or revoked API key.
+ * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key.
  */
 declare const refundsGet: <ThrowOnError extends boolean = false>(options: Options<RefundsGetData, ThrowOnError>) => RequestResult<RefundsGetResponses, RefundsGetErrors, ThrowOnError, "fields">;
 /**
  * List credit notes
  *
  * Retrieve a paginated list of credit notes with optional filters. Results are ordered by creation date (newest first).
+ *
+ * ---
+ *
+ * **Related endpoints**
+ *
+ * - `POST /credit_notes` — Create a credit note
+ * - `GET /credit_notes/{id}` — Get credit note by ID
+ * - `POST /credit_notes/{id}/void` — Void a credit note
+ * - `GET /credit_notes/invoice/{invoice_id}/eligibility` — Check credit note eligibility for an invoice
+ * - `GET /credit_notes/transaction/{transaction_id}/reversal-eligibility` — Check reversal eligibility for a transaction
+ * - `GET /credit_notes/{id}/lines` — List line items on a credit note
+ * - `POST /credit_notes/preview` — Preview a credit note without creating it
+ *
+ * **Common errors**
+ *
+ * - `401 unauthenticated` — missing, malformed, or revoked API key.
+ *
+ * **Pagination**
+ *
+ * Offset-based with `limit` (default 25, max 100) and `offset`. The response `pagination` block includes `total` and `hasMore`. See [the pagination guide](/docs/fundamentals/pagination) for SDK auto-paging helpers.
  */
 declare const creditNotesList: <ThrowOnError extends boolean = false>(options?: Options<CreditNotesListData, ThrowOnError>) => RequestResult<CreditNotesListResponses, CreditNotesListErrors, ThrowOnError, "fields">;
 /**
  * Create a credit note
  *
  * Issue a credit note for a paid or partially paid invoice. The credit can be applied via refund to payment method, customer balance, or marked as external.
+ *
+ * ---
+ *
+ * **Related endpoints**
+ *
+ * - `GET /credit_notes` — List credit notes
+ * - `GET /credit_notes/{id}` — Get credit note by ID
+ * - `POST /credit_notes/{id}/void` — Void a credit note
+ * - `GET /credit_notes/invoice/{invoice_id}/eligibility` — Check credit note eligibility for an invoice
+ * - `GET /credit_notes/transaction/{transaction_id}/reversal-eligibility` — Check reversal eligibility for a transaction
+ * - `GET /credit_notes/{id}/lines` — List line items on a credit note
+ * - `POST /credit_notes/preview` — Preview a credit note without creating it
+ *
+ * **Common errors**
+ *
+ * - `400 invalid_request` — malformed payload or failed validation.
+ * - `401 unauthenticated` — missing, malformed, or revoked API key.
+ * - `409 conflict` — Idempotency-Key collision with a different body, or a concurrent state-transition conflict.
+ *
+ * **Idempotency**
+ *
+ * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency).
  */
 declare const creditNotesCreate: <ThrowOnError extends boolean = false>(options?: Options<CreditNotesCreateData, ThrowOnError>) => RequestResult<CreditNotesCreateResponses, CreditNotesCreateErrors, ThrowOnError, "fields">;
 /**
  * Get credit note by ID
  *
  * Retrieve a single credit note by its UUID.
+ *
+ * ---
+ *
+ * **Related endpoints**
+ *
+ * - `GET /credit_notes` — List credit notes
+ * - `POST /credit_notes` — Create a credit note
+ * - `POST /credit_notes/{id}/void` — Void a credit note
+ * - `GET /credit_notes/invoice/{invoice_id}/eligibility` — Check credit note eligibility for an invoice
+ * - `GET /credit_notes/transaction/{transaction_id}/reversal-eligibility` — Check reversal eligibility for a transaction
+ * - `GET /credit_notes/{id}/lines` — List line items on a credit note
+ * - `POST /credit_notes/preview` — Preview a credit note without creating it
+ *
+ * **Common errors**
+ *
+ * - `401 unauthenticated` — missing, malformed, or revoked API key.
+ * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key.
  */
 declare const creditNotesGet: <ThrowOnError extends boolean = false>(options: Options<CreditNotesGetData, ThrowOnError>) => RequestResult<CreditNotesGetResponses, CreditNotesGetErrors, ThrowOnError, "fields">;
 /**
  * Void a credit note
  *
  * Void a credit note that has been issued but not yet fully applied. This is an accounting void — it reverses the credit without creating a new financial transaction.
+ *
+ * ---
+ *
+ * **Related endpoints**
+ *
+ * - `GET /credit_notes` — List credit notes
+ * - `POST /credit_notes` — Create a credit note
+ * - `GET /credit_notes/{id}` — Get credit note by ID
+ * - `GET /credit_notes/invoice/{invoice_id}/eligibility` — Check credit note eligibility for an invoice
+ * - `GET /credit_notes/transaction/{transaction_id}/reversal-eligibility` — Check reversal eligibility for a transaction
+ * - `GET /credit_notes/{id}/lines` — List line items on a credit note
+ * - `POST /credit_notes/preview` — Preview a credit note without creating it
+ *
+ * **Common errors**
+ *
+ * - `400 invalid_request` — malformed payload or failed validation.
+ * - `401 unauthenticated` — missing, malformed, or revoked API key.
+ * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key.
+ *
+ * **Idempotency**
+ *
+ * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency).
  */
 declare const creditNotesVoid: <ThrowOnError extends boolean = false>(options: Options<CreditNotesVoidData, ThrowOnError>) => RequestResult<CreditNotesVoidResponses, CreditNotesVoidErrors, ThrowOnError, "fields">;
 /**
  * List line items on a credit note
  *
  * Returns the line items attached to a credit note. Each line describes a portion of the invoice that the credit applies to — either a whole invoice line or a prorated slice. Use this to reconstruct the credit's effect per invoice line (for example, when displaying the credit breakdown in your own UI).
+ *
+ * ---
+ *
+ * **Related endpoints**
+ *
+ * - `GET /credit_notes` — List credit notes
+ * - `POST /credit_notes` — Create a credit note
+ * - `GET /credit_notes/{id}` — Get credit note by ID
+ * - `POST /credit_notes/{id}/void` — Void a credit note
+ * - `GET /credit_notes/invoice/{invoice_id}/eligibility` — Check credit note eligibility for an invoice
+ * - `GET /credit_notes/transaction/{transaction_id}/reversal-eligibility` — Check reversal eligibility for a transaction
+ * - `POST /credit_notes/preview` — Preview a credit note without creating it
+ *
+ * **Common errors**
+ *
+ * - `401 unauthenticated` — missing, malformed, or revoked API key.
+ * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key.
+ *
+ * **Pagination**
+ *
+ * Offset-based with `limit` (default 25, max 100) and `offset`. The response `pagination` block includes `total` and `hasMore`. See [the pagination guide](/docs/fundamentals/pagination) for SDK auto-paging helpers.
  */
 declare const creditNotesListLines: <ThrowOnError extends boolean = false>(options: Options<CreditNotesListLinesData, ThrowOnError>) => RequestResult<CreditNotesListLinesResponses, CreditNotesListLinesErrors, ThrowOnError, "fields">;
 /**
  * Preview a credit note without creating it
  *
  * Compute what a credit note would look like against a specific invoice without persisting anything. Use this to validate amounts and show a "here's what will happen" UI before the merchant commits. No side effects — no DB writes, no events emitted, no refunds initiated. Mirrors Stripe's `POST /v1/credit_notes/preview`.
+ *
+ * ---
+ *
+ * **Related endpoints**
+ *
+ * - `GET /credit_notes` — List credit notes
+ * - `POST /credit_notes` — Create a credit note
+ * - `GET /credit_notes/{id}` — Get credit note by ID
+ * - `POST /credit_notes/{id}/void` — Void a credit note
+ * - `GET /credit_notes/invoice/{invoice_id}/eligibility` — Check credit note eligibility for an invoice
+ * - `GET /credit_notes/transaction/{transaction_id}/reversal-eligibility` — Check reversal eligibility for a transaction
+ * - `GET /credit_notes/{id}/lines` — List line items on a credit note
+ *
+ * **Common errors**
+ *
+ * - `400 invalid_request` — malformed payload or failed validation.
+ * - `401 unauthenticated` — missing, malformed, or revoked API key.
+ * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key.
+ *
+ * **Idempotency**
+ *
+ * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency).
  */
 declare const creditNotesPreview: <ThrowOnError extends boolean = false>(options: Options<CreditNotesPreviewData, ThrowOnError>) => RequestResult<CreditNotesPreviewResponses, CreditNotesPreviewErrors, ThrowOnError, "fields">;
 /**
  * List payment links
  *
  * List payment links for the authenticated merchant with pagination and filters
+ *
+ * ---
+ *
+ * **Related endpoints**
+ *
+ * - `POST /payment-links` — Create a new payment link
+ * - `GET /payment-links/{id}` — Get payment link by ID
+ * - `POST /payment-links/{id}/expire` — Expire a payment link (deprecated)
+ * - `PATCH /payment-links/{id}/status` — Update payment link status
+ * - `POST /payment-links/{id}/deactivate` — Deactivate a payment link (deprecated)
+ * - `POST /payment-links/{id}/activate` — Activate a payment link (deprecated)
+ * - `POST /payment-links/{id}/archive` — Archive a payment link (deprecated)
+ *
+ * **Common errors**
+ *
+ * - `400 invalid_request` — malformed payload or failed validation.
+ * - `401 unauthenticated` — missing, malformed, or revoked API key.
+ *
+ * **Pagination**
+ *
+ * Offset-based with `limit` (default 25, max 100) and `offset`. The response `pagination` block includes `total` and `hasMore`. See [the pagination guide](/docs/fundamentals/pagination) for SDK auto-paging helpers.
  */
 declare const paymentLinksList: <ThrowOnError extends boolean = false>(options?: Options<PaymentLinksListData, ThrowOnError>) => RequestResult<PaymentLinksListResponses, PaymentLinksListErrors, ThrowOnError, "fields">;
 /**
  * Create a new payment link
  *
  * Create a new payment link for invoices, subscriptions, or custom amounts
+ *
+ * ---
+ *
+ * **Related endpoints**
+ *
+ * - `GET /payment-links` — List payment links
+ * - `GET /payment-links/{id}` — Get payment link by ID
+ * - `POST /payment-links/{id}/expire` — Expire a payment link (deprecated)
+ * - `PATCH /payment-links/{id}/status` — Update payment link status
+ * - `POST /payment-links/{id}/deactivate` — Deactivate a payment link (deprecated)
+ * - `POST /payment-links/{id}/activate` — Activate a payment link (deprecated)
+ * - `POST /payment-links/{id}/archive` — Archive a payment link (deprecated)
+ *
+ * **Common errors**
+ *
+ * - `400 invalid_request` — malformed payload or failed validation.
+ * - `401 unauthenticated` — missing, malformed, or revoked API key.
+ * - `409 conflict` — Idempotency-Key collision with a different body, or a concurrent state-transition conflict.
+ *
+ * **Idempotency**
+ *
+ * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency).
  */
 declare const paymentLinksCreate: <ThrowOnError extends boolean = false>(options?: Options<PaymentLinksCreateData, ThrowOnError>) => RequestResult<PaymentLinksCreateResponses, PaymentLinksCreateErrors, ThrowOnError, "fields">;
 /**
  * Get payment link by ID
  *
  * Retrieve a payment link by its UUID or public_id
+ *
+ * ---
+ *
+ * **Related endpoints**
+ *
+ * - `POST /payment-links` — Create a new payment link
+ * - `GET /payment-links` — List payment links
+ * - `POST /payment-links/{id}/expire` — Expire a payment link (deprecated)
+ * - `PATCH /payment-links/{id}/status` — Update payment link status
+ * - `POST /payment-links/{id}/deactivate` — Deactivate a payment link (deprecated)
+ * - `POST /payment-links/{id}/activate` — Activate a payment link (deprecated)
+ * - `POST /payment-links/{id}/archive` — Archive a payment link (deprecated)
+ *
+ * **Common errors**
+ *
+ * - `401 unauthenticated` — missing, malformed, or revoked API key.
+ * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key.
  */
 declare const paymentLinksGet: <ThrowOnError extends boolean = false>(options: Options<PaymentLinksGetData, ThrowOnError>) => RequestResult<PaymentLinksGetResponses, PaymentLinksGetErrors, ThrowOnError, "fields">;
 /**
@@ -9771,6 +10484,28 @@ declare const paymentLinksGet: <ThrowOnError extends boolean = false>(options: O
  *
  * **Deprecated — use `PATCH /v2/payment-links/{id}/status` with `status: "expired"` instead.** This convenience endpoint will be removed in a future API version. Mark a payment link as expired, preventing further use.
  *
+ * ---
+ *
+ * **Related endpoints**
+ *
+ * - `POST /payment-links` — Create a new payment link
+ * - `GET /payment-links` — List payment links
+ * - `GET /payment-links/{id}` — Get payment link by ID
+ * - `PATCH /payment-links/{id}/status` — Update payment link status
+ * - `POST /payment-links/{id}/deactivate` — Deactivate a payment link (deprecated)
+ * - `POST /payment-links/{id}/activate` — Activate a payment link (deprecated)
+ * - `POST /payment-links/{id}/archive` — Archive a payment link (deprecated)
+ *
+ * **Common errors**
+ *
+ * - `400 invalid_request` — malformed payload or failed validation.
+ * - `401 unauthenticated` — missing, malformed, or revoked API key.
+ * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key.
+ *
+ * **Idempotency**
+ *
+ * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency).
+ *
  * @deprecated
  */
 declare const paymentLinksExpire: <ThrowOnError extends boolean = false>(options: Options<PaymentLinksExpireData, ThrowOnError>) => RequestResult<PaymentLinksExpireResponses, PaymentLinksExpireErrors, ThrowOnError, "fields">;
@@ -9778,6 +10513,28 @@ declare const paymentLinksExpire: <ThrowOnError extends boolean = false>(options
  * Update payment link status
  *
  * Change the status of a payment link. Active links accept payments, inactive links are temporarily disabled, and archived links are permanently disabled and cannot be reactivated.
+ *
+ * ---
+ *
+ * **Related endpoints**
+ *
+ * - `POST /payment-links` — Create a new payment link
+ * - `GET /payment-links` — List payment links
+ * - `GET /payment-links/{id}` — Get payment link by ID
+ * - `POST /payment-links/{id}/expire` — Expire a payment link (deprecated)
+ * - `POST /payment-links/{id}/deactivate` — Deactivate a payment link (deprecated)
+ * - `POST /payment-links/{id}/activate` — Activate a payment link (deprecated)
+ * - `POST /payment-links/{id}/archive` — Archive a payment link (deprecated)
+ *
+ * **Common errors**
+ *
+ * - `400 invalid_request` — malformed payload or failed validation.
+ * - `401 unauthenticated` — missing, malformed, or revoked API key.
+ * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key.
+ *
+ * **Idempotency**
+ *
+ * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency).
  */
 declare const paymentLinksUpdate: <ThrowOnError extends boolean = false>(options: Options<PaymentLinksUpdateData, ThrowOnError>) => RequestResult<PaymentLinksUpdateResponses, PaymentLinksUpdateErrors, ThrowOnError, "fields">;
 /**
@@ -9785,6 +10542,28 @@ declare const paymentLinksUpdate: <ThrowOnError extends boolean = false>(options
  *
  * **Deprecated — use `PATCH /v2/payment-links/{id}/status` with `status: "inactive"` instead.** This convenience endpoint will be removed in a future API version. Temporarily disable a payment link. It can be reactivated later.
  *
+ * ---
+ *
+ * **Related endpoints**
+ *
+ * - `POST /payment-links` — Create a new payment link
+ * - `GET /payment-links` — List payment links
+ * - `GET /payment-links/{id}` — Get payment link by ID
+ * - `POST /payment-links/{id}/expire` — Expire a payment link (deprecated)
+ * - `PATCH /payment-links/{id}/status` — Update payment link status
+ * - `POST /payment-links/{id}/activate` — Activate a payment link (deprecated)
+ * - `POST /payment-links/{id}/archive` — Archive a payment link (deprecated)
+ *
+ * **Common errors**
+ *
+ * - `400 invalid_request` — malformed payload or failed validation.
+ * - `401 unauthenticated` — missing, malformed, or revoked API key.
+ * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key.
+ *
+ * **Idempotency**
+ *
+ * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency).
+ *
  * @deprecated
  */
 declare const paymentLinksDeactivate: <ThrowOnError extends boolean = false>(options: Options<PaymentLinksDeactivateData, ThrowOnError>) => RequestResult<PaymentLinksDeactivateResponses, PaymentLinksDeactivateErrors, ThrowOnError, "fields">;
@@ -9793,6 +10572,28 @@ declare const paymentLinksDeactivate: <ThrowOnError extends boolean = false>(opt
  *
  * **Deprecated — use `PATCH /v2/payment-links/{id}/status` with `status: "active"` instead.** This convenience endpoint will be removed in a future API version. Enable a payment link to accept payments. Cannot be used on archived links.
  *
+ * ---
+ *
+ * **Related endpoints**
+ *
+ * - `POST /payment-links` — Create a new payment link
+ * - `GET /payment-links` — List payment links
+ * - `GET /payment-links/{id}` — Get payment link by ID
+ * - `POST /payment-links/{id}/expire` — Expire a payment link (deprecated)
+ * - `PATCH /payment-links/{id}/status` — Update payment link status
+ * - `POST /payment-links/{id}/deactivate` — Deactivate a payment link (deprecated)
+ * - `POST /payment-links/{id}/archive` — Archive a payment link (deprecated)
+ *
+ * **Common errors**
+ *
+ * - `400 invalid_request` — malformed payload or failed validation.
+ * - `401 unauthenticated` — missing, malformed, or revoked API key.
+ * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key.
+ *
+ * **Idempotency**
+ *
+ * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency).
+ *
  * @deprecated
  */
 declare const paymentLinksActivate: <ThrowOnError extends boolean = false>(options: Options<PaymentLinksActivateData, ThrowOnError>) => RequestResult<PaymentLinksActivateResponses, PaymentLinksActivateErrors, ThrowOnError, "fields">;
@@ -9801,6 +10602,27 @@ declare const paymentLinksActivate: <ThrowOnError extends boolean = false>(optio
  *
  * **Deprecated — use `PATCH /v2/payment-links/{id}/status` with `status: "archived"` instead.** This convenience endpoint will be removed in a future API version. Permanently disable a payment link. This action cannot be undone.
  *
+ * ---
+ *
+ * **Related endpoints**
+ *
+ * - `POST /payment-links` — Create a new payment link
+ * - `GET /payment-links` — List payment links
+ * - `GET /payment-links/{id}` — Get payment link by ID
+ * - `POST /payment-links/{id}/expire` — Expire a payment link (deprecated)
+ * - `PATCH /payment-links/{id}/status` — Update payment link status
+ * - `POST /payment-links/{id}/deactivate` — Deactivate a payment link (deprecated)
+ * - `POST /payment-links/{id}/activate` — Activate a payment link (deprecated)
+ *
+ * **Common errors**
+ *
+ * - `401 unauthenticated` — missing, malformed, or revoked API key.
+ * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key.
+ *
+ * **Idempotency**
+ *
+ * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency).
+ *
  * @deprecated
  */
 declare const paymentLinksArchive: <ThrowOnError extends boolean = false>(options: Options<PaymentLinksArchiveData, ThrowOnError>) => RequestResult<PaymentLinksArchiveResponses, PaymentLinksArchiveErrors, ThrowOnError, "fields">;
@@ -9808,96 +10630,437 @@ declare const paymentLinksArchive: <ThrowOnError extends boolean = false>(option
  * List prices
  *
  * List all prices for the authenticated merchant. Supports filtering and cursor-based pagination.
+ *
+ * ---
+ *
+ * **Related endpoints**
+ *
+ * - `POST /prices` — Create a price
+ * - `GET /prices/{id}` — Retrieve a price
+ * - `PATCH /prices/{id}` — Update a price
+ * - `DELETE /prices/{id}` — Archive a price
+ *
+ * **Common errors**
+ *
+ * - `401 unauthenticated` — missing, malformed, or revoked API key.
+ *
+ * **Pagination**
+ *
+ * Offset-based with `limit` (default 25, max 100) and `offset`. The response `pagination` block includes `total` and `hasMore`. See [the pagination guide](/docs/fundamentals/pagination) for SDK auto-paging helpers.
  */
 declare const pricesList: <ThrowOnError extends boolean = false>(options?: Options<PricesListData, ThrowOnError>) => RequestResult<PricesListResponses, PricesListErrors, ThrowOnError, "fields">;
 /**
  * Create a price
  *
  * Creates a new price for a product. Supports fixed, pay-what-you-want, and free pricing models.
+ *
+ * ---
+ *
+ * **Related endpoints**
+ *
+ * - `GET /prices` — List prices
+ * - `GET /prices/{id}` — Retrieve a price
+ * - `PATCH /prices/{id}` — Update a price
+ * - `DELETE /prices/{id}` — Archive a price
+ *
+ * **Common errors**
+ *
+ * - `400 invalid_request` — malformed payload or failed validation.
+ * - `401 unauthenticated` — missing, malformed, or revoked API key.
+ * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key.
+ *
+ * **Idempotency**
+ *
+ * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency).
  */
 declare const pricesCreate: <ThrowOnError extends boolean = false>(options: Options<PricesCreateData, ThrowOnError>) => RequestResult<PricesCreateResponses, PricesCreateErrors, ThrowOnError, "fields">;
 /**
  * Archive a price
  *
  * Archives a price by setting active to false. The price remains in the system but cannot be used for new purchases.
+ *
+ * ---
+ *
+ * **Related endpoints**
+ *
+ * - `GET /prices` — List prices
+ * - `POST /prices` — Create a price
+ * - `GET /prices/{id}` — Retrieve a price
+ * - `PATCH /prices/{id}` — Update a price
+ *
+ * **Common errors**
+ *
+ * - `401 unauthenticated` — missing, malformed, or revoked API key.
+ * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key.
+ *
+ * **Idempotency**
+ *
+ * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency).
  */
 declare const pricesArchive: <ThrowOnError extends boolean = false>(options: Options<PricesArchiveData, ThrowOnError>) => RequestResult<PricesArchiveResponses, PricesArchiveErrors, ThrowOnError, "fields">;
 /**
  * Retrieve a price
  *
  * Retrieves a price by its ID.
+ *
+ * ---
+ *
+ * **Related endpoints**
+ *
+ * - `GET /prices` — List prices
+ * - `POST /prices` — Create a price
+ * - `PATCH /prices/{id}` — Update a price
+ * - `DELETE /prices/{id}` — Archive a price
+ *
+ * **Common errors**
+ *
+ * - `401 unauthenticated` — missing, malformed, or revoked API key.
+ * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key.
  */
 declare const pricesGet: <ThrowOnError extends boolean = false>(options: Options<PricesGetData, ThrowOnError>) => RequestResult<PricesGetResponses, PricesGetErrors, ThrowOnError, "fields">;
 /**
  * Update a price
  *
  * Updates a price. Only certain fields can be updated (active, nickname, lookup_key, metadata). Core pricing fields are immutable.
+ *
+ * ---
+ *
+ * **Related endpoints**
+ *
+ * - `GET /prices` — List prices
+ * - `POST /prices` — Create a price
+ * - `GET /prices/{id}` — Retrieve a price
+ * - `DELETE /prices/{id}` — Archive a price
+ *
+ * **Common errors**
+ *
+ * - `400 invalid_request` — malformed payload or failed validation.
+ * - `401 unauthenticated` — missing, malformed, or revoked API key.
+ * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key.
+ *
+ * **Idempotency**
+ *
+ * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency).
  */
 declare const pricesUpdate: <ThrowOnError extends boolean = false>(options: Options<PricesUpdateData, ThrowOnError>) => RequestResult<PricesUpdateResponses, PricesUpdateErrors, ThrowOnError, "fields">;
+/**
+ * ---
+ *
+ * **Related endpoints**
+ *
+ * - `POST /webhook-endpoints` — webhook endpoints create
+ * - `GET /webhook-endpoints/{id}` — webhook endpoints get
+ * - `PATCH /webhook-endpoints/{id}` — webhook endpoints update
+ * - `DELETE /webhook-endpoints/{id}` — webhook endpoints delete
+ * - `POST /webhook-endpoints/{id}/rotate-secret` — webhook endpoints rotate secret
+ *
+ * **Pagination**
+ *
+ * Offset-based with `limit` (default 25, max 100) and `offset`. The response `pagination` block includes `total` and `hasMore`. See [the pagination guide](/docs/fundamentals/pagination) for SDK auto-paging helpers.
+ */
 declare const webhookEndpointsList: <ThrowOnError extends boolean = false>(options?: Options<WebhookEndpointsListData, ThrowOnError>) => RequestResult<WebhookEndpointsListResponses, unknown, ThrowOnError, "fields">;
+/**
+ * ---
+ *
+ * **Related endpoints**
+ *
+ * - `GET /webhook-endpoints` — webhook endpoints list
+ * - `GET /webhook-endpoints/{id}` — webhook endpoints get
+ * - `PATCH /webhook-endpoints/{id}` — webhook endpoints update
+ * - `DELETE /webhook-endpoints/{id}` — webhook endpoints delete
+ * - `POST /webhook-endpoints/{id}/rotate-secret` — webhook endpoints rotate secret
+ *
+ * **Idempotency**
+ *
+ * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency).
+ */
 declare const webhookEndpointsCreate: <ThrowOnError extends boolean = false>(options?: Options<WebhookEndpointsCreateData, ThrowOnError>) => RequestResult<WebhookEndpointsCreateResponses, unknown, ThrowOnError, "fields">;
+/**
+ * ---
+ *
+ * **Related endpoints**
+ *
+ * - `GET /webhook-endpoints` — webhook endpoints list
+ * - `POST /webhook-endpoints` — webhook endpoints create
+ * - `GET /webhook-endpoints/{id}` — webhook endpoints get
+ * - `PATCH /webhook-endpoints/{id}` — webhook endpoints update
+ * - `POST /webhook-endpoints/{id}/rotate-secret` — webhook endpoints rotate secret
+ *
+ * **Idempotency**
+ *
+ * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency).
+ */
 declare const webhookEndpointsDelete: <ThrowOnError extends boolean = false>(options: Options<WebhookEndpointsDeleteData, ThrowOnError>) => RequestResult<WebhookEndpointsDeleteResponses, unknown, ThrowOnError, "fields">;
+/**
+ * ---
+ *
+ * **Related endpoints**
+ *
+ * - `GET /webhook-endpoints` — webhook endpoints list
+ * - `POST /webhook-endpoints` — webhook endpoints create
+ * - `PATCH /webhook-endpoints/{id}` — webhook endpoints update
+ * - `DELETE /webhook-endpoints/{id}` — webhook endpoints delete
+ * - `POST /webhook-endpoints/{id}/rotate-secret` — webhook endpoints rotate secret
+ */
 declare const webhookEndpointsGet: <ThrowOnError extends boolean = false>(options: Options<WebhookEndpointsGetData, ThrowOnError>) => RequestResult<WebhookEndpointsGetResponses, unknown, ThrowOnError, "fields">;
+/**
+ * ---
+ *
+ * **Related endpoints**
+ *
+ * - `GET /webhook-endpoints` — webhook endpoints list
+ * - `POST /webhook-endpoints` — webhook endpoints create
+ * - `GET /webhook-endpoints/{id}` — webhook endpoints get
+ * - `DELETE /webhook-endpoints/{id}` — webhook endpoints delete
+ * - `POST /webhook-endpoints/{id}/rotate-secret` — webhook endpoints rotate secret
+ *
+ * **Idempotency**
+ *
+ * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency).
+ */
 declare const webhookEndpointsUpdate: <ThrowOnError extends boolean = false>(options: Options<WebhookEndpointsUpdateData, ThrowOnError>) => RequestResult<WebhookEndpointsUpdateResponses, unknown, ThrowOnError, "fields">;
+/**
+ * ---
+ *
+ * **Related endpoints**
+ *
+ * - `GET /webhook-endpoints` — webhook endpoints list
+ * - `POST /webhook-endpoints` — webhook endpoints create
+ * - `GET /webhook-endpoints/{id}` — webhook endpoints get
+ * - `PATCH /webhook-endpoints/{id}` — webhook endpoints update
+ * - `DELETE /webhook-endpoints/{id}` — webhook endpoints delete
+ *
+ * **Idempotency**
+ *
+ * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency).
+ */
 declare const webhookEndpointsRotateSecret: <ThrowOnError extends boolean = false>(options: Options<WebhookEndpointsRotateSecretData, ThrowOnError>) => RequestResult<WebhookEndpointsRotateSecretResponses, unknown, ThrowOnError, "fields">;
 /**
  * List webhook deliveries
  *
  * List individual webhook delivery attempts across all endpoints for the authenticated merchant. Use filters to scope to a specific endpoint, a specific event, or a specific delivery status. Results are returned in reverse chronological order.
+ *
+ * ---
+ *
+ * **Related endpoints**
+ *
+ * - `GET /webhook-deliveries/{id}` — Retrieve a webhook delivery
+ * - `POST /webhook-deliveries/{id}/retry` — Retry a webhook delivery
+ *
+ * **Common errors**
+ *
+ * - `401 unauthenticated` — missing, malformed, or revoked API key.
+ *
+ * **Pagination**
+ *
+ * Offset-based with `limit` (default 25, max 100) and `offset`. The response `pagination` block includes `total` and `hasMore`. See [the pagination guide](/docs/fundamentals/pagination) for SDK auto-paging helpers.
  */
 declare const webhookDeliveriesList: <ThrowOnError extends boolean = false>(options?: Options<WebhookDeliveriesListData, ThrowOnError>) => RequestResult<WebhookDeliveriesListResponses, WebhookDeliveriesListErrors, ThrowOnError, "fields">;
 /**
  * Retrieve a webhook delivery
  *
  * Retrieve the details of a single webhook delivery including its last attempt outcome.
+ *
+ * ---
+ *
+ * **Related endpoints**
+ *
+ * - `GET /webhook-deliveries` — List webhook deliveries
+ * - `POST /webhook-deliveries/{id}/retry` — Retry a webhook delivery
+ *
+ * **Common errors**
+ *
+ * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key.
  */
 declare const webhookDeliveriesGet: <ThrowOnError extends boolean = false>(options: Options<WebhookDeliveriesGetData, ThrowOnError>) => RequestResult<WebhookDeliveriesGetResponses, WebhookDeliveriesGetErrors, ThrowOnError, "fields">;
 /**
  * Retry a webhook delivery
  *
  * Queue an immediate retry of this delivery. The delivery is marked `pending` and `next_retry_at` is set to now; the dispatcher picks it up on its next tick. Calling retry on an already-pending delivery just advances its retry time. Dead-lettered deliveries can be retried once; succeeded deliveries cannot.
+ *
+ * ---
+ *
+ * **Related endpoints**
+ *
+ * - `GET /webhook-deliveries` — List webhook deliveries
+ * - `GET /webhook-deliveries/{id}` — Retrieve a webhook delivery
+ *
+ * **Common errors**
+ *
+ * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key.
+ * - `409 conflict` — Idempotency-Key collision with a different body, or a concurrent state-transition conflict.
+ *
+ * **Idempotency**
+ *
+ * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency).
  */
 declare const webhookDeliveriesRetry: <ThrowOnError extends boolean = false>(options: Options<WebhookDeliveriesRetryData, ThrowOnError>) => RequestResult<WebhookDeliveriesRetryResponses, WebhookDeliveriesRetryErrors, ThrowOnError, "fields">;
 /**
  * Create a customer-portal session
  *
  * Mint a short-lived bearer token that authenticates a specific customer against /v2/customer-portal*. Returns an opaque `rkcps_...` token that expires in 60 minutes by default. Call this server-side from the merchant's backend, then hand the token to the customer's browser or embedded client. Treat the token like a password — never log it and never expose it to untrusted code.
+ *
+ * ---
+ *
+ * **Related endpoints**
+ *
+ * - `GET /customer-portal/customer` — Retrieve the authenticated customer
+ * - `GET /customer-portal/subscriptions` — List the authenticated customer's subscriptions
+ * - `GET /customer-portal/subscriptions/{id}` — Retrieve a subscription
+ * - `POST /customer-portal/subscriptions/{id}/cancel` — Cancel a subscription
+ * - `GET /customer-portal/invoices` — List the authenticated customer's invoices
+ * - `GET /customer-portal/invoices/{id}` — Retrieve an invoice
+ *
+ * **Common errors**
+ *
+ * - `401 unauthenticated` — missing, malformed, or revoked API key.
+ * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key.
+ *
+ * **Idempotency**
+ *
+ * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency).
  */
 declare const customerPortalSessionsCreate: <ThrowOnError extends boolean = false>(options: Options<CustomerPortalSessionsCreateData, ThrowOnError>) => RequestResult<CustomerPortalSessionsCreateResponses, CustomerPortalSessionsCreateErrors, ThrowOnError, "fields">;
 /**
  * Retrieve the authenticated customer
  *
  * Returns the customer represented by the bearer token. Useful as a warm-up / identity check when an embedded portal page loads.
+ *
+ * ---
+ *
+ * **Related endpoints**
+ *
+ * - `POST /customer-portal/sessions` — Create a customer-portal session
+ * - `GET /customer-portal/subscriptions` — List the authenticated customer's subscriptions
+ * - `GET /customer-portal/subscriptions/{id}` — Retrieve a subscription
+ * - `POST /customer-portal/subscriptions/{id}/cancel` — Cancel a subscription
+ * - `GET /customer-portal/invoices` — List the authenticated customer's invoices
+ * - `GET /customer-portal/invoices/{id}` — Retrieve an invoice
+ *
+ * **Common errors**
+ *
+ * - `401 unauthenticated` — missing, malformed, or revoked API key.
+ * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key.
  */
 declare const customerPortalCustomerGet: <ThrowOnError extends boolean = false>(options?: Options<CustomerPortalCustomerGetData, ThrowOnError>) => RequestResult<CustomerPortalCustomerGetResponses, CustomerPortalCustomerGetErrors, ThrowOnError, "fields">;
 /**
  * List the authenticated customer's subscriptions
  *
  * Returns subscriptions where the customer is the subscriber. Results are reverse-chronological by creation time and paginate via `starting_after` / `ending_before` cursors.
+ *
+ * ---
+ *
+ * **Related endpoints**
+ *
+ * - `POST /customer-portal/sessions` — Create a customer-portal session
+ * - `GET /customer-portal/customer` — Retrieve the authenticated customer
+ * - `GET /customer-portal/subscriptions/{id}` — Retrieve a subscription
+ * - `POST /customer-portal/subscriptions/{id}/cancel` — Cancel a subscription
+ * - `GET /customer-portal/invoices` — List the authenticated customer's invoices
+ * - `GET /customer-portal/invoices/{id}` — Retrieve an invoice
+ *
+ * **Common errors**
+ *
+ * - `401 unauthenticated` — missing, malformed, or revoked API key.
+ *
+ * **Pagination**
+ *
+ * Offset-based with `limit` (default 25, max 100) and `offset`. The response `pagination` block includes `total` and `hasMore`. See [the pagination guide](/docs/fundamentals/pagination) for SDK auto-paging helpers.
  */
 declare const customerPortalSubscriptionsList: <ThrowOnError extends boolean = false>(options?: Options<CustomerPortalSubscriptionsListData, ThrowOnError>) => RequestResult<CustomerPortalSubscriptionsListResponses, CustomerPortalSubscriptionsListErrors, ThrowOnError, "fields">;
 /**
  * Retrieve a subscription
  *
  * Returns a subscription owned by the authenticated customer. 404s on cross-customer access even if the subscription exists.
+ *
+ * ---
+ *
+ * **Related endpoints**
+ *
+ * - `POST /customer-portal/sessions` — Create a customer-portal session
+ * - `GET /customer-portal/customer` — Retrieve the authenticated customer
+ * - `GET /customer-portal/subscriptions` — List the authenticated customer's subscriptions
+ * - `POST /customer-portal/subscriptions/{id}/cancel` — Cancel a subscription
+ * - `GET /customer-portal/invoices` — List the authenticated customer's invoices
+ * - `GET /customer-portal/invoices/{id}` — Retrieve an invoice
+ *
+ * **Common errors**
+ *
+ * - `401 unauthenticated` — missing, malformed, or revoked API key.
+ * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key.
  */
 declare const customerPortalSubscriptionsGet: <ThrowOnError extends boolean = false>(options: Options<CustomerPortalSubscriptionsGetData, ThrowOnError>) => RequestResult<CustomerPortalSubscriptionsGetResponses, CustomerPortalSubscriptionsGetErrors, ThrowOnError, "fields">;
 /**
  * Cancel a subscription
  *
  * Cancel a subscription owned by the authenticated customer. By default the subscription is scheduled to cancel at the end of the current billing period — set `cancel_at_period_end=false` to cancel immediately. Idempotent — cancelling an already-canceled subscription is a no-op that returns the current state.
+ *
+ * ---
+ *
+ * **Related endpoints**
+ *
+ * - `POST /customer-portal/sessions` — Create a customer-portal session
+ * - `GET /customer-portal/customer` — Retrieve the authenticated customer
+ * - `GET /customer-portal/subscriptions` — List the authenticated customer's subscriptions
+ * - `GET /customer-portal/subscriptions/{id}` — Retrieve a subscription
+ * - `GET /customer-portal/invoices` — List the authenticated customer's invoices
+ * - `GET /customer-portal/invoices/{id}` — Retrieve an invoice
+ *
+ * **Common errors**
+ *
+ * - `401 unauthenticated` — missing, malformed, or revoked API key.
+ * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key.
+ *
+ * **Idempotency**
+ *
+ * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency).
  */
 declare const customerPortalSubscriptionsCancel: <ThrowOnError extends boolean = false>(options: Options<CustomerPortalSubscriptionsCancelData, ThrowOnError>) => RequestResult<CustomerPortalSubscriptionsCancelResponses, CustomerPortalSubscriptionsCancelErrors, ThrowOnError, "fields">;
 /**
  * List the authenticated customer's invoices
  *
  * Returns invoices owned by the authenticated customer, reverse-chronological by `invoice_date`. Use the same `starting_after`/`ending_before` cursor pattern as subscriptions.
+ *
+ * ---
+ *
+ * **Related endpoints**
+ *
+ * - `POST /customer-portal/sessions` — Create a customer-portal session
+ * - `GET /customer-portal/customer` — Retrieve the authenticated customer
+ * - `GET /customer-portal/subscriptions` — List the authenticated customer's subscriptions
+ * - `GET /customer-portal/subscriptions/{id}` — Retrieve a subscription
+ * - `POST /customer-portal/subscriptions/{id}/cancel` — Cancel a subscription
+ * - `GET /customer-portal/invoices/{id}` — Retrieve an invoice
+ *
+ * **Common errors**
+ *
+ * - `401 unauthenticated` — missing, malformed, or revoked API key.
+ *
+ * **Pagination**
+ *
+ * Offset-based with `limit` (default 25, max 100) and `offset`. The response `pagination` block includes `total` and `hasMore`. See [the pagination guide](/docs/fundamentals/pagination) for SDK auto-paging helpers.
  */
 declare const customerPortalInvoicesList: <ThrowOnError extends boolean = false>(options?: Options<CustomerPortalInvoicesListData, ThrowOnError>) => RequestResult<CustomerPortalInvoicesListResponses, CustomerPortalInvoicesListErrors, ThrowOnError, "fields">;
 /**
  * Retrieve an invoice
  *
  * Returns an invoice owned by the authenticated customer.
+ *
+ * ---
+ *
+ * **Related endpoints**
+ *
+ * - `POST /customer-portal/sessions` — Create a customer-portal session
+ * - `GET /customer-portal/customer` — Retrieve the authenticated customer
+ * - `GET /customer-portal/subscriptions` — List the authenticated customer's subscriptions
+ * - `GET /customer-portal/subscriptions/{id}` — Retrieve a subscription
+ * - `POST /customer-portal/subscriptions/{id}/cancel` — Cancel a subscription
+ * - `GET /customer-portal/invoices` — List the authenticated customer's invoices
+ *
+ * **Common errors**
+ *
+ * - `401 unauthenticated` — missing, malformed, or revoked API key.
+ * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key.
  */
 declare const customerPortalInvoicesGet: <ThrowOnError extends boolean = false>(options: Options<CustomerPortalInvoicesGetData, ThrowOnError>) => RequestResult<CustomerPortalInvoicesGetResponses, CustomerPortalInvoicesGetErrors, ThrowOnError, "fields">;
 /**
@@ -9906,90 +11069,338 @@ declare const customerPortalInvoicesGet: <ThrowOnError extends boolean = false>(
  * Returns per-meter aggregates for a single customer. Requires a `customer_id` query parameter. For each meter the merchant has defined, the response includes the aggregate quantity (applying the meter's native aggregation function), the event count, and the most recent event timestamp.
  *
  * Use this to render a customer's current consumption snapshot in your own UI — for example, a usage dashboard showing "4,820 / 10,000 requests this period".
+ *
+ * ---
+ *
+ * **Related endpoints**
+ *
+ * - `GET /customer-meters/{customer_id}/{meter_id}` — Retrieve a customer-meter aggregate
+ *
+ * **Common errors**
+ *
+ * - `400 invalid_request` — malformed payload or failed validation.
+ * - `401 unauthenticated` — missing, malformed, or revoked API key.
+ *
+ * **Pagination**
+ *
+ * Offset-based with `limit` (default 25, max 100) and `offset`. The response `pagination` block includes `total` and `hasMore`. See [the pagination guide](/docs/fundamentals/pagination) for SDK auto-paging helpers.
  */
 declare const customerMetersList: <ThrowOnError extends boolean = false>(options: Options<CustomerMetersListData, ThrowOnError>) => RequestResult<CustomerMetersListResponses, CustomerMetersListErrors, ThrowOnError, "fields">;
 /**
  * Retrieve a customer-meter aggregate
  *
  * Returns a single customer-meter aggregate for the specified customer + meter pair. Returns 404 only if the meter itself does not exist on the merchant — if the meter exists but the customer has zero events, the response returns an aggregate with `total_quantity: 0`, `event_count: 0`, `last_event_at: null`.
+ *
+ * ---
+ *
+ * **Related endpoints**
+ *
+ * - `GET /customer-meters` — List a customer's meter usage
+ *
+ * **Common errors**
+ *
+ * - `401 unauthenticated` — missing, malformed, or revoked API key.
+ * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key.
  */
 declare const customerMetersGet: <ThrowOnError extends boolean = false>(options: Options<CustomerMetersGetData, ThrowOnError>) => RequestResult<CustomerMetersGetResponses, CustomerMetersGetErrors, ThrowOnError, "fields">;
 /**
  * List payment intents
  *
  * Returns a list of payment intents with optional filtering.
+ *
+ * ---
+ *
+ * **Related endpoints**
+ *
+ * - `POST /payment-intents` — Create a payment intent
+ * - `GET /payment-intents/{id}` — Retrieve a payment intent
+ * - `POST /payment-intents/{id}` — Update a payment intent
+ * - `POST /payment-intents/{id}/confirm` — Confirm a payment intent
+ * - `POST /payment-intents/{id}/capture` — Capture a payment intent
+ * - `POST /payment-intents/{id}/cancel` — Cancel a payment intent
+ *
+ * **Common errors**
+ *
+ * - `401 unauthenticated` — missing, malformed, or revoked API key.
+ *
+ * **Pagination**
+ *
+ * Offset-based with `limit` (default 25, max 100) and `offset`. The response `pagination` block includes `total` and `hasMore`. See [the pagination guide](/docs/fundamentals/pagination) for SDK auto-paging helpers.
  */
 declare const paymentIntentsList: <ThrowOnError extends boolean = false>(options?: Options<PaymentIntentsListData, ThrowOnError>) => RequestResult<PaymentIntentsListResponses, PaymentIntentsListErrors, ThrowOnError, "fields">;
 /**
  * Create a payment intent
  *
  * Creates a payment intent to orchestrate payment collection with support for 3DS/SCA authentication.
+ *
+ * ---
+ *
+ * **Related endpoints**
+ *
+ * - `GET /payment-intents` — List payment intents
+ * - `GET /payment-intents/{id}` — Retrieve a payment intent
+ * - `POST /payment-intents/{id}` — Update a payment intent
+ * - `POST /payment-intents/{id}/confirm` — Confirm a payment intent
+ * - `POST /payment-intents/{id}/capture` — Capture a payment intent
+ * - `POST /payment-intents/{id}/cancel` — Cancel a payment intent
+ *
+ * **Common errors**
+ *
+ * - `400 invalid_request` — malformed payload or failed validation.
+ * - `401 unauthenticated` — missing, malformed, or revoked API key.
+ *
+ * **Idempotency**
+ *
+ * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency).
  */
 declare const paymentIntentsCreate: <ThrowOnError extends boolean = false>(options?: Options<PaymentIntentsCreateData, ThrowOnError>) => RequestResult<PaymentIntentsCreateResponses, PaymentIntentsCreateErrors, ThrowOnError, "fields">;
 /**
  * Retrieve a payment intent
  *
  * Retrieves a payment intent by its ID (pi_xxx).
+ *
+ * ---
+ *
+ * **Related endpoints**
+ *
+ * - `POST /payment-intents` — Create a payment intent
+ * - `GET /payment-intents` — List payment intents
+ * - `POST /payment-intents/{id}` — Update a payment intent
+ * - `POST /payment-intents/{id}/confirm` — Confirm a payment intent
+ * - `POST /payment-intents/{id}/capture` — Capture a payment intent
+ * - `POST /payment-intents/{id}/cancel` — Cancel a payment intent
+ *
+ * **Common errors**
+ *
+ * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key.
  */
 declare const paymentIntentsGet: <ThrowOnError extends boolean = false>(options: Options<PaymentIntentsGetData, ThrowOnError>) => RequestResult<PaymentIntentsGetResponses, PaymentIntentsGetErrors, ThrowOnError, "fields">;
 /**
  * Confirm a payment intent
  *
  * Confirms the payment intent. May return requires_action if 3DS authentication is needed.
+ *
+ * ---
+ *
+ * **Related endpoints**
+ *
+ * - `POST /payment-intents` — Create a payment intent
+ * - `GET /payment-intents` — List payment intents
+ * - `GET /payment-intents/{id}` — Retrieve a payment intent
+ * - `POST /payment-intents/{id}` — Update a payment intent
+ * - `POST /payment-intents/{id}/capture` — Capture a payment intent
+ * - `POST /payment-intents/{id}/cancel` — Cancel a payment intent
+ *
+ * **Common errors**
+ *
+ * - `400 invalid_request` — malformed payload or failed validation.
+ * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key.
+ *
+ * **Idempotency**
+ *
+ * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency).
  */
 declare const paymentIntentsConfirm: <ThrowOnError extends boolean = false>(options: Options<PaymentIntentsConfirmData, ThrowOnError>) => RequestResult<PaymentIntentsConfirmResponses, PaymentIntentsConfirmErrors, ThrowOnError, "fields">;
 /**
  * Capture a payment intent
  *
  * Captures a payment intent that was created with capture_method=manual.
+ *
+ * ---
+ *
+ * **Related endpoints**
+ *
+ * - `POST /payment-intents` — Create a payment intent
+ * - `GET /payment-intents` — List payment intents
+ * - `GET /payment-intents/{id}` — Retrieve a payment intent
+ * - `POST /payment-intents/{id}` — Update a payment intent
+ * - `POST /payment-intents/{id}/confirm` — Confirm a payment intent
+ * - `POST /payment-intents/{id}/cancel` — Cancel a payment intent
+ *
+ * **Common errors**
+ *
+ * - `400 invalid_request` — malformed payload or failed validation.
+ * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key.
+ *
+ * **Idempotency**
+ *
+ * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency).
  */
 declare const paymentIntentsCapture: <ThrowOnError extends boolean = false>(options: Options<PaymentIntentsCaptureData, ThrowOnError>) => RequestResult<PaymentIntentsCaptureResponses, PaymentIntentsCaptureErrors, ThrowOnError, "fields">;
 /**
  * Cancel a payment intent
  *
  * Cancels a payment intent. Cannot cancel if already succeeded or canceled.
+ *
+ * ---
+ *
+ * **Related endpoints**
+ *
+ * - `POST /payment-intents` — Create a payment intent
+ * - `GET /payment-intents` — List payment intents
+ * - `GET /payment-intents/{id}` — Retrieve a payment intent
+ * - `POST /payment-intents/{id}` — Update a payment intent
+ * - `POST /payment-intents/{id}/confirm` — Confirm a payment intent
+ * - `POST /payment-intents/{id}/capture` — Capture a payment intent
+ *
+ * **Common errors**
+ *
+ * - `400 invalid_request` — malformed payload or failed validation.
+ * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key.
+ *
+ * **Idempotency**
+ *
+ * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency).
  */
 declare const paymentIntentsCancel: <ThrowOnError extends boolean = false>(options: Options<PaymentIntentsCancelData, ThrowOnError>) => RequestResult<PaymentIntentsCancelResponses, PaymentIntentsCancelErrors, ThrowOnError, "fields">;
 /**
  * List events
  *
  * Returns a list of events with optional filters. Events are returned in reverse chronological order.
+ *
+ * ---
+ *
+ * **Related endpoints**
+ *
+ * - `GET /events/{id}` — Retrieve an event
+ * - `POST /events/{id}/resend` — Resend webhook for an event
+ * - `POST /events/test` — Create a test event
+ *
+ * **Common errors**
+ *
+ * - `401 unauthenticated` — missing, malformed, or revoked API key.
+ *
+ * **Pagination**
+ *
+ * Offset-based with `limit` (default 25, max 100) and `offset`. The response `pagination` block includes `total` and `hasMore`. See [the pagination guide](/docs/fundamentals/pagination) for SDK auto-paging helpers.
  */
 declare const eventsList: <ThrowOnError extends boolean = false>(options?: Options<EventsListData, ThrowOnError>) => RequestResult<EventsListResponses, EventsListErrors, ThrowOnError, "fields">;
 /**
  * Retrieve an event
  *
  * Retrieves the details of an event by its ID.
+ *
+ * ---
+ *
+ * **Related endpoints**
+ *
+ * - `GET /events` — List events
+ * - `POST /events/{id}/resend` — Resend webhook for an event
+ * - `POST /events/test` — Create a test event
+ *
+ * **Common errors**
+ *
+ * - `401 unauthenticated` — missing, malformed, or revoked API key.
+ * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key.
  */
 declare const eventsGet: <ThrowOnError extends boolean = false>(options: Options<EventsGetData, ThrowOnError>) => RequestResult<EventsGetResponses, EventsGetErrors, ThrowOnError, "fields">;
 /**
  * Resend webhook for an event
  *
  * Queues the event to be resent to all configured webhook endpoints.
+ *
+ * ---
+ *
+ * **Related endpoints**
+ *
+ * - `GET /events` — List events
+ * - `GET /events/{id}` — Retrieve an event
+ * - `POST /events/test` — Create a test event
+ *
+ * **Common errors**
+ *
+ * - `401 unauthenticated` — missing, malformed, or revoked API key.
+ * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key.
+ *
+ * **Idempotency**
+ *
+ * Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency).
  */
 declare const eventsResend: <ThrowOnError extends boolean = false>(options: Options<EventsResendData, ThrowOnError>) => RequestResult<EventsResendResponses, EventsResendErrors, ThrowOnError, "fields">;
 /**
  * List entitlements
  *
  * Retrieve all entitlements for a customer. Pass `customer_id` as a query parameter. Includes computed access status based on subscription state.
+ *
+ * ---
+ *
+ * **Related endpoints**
+ *
+ * - `GET /customers/{customerId}/entitlements` — List customer entitlements
+ * - `POST /customers/{customerId}/entitlements` — Grant entitlement to customer
+ * - `DELETE /customers/{customerId}/entitlements` — Revoke entitlement by benefit key
+ * - `GET /customers/{customerId}/entitlements/check` — Check customer entitlement
+ * - `DELETE /customers/{customerId}/entitlements/{entitlementId}` — Revoke entitlement by ID
+ * - `GET /entitlements/check` — Check entitlement access
+ *
+ * **Common errors**
+ *
+ * - `400 invalid_request` — malformed payload or failed validation.
+ * - `401 unauthenticated` — missing, malformed, or revoked API key.
+ * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key.
+ *
+ * **Pagination**
+ *
+ * Offset-based with `limit` (default 25, max 100) and `offset`. The response `pagination` block includes `total` and `hasMore`. See [the pagination guide](/docs/fundamentals/pagination) for SDK auto-paging helpers.
  */
 declare const entitlementsList: <ThrowOnError extends boolean = false>(options: Options<EntitlementsListData, ThrowOnError>) => RequestResult<EntitlementsListResponses, EntitlementsListErrors, ThrowOnError, "fields">;
 /**
  * Check entitlement access
  *
  * Check if a customer has access to a specific benefit by key. This is the primary endpoint for feature gating and licensing checks.
+ *
+ * ---
+ *
+ * **Related endpoints**
+ *
+ * - `GET /customers/{customerId}/entitlements` — List customer entitlements
+ * - `POST /customers/{customerId}/entitlements` — Grant entitlement to customer
+ * - `DELETE /customers/{customerId}/entitlements` — Revoke entitlement by benefit key
+ * - `GET /customers/{customerId}/entitlements/check` — Check customer entitlement
+ * - `DELETE /customers/{customerId}/entitlements/{entitlementId}` — Revoke entitlement by ID
+ * - `GET /entitlements` — List entitlements
+ *
+ * **Common errors**
+ *
+ * - `401 unauthenticated` — missing, malformed, or revoked API key.
+ * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key.
  */
 declare const entitlementsCheck: <ThrowOnError extends boolean = false>(options: Options<EntitlementsCheckData, ThrowOnError>) => RequestResult<EntitlementsCheckResponses, EntitlementsCheckErrors, ThrowOnError, "fields">;
 /**
  * List transactions
  *
  * List all transactions for the authenticated merchant. Transactions represent the unified financial truth — every sale, refund, void, capture, dispute, and adjustment.
+ *
+ * ---
+ *
+ * **Related endpoints**
+ *
+ * - `GET /transactions/{id}` — Get transaction by ID
+ *
+ * **Common errors**
+ *
+ * - `401 unauthenticated` — missing, malformed, or revoked API key.
+ *
+ * **Pagination**
+ *
+ * Offset-based with `limit` (default 25, max 100) and `offset`. The response `pagination` block includes `total` and `hasMore`. See [the pagination guide](/docs/fundamentals/pagination) for SDK auto-paging helpers.
  */
 declare const transactionsList: <ThrowOnError extends boolean = false>(options?: Options<TransactionsListData, ThrowOnError>) => RequestResult<TransactionsListResponses, TransactionsListErrors, ThrowOnError, "fields">;
 /**
  * Get transaction by ID
  *
  * Retrieve a single transaction by its ID.
+ *
+ * ---
+ *
+ * **Related endpoints**
+ *
+ * - `GET /transactions` — List transactions
+ *
+ * **Common errors**
+ *
+ * - `401 unauthenticated` — missing, malformed, or revoked API key.
+ * - `404 resource_missing` — the referenced resource does not exist or is not visible to your key.
  */
 declare const transactionsGet: <ThrowOnError extends boolean = false>(options: Options<TransactionsGetData, ThrowOnError>) => RequestResult<TransactionsGetResponses, TransactionsGetErrors, ThrowOnError, "fields">;