@flexprice/sdk 2.1.25 → 2.1.30

package/docs/sdk/models/webhook-dto-subscription.md

@@ -10,28 +10,32 @@ let value: WebhookDtoSubscription = {};
 
 ## Fields
 
-| Field                                                                                         | Type                                                                                          | Required                                                                                      | Description                                                                                   |
-| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
-| `billingCadence`                                                                              | [models.BillingCadence](../../sdk/models/billing-cadence.md)                                  | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `billingPeriod`                                                                               | [models.BillingPeriod](../../sdk/models/billing-period.md)                                    | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `billingPeriodCount`                                                                          | *number*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `cancelAt`                                                                                    | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `cancelAtPeriodEnd`                                                                           | *boolean*                                                                                     | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `cancelledAt`                                                                                 | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `currency`                                                                                    | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `currentPeriodEnd`                                                                            | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `currentPeriodStart`                                                                          | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `customer`                                                                                    | [models.WebhookDtoCustomer](../../sdk/models/webhook-dto-customer.md)                         | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `customerId`                                                                                  | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `endDate`                                                                                     | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `id`                                                                                          | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `lookupKey`                                                                                   | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `metadata`                                                                                    | Record<string, *string*>                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `parentSubscriptionId`                                                                        | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `pauseStatus`                                                                                 | [models.PauseStatus](../../sdk/models/pause-status.md)                                        | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `planId`                                                                                      | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `startDate`                                                                                   | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `subscriptionStatus`                                                                          | [models.SubscriptionStatus](../../sdk/models/subscription-status.md)                          | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `subscriptionType`                                                                            | [models.SubscriptionType](../../sdk/models/subscription-type.md)                              | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `trialEnd`                                                                                    | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `trialStart`                                                                                  | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| Field                                                                                             | Type                                                                                              | Required                                                                                          | Description                                                                                       |
+| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
+| `billingCadence`                                                                                  | [models.BillingCadence](../../sdk/models/billing-cadence.md)                                      | :heavy_minus_sign:                                                                                | N/A                                                                                               |
+| `billingPeriod`                                                                                   | [models.BillingPeriod](../../sdk/models/billing-period.md)                                        | :heavy_minus_sign:                                                                                | N/A                                                                                               |
+| `billingPeriodCount`                                                                              | *number*                                                                                          | :heavy_minus_sign:                                                                                | N/A                                                                                               |
+| `cancelAt`                                                                                        | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)     | :heavy_minus_sign:                                                                                | N/A                                                                                               |
+| `cancelAtPeriodEnd`                                                                               | *boolean*                                                                                         | :heavy_minus_sign:                                                                                | N/A                                                                                               |
+| `cancelledAt`                                                                                     | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)     | :heavy_minus_sign:                                                                                | N/A                                                                                               |
+| `couponAssociations`                                                                              | [models.WebhookDtoCouponAssociation](../../sdk/models/webhook-dto-coupon-association.md)[]        | :heavy_minus_sign:                                                                                | N/A                                                                                               |
+| `currency`                                                                                        | *string*                                                                                          | :heavy_minus_sign:                                                                                | N/A                                                                                               |
+| `currentPeriodEnd`                                                                                | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)     | :heavy_minus_sign:                                                                                | N/A                                                                                               |
+| `currentPeriodStart`                                                                              | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)     | :heavy_minus_sign:                                                                                | N/A                                                                                               |
+| `customer`                                                                                        | [models.WebhookDtoCustomer](../../sdk/models/webhook-dto-customer.md)                             | :heavy_minus_sign:                                                                                | N/A                                                                                               |
+| `customerId`                                                                                      | *string*                                                                                          | :heavy_minus_sign:                                                                                | N/A                                                                                               |
+| `endDate`                                                                                         | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)     | :heavy_minus_sign:                                                                                | N/A                                                                                               |
+| `id`                                                                                              | *string*                                                                                          | :heavy_minus_sign:                                                                                | N/A                                                                                               |
+| `invoicingCustomerId`                                                                             | *string*                                                                                          | :heavy_minus_sign:                                                                                | N/A                                                                                               |
+| `lineItems`                                                                                       | [models.WebhookDtoSubscriptionLineItem](../../sdk/models/webhook-dto-subscription-line-item.md)[] | :heavy_minus_sign:                                                                                | N/A                                                                                               |
+| `lookupKey`                                                                                       | *string*                                                                                          | :heavy_minus_sign:                                                                                | N/A                                                                                               |
+| `metadata`                                                                                        | Record<string, *string*>                                                                          | :heavy_minus_sign:                                                                                | N/A                                                                                               |
+| `parentSubscriptionId`                                                                            | *string*                                                                                          | :heavy_minus_sign:                                                                                | N/A                                                                                               |
+| `pauseStatus`                                                                                     | [models.PauseStatus](../../sdk/models/pause-status.md)                                            | :heavy_minus_sign:                                                                                | N/A                                                                                               |
+| `plan`                                                                                            | [models.WebhookDtoPlan](../../sdk/models/webhook-dto-plan.md)                                     | :heavy_minus_sign:                                                                                | N/A                                                                                               |
+| `planId`                                                                                          | *string*                                                                                          | :heavy_minus_sign:                                                                                | N/A                                                                                               |
+| `startDate`                                                                                       | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)     | :heavy_minus_sign:                                                                                | N/A                                                                                               |
+| `subscriptionStatus`                                                                              | [models.SubscriptionStatus](../../sdk/models/subscription-status.md)                              | :heavy_minus_sign:                                                                                | N/A                                                                                               |
+| `subscriptionType`                                                                                | [models.SubscriptionType](../../sdk/models/subscription-type.md)                                  | :heavy_minus_sign:                                                                                | N/A                                                                                               |
+| `trialEnd`                                                                                        | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)     | :heavy_minus_sign:                                                                                | N/A                                                                                               |
+| `trialStart`                                                                                      | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)     | :heavy_minus_sign:                                                                                | N/A                                                                                               |

