# Subscriptions ## Overview ### Available Operations * [createSubscription](#createsubscription) - Create subscription * [~~addSubscriptionAddon~~](#addsubscriptionaddon) - Add addon to subscription :warning: **Deprecated** * [~~removeSubscriptionAddon~~](#removesubscriptionaddon) - Remove addon from subscription :warning: **Deprecated** * [querySubscriptionLineItems](#querysubscriptionlineitems) - Search subscription line items * [updateSubscriptionLineItem](#updatesubscriptionlineitem) - Update subscription line item * [deleteSubscriptionLineItem](#deletesubscriptionlineitem) - Delete subscription line item * [querySubscription](#querysubscription) - Query subscriptions * [getSubscriptionUsage](#getsubscriptionusage) - Get usage by subscription * [getSubscription](#getsubscription) - Get subscription * [updateSubscription](#updatesubscription) - Update subscription * [activateSubscription](#activatesubscription) - Activate draft subscription * [getSubscriptionAddonAssociations](#getsubscriptionaddonassociations) - Get active addon associations * [cancelSubscription](#cancelsubscription) - Cancel subscription * [executeSubscriptionChange](#executesubscriptionchange) - Execute subscription plan change * [previewSubscriptionChange](#previewsubscriptionchange) - Preview subscription plan change * [executeSubscriptionPlanChangeV2](#executesubscriptionplanchangev2) - Execute a plan change (v2, swap in place) * [previewSubscriptionPlanChangeV2](#previewsubscriptionplanchangev2) - Preview a plan change (v2, swap in place) * [getSubscriptionEntitlements](#getsubscriptionentitlements) - Get subscription entitlements * [getSubscriptionUpcomingGrants](#getsubscriptionupcominggrants) - Get upcoming credit grant applications * [createSubscriptionLineItem](#createsubscriptionlineitem) - Create subscription line item * [executeSubscriptionModify](#executesubscriptionmodify) - Execute subscription modification * [previewSubscriptionModify](#previewsubscriptionmodify) - Preview subscription modification * [getSubscriptionV2](#getsubscriptionv2) - Get subscription (V2) * [listAllSubscriptionSchedules](#listallsubscriptionschedules) - List all subscription schedules * [getSubscriptionSchedule](#getsubscriptionschedule) - Get subscription schedule * [cancelSubscriptionSchedule](#cancelsubscriptionschedule) - Cancel subscription schedule * [listSubscriptionSchedules](#listsubscriptionschedules) - List subscription schedules ## createSubscription Use when onboarding a customer to a plan or starting a new subscription. Ideal for draft subscriptions (activate later) or active from start. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.subscriptions.createSubscription({ billingPeriod: "ONETIME", currency: "Kwacha", planId: "", }); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { subscriptionsCreateSubscription } from "@flexprice/sdk/funcs/subscriptions-create-subscription.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 subscriptionsCreateSubscription(flexprice, { billingPeriod: "ONETIME", currency: "Kwacha", planId: "", }); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("subscriptionsCreateSubscription failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [models.CreateSubscriptionRequest](../../sdk/models/create-subscription-request.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.SubscriptionResponse](../../sdk/models/subscription-response.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | models.ErrorsErrorResponse | 400 | application/json | | models.ErrorsErrorResponse | 500 | application/json | | models.SDKError | 4XX, 5XX | \*/\* | ## ~~addSubscriptionAddon~~ Deprecated: use POST /subscriptions/{id}/modify/execute with type "addon" and action "add", which also supports previewing the proration charge first. Use when adding an optional product or add-on to an existing subscription (e.g. extra storage or support tier). > :warning: **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.subscriptions.addSubscriptionAddon({ addonId: "", subscriptionId: "", }); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { subscriptionsAddSubscriptionAddon } from "@flexprice/sdk/funcs/subscriptions-add-subscription-addon.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 subscriptionsAddSubscriptionAddon(flexprice, { addonId: "", subscriptionId: "", }); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("subscriptionsAddSubscriptionAddon failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [models.AddAddonRequest](../../sdk/models/add-addon-request.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.AddAddonToSubscriptionResponse](../../sdk/models/add-addon-to-subscription-response.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | models.ErrorsErrorResponse | 400 | application/json | | models.ErrorsErrorResponse | 500 | application/json | | models.SDKError | 4XX, 5XX | \*/\* | ## ~~removeSubscriptionAddon~~ Deprecated: use POST /subscriptions/{id}/modify/execute with type "addon" and action "remove", which also supports previewing the proration credit first. Use when removing an add-on from a subscription (e.g. downgrade or opt-out). > :warning: **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.subscriptions.removeSubscriptionAddon({ addonAssociationId: "", }); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { subscriptionsRemoveSubscriptionAddon } from "@flexprice/sdk/funcs/subscriptions-remove-subscription-addon.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 subscriptionsRemoveSubscriptionAddon(flexprice, { addonAssociationId: "", }); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("subscriptionsRemoveSubscriptionAddon failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [models.RemoveAddonRequest](../../sdk/models/remove-addon-request.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.SuccessResponse](../../sdk/models/success-response.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | models.ErrorsErrorResponse | 400 | application/json | | models.ErrorsErrorResponse | 500 | application/json | | models.SDKError | 4XX, 5XX | \*/\* | ## querySubscriptionLineItems List subscription line items with a JSON filter (subscription, customer, price, pagination, expand=prices, etc.). ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.subscriptions.querySubscriptionLineItems({}); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { subscriptionsQuerySubscriptionLineItems } from "@flexprice/sdk/funcs/subscriptions-query-subscription-line-items.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 subscriptionsQuerySubscriptionLineItems(flexprice, {}); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("subscriptionsQuerySubscriptionLineItems failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [models.SubscriptionLineItemFilter](../../sdk/models/subscription-line-item-filter.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.ListSubscriptionLineItemsResponse](../../sdk/models/list-subscription-line-items-response.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | models.ErrorsErrorResponse | 400 | application/json | | models.ErrorsErrorResponse | 500 | application/json | | models.SDKError | 4XX, 5XX | \*/\* | ## updateSubscriptionLineItem Use when changing a subscription line item (e.g. quantity or price). Implemented by ending the current line and creating a new one for clean billing. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.subscriptions.updateSubscriptionLineItem("", {}); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { subscriptionsUpdateSubscriptionLineItem } from "@flexprice/sdk/funcs/subscriptions-update-subscription-line-item.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 subscriptionsUpdateSubscriptionLineItem(flexprice, "", {}); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("subscriptionsUpdateSubscriptionLineItem failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `id` | *string* | :heavy_check_mark: | Line Item ID | | `body` | [models.UpdateSubscriptionLineItemRequest](../../sdk/models/update-subscription-line-item-request.md) | :heavy_check_mark: | Update Line Item Request | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.SubscriptionLineItemResponse](../../sdk/models/subscription-line-item-response.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | models.ErrorsErrorResponse | 400 | application/json | | models.ErrorsErrorResponse | 500 | application/json | | models.SDKError | 4XX, 5XX | \*/\* | ## deleteSubscriptionLineItem Use when removing a charge or seat from a subscription (e.g. downgrade). Line item ends; retained for history but no longer billed. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.subscriptions.deleteSubscriptionLineItem("", {}); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { subscriptionsDeleteSubscriptionLineItem } from "@flexprice/sdk/funcs/subscriptions-delete-subscription-line-item.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 subscriptionsDeleteSubscriptionLineItem(flexprice, "", {}); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("subscriptionsDeleteSubscriptionLineItem failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `id` | *string* | :heavy_check_mark: | Line Item ID | | `body` | [models.DeleteSubscriptionLineItemRequest](../../sdk/models/delete-subscription-line-item-request.md) | :heavy_check_mark: | Delete Line Item Request | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.SubscriptionLineItemResponse](../../sdk/models/subscription-line-item-response.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | models.ErrorsErrorResponse | 400 | application/json | | models.ErrorsErrorResponse | 500 | application/json | | models.SDKError | 4XX, 5XX | \*/\* | ## querySubscription Use when listing or searching subscriptions (e.g. admin view or customer subscription list). Returns a paginated list; supports filtering by customer, plan, status. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.subscriptions.querySubscription({}); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { subscriptionsQuerySubscription } from "@flexprice/sdk/funcs/subscriptions-query-subscription.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 subscriptionsQuerySubscription(flexprice, {}); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("subscriptionsQuerySubscription failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [models.SubscriptionFilter](../../sdk/models/subscription-filter.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.ListSubscriptionsResponse](../../sdk/models/list-subscriptions-response.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | models.ErrorsErrorResponse | 400 | application/json | | models.ErrorsErrorResponse | 500 | application/json | | models.SDKError | 4XX, 5XX | \*/\* | ## getSubscriptionUsage Use when showing usage for a subscription (e.g. in a portal or for overage checks). Supports time range and filters. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.subscriptions.getSubscriptionUsage({ endTime: new Date("2024-03-20T00:00:00Z"), lifetimeUsage: false, startTime: new Date("2024-03-13T00:00:00Z"), subscriptionId: "123", }); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { subscriptionsGetSubscriptionUsage } from "@flexprice/sdk/funcs/subscriptions-get-subscription-usage.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 subscriptionsGetSubscriptionUsage(flexprice, { endTime: new Date("2024-03-20T00:00:00Z"), lifetimeUsage: false, startTime: new Date("2024-03-13T00:00:00Z"), subscriptionId: "123", }); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("subscriptionsGetSubscriptionUsage failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [models.GetUsageBySubscriptionRequest](../../sdk/models/get-usage-by-subscription-request.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.GetUsageBySubscriptionResponse](../../sdk/models/get-usage-by-subscription-response.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | models.ErrorsErrorResponse | 400 | application/json | | models.ErrorsErrorResponse | 500 | application/json | | models.SDKError | 4XX, 5XX | \*/\* | ## getSubscription Use when you need to load a single subscription (e.g. for a billing portal or to check status). ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.subscriptions.getSubscription(""); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { subscriptionsGetSubscription } from "@flexprice/sdk/funcs/subscriptions-get-subscription.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 subscriptionsGetSubscription(flexprice, ""); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("subscriptionsGetSubscription failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `id` | *string* | :heavy_check_mark: | Subscription ID | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.SubscriptionResponse](../../sdk/models/subscription-response.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | models.ErrorsErrorResponse | 400 | application/json | | models.ErrorsErrorResponse | 500 | application/json | | models.SDKError | 4XX, 5XX | \*/\* | ## updateSubscription Use when changing subscription details (e.g. quantity, billing anchor, or parent). Supports partial update; send "" to clear parent_subscription_id. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.subscriptions.updateSubscription("", {}); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { subscriptionsUpdateSubscription } from "@flexprice/sdk/funcs/subscriptions-update-subscription.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 subscriptionsUpdateSubscription(flexprice, "", {}); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("subscriptionsUpdateSubscription failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `id` | *string* | :heavy_check_mark: | Subscription ID | | `body` | [models.UpdateSubscriptionRequest](../../sdk/models/update-subscription-request.md) | :heavy_check_mark: | Update Subscription Request | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.SubscriptionResponse](../../sdk/models/subscription-response.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | models.ErrorsErrorResponse | 400 | application/json | | models.ErrorsErrorResponse | 500 | application/json | | models.SDKError | 4XX, 5XX | \*/\* | ## activateSubscription Use when turning a draft subscription live (e.g. after collecting payment or completing setup). Once activated, billing and entitlements apply. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.subscriptions.activateSubscription("", { startDate: new Date("2026-02-04T05:02:31.632Z"), }); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { subscriptionsActivateSubscription } from "@flexprice/sdk/funcs/subscriptions-activate-subscription.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 subscriptionsActivateSubscription(flexprice, "", { startDate: new Date("2026-02-04T05:02:31.632Z"), }); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("subscriptionsActivateSubscription failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `id` | *string* | :heavy_check_mark: | Subscription ID | | `body` | [models.ActivateDraftSubscriptionRequest](../../sdk/models/activate-draft-subscription-request.md) | :heavy_check_mark: | Activate Draft Subscription Request | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.SubscriptionResponse](../../sdk/models/subscription-response.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | models.ErrorsErrorResponse | 400 | application/json | | models.ErrorsErrorResponse | 500 | application/json | | models.SDKError | 4XX, 5XX | \*/\* | ## getSubscriptionAddonAssociations Use when listing which add-ons are currently attached to a subscription (e.g. for display or editing). ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.subscriptions.getSubscriptionAddonAssociations(""); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { subscriptionsGetSubscriptionAddonAssociations } from "@flexprice/sdk/funcs/subscriptions-get-subscription-addon-associations.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 subscriptionsGetSubscriptionAddonAssociations(flexprice, ""); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("subscriptionsGetSubscriptionAddonAssociations failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `id` | *string* | :heavy_check_mark: | Subscription ID | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.AddonAssociationResponse[]](../../models/.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | models.ErrorsErrorResponse | 400, 404 | application/json | | models.ErrorsErrorResponse | 500 | application/json | | models.SDKError | 4XX, 5XX | \*/\* | ## cancelSubscription Use when a customer churns or downgrades. Supports immediate or end-of-period cancellation and proration. Ideal for self-serve or support-driven cancellations. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.subscriptions.cancelSubscription("", { cancellationType: "immediate", }); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { subscriptionsCancelSubscription } from "@flexprice/sdk/funcs/subscriptions-cancel-subscription.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 subscriptionsCancelSubscription(flexprice, "", { cancellationType: "immediate", }); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("subscriptionsCancelSubscription failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `id` | *string* | :heavy_check_mark: | Subscription ID | | `body` | [models.CancelSubscriptionRequest](../../sdk/models/cancel-subscription-request.md) | :heavy_check_mark: | Cancel Subscription Request | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.CancelSubscriptionResponse](../../sdk/models/cancel-subscription-response.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | models.ErrorsErrorResponse | 400 | application/json | | models.ErrorsErrorResponse | 500 | application/json | | models.SDKError | 4XX, 5XX | \*/\* | ## executeSubscriptionChange Use when applying a plan change (e.g. upgrade or downgrade). Executes proration and generates invoice or credit as needed. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.subscriptions.executeSubscriptionChange("", { billingCadence: "RECURRING", billingCycle: "anniversary", billingPeriod: "ANNUAL", prorationBehavior: "none", targetPlanId: "", }); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { subscriptionsExecuteSubscriptionChange } from "@flexprice/sdk/funcs/subscriptions-execute-subscription-change.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 subscriptionsExecuteSubscriptionChange(flexprice, "", { billingCadence: "RECURRING", billingCycle: "anniversary", billingPeriod: "ANNUAL", prorationBehavior: "none", targetPlanId: "", }); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("subscriptionsExecuteSubscriptionChange failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `id` | *string* | :heavy_check_mark: | Subscription ID | | `body` | [models.SubscriptionChangeRequest](../../sdk/models/subscription-change-request.md) | :heavy_check_mark: | Subscription change request | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.SubscriptionChangeExecuteResponse](../../sdk/models/subscription-change-execute-response.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | models.ErrorsErrorResponse | 400, 404 | application/json | | models.ErrorsErrorResponse | 500 | application/json | | models.SDKError | 4XX, 5XX | \*/\* | ## previewSubscriptionChange Use when showing a customer the cost of a plan change before they confirm (e.g. upgrade/downgrade preview with proration). ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.subscriptions.previewSubscriptionChange("", { billingCadence: "RECURRING", billingCycle: "anniversary", billingPeriod: "ONETIME", prorationBehavior: "none", targetPlanId: "", }); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { subscriptionsPreviewSubscriptionChange } from "@flexprice/sdk/funcs/subscriptions-preview-subscription-change.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 subscriptionsPreviewSubscriptionChange(flexprice, "", { billingCadence: "RECURRING", billingCycle: "anniversary", billingPeriod: "ONETIME", prorationBehavior: "none", targetPlanId: "", }); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("subscriptionsPreviewSubscriptionChange failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `id` | *string* | :heavy_check_mark: | Subscription ID | | `body` | [models.SubscriptionChangeRequest](../../sdk/models/subscription-change-request.md) | :heavy_check_mark: | Subscription change preview request | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.SubscriptionChangePreviewResponse](../../sdk/models/subscription-change-preview-response.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | models.ErrorsErrorResponse | 400, 404 | application/json | | models.ErrorsErrorResponse | 500 | application/json | | models.SDKError | 4XX, 5XX | \*/\* | ## executeSubscriptionPlanChangeV2 Change a subscription's plan in place. Subscription id, billing anchor and period bounds are preserved; line items are sliced and settled in one transaction. change_at controls timing. Omitted or 'immediate' applies the change now. 'end_of_period' records a pending schedule that executes at the subscription's current period end: the response returns is_scheduled, schedule_id and scheduled_at instead of a completed change, and nothing is swapped or billed until the boundary. scheduled_at is resolved from the subscription's current period end at request time. If that period end is already in the past (a backdated start date, a resumed pause, or worker downtime can all leave a subscription behind), the change is due immediately and fires on the next billing scan rather than a period away — inspect scheduled_at to see this. Only one plan change may be pending per subscription. By default (on_conflict_policies.on_pending_schedule = 'reject') a second request returns 400; cancel the existing schedule via POST /subscriptions/schedules/{schedule_id}/cancel first. Pending schedules are listable via GET /subscriptions/{id}/schedules. Set on_conflict_policies.on_pending_schedule to 'supersede' to replace the queued change instead: the pending schedule is cancelled and this request applied in the same transaction, so both land or neither does. The cancelled schedule ids are returned in superseded_schedules, and preview reports the same list without writing. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.subscriptions.executeSubscriptionPlanChangeV2("", { prorationBehavior: "create_prorations", targetPlanId: "", }); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { subscriptionsExecuteSubscriptionPlanChangeV2 } from "@flexprice/sdk/funcs/subscriptions-execute-subscription-plan-change-v2.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 subscriptionsExecuteSubscriptionPlanChangeV2(flexprice, "", { prorationBehavior: "create_prorations", targetPlanId: "", }); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("subscriptionsExecuteSubscriptionPlanChangeV2 failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `id` | *string* | :heavy_check_mark: | Subscription ID | | `body` | [models.SubscriptionChangeV2Request](../../sdk/models/subscription-change-v2-request.md) | :heavy_check_mark: | Plan change request | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.SubscriptionChangeV2Response](../../sdk/models/subscription-change-v2-response.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | models.ErrorsErrorResponse | 400, 404 | application/json | | models.ErrorsErrorResponse | 500 | application/json | | models.SDKError | 4XX, 5XX | \*/\* | ## previewSubscriptionPlanChangeV2 Preview a subscription plan change without writing. Swap-in-place: subscription id, billing anchor and period bounds are preserved. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.subscriptions.previewSubscriptionPlanChangeV2("", { prorationBehavior: "none", targetPlanId: "", }); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { subscriptionsPreviewSubscriptionPlanChangeV2 } from "@flexprice/sdk/funcs/subscriptions-preview-subscription-plan-change-v2.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 subscriptionsPreviewSubscriptionPlanChangeV2(flexprice, "", { prorationBehavior: "none", targetPlanId: "", }); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("subscriptionsPreviewSubscriptionPlanChangeV2 failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `id` | *string* | :heavy_check_mark: | Subscription ID | | `body` | [models.SubscriptionChangeV2Request](../../sdk/models/subscription-change-v2-request.md) | :heavy_check_mark: | Plan change request | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.SubscriptionChangeV2Response](../../sdk/models/subscription-change-v2-response.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | models.ErrorsErrorResponse | 400, 404 | application/json | | models.ErrorsErrorResponse | 500 | application/json | | models.SDKError | 4XX, 5XX | \*/\* | ## getSubscriptionEntitlements Use when checking what features or limits a subscription has (e.g. entitlement checks or feature gating). Optional feature_ids to filter. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.subscriptions.getSubscriptionEntitlements(""); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { subscriptionsGetSubscriptionEntitlements } from "@flexprice/sdk/funcs/subscriptions-get-subscription-entitlements.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 subscriptionsGetSubscriptionEntitlements(flexprice, ""); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("subscriptionsGetSubscriptionEntitlements failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `id` | *string* | :heavy_check_mark: | Subscription ID | | `featureIds` | *string*[] | :heavy_minus_sign: | Feature IDs to filter by | | `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.SubscriptionEntitlementsResponse](../../sdk/models/subscription-entitlements-response.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | models.ErrorsErrorResponse | 400, 404 | application/json | | models.ErrorsErrorResponse | 500 | application/json | | models.SDKError | 4XX, 5XX | \*/\* | ## getSubscriptionUpcomingGrants Use when showing upcoming or pending credits for a subscription (e.g. in a portal or for forecasting). ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.subscriptions.getSubscriptionUpcomingGrants(""); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { subscriptionsGetSubscriptionUpcomingGrants } from "@flexprice/sdk/funcs/subscriptions-get-subscription-upcoming-grants.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 subscriptionsGetSubscriptionUpcomingGrants(flexprice, ""); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("subscriptionsGetSubscriptionUpcomingGrants failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `id` | *string* | :heavy_check_mark: | Subscription ID | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.ListCreditGrantApplicationsResponse](../../sdk/models/list-credit-grant-applications-response.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | models.ErrorsErrorResponse | 400, 404 | application/json | | models.ErrorsErrorResponse | 500 | application/json | | models.SDKError | 4XX, 5XX | \*/\* | ## createSubscriptionLineItem Use when adding a new charge or seat to a subscription (e.g. extra seat or one-time add). Supports price_id or inline price. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.subscriptions.createSubscriptionLineItem("", {}); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { subscriptionsCreateSubscriptionLineItem } from "@flexprice/sdk/funcs/subscriptions-create-subscription-line-item.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 subscriptionsCreateSubscriptionLineItem(flexprice, "", {}); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("subscriptionsCreateSubscriptionLineItem failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `id` | *string* | :heavy_check_mark: | Subscription ID | | `body` | [models.CreateSubscriptionLineItemRequest](../../sdk/models/create-subscription-line-item-request.md) | :heavy_check_mark: | Create Line Item Request | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.SubscriptionLineItemResponse](../../sdk/models/subscription-line-item-response.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | models.ErrorsErrorResponse | 400, 404 | application/json | | models.ErrorsErrorResponse | 500 | application/json | | models.SDKError | 4XX, 5XX | \*/\* | ## executeSubscriptionModify Execute a mid-cycle subscription modification (inheritance, quantity change, grouped invoicing, trial end, coupon, tax, or addon add/remove). ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.subscriptions.executeSubscriptionModify("", { type: "inheritance", }); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { subscriptionsExecuteSubscriptionModify } from "@flexprice/sdk/funcs/subscriptions-execute-subscription-modify.js"; // Use `FlexpriceCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const flexprice = new FlexpriceCore({ apiKeyAuth: "", }); async function run() { const res = await subscriptionsExecuteSubscriptionModify(flexprice, "", { type: "inheritance", }); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("subscriptionsExecuteSubscriptionModify failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `id` | *string* | :heavy_check_mark: | Subscription ID | | `body` | [models.ExecuteSubscriptionModifyRequest](../../sdk/models/execute-subscription-modify-request.md) | :heavy_check_mark: | Modification request | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.SubscriptionModifyResponse](../../sdk/models/subscription-modify-response.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | models.ErrorsErrorResponse | 400, 404 | application/json | | models.ErrorsErrorResponse | 500 | application/json | | models.SDKError | 4XX, 5XX | \*/\* | ## previewSubscriptionModify Preview the impact of a mid-cycle subscription modification (inheritance, quantity change, grouped invoicing, trial end, coupon, tax, or addon add/remove) without committing changes. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.subscriptions.previewSubscriptionModify("", { type: "tax", }); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { subscriptionsPreviewSubscriptionModify } from "@flexprice/sdk/funcs/subscriptions-preview-subscription-modify.js"; // Use `FlexpriceCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const flexprice = new FlexpriceCore({ apiKeyAuth: "", }); async function run() { const res = await subscriptionsPreviewSubscriptionModify(flexprice, "", { type: "tax", }); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("subscriptionsPreviewSubscriptionModify failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `id` | *string* | :heavy_check_mark: | Subscription ID | | `body` | [models.ExecuteSubscriptionModifyRequest](../../sdk/models/execute-subscription-modify-request.md) | :heavy_check_mark: | Modification preview request | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.SubscriptionModifyResponse](../../sdk/models/subscription-modify-response.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | models.ErrorsErrorResponse | 400, 404 | application/json | | models.ErrorsErrorResponse | 500 | application/json | | models.SDKError | 4XX, 5XX | \*/\* | ## getSubscriptionV2 Use when you need a subscription with related data (line items, prices, plan). Supports expand for detailed payloads without extra round-trips. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.subscriptions.getSubscriptionV2(""); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { subscriptionsGetSubscriptionV2 } from "@flexprice/sdk/funcs/subscriptions-get-subscription-v2.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 subscriptionsGetSubscriptionV2(flexprice, ""); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("subscriptionsGetSubscriptionV2 failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `id` | *string* | :heavy_check_mark: | Subscription ID | | `expand` | *string* | :heavy_minus_sign: | Comma-separated list of fields to expand (e.g., 'subscription_line_items,prices,plan') | | `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.SubscriptionResponseV2](../../sdk/models/subscription-response-v2.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | models.ErrorsErrorResponse | 400 | application/json | | models.ErrorsErrorResponse | 500 | application/json | | models.SDKError | 4XX, 5XX | \*/\* | ## listAllSubscriptionSchedules Use when listing or searching scheduled changes across subscriptions (e.g. admin view). Returns schedules with optional filtering. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.subscriptions.listAllSubscriptionSchedules(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { subscriptionsListAllSubscriptionSchedules } from "@flexprice/sdk/funcs/subscriptions-list-all-subscription-schedules.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 subscriptionsListAllSubscriptionSchedules(flexprice); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("subscriptionsListAllSubscriptionSchedules failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `pendingOnly` | *boolean* | :heavy_minus_sign: | Filter to pending schedules only | | `subscriptionId` | *string* | :heavy_minus_sign: | Filter by subscription ID | | `limit` | *number* | :heavy_minus_sign: | Limit results | | `offset` | *number* | :heavy_minus_sign: | Offset for pagination | | `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.GetPendingSchedulesResponse](../../sdk/models/get-pending-schedules-response.md)\>** ### Errors | Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | | models.SDKError | 4XX, 5XX | \*/\* | ## getSubscriptionSchedule Use when you need to load a single scheduled change (e.g. to show when a plan change or renewal takes effect). ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.subscriptions.getSubscriptionSchedule(""); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { subscriptionsGetSubscriptionSchedule } from "@flexprice/sdk/funcs/subscriptions-get-subscription-schedule.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 subscriptionsGetSubscriptionSchedule(flexprice, ""); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("subscriptionsGetSubscriptionSchedule failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `id` | *string* | :heavy_check_mark: | Schedule ID | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.SubscriptionScheduleResponse](../../sdk/models/subscription-schedule-response.md)\>** ### Errors | Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | | models.SDKError | 4XX, 5XX | \*/\* | ## cancelSubscriptionSchedule Use when cancelling a scheduled change (e.g. customer changed mind). Identify by schedule ID in path or by subscription ID + schedule type in body. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.subscriptions.cancelSubscriptionSchedule(""); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { subscriptionsCancelSubscriptionSchedule } from "@flexprice/sdk/funcs/subscriptions-cancel-subscription-schedule.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 subscriptionsCancelSubscriptionSchedule(flexprice, ""); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("subscriptionsCancelSubscriptionSchedule failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `scheduleId` | *string* | :heavy_check_mark: | Schedule ID (optional if using request body) | | `body` | [models.CancelScheduleRequest](../../sdk/models/cancel-schedule-request.md) | :heavy_minus_sign: | Cancel request (optional if using path parameter) | | `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.CancelScheduleResponse](../../sdk/models/cancel-schedule-response.md)\>** ### Errors | Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | | models.SDKError | 4XX, 5XX | \*/\* | ## listSubscriptionSchedules Use when listing scheduled changes for a subscription (e.g. upcoming plan change or renewal). Returns all schedules for that subscription. ### Example Usage ```typescript import { Flexprice } from "@flexprice/sdk"; const flexprice = new Flexprice({ apiKeyAuth: "", }); async function run() { const result = await flexprice.subscriptions.listSubscriptionSchedules(""); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { FlexpriceCore } from "@flexprice/sdk/core.js"; import { subscriptionsListSubscriptionSchedules } from "@flexprice/sdk/funcs/subscriptions-list-subscription-schedules.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 subscriptionsListSubscriptionSchedules(flexprice, ""); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("subscriptionsListSubscriptionSchedules failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `subscriptionId` | *string* | :heavy_check_mark: | Subscription ID | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.GetPendingSchedulesResponse](../../sdk/models/get-pending-schedules-response.md)\>** ### Errors | Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | | models.SDKError | 4XX, 5XX | \*/\* |