# WebhookEvents ## Overview ### Available Operations * [postWebhookEventsCheckoutSessionCompleted](#postwebhookeventscheckoutsessioncompleted) - checkout.session.completed * [postWebhookEventsCheckoutSessionExpired](#postwebhookeventscheckoutsessionexpired) - checkout.session.expired * [postWebhookEventsCheckoutSessionFailed](#postwebhookeventscheckoutsessionfailed) - checkout.session.failed * [postWebhookEventsCheckoutSessionInitiated](#postwebhookeventscheckoutsessioninitiated) - checkout.session.initiated * [postWebhookEventsCreditNoteCreated](#postwebhookeventscreditnotecreated) - credit_note.created * [postWebhookEventsCreditNoteUpdated](#postwebhookeventscreditnoteupdated) - credit_note.updated * [postWebhookEventsCustomerCreated](#postwebhookeventscustomercreated) - customer.created * [postWebhookEventsCustomerDeleted](#postwebhookeventscustomerdeleted) - customer.deleted * [postWebhookEventsCustomerUpdated](#postwebhookeventscustomerupdated) - customer.updated * [postWebhookEventsEntitlementCreated](#postwebhookeventsentitlementcreated) - entitlement.created * [postWebhookEventsEntitlementDeleted](#postwebhookeventsentitlementdeleted) - entitlement.deleted * [postWebhookEventsEntitlementUpdated](#postwebhookeventsentitlementupdated) - entitlement.updated * [postWebhookEventsEventRejected](#postwebhookeventseventrejected) - event.rejected * [postWebhookEventsFeatureCreated](#postwebhookeventsfeaturecreated) - feature.created * [postWebhookEventsFeatureDeleted](#postwebhookeventsfeaturedeleted) - feature.deleted * [postWebhookEventsFeatureUpdated](#postwebhookeventsfeatureupdated) - feature.updated * [postWebhookEventsFeatureWalletBalanceAlert](#postwebhookeventsfeaturewalletbalancealert) - feature.wallet_balance.alert * [postWebhookEventsInvoiceCommunicationTriggered](#postwebhookeventsinvoicecommunicationtriggered) - invoice.communication.triggered * [postWebhookEventsInvoiceCreateDrafted](#postwebhookeventsinvoicecreatedrafted) - invoice.create.drafted * [postWebhookEventsInvoicePaymentOverdue](#postwebhookeventsinvoicepaymentoverdue) - invoice.payment.overdue * [postWebhookEventsInvoiceUpdate](#postwebhookeventsinvoiceupdate) - invoice.update * [postWebhookEventsInvoiceUpdateFinalized](#postwebhookeventsinvoiceupdatefinalized) - invoice.update.finalized * [postWebhookEventsInvoiceUpdatePayment](#postwebhookeventsinvoiceupdatepayment) - invoice.update.payment * [postWebhookEventsInvoiceUpdateVoided](#postwebhookeventsinvoiceupdatevoided) - invoice.update.voided * [postWebhookEventsPaymentCreated](#postwebhookeventspaymentcreated) - payment.created * [postWebhookEventsPaymentFailed](#postwebhookeventspaymentfailed) - payment.failed * [postWebhookEventsPaymentPending](#postwebhookeventspaymentpending) - payment.pending * [postWebhookEventsPaymentSuccess](#postwebhookeventspaymentsuccess) - payment.success * [postWebhookEventsPaymentUpdated](#postwebhookeventspaymentupdated) - payment.updated * [postWebhookEventsSubscriptionActivated](#postwebhookeventssubscriptionactivated) - subscription.activated * [postWebhookEventsSubscriptionCancelled](#postwebhookeventssubscriptioncancelled) - subscription.cancelled * [postWebhookEventsSubscriptionCreated](#postwebhookeventssubscriptioncreated) - subscription.created * [postWebhookEventsSubscriptionDraftCreated](#postwebhookeventssubscriptiondraftcreated) - subscription.draft.created * [postWebhookEventsSubscriptionGroupSpendThresholdReached](#postwebhookeventssubscriptiongroupspendthresholdreached) - subscription.group_spend.threshold_reached * [postWebhookEventsSubscriptionGroupSpendThresholdRecovered](#postwebhookeventssubscriptiongroupspendthresholdrecovered) - subscription.group_spend.threshold_recovered * [postWebhookEventsSubscriptionLineItemSpendThresholdReached](#postwebhookeventssubscriptionlineitemspendthresholdreached) - subscription.line_item_spend.threshold_reached * [postWebhookEventsSubscriptionLineItemSpendThresholdRecovered](#postwebhookeventssubscriptionlineitemspendthresholdrecovered) - subscription.line_item_spend.threshold_recovered * [postWebhookEventsSubscriptionPaused](#postwebhookeventssubscriptionpaused) - subscription.paused * [postWebhookEventsSubscriptionPhaseCreated](#postwebhookeventssubscriptionphasecreated) - subscription.phase.created * [postWebhookEventsSubscriptionPhaseDeleted](#postwebhookeventssubscriptionphasedeleted) - subscription.phase.deleted * [postWebhookEventsSubscriptionPhaseUpdated](#postwebhookeventssubscriptionphaseupdated) - subscription.phase.updated * [postWebhookEventsSubscriptionPlanChanged](#postwebhookeventssubscriptionplanchanged) - subscription.plan_changed * [postWebhookEventsSubscriptionRenewalDue](#postwebhookeventssubscriptionrenewaldue) - subscription.renewal.due * [postWebhookEventsSubscriptionResumed](#postwebhookeventssubscriptionresumed) - subscription.resumed * [postWebhookEventsSubscriptionSpendThresholdReached](#postwebhookeventssubscriptionspendthresholdreached) - subscription.spend.threshold_reached * [postWebhookEventsSubscriptionSpendThresholdRecovered](#postwebhookeventssubscriptionspendthresholdrecovered) - subscription.spend.threshold_recovered * [postWebhookEventsSubscriptionUpdated](#postwebhookeventssubscriptionupdated) - subscription.updated * [postWebhookEventsWalletCreated](#postwebhookeventswalletcreated) - wallet.created * [postWebhookEventsWalletCreditBalanceDropped](#postwebhookeventswalletcreditbalancedropped) - wallet.credit_balance.dropped * [postWebhookEventsWalletCreditBalanceRecovered](#postwebhookeventswalletcreditbalancerecovered) - wallet.credit_balance.recovered * [postWebhookEventsWalletOngoingBalanceDropped](#postwebhookeventswalletongoingbalancedropped) - wallet.ongoing_balance.dropped * [postWebhookEventsWalletOngoingBalanceRecovered](#postwebhookeventswalletongoingbalancerecovered) - wallet.ongoing_balance.recovered * [postWebhookEventsWalletOngoingBalanceUpdated](#postwebhookeventswalletongoingbalanceupdated) - wallet.ongoing_balance.updated * [postWebhookEventsWalletTerminated](#postwebhookeventswalletterminated) - wallet.terminated * [postWebhookEventsWalletTransactionCreated](#postwebhookeventswallettransactioncreated) - wallet.transaction.created * [postWebhookEventsWalletTransactionUpdated](#postwebhookeventswallettransactionupdated) - wallet.transaction.updated * [postWebhookEventsWalletUpdated](#postwebhookeventswalletupdated) - wallet.updated ## postWebhookEventsCheckoutSessionCompleted Fired when payment is confirmed; the subscription is now active and the invoice is finalized. Doc-only for parsing. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.webhookEvents.postWebhookEventsCheckoutSessionCompleted(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { webhookEventsPostWebhookEventsCheckoutSessionCompleted } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-checkout-session-completed.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: "", }); async function run() { const res = await webhookEventsPostWebhookEventsCheckoutSessionCompleted(flexprice); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("webhookEventsPostWebhookEventsCheckoutSessionCompleted failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `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.WebhookDtoCheckoutSessionWebhookPayload](../../sdk/models/webhook-dto-checkout-session-webhook-payload.md)\>** ### Errors | Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | | models.SDKError | 4XX, 5XX | \*/\* | ## postWebhookEventsCheckoutSessionExpired Fired when a Checkout Session times out without payment; draft records are cleaned up. Doc-only for parsing. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.webhookEvents.postWebhookEventsCheckoutSessionExpired(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { webhookEventsPostWebhookEventsCheckoutSessionExpired } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-checkout-session-expired.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: "", }); async function run() { const res = await webhookEventsPostWebhookEventsCheckoutSessionExpired(flexprice); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("webhookEventsPostWebhookEventsCheckoutSessionExpired failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `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.WebhookDtoCheckoutSessionWebhookPayload](../../sdk/models/webhook-dto-checkout-session-webhook-payload.md)\>** ### Errors | Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | | models.SDKError | 4XX, 5XX | \*/\* | ## postWebhookEventsCheckoutSessionFailed Fired when payment fails or the provider cancels the payment link. Doc-only for parsing. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.webhookEvents.postWebhookEventsCheckoutSessionFailed(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { webhookEventsPostWebhookEventsCheckoutSessionFailed } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-checkout-session-failed.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: "", }); async function run() { const res = await webhookEventsPostWebhookEventsCheckoutSessionFailed(flexprice); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("webhookEventsPostWebhookEventsCheckoutSessionFailed failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `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.WebhookDtoCheckoutSessionWebhookPayload](../../sdk/models/webhook-dto-checkout-session-webhook-payload.md)\>** ### Errors | Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | | models.SDKError | 4XX, 5XX | \*/\* | ## postWebhookEventsCheckoutSessionInitiated Fired when a Checkout Session is created and a payment URL is returned to the customer. Doc-only for parsing. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.webhookEvents.postWebhookEventsCheckoutSessionInitiated(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { webhookEventsPostWebhookEventsCheckoutSessionInitiated } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-checkout-session-initiated.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: "", }); async function run() { const res = await webhookEventsPostWebhookEventsCheckoutSessionInitiated(flexprice); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("webhookEventsPostWebhookEventsCheckoutSessionInitiated failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `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.WebhookDtoCheckoutSessionWebhookPayload](../../sdk/models/webhook-dto-checkout-session-webhook-payload.md)\>** ### Errors | Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | | models.SDKError | 4XX, 5XX | \*/\* | ## postWebhookEventsCreditNoteCreated Fired when a new credit note is created. Doc-only for parsing. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.webhookEvents.postWebhookEventsCreditNoteCreated(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { webhookEventsPostWebhookEventsCreditNoteCreated } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-credit-note-created.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: "", }); async function run() { const res = await webhookEventsPostWebhookEventsCreditNoteCreated(flexprice); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("webhookEventsPostWebhookEventsCreditNoteCreated failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `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.WebhookDtoCreditNoteWebhookPayload](../../sdk/models/webhook-dto-credit-note-webhook-payload.md)\>** ### Errors | Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | | models.SDKError | 4XX, 5XX | \*/\* | ## postWebhookEventsCreditNoteUpdated Fired when a credit note is updated. Doc-only for parsing. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.webhookEvents.postWebhookEventsCreditNoteUpdated(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { webhookEventsPostWebhookEventsCreditNoteUpdated } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-credit-note-updated.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: "", }); async function run() { const res = await webhookEventsPostWebhookEventsCreditNoteUpdated(flexprice); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("webhookEventsPostWebhookEventsCreditNoteUpdated failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `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.WebhookDtoCreditNoteWebhookPayload](../../sdk/models/webhook-dto-credit-note-webhook-payload.md)\>** ### Errors | Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | | models.SDKError | 4XX, 5XX | \*/\* | ## postWebhookEventsCustomerCreated Fired when a new customer is created. Doc-only for parsing. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.webhookEvents.postWebhookEventsCustomerCreated(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { webhookEventsPostWebhookEventsCustomerCreated } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-customer-created.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: "", }); async function run() { const res = await webhookEventsPostWebhookEventsCustomerCreated(flexprice); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("webhookEventsPostWebhookEventsCustomerCreated failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `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.WebhookDtoCustomerWebhookPayload](../../sdk/models/webhook-dto-customer-webhook-payload.md)\>** ### Errors | Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | | models.SDKError | 4XX, 5XX | \*/\* | ## postWebhookEventsCustomerDeleted Fired when a customer is deleted. Doc-only for parsing. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.webhookEvents.postWebhookEventsCustomerDeleted(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { webhookEventsPostWebhookEventsCustomerDeleted } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-customer-deleted.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: "", }); async function run() { const res = await webhookEventsPostWebhookEventsCustomerDeleted(flexprice); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("webhookEventsPostWebhookEventsCustomerDeleted failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `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.WebhookDtoCustomerWebhookPayload](../../sdk/models/webhook-dto-customer-webhook-payload.md)\>** ### Errors | Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | | models.SDKError | 4XX, 5XX | \*/\* | ## postWebhookEventsCustomerUpdated Fired when a customer is updated. Doc-only for parsing. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.webhookEvents.postWebhookEventsCustomerUpdated(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { webhookEventsPostWebhookEventsCustomerUpdated } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-customer-updated.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: "", }); async function run() { const res = await webhookEventsPostWebhookEventsCustomerUpdated(flexprice); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("webhookEventsPostWebhookEventsCustomerUpdated failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `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.WebhookDtoCustomerWebhookPayload](../../sdk/models/webhook-dto-customer-webhook-payload.md)\>** ### Errors | Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | | models.SDKError | 4XX, 5XX | \*/\* | ## postWebhookEventsEntitlementCreated Fired when a new entitlement is created. Doc-only for parsing. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.webhookEvents.postWebhookEventsEntitlementCreated(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { webhookEventsPostWebhookEventsEntitlementCreated } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-entitlement-created.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: "", }); async function run() { const res = await webhookEventsPostWebhookEventsEntitlementCreated(flexprice); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("webhookEventsPostWebhookEventsEntitlementCreated failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `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.WebhookDtoEntitlementWebhookPayload](../../sdk/models/webhook-dto-entitlement-webhook-payload.md)\>** ### Errors | Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | | models.SDKError | 4XX, 5XX | \*/\* | ## postWebhookEventsEntitlementDeleted Fired when an entitlement is deleted. Doc-only for parsing. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.webhookEvents.postWebhookEventsEntitlementDeleted(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { webhookEventsPostWebhookEventsEntitlementDeleted } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-entitlement-deleted.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: "", }); async function run() { const res = await webhookEventsPostWebhookEventsEntitlementDeleted(flexprice); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("webhookEventsPostWebhookEventsEntitlementDeleted failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `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.WebhookDtoEntitlementWebhookPayload](../../sdk/models/webhook-dto-entitlement-webhook-payload.md)\>** ### Errors | Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | | models.SDKError | 4XX, 5XX | \*/\* | ## postWebhookEventsEntitlementUpdated Fired when an entitlement is updated. Doc-only for parsing. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.webhookEvents.postWebhookEventsEntitlementUpdated(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { webhookEventsPostWebhookEventsEntitlementUpdated } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-entitlement-updated.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: "", }); async function run() { const res = await webhookEventsPostWebhookEventsEntitlementUpdated(flexprice); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("webhookEventsPostWebhookEventsEntitlementUpdated failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `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.WebhookDtoEntitlementWebhookPayload](../../sdk/models/webhook-dto-entitlement-webhook-payload.md)\>** ### Errors | Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | | models.SDKError | 4XX, 5XX | \*/\* | ## postWebhookEventsEventRejected Fired when an ingested usage event produces no meter usage — either no meter is registered for its event name, or meters exist for the name but the event matched none of their filters. Throttled to at most once per configured window per event name. Doc-only for parsing. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.webhookEvents.postWebhookEventsEventRejected(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { webhookEventsPostWebhookEventsEventRejected } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-event-rejected.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: "", }); async function run() { const res = await webhookEventsPostWebhookEventsEventRejected(flexprice); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("webhookEventsPostWebhookEventsEventRejected failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `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.WebhookDtoRejectedEventWebhookPayload](../../sdk/models/webhook-dto-rejected-event-webhook-payload.md)\>** ### Errors | Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | | models.SDKError | 4XX, 5XX | \*/\* | ## postWebhookEventsFeatureCreated Fired when a new feature is created. Doc-only for parsing. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.webhookEvents.postWebhookEventsFeatureCreated(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { webhookEventsPostWebhookEventsFeatureCreated } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-feature-created.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: "", }); async function run() { const res = await webhookEventsPostWebhookEventsFeatureCreated(flexprice); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("webhookEventsPostWebhookEventsFeatureCreated failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `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.WebhookDtoFeatureWebhookPayload](../../sdk/models/webhook-dto-feature-webhook-payload.md)\>** ### Errors | Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | | models.SDKError | 4XX, 5XX | \*/\* | ## postWebhookEventsFeatureDeleted Fired when a feature is deleted. Doc-only for parsing. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.webhookEvents.postWebhookEventsFeatureDeleted(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { webhookEventsPostWebhookEventsFeatureDeleted } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-feature-deleted.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: "", }); async function run() { const res = await webhookEventsPostWebhookEventsFeatureDeleted(flexprice); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("webhookEventsPostWebhookEventsFeatureDeleted failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `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.WebhookDtoFeatureWebhookPayload](../../sdk/models/webhook-dto-feature-webhook-payload.md)\>** ### Errors | Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | | models.SDKError | 4XX, 5XX | \*/\* | ## postWebhookEventsFeatureUpdated Fired when a feature is updated. Doc-only for parsing. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.webhookEvents.postWebhookEventsFeatureUpdated(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { webhookEventsPostWebhookEventsFeatureUpdated } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-feature-updated.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: "", }); async function run() { const res = await webhookEventsPostWebhookEventsFeatureUpdated(flexprice); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("webhookEventsPostWebhookEventsFeatureUpdated failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `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.WebhookDtoFeatureWebhookPayload](../../sdk/models/webhook-dto-feature-webhook-payload.md)\>** ### Errors | Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | | models.SDKError | 4XX, 5XX | \*/\* | ## postWebhookEventsFeatureWalletBalanceAlert Fired when a feature's associated wallet balance crosses an alert threshold. Doc-only for parsing. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.webhookEvents.postWebhookEventsFeatureWalletBalanceAlert(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { webhookEventsPostWebhookEventsFeatureWalletBalanceAlert } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-feature-wallet-balance-alert.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: "", }); async function run() { const res = await webhookEventsPostWebhookEventsFeatureWalletBalanceAlert(flexprice); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("webhookEventsPostWebhookEventsFeatureWalletBalanceAlert failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `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.WebhookDtoAlertWebhookPayload](../../sdk/models/webhook-dto-alert-webhook-payload.md)\>** ### Errors | Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | | models.SDKError | 4XX, 5XX | \*/\* | ## postWebhookEventsInvoiceCommunicationTriggered Fired when an invoice communication (e.g. email notification) is triggered. Doc-only for parsing. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.webhookEvents.postWebhookEventsInvoiceCommunicationTriggered(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { webhookEventsPostWebhookEventsInvoiceCommunicationTriggered } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-invoice-communication-triggered.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: "", }); async function run() { const res = await webhookEventsPostWebhookEventsInvoiceCommunicationTriggered(flexprice); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("webhookEventsPostWebhookEventsInvoiceCommunicationTriggered failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `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.WebhookDtoCommunicationWebhookPayload](../../sdk/models/webhook-dto-communication-webhook-payload.md)\>** ### Errors | Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | | models.SDKError | 4XX, 5XX | \*/\* | ## postWebhookEventsInvoiceCreateDrafted Fired when a new invoice is created in draft state. Doc-only for parsing. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.webhookEvents.postWebhookEventsInvoiceCreateDrafted(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { webhookEventsPostWebhookEventsInvoiceCreateDrafted } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-invoice-create-drafted.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: "", }); async function run() { const res = await webhookEventsPostWebhookEventsInvoiceCreateDrafted(flexprice); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("webhookEventsPostWebhookEventsInvoiceCreateDrafted failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `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.WebhookDtoInvoiceWebhookPayload](../../sdk/models/webhook-dto-invoice-webhook-payload.md)\>** ### Errors | Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | | models.SDKError | 4XX, 5XX | \*/\* | ## postWebhookEventsInvoicePaymentOverdue Fired when an invoice payment is overdue past the due date. Doc-only for parsing. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.webhookEvents.postWebhookEventsInvoicePaymentOverdue(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { webhookEventsPostWebhookEventsInvoicePaymentOverdue } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-invoice-payment-overdue.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: "", }); async function run() { const res = await webhookEventsPostWebhookEventsInvoicePaymentOverdue(flexprice); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("webhookEventsPostWebhookEventsInvoicePaymentOverdue failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `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.WebhookDtoInvoiceWebhookPayload](../../sdk/models/webhook-dto-invoice-webhook-payload.md)\>** ### Errors | Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | | models.SDKError | 4XX, 5XX | \*/\* | ## postWebhookEventsInvoiceUpdate Fired when an invoice is updated. Doc-only for parsing. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.webhookEvents.postWebhookEventsInvoiceUpdate(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { webhookEventsPostWebhookEventsInvoiceUpdate } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-invoice-update.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: "", }); async function run() { const res = await webhookEventsPostWebhookEventsInvoiceUpdate(flexprice); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("webhookEventsPostWebhookEventsInvoiceUpdate failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `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.WebhookDtoInvoiceWebhookPayload](../../sdk/models/webhook-dto-invoice-webhook-payload.md)\>** ### Errors | Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | | models.SDKError | 4XX, 5XX | \*/\* | ## postWebhookEventsInvoiceUpdateFinalized Fired when an invoice is finalized and locked for payment. Doc-only for parsing. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.webhookEvents.postWebhookEventsInvoiceUpdateFinalized(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { webhookEventsPostWebhookEventsInvoiceUpdateFinalized } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-invoice-update-finalized.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: "", }); async function run() { const res = await webhookEventsPostWebhookEventsInvoiceUpdateFinalized(flexprice); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("webhookEventsPostWebhookEventsInvoiceUpdateFinalized failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `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.WebhookDtoInvoiceWebhookPayload](../../sdk/models/webhook-dto-invoice-webhook-payload.md)\>** ### Errors | Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | | models.SDKError | 4XX, 5XX | \*/\* | ## postWebhookEventsInvoiceUpdatePayment Fired when an invoice payment status changes. Doc-only for parsing. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.webhookEvents.postWebhookEventsInvoiceUpdatePayment(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { webhookEventsPostWebhookEventsInvoiceUpdatePayment } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-invoice-update-payment.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: "", }); async function run() { const res = await webhookEventsPostWebhookEventsInvoiceUpdatePayment(flexprice); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("webhookEventsPostWebhookEventsInvoiceUpdatePayment failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `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.WebhookDtoInvoiceWebhookPayload](../../sdk/models/webhook-dto-invoice-webhook-payload.md)\>** ### Errors | Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | | models.SDKError | 4XX, 5XX | \*/\* | ## postWebhookEventsInvoiceUpdateVoided Fired when an invoice is voided (e.g. order cancelled or duplicate). Doc-only for parsing. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.webhookEvents.postWebhookEventsInvoiceUpdateVoided(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { webhookEventsPostWebhookEventsInvoiceUpdateVoided } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-invoice-update-voided.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: "", }); async function run() { const res = await webhookEventsPostWebhookEventsInvoiceUpdateVoided(flexprice); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("webhookEventsPostWebhookEventsInvoiceUpdateVoided failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `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.WebhookDtoInvoiceWebhookPayload](../../sdk/models/webhook-dto-invoice-webhook-payload.md)\>** ### Errors | Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | | models.SDKError | 4XX, 5XX | \*/\* | ## postWebhookEventsPaymentCreated Fired when a new payment is created. Doc-only for parsing. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.webhookEvents.postWebhookEventsPaymentCreated(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { webhookEventsPostWebhookEventsPaymentCreated } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-payment-created.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: "", }); async function run() { const res = await webhookEventsPostWebhookEventsPaymentCreated(flexprice); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("webhookEventsPostWebhookEventsPaymentCreated failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `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.WebhookDtoPaymentWebhookPayload](../../sdk/models/webhook-dto-payment-webhook-payload.md)\>** ### Errors | Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | | models.SDKError | 4XX, 5XX | \*/\* | ## postWebhookEventsPaymentFailed Fired when a payment fails. Doc-only for parsing. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.webhookEvents.postWebhookEventsPaymentFailed(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { webhookEventsPostWebhookEventsPaymentFailed } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-payment-failed.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: "", }); async function run() { const res = await webhookEventsPostWebhookEventsPaymentFailed(flexprice); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("webhookEventsPostWebhookEventsPaymentFailed failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `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.WebhookDtoPaymentWebhookPayload](../../sdk/models/webhook-dto-payment-webhook-payload.md)\>** ### Errors | Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | | models.SDKError | 4XX, 5XX | \*/\* | ## postWebhookEventsPaymentPending Fired when a payment is pending processing. Doc-only for parsing. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.webhookEvents.postWebhookEventsPaymentPending(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { webhookEventsPostWebhookEventsPaymentPending } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-payment-pending.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: "", }); async function run() { const res = await webhookEventsPostWebhookEventsPaymentPending(flexprice); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("webhookEventsPostWebhookEventsPaymentPending failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `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.WebhookDtoPaymentWebhookPayload](../../sdk/models/webhook-dto-payment-webhook-payload.md)\>** ### Errors | Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | | models.SDKError | 4XX, 5XX | \*/\* | ## postWebhookEventsPaymentSuccess Fired when a payment succeeds. Doc-only for parsing. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.webhookEvents.postWebhookEventsPaymentSuccess(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { webhookEventsPostWebhookEventsPaymentSuccess } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-payment-success.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: "", }); async function run() { const res = await webhookEventsPostWebhookEventsPaymentSuccess(flexprice); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("webhookEventsPostWebhookEventsPaymentSuccess failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `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.WebhookDtoPaymentWebhookPayload](../../sdk/models/webhook-dto-payment-webhook-payload.md)\>** ### Errors | Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | | models.SDKError | 4XX, 5XX | \*/\* | ## postWebhookEventsPaymentUpdated Fired when a payment is updated. Doc-only for parsing. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.webhookEvents.postWebhookEventsPaymentUpdated(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { webhookEventsPostWebhookEventsPaymentUpdated } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-payment-updated.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: "", }); async function run() { const res = await webhookEventsPostWebhookEventsPaymentUpdated(flexprice); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("webhookEventsPostWebhookEventsPaymentUpdated failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `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.WebhookDtoPaymentWebhookPayload](../../sdk/models/webhook-dto-payment-webhook-payload.md)\>** ### Errors | Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | | models.SDKError | 4XX, 5XX | \*/\* | ## postWebhookEventsSubscriptionActivated Fired when a draft subscription is activated. Doc-only for parsing. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.webhookEvents.postWebhookEventsSubscriptionActivated(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { webhookEventsPostWebhookEventsSubscriptionActivated } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-subscription-activated.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: "", }); async function run() { const res = await webhookEventsPostWebhookEventsSubscriptionActivated(flexprice); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("webhookEventsPostWebhookEventsSubscriptionActivated failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `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.WebhookDtoSubscriptionWebhookPayload](../../sdk/models/webhook-dto-subscription-webhook-payload.md)\>** ### Errors | Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | | models.SDKError | 4XX, 5XX | \*/\* | ## postWebhookEventsSubscriptionCancelled Fired when a subscription is cancelled (immediately or end-of-period). Doc-only for parsing. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.webhookEvents.postWebhookEventsSubscriptionCancelled(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { webhookEventsPostWebhookEventsSubscriptionCancelled } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-subscription-cancelled.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: "", }); async function run() { const res = await webhookEventsPostWebhookEventsSubscriptionCancelled(flexprice); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("webhookEventsPostWebhookEventsSubscriptionCancelled failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `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.WebhookDtoSubscriptionWebhookPayload](../../sdk/models/webhook-dto-subscription-webhook-payload.md)\>** ### Errors | Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | | models.SDKError | 4XX, 5XX | \*/\* | ## postWebhookEventsSubscriptionCreated Fired when a new subscription is created. Doc-only for parsing. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.webhookEvents.postWebhookEventsSubscriptionCreated(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { webhookEventsPostWebhookEventsSubscriptionCreated } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-subscription-created.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: "", }); async function run() { const res = await webhookEventsPostWebhookEventsSubscriptionCreated(flexprice); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("webhookEventsPostWebhookEventsSubscriptionCreated failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `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.WebhookDtoSubscriptionWebhookPayload](../../sdk/models/webhook-dto-subscription-webhook-payload.md)\>** ### Errors | Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | | models.SDKError | 4XX, 5XX | \*/\* | ## postWebhookEventsSubscriptionDraftCreated Fired when a new draft subscription is created (not yet activated). Doc-only for parsing. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.webhookEvents.postWebhookEventsSubscriptionDraftCreated(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { webhookEventsPostWebhookEventsSubscriptionDraftCreated } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-subscription-draft-created.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: "", }); async function run() { const res = await webhookEventsPostWebhookEventsSubscriptionDraftCreated(flexprice); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("webhookEventsPostWebhookEventsSubscriptionDraftCreated failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `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.WebhookDtoSubscriptionWebhookPayload](../../sdk/models/webhook-dto-subscription-webhook-payload.md)\>** ### Errors | Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | | models.SDKError | 4XX, 5XX | \*/\* | ## postWebhookEventsSubscriptionGroupSpendThresholdReached Fired when a feature group's total metered spend on a subscription crosses an alert threshold (critical, warning, or info) for the current billing period. Doc-only for parsing. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.webhookEvents.postWebhookEventsSubscriptionGroupSpendThresholdReached(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { webhookEventsPostWebhookEventsSubscriptionGroupSpendThresholdReached } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-subscription-group-spend-threshold-reached.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: "", }); async function run() { const res = await webhookEventsPostWebhookEventsSubscriptionGroupSpendThresholdReached(flexprice); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("webhookEventsPostWebhookEventsSubscriptionGroupSpendThresholdReached failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `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.WebhookDtoSpendAlertEvent](../../sdk/models/webhook-dto-spend-alert-event.md)\>** ### Errors | Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | | models.SDKError | 4XX, 5XX | \*/\* | ## postWebhookEventsSubscriptionGroupSpendThresholdRecovered Fired when a feature group's total metered spend on a subscription falls back below all configured alert thresholds for the current billing period. Doc-only for parsing. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.webhookEvents.postWebhookEventsSubscriptionGroupSpendThresholdRecovered(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { webhookEventsPostWebhookEventsSubscriptionGroupSpendThresholdRecovered } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-subscription-group-spend-threshold-recovered.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: "", }); async function run() { const res = await webhookEventsPostWebhookEventsSubscriptionGroupSpendThresholdRecovered(flexprice); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("webhookEventsPostWebhookEventsSubscriptionGroupSpendThresholdRecovered failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `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.WebhookDtoSpendAlertEvent](../../sdk/models/webhook-dto-spend-alert-event.md)\>** ### Errors | Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | | models.SDKError | 4XX, 5XX | \*/\* | ## postWebhookEventsSubscriptionLineItemSpendThresholdReached Fired when a subscription line item's metered spend crosses an alert threshold (critical, warning, or info) for the current billing period. Doc-only for parsing. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.webhookEvents.postWebhookEventsSubscriptionLineItemSpendThresholdReached(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { webhookEventsPostWebhookEventsSubscriptionLineItemSpendThresholdReached } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-subscription-line-item-spend-threshold-reached.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: "", }); async function run() { const res = await webhookEventsPostWebhookEventsSubscriptionLineItemSpendThresholdReached(flexprice); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("webhookEventsPostWebhookEventsSubscriptionLineItemSpendThresholdReached failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `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.WebhookDtoSpendAlertEvent](../../sdk/models/webhook-dto-spend-alert-event.md)\>** ### Errors | Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | | models.SDKError | 4XX, 5XX | \*/\* | ## postWebhookEventsSubscriptionLineItemSpendThresholdRecovered Fired when a subscription line item's metered spend falls back below all configured alert thresholds for the current billing period. Doc-only for parsing. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.webhookEvents.postWebhookEventsSubscriptionLineItemSpendThresholdRecovered(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { webhookEventsPostWebhookEventsSubscriptionLineItemSpendThresholdRecovered } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-subscription-line-item-spend-threshold-recovered.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: "", }); async function run() { const res = await webhookEventsPostWebhookEventsSubscriptionLineItemSpendThresholdRecovered(flexprice); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("webhookEventsPostWebhookEventsSubscriptionLineItemSpendThresholdRecovered failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `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.WebhookDtoSpendAlertEvent](../../sdk/models/webhook-dto-spend-alert-event.md)\>** ### Errors | Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | | models.SDKError | 4XX, 5XX | \*/\* | ## postWebhookEventsSubscriptionPaused Fired when a subscription is paused. Doc-only for parsing. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.webhookEvents.postWebhookEventsSubscriptionPaused(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { webhookEventsPostWebhookEventsSubscriptionPaused } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-subscription-paused.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: "", }); async function run() { const res = await webhookEventsPostWebhookEventsSubscriptionPaused(flexprice); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("webhookEventsPostWebhookEventsSubscriptionPaused failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `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.WebhookDtoSubscriptionWebhookPayload](../../sdk/models/webhook-dto-subscription-webhook-payload.md)\>** ### Errors | Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | | models.SDKError | 4XX, 5XX | \*/\* | ## postWebhookEventsSubscriptionPhaseCreated Fired when a new subscription phase is created. Doc-only for parsing. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.webhookEvents.postWebhookEventsSubscriptionPhaseCreated(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { webhookEventsPostWebhookEventsSubscriptionPhaseCreated } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-subscription-phase-created.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: "", }); async function run() { const res = await webhookEventsPostWebhookEventsSubscriptionPhaseCreated(flexprice); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("webhookEventsPostWebhookEventsSubscriptionPhaseCreated failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `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.WebhookDtoSubscriptionPhaseWebhookPayload](../../sdk/models/webhook-dto-subscription-phase-webhook-payload.md)\>** ### Errors | Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | | models.SDKError | 4XX, 5XX | \*/\* | ## postWebhookEventsSubscriptionPhaseDeleted Fired when a subscription phase is deleted. Doc-only for parsing. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.webhookEvents.postWebhookEventsSubscriptionPhaseDeleted(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { webhookEventsPostWebhookEventsSubscriptionPhaseDeleted } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-subscription-phase-deleted.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: "", }); async function run() { const res = await webhookEventsPostWebhookEventsSubscriptionPhaseDeleted(flexprice); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("webhookEventsPostWebhookEventsSubscriptionPhaseDeleted failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `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.WebhookDtoSubscriptionPhaseWebhookPayload](../../sdk/models/webhook-dto-subscription-phase-webhook-payload.md)\>** ### Errors | Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | | models.SDKError | 4XX, 5XX | \*/\* | ## postWebhookEventsSubscriptionPhaseUpdated Fired when a subscription phase is updated. Doc-only for parsing. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.webhookEvents.postWebhookEventsSubscriptionPhaseUpdated(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { webhookEventsPostWebhookEventsSubscriptionPhaseUpdated } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-subscription-phase-updated.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: "", }); async function run() { const res = await webhookEventsPostWebhookEventsSubscriptionPhaseUpdated(flexprice); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("webhookEventsPostWebhookEventsSubscriptionPhaseUpdated failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `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.WebhookDtoSubscriptionPhaseWebhookPayload](../../sdk/models/webhook-dto-subscription-phase-webhook-payload.md)\>** ### Errors | Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | | models.SDKError | 4XX, 5XX | \*/\* | ## postWebhookEventsSubscriptionPlanChanged Fired when a subscription plan changes in place (id/anchor preserved; not cancelled+created). Doc-only for parsing. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.webhookEvents.postWebhookEventsSubscriptionPlanChanged(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { webhookEventsPostWebhookEventsSubscriptionPlanChanged } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-subscription-plan-changed.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: "", }); async function run() { const res = await webhookEventsPostWebhookEventsSubscriptionPlanChanged(flexprice); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("webhookEventsPostWebhookEventsSubscriptionPlanChanged failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `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.WebhookDtoSubscriptionWebhookPayload](../../sdk/models/webhook-dto-subscription-webhook-payload.md)\>** ### Errors | Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | | models.SDKError | 4XX, 5XX | \*/\* | ## postWebhookEventsSubscriptionRenewalDue Fired when a subscription renewal is upcoming (cron-driven). Doc-only for parsing. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.webhookEvents.postWebhookEventsSubscriptionRenewalDue(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { webhookEventsPostWebhookEventsSubscriptionRenewalDue } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-subscription-renewal-due.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: "", }); async function run() { const res = await webhookEventsPostWebhookEventsSubscriptionRenewalDue(flexprice); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("webhookEventsPostWebhookEventsSubscriptionRenewalDue failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `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.WebhookDtoSubscriptionWebhookPayload](../../sdk/models/webhook-dto-subscription-webhook-payload.md)\>** ### Errors | Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | | models.SDKError | 4XX, 5XX | \*/\* | ## postWebhookEventsSubscriptionResumed Fired when a paused subscription is resumed. Doc-only for parsing. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.webhookEvents.postWebhookEventsSubscriptionResumed(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { webhookEventsPostWebhookEventsSubscriptionResumed } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-subscription-resumed.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: "", }); async function run() { const res = await webhookEventsPostWebhookEventsSubscriptionResumed(flexprice); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("webhookEventsPostWebhookEventsSubscriptionResumed failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `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.WebhookDtoSubscriptionWebhookPayload](../../sdk/models/webhook-dto-subscription-webhook-payload.md)\>** ### Errors | Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | | models.SDKError | 4XX, 5XX | \*/\* | ## postWebhookEventsSubscriptionSpendThresholdReached Fired when a subscription's total metered spend crosses an alert threshold (critical, warning, or info) for the current billing period. Doc-only for parsing. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.webhookEvents.postWebhookEventsSubscriptionSpendThresholdReached(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { webhookEventsPostWebhookEventsSubscriptionSpendThresholdReached } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-subscription-spend-threshold-reached.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: "", }); async function run() { const res = await webhookEventsPostWebhookEventsSubscriptionSpendThresholdReached(flexprice); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("webhookEventsPostWebhookEventsSubscriptionSpendThresholdReached failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `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.WebhookDtoSpendAlertEvent](../../sdk/models/webhook-dto-spend-alert-event.md)\>** ### Errors | Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | | models.SDKError | 4XX, 5XX | \*/\* | ## postWebhookEventsSubscriptionSpendThresholdRecovered Fired when a subscription's total metered spend falls back below all configured alert thresholds for the current billing period. Doc-only for parsing. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.webhookEvents.postWebhookEventsSubscriptionSpendThresholdRecovered(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { webhookEventsPostWebhookEventsSubscriptionSpendThresholdRecovered } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-subscription-spend-threshold-recovered.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: "", }); async function run() { const res = await webhookEventsPostWebhookEventsSubscriptionSpendThresholdRecovered(flexprice); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("webhookEventsPostWebhookEventsSubscriptionSpendThresholdRecovered failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `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.WebhookDtoSpendAlertEvent](../../sdk/models/webhook-dto-spend-alert-event.md)\>** ### Errors | Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | | models.SDKError | 4XX, 5XX | \*/\* | ## postWebhookEventsSubscriptionUpdated Fired when a subscription is updated (e.g. quantity, billing anchor, or metadata changes). Doc-only for parsing. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.webhookEvents.postWebhookEventsSubscriptionUpdated(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { webhookEventsPostWebhookEventsSubscriptionUpdated } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-subscription-updated.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: "", }); async function run() { const res = await webhookEventsPostWebhookEventsSubscriptionUpdated(flexprice); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("webhookEventsPostWebhookEventsSubscriptionUpdated failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `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.WebhookDtoSubscriptionWebhookPayload](../../sdk/models/webhook-dto-subscription-webhook-payload.md)\>** ### Errors | Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | | models.SDKError | 4XX, 5XX | \*/\* | ## postWebhookEventsWalletCreated Fired when a new wallet is created. Doc-only for parsing. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.webhookEvents.postWebhookEventsWalletCreated(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { webhookEventsPostWebhookEventsWalletCreated } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-wallet-created.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: "", }); async function run() { const res = await webhookEventsPostWebhookEventsWalletCreated(flexprice); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("webhookEventsPostWebhookEventsWalletCreated failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `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.WebhookDtoWalletWebhookPayload](../../sdk/models/webhook-dto-wallet-webhook-payload.md)\>** ### Errors | Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | | models.SDKError | 4XX, 5XX | \*/\* | ## postWebhookEventsWalletCreditBalanceDropped Fired when a wallet's credit balance drops below an alert threshold. Doc-only for parsing. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.webhookEvents.postWebhookEventsWalletCreditBalanceDropped(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { webhookEventsPostWebhookEventsWalletCreditBalanceDropped } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-wallet-credit-balance-dropped.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: "", }); async function run() { const res = await webhookEventsPostWebhookEventsWalletCreditBalanceDropped(flexprice); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("webhookEventsPostWebhookEventsWalletCreditBalanceDropped failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `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.WebhookDtoWalletWebhookPayload](../../sdk/models/webhook-dto-wallet-webhook-payload.md)\>** ### Errors | Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | | models.SDKError | 4XX, 5XX | \*/\* | ## postWebhookEventsWalletCreditBalanceRecovered Fired when a wallet's credit balance recovers above an alert threshold. Doc-only for parsing. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.webhookEvents.postWebhookEventsWalletCreditBalanceRecovered(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { webhookEventsPostWebhookEventsWalletCreditBalanceRecovered } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-wallet-credit-balance-recovered.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: "", }); async function run() { const res = await webhookEventsPostWebhookEventsWalletCreditBalanceRecovered(flexprice); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("webhookEventsPostWebhookEventsWalletCreditBalanceRecovered failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `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.WebhookDtoWalletWebhookPayload](../../sdk/models/webhook-dto-wallet-webhook-payload.md)\>** ### Errors | Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | | models.SDKError | 4XX, 5XX | \*/\* | ## postWebhookEventsWalletOngoingBalanceDropped Fired when a wallet's ongoing balance drops below an alert threshold. Doc-only for parsing. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.webhookEvents.postWebhookEventsWalletOngoingBalanceDropped(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { webhookEventsPostWebhookEventsWalletOngoingBalanceDropped } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-wallet-ongoing-balance-dropped.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: "", }); async function run() { const res = await webhookEventsPostWebhookEventsWalletOngoingBalanceDropped(flexprice); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("webhookEventsPostWebhookEventsWalletOngoingBalanceDropped failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `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.WebhookDtoWalletWebhookPayload](../../sdk/models/webhook-dto-wallet-webhook-payload.md)\>** ### Errors | Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | | models.SDKError | 4XX, 5XX | \*/\* | ## postWebhookEventsWalletOngoingBalanceRecovered Fired when a wallet's ongoing balance recovers above an alert threshold. Doc-only for parsing. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.webhookEvents.postWebhookEventsWalletOngoingBalanceRecovered(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { webhookEventsPostWebhookEventsWalletOngoingBalanceRecovered } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-wallet-ongoing-balance-recovered.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: "", }); async function run() { const res = await webhookEventsPostWebhookEventsWalletOngoingBalanceRecovered(flexprice); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("webhookEventsPostWebhookEventsWalletOngoingBalanceRecovered failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `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.WebhookDtoWalletWebhookPayload](../../sdk/models/webhook-dto-wallet-webhook-payload.md)\>** ### Errors | Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | | models.SDKError | 4XX, 5XX | \*/\* | ## postWebhookEventsWalletOngoingBalanceUpdated Fired when a wallet's ongoing (real-time) balance changes. Doc-only for parsing. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.webhookEvents.postWebhookEventsWalletOngoingBalanceUpdated(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { webhookEventsPostWebhookEventsWalletOngoingBalanceUpdated } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-wallet-ongoing-balance-updated.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: "", }); async function run() { const res = await webhookEventsPostWebhookEventsWalletOngoingBalanceUpdated(flexprice); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("webhookEventsPostWebhookEventsWalletOngoingBalanceUpdated failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `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.WebhookDtoWalletWebhookPayload](../../sdk/models/webhook-dto-wallet-webhook-payload.md)\>** ### Errors | Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | | models.SDKError | 4XX, 5XX | \*/\* | ## postWebhookEventsWalletTerminated Fired when a wallet is terminated. Doc-only for parsing. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.webhookEvents.postWebhookEventsWalletTerminated(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { webhookEventsPostWebhookEventsWalletTerminated } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-wallet-terminated.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: "", }); async function run() { const res = await webhookEventsPostWebhookEventsWalletTerminated(flexprice); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("webhookEventsPostWebhookEventsWalletTerminated failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `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.WebhookDtoWalletWebhookPayload](../../sdk/models/webhook-dto-wallet-webhook-payload.md)\>** ### Errors | Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | | models.SDKError | 4XX, 5XX | \*/\* | ## postWebhookEventsWalletTransactionCreated Fired when a new wallet transaction is created (top-up, deduction, etc.). Doc-only for parsing. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.webhookEvents.postWebhookEventsWalletTransactionCreated(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { webhookEventsPostWebhookEventsWalletTransactionCreated } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-wallet-transaction-created.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: "", }); async function run() { const res = await webhookEventsPostWebhookEventsWalletTransactionCreated(flexprice); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("webhookEventsPostWebhookEventsWalletTransactionCreated failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `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.WebhookDtoTransactionWebhookPayload](../../sdk/models/webhook-dto-transaction-webhook-payload.md)\>** ### Errors | Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | | models.SDKError | 4XX, 5XX | \*/\* | ## postWebhookEventsWalletTransactionUpdated Fired when an existing wallet transaction is updated (e.g. pending to completed). Doc-only for parsing. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.webhookEvents.postWebhookEventsWalletTransactionUpdated(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { webhookEventsPostWebhookEventsWalletTransactionUpdated } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-wallet-transaction-updated.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: "", }); async function run() { const res = await webhookEventsPostWebhookEventsWalletTransactionUpdated(flexprice); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("webhookEventsPostWebhookEventsWalletTransactionUpdated failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `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.WebhookDtoTransactionUpdatedWebhookPayload](../../sdk/models/webhook-dto-transaction-updated-webhook-payload.md)\>** ### Errors | Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | | models.SDKError | 4XX, 5XX | \*/\* | ## postWebhookEventsWalletUpdated Fired when a wallet is updated. Doc-only for parsing. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.webhookEvents.postWebhookEventsWalletUpdated(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { webhookEventsPostWebhookEventsWalletUpdated } from "@flexprice/sdk/funcs/webhook-events-post-webhook-events-wallet-updated.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: "", }); async function run() { const res = await webhookEventsPostWebhookEventsWalletUpdated(flexprice); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("webhookEventsPostWebhookEventsWalletUpdated failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `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.WebhookDtoWalletWebhookPayload](../../sdk/models/webhook-dto-wallet-webhook-payload.md)\>** ### Errors | Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | | models.SDKError | 4XX, 5XX | \*/\* |