package/docs/sdk/models/webhook-dto-tax-applied.md

@@ -0,0 +1,23 @@
+# WebhookDtoTaxApplied
+
+## Example Usage
+
+```typescript
+import { WebhookDtoTaxApplied } from "@flexprice/sdk/sdk/models";
+
+let value: WebhookDtoTaxApplied = {};
+```
+
+## Fields
+
+| Field                                                                                         | Type                                                                                          | Required                                                                                      | Description                                                                                   |
+| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
+| `appliedAt`                                                                                   | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `currency`                                                                                    | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `id`                                                                                          | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `metadata`                                                                                    | Record<string, *string*>                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `taxAmount`                                                                                   | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `taxBehavior`                                                                                 | [models.TaxBehavior](../../sdk/models/tax-behavior.md)                                        | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `taxRate`                                                                                     | [models.WebhookDtoTaxRate](../../sdk/models/webhook-dto-tax-rate.md)                          | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `taxRateId`                                                                                   | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `taxableAmount`                                                                               | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |

package/docs/sdk/models/webhook-dto-tax-rate.md

@@ -0,0 +1,20 @@
+# WebhookDtoTaxRate
+
+## Example Usage
+
+```typescript
+import { WebhookDtoTaxRate } from "@flexprice/sdk/sdk/models";
+
+let value: WebhookDtoTaxRate = {};
+```
+
+## Fields
+
+| Field                                                   | Type                                                    | Required                                                | Description                                             |
+| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
+| `code`                                                  | *string*                                                | :heavy_minus_sign:                                      | N/A                                                     |
+| `description`                                           | *string*                                                | :heavy_minus_sign:                                      | N/A                                                     |
+| `id`                                                    | *string*                                                | :heavy_minus_sign:                                      | N/A                                                     |
+| `name`                                                  | *string*                                                | :heavy_minus_sign:                                      | N/A                                                     |
+| `percentageValue`                                       | *string*                                                | :heavy_minus_sign:                                      | N/A                                                     |
+| `taxRateType`                                           | [models.TaxRateType](../../sdk/models/tax-rate-type.md) | :heavy_minus_sign:                                      | N/A                                                     |

package/docs/sdk/models/webhook-dto-wallet-webhook-payload.md

