@outseta/react 0.2.0 → 0.2.1

package/src/generated/billing/billing.ts

@@ -0,0 +1,1333 @@
+// @ts-nocheck
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * Outseta API
+ * # Outseta REST API
+
+The Outseta REST API enables you to perform a variety of powerful tasks such as creating and updating people, accounts, subscriptions, and invoices. Outseta uses standard HTTP protocols within a compliant architecture that is simple to integrate. You can use the API both on the client or the server side; see the authentication section below for each scenario.
+
+**Base URL:** `https://{your-domain}.outseta.com/api/v1/`
+
+## API Guidelines
+
+1. The API will only respond to secured communication done over **HTTPS**. HTTP requests will be sent a `301` redirect to the corresponding HTTPS resource.
+2. Responses are sent in **JSON** format. In case the API request results in an error, it is represented by an `"error": {}` key in the JSON response.
+3. The request method (verb) determines the nature of the action: **GET** fetches data, **POST** creates new records, **PUT** updates existing records.
+4. The API responds with appropriate **HTTP status codes** for all requests.
+5. Use `donotlog=1` as a query parameter on any API call where you don't want the action to be logged in the activity log.
+
+## Authentication
+
+All API requests require authentication via one of two methods:
+
+### Server-Side (API Keys)
+
+Use API keys for server-to-server integrations. Create keys at **Settings > Integrations > API Keys**. Make sure to record the secret key when you create it.
+
+```
+Authorization: Outseta {api_key}:{api_secret}
+```
+
+**Example:**
+```
+Authorization: Outseta ce08fd5a-e1ee-4472-9c5f-b7575d8369b2:74fc1d2242a4eb7336d34b0e40cfbc5f
+```
+
+> **Warning:** Never expose API keys in client-side code. The API key and secret combined give full access to all data in your account.
+
+### Client-Side (Bearer Token)
+
+Do **not** use API keys on the client side — they can be easily copied. Instead, obtain a JWT access token by calling the `POST /tokens` endpoint from the server side with your credentials, then use it on the client:
+
+```
+Authorization: bearer {access_token}
+```
+
+Tokens are JWTs containing claims such as `PersonUid`, `AccountUid`, and subscription details. Tokens expire after approximately one year.
+
+Verify tokens server-side using Outseta's [JWKS endpoint](https://{your-domain}.outseta.com/.well-known/jwks.json).
+
+## Field Selection
+
+When you make an API request, you'll automatically get all the basic information from the main object and its immediate child objects. Referenced objects beyond the first level are returned as `null`.
+
+Change this behavior using the `fields` query parameter:
+
+- **Go deeper** — Request fields lower down in the object tree: `?fields=CurrentSubscription.Plan.*`
+- **Go lighter** — Request only the essentials for faster performance: `?fields=Uid,Name`
+- **Combination** — `?fields=Uid,Name,CurrentSubscription.Plan.Uid`
+- **Wildcard** — Use `*` to get all fields in an object: `?fields=*` or `?fields=CurrentSubscription.Plan.*`
+
+> **Tip:** When expanding nested paths, include `*` and intermediate path segments (e.g., `PersonAccount.*`) to preserve root-level and intermediate fields.
+
+**Examples:**
+
+```
+# Get the current subscription plan UID for an account
+GET /crm/accounts/{uid}?fields=CurrentSubscription.Plan.Uid
+
+# Get the account UID and plan UID for a list of accounts
+GET /crm/accounts?fields=Uid,CurrentSubscription.Plan.Uid
+
+# Get the full plan object for an account's current subscription
+GET /crm/accounts/{uid}?fields=CurrentSubscription.Plan.*
+
+# Get a person with their account and subscription info
+GET /crm/people/{uid}?fields=Uid,PersonAccount.Account.CurrentSubscription.Plan.Uid
+```
+
+If your request includes fields from a child object you will be limited to retrieving **25 items** per page. The maximum for requests not expanding child object fields is **100 items**.
+
+## Pagination
+
+List endpoints return paginated results with a `metadata` object and an `items` array:
+
+```json
+{
+  "metadata": {
+    "limit": 25,
+    "offset": 0,
+    "total": 142
+  },
+  "items": [ ... ]
+}
+```
+
+| Parameter | Type | Default | Description |
+|-----------|------|---------|-------------|
+| `offset` | integer | `0` | Page number (zero-based) |
+| `limit` | integer | `25` | Maximum number of records per page |
+
+**Examples:**
+```
+?offset=0&limit=20    # returns results 1-20
+?offset=1&limit=20    # returns results 21-40
+```
+
+## Sorting
+
+Sort results using the `orderBy` parameter with a property name and direction:
+
+```
+?orderBy=PropertyName+DESC
+```
+
+## Filtering
+
+Filter results by passing entity properties as query parameters.
+
+### Basic Filtering
+
+Filter on any field using the field name as a query parameter:
+
+```
+GET /crm/people?Email=john@example.com
+GET /crm/accounts?AccountStage=2
+```
+
+### Wildcard Matching
+
+| Pattern | Match Type | Example |
+|---------|-----------|---------|
+| `*value` | Ends with | `?Email=*@example.com` |
+| `value*` | Starts with | `?Name=Acme*` |
+| `*value*` | Contains | `?Name=*corp*` |
+
+### Comparison Operators
+
+For advanced filtering, append comparison operators to field names:
+
+| Operator | Description | Example |
+|----------|-------------|---------|
+| `__gt` | Greater than | `Created__gt=2024-01-01` |
+| `__gte` | Greater than or equal | `Amount__gte=100` |
+| `__lt` | Less than | `Created__lt=2024-12-31` |
+| `__lte` | Less than or equal | `Amount__lte=500` |
+| `__ne` | Not equal | `Status__ne=Active` |
+| `__isnull` | Is null (true/false) | `ProfileImageS3Url__isnull=true` |
+
+**Examples:**
+
+```
+# Date filtering
+GET /crm/accounts?Created__gt=2024-01-01
+GET /billing/subscriptions?EndDate__lt=2024-08-01
+
+# Numeric filtering
+GET /billing/invoices?Amount__gte=1000
+
+# Null value filtering
+GET /crm/people?ProfileImageS3Url__isnull=true
+
+# Multiple filters combined with field selection
+GET /billing/subscriptions?StartDate__gte=2024-01-01&Rate__lt=100&DiscountCode__isnull=false&fields=Uid,Amount,StartDate,DiscountCode,Plan.Name
+```
+
+## Account Billing Stages
+
+Account stages reflect the financial standing of each account and are not directly editable — they change automatically based on subscription activity.
+
+| Value | Stage | Description |
+|-------|-------|-------------|
+| `2` | Trialing | Currently on a free trial or free plan |
+| `3` | Subscribing | Active paid subscription (contributes to MRR) |
+| `4` | Canceling | Customer has indicated intent to cancel |
+| `5` | Expired | Subscription has ended after cancellation |
+| `6` | Trial Expired | Free trial ended without conversion to paid |
+
+Filter by stage: `GET /crm/accounts?AccountStage=3` returns all actively subscribing accounts.
+
+## Webhooks
+
+Use **Activity Notifications** to receive real-time callbacks when events occur in Outseta. Configure webhooks at **Settings > Notifications**.
+
+Common events include:
+- `Person Created` / `Person Updated`
+- `Account Created` / `Account Updated`
+- `Subscription Created` / `Subscription Updated`
+
+Always verify webhook signatures using the SHA256 secret provided in the Outseta dashboard.
+
+## Error Responses
+
+| Status Code | Description |
+|-------------|-------------|
+| `200` | Success |
+| `301` | Redirect — HTTP requests are redirected to HTTPS |
+| `400` | Bad request — invalid parameters or Uid format |
+| `401` | Unauthorized — missing or invalid authentication |
+| `404` | Entity not found |
+| `4XX` / `5XX` | Client or server error |
+
+Validation errors return a JSON body with `ErrorMessage` and `PropertyName` fields:
+
+```json
+{
+  "ErrorMessage": "Invalid company email",
+  "PropertyName": "Email"
+}
+```
+
+## Rate Limits
+
+Requests authorized by an API Key should not exceed **4 requests/second**.
+
+## Support
+
+For help regarding the Outseta API please email [support@outseta.com](mailto:support@outseta.com).
+
+ * OpenAPI spec version: v1
+ */
+import {
+  useMutation,
+  useQuery
+} from '@tanstack/react-query';
+import type {
+  MutationFunction,
+  QueryFunction,
+  QueryKey,
+  UseMutationOptions,
+  UseMutationResult,
+  UseQueryOptions,
+  UseQueryResult
+} from '@tanstack/react-query';
+
+import type {
+  DiscountCoupon,
+  DiscountCouponAddDiscountCouponBody,
+  Invoice,
+  InvoiceAddInvoiceBody,
+  PaymentInformation,
+  PaymentInformationSavePaymentInformationBody,
+  Plan,
+  PlanFamily,
+  Subscription,
+  SubscriptionAddOnAddSubscriptionAddOnBody,
+  SubscriptionChangeSubscriptionBody,
+  SubscriptionChangeSubscriptionParams,
+  SubscriptionChangeSubscriptionPreviewBody,
+  SubscriptionChangeSubscriptionPreviewParams,
+  SubscriptionFirstTimeSubscriptionBody,
+  SubscriptionFirstTimeSubscriptionPreviewBody,
+  SubscriptionFirstTimeSubscriptionPreviewParams,
+  SubscriptionSetSubscriptionUpgradeRequiredBody,
+  Transaction,
+  TransactionsAddPaymentTransactionBody,
+  Usage,
+  UsageAddUsageBody
+} from '../outsetaAPI.schemas';
+
+import { customFetch } from '../../mutator';
+
+
+type SecondParameter<T extends (...args: never) => unknown> = Parameters<T>[1];
+
+
+
+/**
+ * @summary Add a new discount coupon. Only one of AmountOff or PercentOff should be set.
+Duration values: 1 = Forever, 2 = Once, 3 = Repeating (DurationInMonths must be set).
+ */
+export const discountCouponAddDiscountCoupon = (
+    discountCouponAddDiscountCouponBody: DiscountCouponAddDiscountCouponBody,
+ options?: SecondParameter<typeof customFetch>,signal?: AbortSignal
+) => {
+      
+      
+      return customFetch<DiscountCoupon>(
+      {url: `/api/v1/billing/discountcoupons`, method: 'POST',
+      headers: {'Content-Type': 'application/json', },
+      data: discountCouponAddDiscountCouponBody, signal
+    },
+      options);
+    }
+  
+
+
+export const getDiscountCouponAddDiscountCouponMutationOptions = <TError = void,
+    TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof discountCouponAddDiscountCoupon>>, TError,{data: DiscountCouponAddDiscountCouponBody}, TContext>, request?: SecondParameter<typeof customFetch>}
+): UseMutationOptions<Awaited<ReturnType<typeof discountCouponAddDiscountCoupon>>, TError,{data: DiscountCouponAddDiscountCouponBody}, TContext> => {
+
+const mutationKey = ['discountCouponAddDiscountCoupon'];
+const {mutation: mutationOptions, request: requestOptions} = options ?
+      options.mutation && 'mutationKey' in options.mutation && options.mutation.mutationKey ?
+      options
+      : {...options, mutation: {...options.mutation, mutationKey}}
+      : {mutation: { mutationKey, }, request: undefined};
+
+      
+
+
+      const mutationFn: MutationFunction<Awaited<ReturnType<typeof discountCouponAddDiscountCoupon>>, {data: DiscountCouponAddDiscountCouponBody}> = (props) => {
+          const {data} = props ?? {};
+
+          return  discountCouponAddDiscountCoupon(data,requestOptions)
+        }
+
+        
+
+
+  return  { mutationFn, ...mutationOptions }}
+
+    export type DiscountCouponAddDiscountCouponMutationResult = NonNullable<Awaited<ReturnType<typeof discountCouponAddDiscountCoupon>>>
+    export type DiscountCouponAddDiscountCouponMutationBody = DiscountCouponAddDiscountCouponBody
+    export type DiscountCouponAddDiscountCouponMutationError = void
+
+    /**
+ * @summary Add a new discount coupon. Only one of AmountOff or PercentOff should be set.
+Duration values: 1 = Forever, 2 = Once, 3 = Repeating (DurationInMonths must be set).
+ */
+export const useDiscountCouponAddDiscountCoupon = <TError = void,
+    TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof discountCouponAddDiscountCoupon>>, TError,{data: DiscountCouponAddDiscountCouponBody}, TContext>, request?: SecondParameter<typeof customFetch>}
+ ): UseMutationResult<
+        Awaited<ReturnType<typeof discountCouponAddDiscountCoupon>>,
+        TError,
+        {data: DiscountCouponAddDiscountCouponBody},
+        TContext
+      > => {
+
+      const mutationOptions = getDiscountCouponAddDiscountCouponMutationOptions(options);
+
+      return useMutation(mutationOptions);
+    }
+    /**
+ * @summary Add a usage entry for an add-on that bills for usage at the end of the month.
+ */
+export const usageAddUsage = (
+    usageAddUsageBody: UsageAddUsageBody,
+ options?: SecondParameter<typeof customFetch>,signal?: AbortSignal
+) => {
+      
+      
+      return customFetch<Usage>(
+      {url: `/api/v1/billing/usage`, method: 'POST',
+      headers: {'Content-Type': 'application/json', },
+      data: usageAddUsageBody, signal
+    },
+      options);
+    }
+  
+
+
+export const getUsageAddUsageMutationOptions = <TError = void,
+    TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof usageAddUsage>>, TError,{data: UsageAddUsageBody}, TContext>, request?: SecondParameter<typeof customFetch>}
+): UseMutationOptions<Awaited<ReturnType<typeof usageAddUsage>>, TError,{data: UsageAddUsageBody}, TContext> => {
+
+const mutationKey = ['usageAddUsage'];
+const {mutation: mutationOptions, request: requestOptions} = options ?
+      options.mutation && 'mutationKey' in options.mutation && options.mutation.mutationKey ?
+      options
+      : {...options, mutation: {...options.mutation, mutationKey}}
+      : {mutation: { mutationKey, }, request: undefined};
+
+      
+
+
+      const mutationFn: MutationFunction<Awaited<ReturnType<typeof usageAddUsage>>, {data: UsageAddUsageBody}> = (props) => {
+          const {data} = props ?? {};
+
+          return  usageAddUsage(data,requestOptions)
+        }
+
+        
+
+
+  return  { mutationFn, ...mutationOptions }}
+
+    export type UsageAddUsageMutationResult = NonNullable<Awaited<ReturnType<typeof usageAddUsage>>>
+    export type UsageAddUsageMutationBody = UsageAddUsageBody
+    export type UsageAddUsageMutationError = void
+
+    /**
+ * @summary Add a usage entry for an add-on that bills for usage at the end of the month.
+ */
+export const useUsageAddUsage = <TError = void,
+    TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof usageAddUsage>>, TError,{data: UsageAddUsageBody}, TContext>, request?: SecondParameter<typeof customFetch>}
+ ): UseMutationResult<
+        Awaited<ReturnType<typeof usageAddUsage>>,
+        TError,
+        {data: UsageAddUsageBody},
+        TContext
+      > => {
+
+      const mutationOptions = getUsageAddUsageMutationOptions(options);
+
+      return useMutation(mutationOptions);
+    }
+    /**
+ * @summary Retrieves all transactions for a given account. Transactions are tied to accounts and invoices.
+BillingTransactionType: Invoice = 1, Payment = 2, Credit = 3, Refund = 4, Chargeback = 5.
+ */
+export const transactionsGetAllTransactionsByAccountId = (
+    accountUid: string | null,
+ options?: SecondParameter<typeof customFetch>,signal?: AbortSignal
+) => {
+      
+      
+      return customFetch<Transaction[]>(
+      {url: `/api/v1/billing/transactions/${accountUid}`, method: 'GET', signal
+    },
+      options);
+    }
+  
+
+
+
+export const getTransactionsGetAllTransactionsByAccountIdQueryKey = (accountUid?: string | null,) => {
+    return [
+    `/api/v1/billing/transactions/${accountUid}`
+    ] as const;
+    }
+
+    
+export const getTransactionsGetAllTransactionsByAccountIdQueryOptions = <TData = Awaited<ReturnType<typeof transactionsGetAllTransactionsByAccountId>>, TError = void>(accountUid: string | null, options?: { query?:UseQueryOptions<Awaited<ReturnType<typeof transactionsGetAllTransactionsByAccountId>>, TError, TData>, request?: SecondParameter<typeof customFetch>}
+) => {
+
+const {query: queryOptions, request: requestOptions} = options ?? {};
+
+  const queryKey =  queryOptions?.queryKey ?? getTransactionsGetAllTransactionsByAccountIdQueryKey(accountUid);
+
+  
+
+    const queryFn: QueryFunction<Awaited<ReturnType<typeof transactionsGetAllTransactionsByAccountId>>> = ({ signal }) => transactionsGetAllTransactionsByAccountId(accountUid, requestOptions, signal);
+
+      
+
+      
+
+   return  { queryKey, queryFn, enabled: !!(accountUid), ...queryOptions} as UseQueryOptions<Awaited<ReturnType<typeof transactionsGetAllTransactionsByAccountId>>, TError, TData> & { queryKey: QueryKey }
+}
+
+export type TransactionsGetAllTransactionsByAccountIdQueryResult = NonNullable<Awaited<ReturnType<typeof transactionsGetAllTransactionsByAccountId>>>
+export type TransactionsGetAllTransactionsByAccountIdQueryError = void
+
+
+/**
+ * @summary Retrieves all transactions for a given account. Transactions are tied to accounts and invoices.
+BillingTransactionType: Invoice = 1, Payment = 2, Credit = 3, Refund = 4, Chargeback = 5.
+ */
+
+export function useTransactionsGetAllTransactionsByAccountId<TData = Awaited<ReturnType<typeof transactionsGetAllTransactionsByAccountId>>, TError = void>(
+ accountUid: string | null, options?: { query?:UseQueryOptions<Awaited<ReturnType<typeof transactionsGetAllTransactionsByAccountId>>, TError, TData>, request?: SecondParameter<typeof customFetch>}
+  
+ ):  UseQueryResult<TData, TError> & { queryKey: QueryKey } {
+
+  const queryOptions = getTransactionsGetAllTransactionsByAccountIdQueryOptions(accountUid,options)
+
+  const query = useQuery(queryOptions) as  UseQueryResult<TData, TError> & { queryKey: QueryKey };
+
+  query.queryKey = queryOptions.queryKey ;
+
+  return query;
+}
+
+
+
+
+/**
+ * @summary Adds a payment to an invoice. If the amount matches the outstanding amount of the invoice,
+the invoice will be marked as Paid.
+ */
+export const transactionsAddPaymentTransaction = (
+    transactionsAddPaymentTransactionBody: TransactionsAddPaymentTransactionBody,
+ options?: SecondParameter<typeof customFetch>,signal?: AbortSignal
+) => {
+      
+      
+      return customFetch<Transaction>(
+      {url: `/api/v1/billing/transactions/payment`, method: 'POST',
+      headers: {'Content-Type': 'application/json', },
+      data: transactionsAddPaymentTransactionBody, signal
+    },
+      options);
+    }
+  
+
+
+export const getTransactionsAddPaymentTransactionMutationOptions = <TError = void,
+    TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof transactionsAddPaymentTransaction>>, TError,{data: TransactionsAddPaymentTransactionBody}, TContext>, request?: SecondParameter<typeof customFetch>}
+): UseMutationOptions<Awaited<ReturnType<typeof transactionsAddPaymentTransaction>>, TError,{data: TransactionsAddPaymentTransactionBody}, TContext> => {
+
+const mutationKey = ['transactionsAddPaymentTransaction'];
+const {mutation: mutationOptions, request: requestOptions} = options ?
+      options.mutation && 'mutationKey' in options.mutation && options.mutation.mutationKey ?
+      options
+      : {...options, mutation: {...options.mutation, mutationKey}}
+      : {mutation: { mutationKey, }, request: undefined};
+
+      
+
+
+      const mutationFn: MutationFunction<Awaited<ReturnType<typeof transactionsAddPaymentTransaction>>, {data: TransactionsAddPaymentTransactionBody}> = (props) => {
+          const {data} = props ?? {};
+
+          return  transactionsAddPaymentTransaction(data,requestOptions)
+        }
+
+        
+
+
+  return  { mutationFn, ...mutationOptions }}
+
+    export type TransactionsAddPaymentTransactionMutationResult = NonNullable<Awaited<ReturnType<typeof transactionsAddPaymentTransaction>>>
+    export type TransactionsAddPaymentTransactionMutationBody = TransactionsAddPaymentTransactionBody
+    export type TransactionsAddPaymentTransactionMutationError = void
+
+    /**
+ * @summary Adds a payment to an invoice. If the amount matches the outstanding amount of the invoice,
+the invoice will be marked as Paid.
+ */
+export const useTransactionsAddPaymentTransaction = <TError = void,
+    TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof transactionsAddPaymentTransaction>>, TError,{data: TransactionsAddPaymentTransactionBody}, TContext>, request?: SecondParameter<typeof customFetch>}
+ ): UseMutationResult<
+        Awaited<ReturnType<typeof transactionsAddPaymentTransaction>>,
+        TError,
+        {data: TransactionsAddPaymentTransactionBody},
+        TContext
+      > => {
+
+      const mutationOptions = getTransactionsAddPaymentTransactionMutationOptions(options);
+
+      return useMutation(mutationOptions);
+    }
+    /**
+ * @summary Update payment information for an account.
+ */
+export const paymentInformationSavePaymentInformation = (
+    paymentInformationSavePaymentInformationBody: PaymentInformationSavePaymentInformationBody,
+ options?: SecondParameter<typeof customFetch>,signal?: AbortSignal
+) => {
+      
+      
+      return customFetch<PaymentInformation>(
+      {url: `/api/v1/billing/paymentinformation`, method: 'POST',
+      headers: {'Content-Type': 'application/json', },
+      data: paymentInformationSavePaymentInformationBody, signal
+    },
+      options);
+    }
+  
+
+
+export const getPaymentInformationSavePaymentInformationMutationOptions = <TError = void,
+    TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof paymentInformationSavePaymentInformation>>, TError,{data: PaymentInformationSavePaymentInformationBody}, TContext>, request?: SecondParameter<typeof customFetch>}
+): UseMutationOptions<Awaited<ReturnType<typeof paymentInformationSavePaymentInformation>>, TError,{data: PaymentInformationSavePaymentInformationBody}, TContext> => {
+
+const mutationKey = ['paymentInformationSavePaymentInformation'];
+const {mutation: mutationOptions, request: requestOptions} = options ?
+      options.mutation && 'mutationKey' in options.mutation && options.mutation.mutationKey ?
+      options
+      : {...options, mutation: {...options.mutation, mutationKey}}
+      : {mutation: { mutationKey, }, request: undefined};
+
+      
+
+
+      const mutationFn: MutationFunction<Awaited<ReturnType<typeof paymentInformationSavePaymentInformation>>, {data: PaymentInformationSavePaymentInformationBody}> = (props) => {
+          const {data} = props ?? {};
+
+          return  paymentInformationSavePaymentInformation(data,requestOptions)
+        }
+
+        
+
+
+  return  { mutationFn, ...mutationOptions }}
+
+    export type PaymentInformationSavePaymentInformationMutationResult = NonNullable<Awaited<ReturnType<typeof paymentInformationSavePaymentInformation>>>
+    export type PaymentInformationSavePaymentInformationMutationBody = PaymentInformationSavePaymentInformationBody
+    export type PaymentInformationSavePaymentInformationMutationError = void
+
+    /**
+ * @summary Update payment information for an account.
+ */
+export const usePaymentInformationSavePaymentInformation = <TError = void,
+    TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof paymentInformationSavePaymentInformation>>, TError,{data: PaymentInformationSavePaymentInformationBody}, TContext>, request?: SecondParameter<typeof customFetch>}
+ ): UseMutationResult<
+        Awaited<ReturnType<typeof paymentInformationSavePaymentInformation>>,
+        TError,
+        {data: PaymentInformationSavePaymentInformationBody},
+        TContext
+      > => {
+
+      const mutationOptions = getPaymentInformationSavePaymentInformationMutationOptions(options);
+
+      return useMutation(mutationOptions);
+    }
+    /**
+ * @summary Add an add-on to a subscription.
+ */
+export const subscriptionAddOnAddSubscriptionAddOn = (
+    subscriptionAddOnAddSubscriptionAddOnBody: SubscriptionAddOnAddSubscriptionAddOnBody,
+ options?: SecondParameter<typeof customFetch>,signal?: AbortSignal
+) => {
+      
+      
+      return customFetch<Blob>(
+      {url: `/api/v1/billing/subscriptionaddons`, method: 'POST',
+      headers: {'Content-Type': 'application/json', },
+      data: subscriptionAddOnAddSubscriptionAddOnBody,
+        responseType: 'blob', signal
+    },
+      options);
+    }
+  
+
+
+export const getSubscriptionAddOnAddSubscriptionAddOnMutationOptions = <TError = void,
+    TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof subscriptionAddOnAddSubscriptionAddOn>>, TError,{data: SubscriptionAddOnAddSubscriptionAddOnBody}, TContext>, request?: SecondParameter<typeof customFetch>}
+): UseMutationOptions<Awaited<ReturnType<typeof subscriptionAddOnAddSubscriptionAddOn>>, TError,{data: SubscriptionAddOnAddSubscriptionAddOnBody}, TContext> => {
+
+const mutationKey = ['subscriptionAddOnAddSubscriptionAddOn'];
+const {mutation: mutationOptions, request: requestOptions} = options ?
+      options.mutation && 'mutationKey' in options.mutation && options.mutation.mutationKey ?
+      options
+      : {...options, mutation: {...options.mutation, mutationKey}}
+      : {mutation: { mutationKey, }, request: undefined};
+
+      
+
+
+      const mutationFn: MutationFunction<Awaited<ReturnType<typeof subscriptionAddOnAddSubscriptionAddOn>>, {data: SubscriptionAddOnAddSubscriptionAddOnBody}> = (props) => {
+          const {data} = props ?? {};
+
+          return  subscriptionAddOnAddSubscriptionAddOn(data,requestOptions)
+        }
+
+        
+
+
+  return  { mutationFn, ...mutationOptions }}
+
+    export type SubscriptionAddOnAddSubscriptionAddOnMutationResult = NonNullable<Awaited<ReturnType<typeof subscriptionAddOnAddSubscriptionAddOn>>>
+    export type SubscriptionAddOnAddSubscriptionAddOnMutationBody = SubscriptionAddOnAddSubscriptionAddOnBody
+    export type SubscriptionAddOnAddSubscriptionAddOnMutationError = void
+
+    /**
+ * @summary Add an add-on to a subscription.
+ */
+export const useSubscriptionAddOnAddSubscriptionAddOn = <TError = void,
+    TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof subscriptionAddOnAddSubscriptionAddOn>>, TError,{data: SubscriptionAddOnAddSubscriptionAddOnBody}, TContext>, request?: SecondParameter<typeof customFetch>}
+ ): UseMutationResult<
+        Awaited<ReturnType<typeof subscriptionAddOnAddSubscriptionAddOn>>,
+        TError,
+        {data: SubscriptionAddOnAddSubscriptionAddOnBody},
+        TContext
+      > => {
+
+      const mutationOptions = getSubscriptionAddOnAddSubscriptionAddOnMutationOptions(options);
+
+      return useMutation(mutationOptions);
+    }
+    /**
+ * @summary Create an ad-hoc invoice for a given account.
+ */
+export const invoiceAddInvoice = (
+    invoiceAddInvoiceBody: InvoiceAddInvoiceBody,
+ options?: SecondParameter<typeof customFetch>,signal?: AbortSignal
+) => {
+      
+      
+      return customFetch<Invoice>(
+      {url: `/api/v1/billing/invoices`, method: 'POST',
+      headers: {'Content-Type': 'application/json', },
+      data: invoiceAddInvoiceBody, signal
+    },
+      options);
+    }
+  
+
+
+export const getInvoiceAddInvoiceMutationOptions = <TError = void,
+    TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof invoiceAddInvoice>>, TError,{data: InvoiceAddInvoiceBody}, TContext>, request?: SecondParameter<typeof customFetch>}
+): UseMutationOptions<Awaited<ReturnType<typeof invoiceAddInvoice>>, TError,{data: InvoiceAddInvoiceBody}, TContext> => {
+
+const mutationKey = ['invoiceAddInvoice'];
+const {mutation: mutationOptions, request: requestOptions} = options ?
+      options.mutation && 'mutationKey' in options.mutation && options.mutation.mutationKey ?
+      options
+      : {...options, mutation: {...options.mutation, mutationKey}}
+      : {mutation: { mutationKey, }, request: undefined};
+
+      
+
+
+      const mutationFn: MutationFunction<Awaited<ReturnType<typeof invoiceAddInvoice>>, {data: InvoiceAddInvoiceBody}> = (props) => {
+          const {data} = props ?? {};
+
+          return  invoiceAddInvoice(data,requestOptions)
+        }
+
+        
+
+
+  return  { mutationFn, ...mutationOptions }}
+
+    export type InvoiceAddInvoiceMutationResult = NonNullable<Awaited<ReturnType<typeof invoiceAddInvoice>>>
+    export type InvoiceAddInvoiceMutationBody = InvoiceAddInvoiceBody
+    export type InvoiceAddInvoiceMutationError = void
+
+    /**
+ * @summary Create an ad-hoc invoice for a given account.
+ */
+export const useInvoiceAddInvoice = <TError = void,
+    TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof invoiceAddInvoice>>, TError,{data: InvoiceAddInvoiceBody}, TContext>, request?: SecondParameter<typeof customFetch>}
+ ): UseMutationResult<
+        Awaited<ReturnType<typeof invoiceAddInvoice>>,
+        TError,
+        {data: InvoiceAddInvoiceBody},
+        TContext
+      > => {
+
+      const mutationOptions = getInvoiceAddInvoiceMutationOptions(options);
+
+      return useMutation(mutationOptions);
+    }
+    /**
+ * @summary Retrieves a subscription.
+ */
+export const subscriptionGetSubscription = (
+    subscriptionUid: string | null,
+ options?: SecondParameter<typeof customFetch>,signal?: AbortSignal
+) => {
+      
+      
+      return customFetch<Subscription>(
+      {url: `/api/v1/billing/subscriptions/${subscriptionUid}`, method: 'GET', signal
+    },
+      options);
+    }
+  
+
+
+
+export const getSubscriptionGetSubscriptionQueryKey = (subscriptionUid?: string | null,) => {
+    return [
+    `/api/v1/billing/subscriptions/${subscriptionUid}`
+    ] as const;
+    }
+
+    
+export const getSubscriptionGetSubscriptionQueryOptions = <TData = Awaited<ReturnType<typeof subscriptionGetSubscription>>, TError = void>(subscriptionUid: string | null, options?: { query?:UseQueryOptions<Awaited<ReturnType<typeof subscriptionGetSubscription>>, TError, TData>, request?: SecondParameter<typeof customFetch>}
+) => {
+
+const {query: queryOptions, request: requestOptions} = options ?? {};
+
+  const queryKey =  queryOptions?.queryKey ?? getSubscriptionGetSubscriptionQueryKey(subscriptionUid);
+
+  
+
+    const queryFn: QueryFunction<Awaited<ReturnType<typeof subscriptionGetSubscription>>> = ({ signal }) => subscriptionGetSubscription(subscriptionUid, requestOptions, signal);
+
+      
+
+      
+
+   return  { queryKey, queryFn, enabled: !!(subscriptionUid), ...queryOptions} as UseQueryOptions<Awaited<ReturnType<typeof subscriptionGetSubscription>>, TError, TData> & { queryKey: QueryKey }
+}
+
+export type SubscriptionGetSubscriptionQueryResult = NonNullable<Awaited<ReturnType<typeof subscriptionGetSubscription>>>
+export type SubscriptionGetSubscriptionQueryError = void
+
+
+/**
+ * @summary Retrieves a subscription.
+ */
+
+export function useSubscriptionGetSubscription<TData = Awaited<ReturnType<typeof subscriptionGetSubscription>>, TError = void>(
+ subscriptionUid: string | null, options?: { query?:UseQueryOptions<Awaited<ReturnType<typeof subscriptionGetSubscription>>, TError, TData>, request?: SecondParameter<typeof customFetch>}
+  
+ ):  UseQueryResult<TData, TError> & { queryKey: QueryKey } {
+
+  const queryOptions = getSubscriptionGetSubscriptionQueryOptions(subscriptionUid,options)
+
+  const query = useQuery(queryOptions) as  UseQueryResult<TData, TError> & { queryKey: QueryKey };
+
+  query.queryKey = queryOptions.queryKey ;
+
+  return query;
+}
+
+
+
+
+/**
+ * @summary Add a discount to a subscription.
+ */
+export const subscriptionAddDiscountToSubscription = (
+    subscriptionUid: string | null,
+    discountUid: string | null,
+ options?: SecondParameter<typeof customFetch>,signal?: AbortSignal
+) => {
+      
+      
+      return customFetch<Blob>(
+      {url: `/api/v1/billing/subscriptions/${subscriptionUid}/discounts/${discountUid}`, method: 'POST',
+        responseType: 'blob', signal
+    },
+      options);
+    }
+  
+
+
+export const getSubscriptionAddDiscountToSubscriptionMutationOptions = <TError = void,
+    TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof subscriptionAddDiscountToSubscription>>, TError,{subscriptionUid: string | null;discountUid: string | null}, TContext>, request?: SecondParameter<typeof customFetch>}
+): UseMutationOptions<Awaited<ReturnType<typeof subscriptionAddDiscountToSubscription>>, TError,{subscriptionUid: string | null;discountUid: string | null}, TContext> => {
+
+const mutationKey = ['subscriptionAddDiscountToSubscription'];
+const {mutation: mutationOptions, request: requestOptions} = options ?
+      options.mutation && 'mutationKey' in options.mutation && options.mutation.mutationKey ?
+      options
+      : {...options, mutation: {...options.mutation, mutationKey}}
+      : {mutation: { mutationKey, }, request: undefined};
+
+      
+
+
+      const mutationFn: MutationFunction<Awaited<ReturnType<typeof subscriptionAddDiscountToSubscription>>, {subscriptionUid: string | null;discountUid: string | null}> = (props) => {
+          const {subscriptionUid,discountUid} = props ?? {};
+
+          return  subscriptionAddDiscountToSubscription(subscriptionUid,discountUid,requestOptions)
+        }
+
+        
+
+
+  return  { mutationFn, ...mutationOptions }}
+
+    export type SubscriptionAddDiscountToSubscriptionMutationResult = NonNullable<Awaited<ReturnType<typeof subscriptionAddDiscountToSubscription>>>
+    
+    export type SubscriptionAddDiscountToSubscriptionMutationError = void
+
+    /**
+ * @summary Add a discount to a subscription.
+ */
+export const useSubscriptionAddDiscountToSubscription = <TError = void,
+    TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof subscriptionAddDiscountToSubscription>>, TError,{subscriptionUid: string | null;discountUid: string | null}, TContext>, request?: SecondParameter<typeof customFetch>}
+ ): UseMutationResult<
+        Awaited<ReturnType<typeof subscriptionAddDiscountToSubscription>>,
+        TError,
+        {subscriptionUid: string | null;discountUid: string | null},
+        TContext
+      > => {
+
+      const mutationOptions = getSubscriptionAddDiscountToSubscriptionMutationOptions(options);
+
+      return useMutation(mutationOptions);
+    }
+    /**
+ * @summary Indicate that an upgrade of plan is required. When a subscription is flagged, next time
+the user authenticates the authentication widget will prompt the user to change plan.
+ */
+export const subscriptionSetSubscriptionUpgradeRequired = (
+    subscriptionUid: string | null,
+    subscriptionSetSubscriptionUpgradeRequiredBody: SubscriptionSetSubscriptionUpgradeRequiredBody,
+ options?: SecondParameter<typeof customFetch>,) => {
+      
+      
+      return customFetch<Subscription>(
+      {url: `/api/v1/billing/subscriptions/${subscriptionUid}/setsubscriptionupgraderequired`, method: 'PUT',
+      headers: {'Content-Type': 'application/json', },
+      data: subscriptionSetSubscriptionUpgradeRequiredBody
+    },
+      options);
+    }
+  
+
+
+export const getSubscriptionSetSubscriptionUpgradeRequiredMutationOptions = <TError = void,
+    TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof subscriptionSetSubscriptionUpgradeRequired>>, TError,{subscriptionUid: string | null;data: SubscriptionSetSubscriptionUpgradeRequiredBody}, TContext>, request?: SecondParameter<typeof customFetch>}
+): UseMutationOptions<Awaited<ReturnType<typeof subscriptionSetSubscriptionUpgradeRequired>>, TError,{subscriptionUid: string | null;data: SubscriptionSetSubscriptionUpgradeRequiredBody}, TContext> => {
+
+const mutationKey = ['subscriptionSetSubscriptionUpgradeRequired'];
+const {mutation: mutationOptions, request: requestOptions} = options ?
+      options.mutation && 'mutationKey' in options.mutation && options.mutation.mutationKey ?
+      options
+      : {...options, mutation: {...options.mutation, mutationKey}}
+      : {mutation: { mutationKey, }, request: undefined};
+
+      
+
+
+      const mutationFn: MutationFunction<Awaited<ReturnType<typeof subscriptionSetSubscriptionUpgradeRequired>>, {subscriptionUid: string | null;data: SubscriptionSetSubscriptionUpgradeRequiredBody}> = (props) => {
+          const {subscriptionUid,data} = props ?? {};
+
+          return  subscriptionSetSubscriptionUpgradeRequired(subscriptionUid,data,requestOptions)
+        }
+
+        
+
+
+  return  { mutationFn, ...mutationOptions }}
+
+    export type SubscriptionSetSubscriptionUpgradeRequiredMutationResult = NonNullable<Awaited<ReturnType<typeof subscriptionSetSubscriptionUpgradeRequired>>>
+    export type SubscriptionSetSubscriptionUpgradeRequiredMutationBody = SubscriptionSetSubscriptionUpgradeRequiredBody
+    export type SubscriptionSetSubscriptionUpgradeRequiredMutationError = void
+
+    /**
+ * @summary Indicate that an upgrade of plan is required. When a subscription is flagged, next time
+the user authenticates the authentication widget will prompt the user to change plan.
+ */
+export const useSubscriptionSetSubscriptionUpgradeRequired = <TError = void,
+    TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof subscriptionSetSubscriptionUpgradeRequired>>, TError,{subscriptionUid: string | null;data: SubscriptionSetSubscriptionUpgradeRequiredBody}, TContext>, request?: SecondParameter<typeof customFetch>}
+ ): UseMutationResult<
+        Awaited<ReturnType<typeof subscriptionSetSubscriptionUpgradeRequired>>,
+        TError,
+        {subscriptionUid: string | null;data: SubscriptionSetSubscriptionUpgradeRequiredBody},
+        TContext
+      > => {
+
+      const mutationOptions = getSubscriptionSetSubscriptionUpgradeRequiredMutationOptions(options);
+
+      return useMutation(mutationOptions);
+    }
+    /**
+ * @summary Preview what the initial or renewal invoice would look like if an account were to register
+with this subscription. Returns an invoice object with information about the amount outstanding.
+BillingRenewalTerm values: 1 = Monthly, 2 = Yearly, 3 = Quarterly, 4 = OneTime.
+Pass asOf=renewal to see the renewal invoice instead of the initial invoice.
+ */
+export const subscriptionFirstTimeSubscriptionPreview = (
+    subscriptionFirstTimeSubscriptionPreviewBody: SubscriptionFirstTimeSubscriptionPreviewBody,
+    params?: SubscriptionFirstTimeSubscriptionPreviewParams,
+ options?: SecondParameter<typeof customFetch>,signal?: AbortSignal
+) => {
+      
+      
+      return customFetch<Invoice>(
+      {url: `/api/v1/billing/subscriptions/compute-charge-summary`, method: 'POST',
+      headers: {'Content-Type': 'application/json', },
+      data: subscriptionFirstTimeSubscriptionPreviewBody,
+        params, signal
+    },
+      options);
+    }
+  
+
+
+export const getSubscriptionFirstTimeSubscriptionPreviewMutationOptions = <TError = unknown,
+    TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof subscriptionFirstTimeSubscriptionPreview>>, TError,{data: SubscriptionFirstTimeSubscriptionPreviewBody;params?: SubscriptionFirstTimeSubscriptionPreviewParams}, TContext>, request?: SecondParameter<typeof customFetch>}
+): UseMutationOptions<Awaited<ReturnType<typeof subscriptionFirstTimeSubscriptionPreview>>, TError,{data: SubscriptionFirstTimeSubscriptionPreviewBody;params?: SubscriptionFirstTimeSubscriptionPreviewParams}, TContext> => {
+
+const mutationKey = ['subscriptionFirstTimeSubscriptionPreview'];
+const {mutation: mutationOptions, request: requestOptions} = options ?
+      options.mutation && 'mutationKey' in options.mutation && options.mutation.mutationKey ?
+      options
+      : {...options, mutation: {...options.mutation, mutationKey}}
+      : {mutation: { mutationKey, }, request: undefined};
+
+      
+
+
+      const mutationFn: MutationFunction<Awaited<ReturnType<typeof subscriptionFirstTimeSubscriptionPreview>>, {data: SubscriptionFirstTimeSubscriptionPreviewBody;params?: SubscriptionFirstTimeSubscriptionPreviewParams}> = (props) => {
+          const {data,params} = props ?? {};
+
+          return  subscriptionFirstTimeSubscriptionPreview(data,params,requestOptions)
+        }
+
+        
+
+
+  return  { mutationFn, ...mutationOptions }}
+
+    export type SubscriptionFirstTimeSubscriptionPreviewMutationResult = NonNullable<Awaited<ReturnType<typeof subscriptionFirstTimeSubscriptionPreview>>>
+    export type SubscriptionFirstTimeSubscriptionPreviewMutationBody = SubscriptionFirstTimeSubscriptionPreviewBody
+    export type SubscriptionFirstTimeSubscriptionPreviewMutationError = unknown
+
+    /**
+ * @summary Preview what the initial or renewal invoice would look like if an account were to register
+with this subscription. Returns an invoice object with information about the amount outstanding.
+BillingRenewalTerm values: 1 = Monthly, 2 = Yearly, 3 = Quarterly, 4 = OneTime.
+Pass asOf=renewal to see the renewal invoice instead of the initial invoice.
+ */
+export const useSubscriptionFirstTimeSubscriptionPreview = <TError = unknown,
+    TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof subscriptionFirstTimeSubscriptionPreview>>, TError,{data: SubscriptionFirstTimeSubscriptionPreviewBody;params?: SubscriptionFirstTimeSubscriptionPreviewParams}, TContext>, request?: SecondParameter<typeof customFetch>}
+ ): UseMutationResult<
+        Awaited<ReturnType<typeof subscriptionFirstTimeSubscriptionPreview>>,
+        TError,
+        {data: SubscriptionFirstTimeSubscriptionPreviewBody;params?: SubscriptionFirstTimeSubscriptionPreviewParams},
+        TContext
+      > => {
+
+      const mutationOptions = getSubscriptionFirstTimeSubscriptionPreviewMutationOptions(options);
+
+      return useMutation(mutationOptions);
+    }
+    /**
+ * @summary Add a subscription to an account for the first time. Returns an invoice object
+with information about the amount outstanding.
+ */
+export const subscriptionFirstTimeSubscription = (
+    subscriptionFirstTimeSubscriptionBody: SubscriptionFirstTimeSubscriptionBody,
+ options?: SecondParameter<typeof customFetch>,) => {
+      
+      
+      return customFetch<Invoice>(
+      {url: `/api/v1/billing/subscriptions/firsttimesubscription`, method: 'PUT',
+      headers: {'Content-Type': 'application/json', },
+      data: subscriptionFirstTimeSubscriptionBody
+    },
+      options);
+    }
+  
+
+
+export const getSubscriptionFirstTimeSubscriptionMutationOptions = <TError = void,
+    TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof subscriptionFirstTimeSubscription>>, TError,{data: SubscriptionFirstTimeSubscriptionBody}, TContext>, request?: SecondParameter<typeof customFetch>}
+): UseMutationOptions<Awaited<ReturnType<typeof subscriptionFirstTimeSubscription>>, TError,{data: SubscriptionFirstTimeSubscriptionBody}, TContext> => {
+
+const mutationKey = ['subscriptionFirstTimeSubscription'];
+const {mutation: mutationOptions, request: requestOptions} = options ?
+      options.mutation && 'mutationKey' in options.mutation && options.mutation.mutationKey ?
+      options
+      : {...options, mutation: {...options.mutation, mutationKey}}
+      : {mutation: { mutationKey, }, request: undefined};
+
+      
+
+
+      const mutationFn: MutationFunction<Awaited<ReturnType<typeof subscriptionFirstTimeSubscription>>, {data: SubscriptionFirstTimeSubscriptionBody}> = (props) => {
+          const {data} = props ?? {};
+
+          return  subscriptionFirstTimeSubscription(data,requestOptions)
+        }
+
+        
+
+
+  return  { mutationFn, ...mutationOptions }}
+
+    export type SubscriptionFirstTimeSubscriptionMutationResult = NonNullable<Awaited<ReturnType<typeof subscriptionFirstTimeSubscription>>>
+    export type SubscriptionFirstTimeSubscriptionMutationBody = SubscriptionFirstTimeSubscriptionBody
+    export type SubscriptionFirstTimeSubscriptionMutationError = void
+
+    /**
+ * @summary Add a subscription to an account for the first time. Returns an invoice object
+with information about the amount outstanding.
+ */
+export const useSubscriptionFirstTimeSubscription = <TError = void,
+    TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof subscriptionFirstTimeSubscription>>, TError,{data: SubscriptionFirstTimeSubscriptionBody}, TContext>, request?: SecondParameter<typeof customFetch>}
+ ): UseMutationResult<
+        Awaited<ReturnType<typeof subscriptionFirstTimeSubscription>>,
+        TError,
+        {data: SubscriptionFirstTimeSubscriptionBody},
+        TContext
+      > => {
+
+      const mutationOptions = getSubscriptionFirstTimeSubscriptionMutationOptions(options);
+
+      return useMutation(mutationOptions);
+    }
+    /**
+ * @summary Preview what the invoice would look like when changing a subscription. Returns an invoice object
+with information about the amount outstanding. This method does not commit the subscription change.
+ */
+export const subscriptionChangeSubscriptionPreview = (
+    subscriptionUid: string | null,
+    subscriptionChangeSubscriptionPreviewBody: SubscriptionChangeSubscriptionPreviewBody,
+    params?: SubscriptionChangeSubscriptionPreviewParams,
+ options?: SecondParameter<typeof customFetch>,) => {
+      
+      
+      return customFetch<Invoice>(
+      {url: `/api/v1/billing/subscriptions/${subscriptionUid}/changesubscriptionpreview`, method: 'PUT',
+      headers: {'Content-Type': 'application/json', },
+      data: subscriptionChangeSubscriptionPreviewBody,
+        params
+    },
+      options);
+    }
+  
+
+
+export const getSubscriptionChangeSubscriptionPreviewMutationOptions = <TError = void,
+    TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof subscriptionChangeSubscriptionPreview>>, TError,{subscriptionUid: string | null;data: SubscriptionChangeSubscriptionPreviewBody;params?: SubscriptionChangeSubscriptionPreviewParams}, TContext>, request?: SecondParameter<typeof customFetch>}
+): UseMutationOptions<Awaited<ReturnType<typeof subscriptionChangeSubscriptionPreview>>, TError,{subscriptionUid: string | null;data: SubscriptionChangeSubscriptionPreviewBody;params?: SubscriptionChangeSubscriptionPreviewParams}, TContext> => {
+
+const mutationKey = ['subscriptionChangeSubscriptionPreview'];
+const {mutation: mutationOptions, request: requestOptions} = options ?
+      options.mutation && 'mutationKey' in options.mutation && options.mutation.mutationKey ?
+      options
+      : {...options, mutation: {...options.mutation, mutationKey}}
+      : {mutation: { mutationKey, }, request: undefined};
+
+      
+
+
+      const mutationFn: MutationFunction<Awaited<ReturnType<typeof subscriptionChangeSubscriptionPreview>>, {subscriptionUid: string | null;data: SubscriptionChangeSubscriptionPreviewBody;params?: SubscriptionChangeSubscriptionPreviewParams}> = (props) => {
+          const {subscriptionUid,data,params} = props ?? {};
+
+          return  subscriptionChangeSubscriptionPreview(subscriptionUid,data,params,requestOptions)
+        }
+
+        
+
+
+  return  { mutationFn, ...mutationOptions }}
+
+    export type SubscriptionChangeSubscriptionPreviewMutationResult = NonNullable<Awaited<ReturnType<typeof subscriptionChangeSubscriptionPreview>>>
+    export type SubscriptionChangeSubscriptionPreviewMutationBody = SubscriptionChangeSubscriptionPreviewBody
+    export type SubscriptionChangeSubscriptionPreviewMutationError = void
+
+    /**
+ * @summary Preview what the invoice would look like when changing a subscription. Returns an invoice object
+with information about the amount outstanding. This method does not commit the subscription change.
+ */
+export const useSubscriptionChangeSubscriptionPreview = <TError = void,
+    TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof subscriptionChangeSubscriptionPreview>>, TError,{subscriptionUid: string | null;data: SubscriptionChangeSubscriptionPreviewBody;params?: SubscriptionChangeSubscriptionPreviewParams}, TContext>, request?: SecondParameter<typeof customFetch>}
+ ): UseMutationResult<
+        Awaited<ReturnType<typeof subscriptionChangeSubscriptionPreview>>,
+        TError,
+        {subscriptionUid: string | null;data: SubscriptionChangeSubscriptionPreviewBody;params?: SubscriptionChangeSubscriptionPreviewParams},
+        TContext
+      > => {
+
+      const mutationOptions = getSubscriptionChangeSubscriptionPreviewMutationOptions(options);
+
+      return useMutation(mutationOptions);
+    }
+    /**
+ * @summary Change a subscription on an account. Returns an invoice object with information about
+the amount outstanding.
+ */
+export const subscriptionChangeSubscription = (
+    subscriptionUid: string | null,
+    subscriptionChangeSubscriptionBody: SubscriptionChangeSubscriptionBody,
+    params?: SubscriptionChangeSubscriptionParams,
+ options?: SecondParameter<typeof customFetch>,) => {
+      
+      
+      return customFetch<Subscription>(
+      {url: `/api/v1/billing/subscriptions/${subscriptionUid}/changesubscription`, method: 'PUT',
+      headers: {'Content-Type': 'application/json', },
+      data: subscriptionChangeSubscriptionBody,
+        params
+    },
+      options);
+    }
+  
+
+
+export const getSubscriptionChangeSubscriptionMutationOptions = <TError = void,
+    TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof subscriptionChangeSubscription>>, TError,{subscriptionUid: string | null;data: SubscriptionChangeSubscriptionBody;params?: SubscriptionChangeSubscriptionParams}, TContext>, request?: SecondParameter<typeof customFetch>}
+): UseMutationOptions<Awaited<ReturnType<typeof subscriptionChangeSubscription>>, TError,{subscriptionUid: string | null;data: SubscriptionChangeSubscriptionBody;params?: SubscriptionChangeSubscriptionParams}, TContext> => {
+
+const mutationKey = ['subscriptionChangeSubscription'];
+const {mutation: mutationOptions, request: requestOptions} = options ?
+      options.mutation && 'mutationKey' in options.mutation && options.mutation.mutationKey ?
+      options
+      : {...options, mutation: {...options.mutation, mutationKey}}
+      : {mutation: { mutationKey, }, request: undefined};
+
+      
+
+
+      const mutationFn: MutationFunction<Awaited<ReturnType<typeof subscriptionChangeSubscription>>, {subscriptionUid: string | null;data: SubscriptionChangeSubscriptionBody;params?: SubscriptionChangeSubscriptionParams}> = (props) => {
+          const {subscriptionUid,data,params} = props ?? {};
+
+          return  subscriptionChangeSubscription(subscriptionUid,data,params,requestOptions)
+        }
+
+        
+
+
+  return  { mutationFn, ...mutationOptions }}
+
+    export type SubscriptionChangeSubscriptionMutationResult = NonNullable<Awaited<ReturnType<typeof subscriptionChangeSubscription>>>
+    export type SubscriptionChangeSubscriptionMutationBody = SubscriptionChangeSubscriptionBody
+    export type SubscriptionChangeSubscriptionMutationError = void
+
+    /**
+ * @summary Change a subscription on an account. Returns an invoice object with information about
+the amount outstanding.
+ */
+export const useSubscriptionChangeSubscription = <TError = void,
+    TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof subscriptionChangeSubscription>>, TError,{subscriptionUid: string | null;data: SubscriptionChangeSubscriptionBody;params?: SubscriptionChangeSubscriptionParams}, TContext>, request?: SecondParameter<typeof customFetch>}
+ ): UseMutationResult<
+        Awaited<ReturnType<typeof subscriptionChangeSubscription>>,
+        TError,
+        {subscriptionUid: string | null;data: SubscriptionChangeSubscriptionBody;params?: SubscriptionChangeSubscriptionParams},
+        TContext
+      > => {
+
+      const mutationOptions = getSubscriptionChangeSubscriptionMutationOptions(options);
+
+      return useMutation(mutationOptions);
+    }
+    /**
+ * @summary Retrieves all plans.
+ */
+export const planGetAllPlans = (
+    
+ options?: SecondParameter<typeof customFetch>,signal?: AbortSignal
+) => {
+      
+      
+      return customFetch<Plan[]>(
+      {url: `/api/v1/billing/plans`, method: 'GET', signal
+    },
+      options);
+    }
+  
+
+
+
+export const getPlanGetAllPlansQueryKey = () => {
+    return [
+    `/api/v1/billing/plans`
+    ] as const;
+    }
+
+    
+export const getPlanGetAllPlansQueryOptions = <TData = Awaited<ReturnType<typeof planGetAllPlans>>, TError = unknown>( options?: { query?:UseQueryOptions<Awaited<ReturnType<typeof planGetAllPlans>>, TError, TData>, request?: SecondParameter<typeof customFetch>}
+) => {
+
+const {query: queryOptions, request: requestOptions} = options ?? {};
+
+  const queryKey =  queryOptions?.queryKey ?? getPlanGetAllPlansQueryKey();
+
+  
+
+    const queryFn: QueryFunction<Awaited<ReturnType<typeof planGetAllPlans>>> = ({ signal }) => planGetAllPlans(requestOptions, signal);
+
+      
+
+      
+
+   return  { queryKey, queryFn, ...queryOptions} as UseQueryOptions<Awaited<ReturnType<typeof planGetAllPlans>>, TError, TData> & { queryKey: QueryKey }
+}
+
+export type PlanGetAllPlansQueryResult = NonNullable<Awaited<ReturnType<typeof planGetAllPlans>>>
+export type PlanGetAllPlansQueryError = unknown
+
+
+/**
+ * @summary Retrieves all plans.
+ */
+
+export function usePlanGetAllPlans<TData = Awaited<ReturnType<typeof planGetAllPlans>>, TError = unknown>(
+  options?: { query?:UseQueryOptions<Awaited<ReturnType<typeof planGetAllPlans>>, TError, TData>, request?: SecondParameter<typeof customFetch>}
+  
+ ):  UseQueryResult<TData, TError> & { queryKey: QueryKey } {
+
+  const queryOptions = getPlanGetAllPlansQueryOptions(options)
+
+  const query = useQuery(queryOptions) as  UseQueryResult<TData, TError> & { queryKey: QueryKey };
+
+  query.queryKey = queryOptions.queryKey ;
+
+  return query;
+}
+
+
+
+
+/**
+ * @summary Retrieves all plan families.
+ */
+export const planFamilyGetAllPlanFamilies = (
+    
+ options?: SecondParameter<typeof customFetch>,signal?: AbortSignal
+) => {
+      
+      
+      return customFetch<PlanFamily[]>(
+      {url: `/api/v1/billing/planfamilies`, method: 'GET', signal
+    },
+      options);
+    }
+  
+
+
+
+export const getPlanFamilyGetAllPlanFamiliesQueryKey = () => {
+    return [
+    `/api/v1/billing/planfamilies`
+    ] as const;
+    }
+
+    
+export const getPlanFamilyGetAllPlanFamiliesQueryOptions = <TData = Awaited<ReturnType<typeof planFamilyGetAllPlanFamilies>>, TError = unknown>( options?: { query?:UseQueryOptions<Awaited<ReturnType<typeof planFamilyGetAllPlanFamilies>>, TError, TData>, request?: SecondParameter<typeof customFetch>}
+) => {
+
+const {query: queryOptions, request: requestOptions} = options ?? {};
+
+  const queryKey =  queryOptions?.queryKey ?? getPlanFamilyGetAllPlanFamiliesQueryKey();
+
+  
+
+    const queryFn: QueryFunction<Awaited<ReturnType<typeof planFamilyGetAllPlanFamilies>>> = ({ signal }) => planFamilyGetAllPlanFamilies(requestOptions, signal);
+
+      
+
+      
+
+   return  { queryKey, queryFn, ...queryOptions} as UseQueryOptions<Awaited<ReturnType<typeof planFamilyGetAllPlanFamilies>>, TError, TData> & { queryKey: QueryKey }
+}
+
+export type PlanFamilyGetAllPlanFamiliesQueryResult = NonNullable<Awaited<ReturnType<typeof planFamilyGetAllPlanFamilies>>>
+export type PlanFamilyGetAllPlanFamiliesQueryError = unknown
+
+
+/**
+ * @summary Retrieves all plan families.
+ */
+
+export function usePlanFamilyGetAllPlanFamilies<TData = Awaited<ReturnType<typeof planFamilyGetAllPlanFamilies>>, TError = unknown>(
+  options?: { query?:UseQueryOptions<Awaited<ReturnType<typeof planFamilyGetAllPlanFamilies>>, TError, TData>, request?: SecondParameter<typeof customFetch>}
+  
+ ):  UseQueryResult<TData, TError> & { queryKey: QueryKey } {
+
+  const queryOptions = getPlanFamilyGetAllPlanFamiliesQueryOptions(options)
+
+  const query = useQuery(queryOptions) as  UseQueryResult<TData, TError> & { queryKey: QueryKey };
+
+  query.queryKey = queryOptions.queryKey ;
+
+  return query;
+}
+
+
+
+