@@ -13,5 +13,6 @@ let value: WebhookDtoWalletWebhookPayload = {};
 | Field                                                                                 | Type                                                                                  | Required                                                                              | Description                                                                           |
 | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
 | `alert`                                                                               | [models.WebhookDtoWalletAlertInfo](../../sdk/models/webhook-dto-wallet-alert-info.md) | :heavy_minus_sign:                                                                    | N/A                                                                                   |
+| `customer`                                                                            | [models.WebhookDtoCustomer](../../sdk/models/webhook-dto-customer.md)                 | :heavy_minus_sign:                                                                    | N/A                                                                                   |
 | `eventType`                                                                           | [models.WebhookEventName](../../sdk/models/webhook-event-name.md)                     | :heavy_minus_sign:                                                                    | N/A                                                                                   |
 | `wallet`                                                                              | [models.WebhookDtoWallet](../../sdk/models/webhook-dto-wallet.md)                     | :heavy_minus_sign:                                                                    | N/A                                                                                   |

package/docs/sdk/models/webhook-event-name.md

@@ -13,5 +13,5 @@ let value: WebhookEventName = "subscription.draft.created";
 ## Values
 
 ```typescript
-"subscription.created" | "subscription.draft.created" | "subscription.activated" | "subscription.updated" | "subscription.paused" | "subscription.cancelled" | "subscription.resumed" | "subscription.plan_changed" | "subscription.phase.created" | "subscription.phase.updated" | "subscription.phase.deleted" | "feature.created" | "feature.updated" | "feature.deleted" | "feature.wallet_balance.alert" | "entitlement.created" | "entitlement.updated" | "entitlement.deleted" | "wallet.created" | "wallet.updated" | "wallet.terminated" | "wallet.transaction.created" | "wallet.transaction.updated" | "payment.created" | "payment.updated" | "payment.failed" | "payment.success" | "payment.pending" | "customer.created" | "customer.updated" | "customer.deleted" | "invoice.update.finalized" | "invoice.update.payment" | "invoice.update.voided" | "invoice.update" | "invoice.payment.overdue" | "wallet.credit_balance.dropped" | "wallet.credit_balance.recovered" | "wallet.ongoing_balance.dropped" | "wallet.ongoing_balance.recovered" | "wallet.ongoing_balance.updated" | "subscription.spend.threshold_reached" | "subscription.spend.threshold_recovered" | "subscription.line_item_spend.threshold_reached" | "subscription.line_item_spend.threshold_recovered" | "subscription.group_spend.threshold_reached" | "subscription.group_spend.threshold_recovered" | "entitlement.grant.exhausted" | "subscription.renewal.due" | "invoice.communication.triggered" | "credit_note.created" | "credit_note.updated" | "checkout.session.initiated" | "checkout.session.completed" | "checkout.session.failed" | "checkout.session.expired" | "event.rejected" | Unrecognized<string>
+"subscription.created" | "subscription.draft.created" | "subscription.activated" | "subscription.updated" | "subscription.paused" | "subscription.cancelled" | "subscription.resumed" | "subscription.plan_changed" | "subscription.phase.created" | "subscription.phase.updated" | "subscription.phase.deleted" | "feature.created" | "feature.updated" | "feature.deleted" | "feature.wallet_balance.alert" | "entitlement.created" | "entitlement.updated" | "entitlement.deleted" | "wallet.created" | "wallet.updated" | "wallet.terminated" | "wallet.transaction.created" | "wallet.transaction.updated" | "payment.created" | "payment.updated" | "payment.failed" | "payment.success" | "payment.pending" | "refund.created" | "refund.succeeded" | "refund.failed" | "customer.created" | "customer.updated" | "customer.deleted" | "invoice.update.finalized" | "invoice.update.payment" | "invoice.update.voided" | "invoice.update" | "invoice.payment.overdue" | "wallet.credit_balance.dropped" | "wallet.credit_balance.recovered" | "wallet.ongoing_balance.dropped" | "wallet.ongoing_balance.recovered" | "wallet.ongoing_balance.updated" | "subscription.spend.threshold_reached" | "subscription.spend.threshold_recovered" | "subscription.line_item_spend.threshold_reached" | "subscription.line_item_spend.threshold_recovered" | "subscription.group_spend.threshold_reached" | "subscription.group_spend.threshold_recovered" | "entitlement.grant.exhausted" | "subscription.renewal.due" | "invoice.communication.triggered" | "credit_note.created" | "credit_note.updated" | "checkout.session.initiated" | "checkout.session.completed" | "checkout.session.failed" | "checkout.session.expired" | "event.rejected" | Unrecognized<string>
 ```

package/docs/sdks/creditnotes/README.md

@@ -212,6 +212,7 @@ run();
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
 | `id`                                                                                                                                                                           | *string*                                                                                                                                                                       | :heavy_check_mark:                                                                                                                                                             | Credit note ID                                                                                                                                                                 |
+| `body`                                                                                                                                                                         | [models.FinalizeCreditNoteRequest](../../sdk/models/finalize-credit-note-request.md)                                                                                           | :heavy_minus_sign:                                                                                                                                                             | Finalize options                                                                                                                                                               |
 | `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
 | `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
 | `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |

package/docs/sdks/invoices/README.md

@@ -12,6 +12,7 @@
 * [updateInvoice](#updateinvoice) - Update invoice
 * [triggerInvoiceCommsWebhook](#triggerinvoicecommswebhook) - Trigger invoice communication webhook
 * [finalizeInvoice](#finalizeinvoice) - Finalize invoice
+* [executeInvoiceModify](#executeinvoicemodify) - Execute invoice modification
 * [updateInvoicePaymentStatus](#updateinvoicepaymentstatus) - Update invoice payment status
 * [attemptInvoicePayment](#attemptinvoicepayment) - Attempt invoice payment
 * [getInvoicePdf](#getinvoicepdf) - Get invoice PDF
@@ -607,6 +608,82 @@ run();
 | models.ErrorsErrorResponse | 500                        | application/json           |
 | models.SDKError            | 4XX, 5XX                   | \*/\*                      |
 
+## executeInvoiceModify
+
+Execute a modification on a draft or finalized invoice. Supports line item changes: add (bulk), update (one line item per call; the edit is versioned, so the line item id changes), and remove (bulk, soft delete). Totals are recalculated from the remaining line items; a manual edit marks the invoice as manually edited, which disables recompute. Modifying a FINALIZED invoice voids it and recreates it as a draft copy carrying all current data (description, billing period, due date, metadata, line items); the modification lands on the copy and the response returns the new draft — chain subsequent calls to the returned invoice id; a call that still targets the voided original is rejected with an error naming the replacement.
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="executeInvoiceModify" method="post" path="/invoices/{id}/modify/execute" -->
+```typescript
+import { Flexprice } from "@flexprice/sdk";
+
+const flexprice = new Flexprice({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const result = await flexprice.invoices.executeInvoiceModify("<id>", {
+    type: "line_item",
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { FlexpriceCore } from "@flexprice/sdk/core.js";
+import { invoicesExecuteInvoiceModify } from "@flexprice/sdk/funcs/invoices-execute-invoice-modify.js";
+
+// Use `FlexpriceCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const flexprice = new FlexpriceCore({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const res = await invoicesExecuteInvoiceModify(flexprice, "<id>", {
+    type: "line_item",
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("invoicesExecuteInvoiceModify failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `id`                                                                                                                                                                           | *string*                                                                                                                                                                       | :heavy_check_mark:                                                                                                                                                             | Invoice ID                                                                                                                                                                     |
+| `body`                                                                                                                                                                         | [models.ExecuteInvoiceModifyRequest](../../sdk/models/execute-invoice-modify-request.md)                                                                                       | :heavy_check_mark:                                                                                                                                                             | Modification request                                                                                                                                                           |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[models.InvoiceModifyResponse](../../sdk/models/invoice-modify-response.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| models.ErrorsErrorResponse | 400, 404                   | application/json           |
+| models.ErrorsErrorResponse | 500                        | application/json           |
+| models.SDKError            | 4XX, 5XX                   | \*/\*                      |
+
 ## updateInvoicePaymentStatus
 
 Use when reconciling payment status from an external gateway or manual entry (e.g. mark paid after bank confirmation).

package/docs/sdks/prices/README.md

@@ -243,7 +243,7 @@ run();
 
 | Error Type                 | Status Code                | Content Type               |
 | -------------------------- | -------------------------- | -------------------------- |
-| models.ErrorsErrorResponse | 400                        | application/json           |
+| models.ErrorsErrorResponse | 400, 404                   | application/json           |
 | models.ErrorsErrorResponse | 500                        | application/json           |
 | models.SDKError            | 4XX, 5XX                   | \*/\*                      |
 

package/docs/sdks/refunds/README.md

@@ -0,0 +1,222 @@
+# Refunds
+
+## Overview
+
+### Available Operations
+
+* [listRefunds](#listrefunds) - List refunds
+* [getRefund](#getrefund) - Get refund
+* [retryRefund](#retryrefund) - Retry refund
+
+## listRefunds
+
+Use to see where refunded money actually went and whether it has settled. Filter by invoice_ids to get every settlement row for one invoice.
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="listRefunds" method="get" path="/refunds" -->
+```typescript
+import { Flexprice } from "@flexprice/sdk";
+
+const flexprice = new Flexprice({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const result = await flexprice.refunds.listRefunds();
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { FlexpriceCore } from "@flexprice/sdk/core.js";
+import { refundsListRefunds } from "@flexprice/sdk/funcs/refunds-list-refunds.js";
+
+// Use `FlexpriceCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const flexprice = new FlexpriceCore({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const res = await refundsListRefunds(flexprice);
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("refundsListRefunds failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [models.ListRefundsRequest](../../sdk/models/list-refunds-request.md)                                                                                                          | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[models.ListRefundsResponse](../../sdk/models/list-refunds-response.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| models.ErrorsErrorResponse | 400, 401                   | application/json           |
+| models.ErrorsErrorResponse | 500                        | application/json           |
+| models.SDKError            | 4XX, 5XX                   | \*/\*                      |
+
+## getRefund
+
+Use to inspect a single refund: its destination, settled amount and failure reason.
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="getRefund" method="get" path="/refunds/{id}" -->
+```typescript
+import { Flexprice } from "@flexprice/sdk";
+
+const flexprice = new Flexprice({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const result = await flexprice.refunds.getRefund("<id>");
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { FlexpriceCore } from "@flexprice/sdk/core.js";
+import { refundsGetRefund } from "@flexprice/sdk/funcs/refunds-get-refund.js";
+
+// Use `FlexpriceCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const flexprice = new FlexpriceCore({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const res = await refundsGetRefund(flexprice, "<id>");
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("refundsGetRefund failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `id`                                                                                                                                                                           | *string*                                                                                                                                                                       | :heavy_check_mark:                                                                                                                                                             | Refund ID                                                                                                                                                                      |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[models.RefundResponse](../../sdk/models/refund-response.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| models.ErrorsErrorResponse | 400, 404                   | application/json           |
+| models.ErrorsErrorResponse | 500                        | application/json           |
+| models.SDKError            | 4XX, 5XX                   | \*/\*                      |
+
+## retryRefund
+
+Use when a refund failed or is stuck pending. A failed gateway refund is retried into the customer's wallet; an already-settled refund is rejected.
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="retryRefund" method="post" path="/refunds/{id}/retry" -->
+```typescript
+import { Flexprice } from "@flexprice/sdk";
+
+const flexprice = new Flexprice({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const result = await flexprice.refunds.retryRefund("<id>");
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { FlexpriceCore } from "@flexprice/sdk/core.js";
+import { refundsRetryRefund } from "@flexprice/sdk/funcs/refunds-retry-refund.js";
+
+// Use `FlexpriceCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const flexprice = new FlexpriceCore({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const res = await refundsRetryRefund(flexprice, "<id>");
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("refundsRetryRefund failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `id`                                                                                                                                                                           | *string*                                                                                                                                                                       | :heavy_check_mark:                                                                                                                                                             | Refund ID                                                                                                                                                                      |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[models.RefundResponse](../../sdk/models/refund-response.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| models.ErrorsErrorResponse | 400, 401, 404              | application/json           |
+| models.ErrorsErrorResponse | 500                        | application/json           |
+| models.SDKError            | 4XX, 5XX                   | \*/\*                      |