@outseta/api-client 0.1.1 → 0.2.1

package/src/generated/billing/billing.ts

@@ -0,0 +1,1006 @@
+// @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 type {
+  DiscountCoupon,
+  DiscountCouponAddDiscountCouponBody,
+  Invoice,
+  InvoiceAddInvoiceBody,
+  PaymentInformation,
+  PaymentInformationSavePaymentInformationBody,
+  Plan,
+  PlanFamily,
+  Subscription,
+  SubscriptionAddOnAddSubscriptionAddOnBody,
+  SubscriptionChangeSubscriptionBody,
+  SubscriptionChangeSubscriptionParams,
+  SubscriptionChangeSubscriptionPreviewBody,
+  SubscriptionChangeSubscriptionPreviewParams,
+  SubscriptionFirstTimeSubscriptionBody,
+  SubscriptionFirstTimeSubscriptionPreviewBody,
+  SubscriptionFirstTimeSubscriptionPreviewParams,
+  SubscriptionSetSubscriptionUpgradeRequiredBody,
+  Transaction,
+  TransactionsAddPaymentTransactionBody,
+  Usage,
+  UsageAddUsageBody
+} from '.././models';
+
+import { customFetch } from '../../client';
+
+/**
+ * @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 type discountCouponAddDiscountCouponResponse200 = {
+  data: DiscountCoupon
+  status: 200
+}
+
+export type discountCouponAddDiscountCouponResponse401 = {
+  data: void
+  status: 401
+}
+    
+export type discountCouponAddDiscountCouponResponseSuccess = (discountCouponAddDiscountCouponResponse200) & {
+  headers: Headers;
+};
+export type discountCouponAddDiscountCouponResponseError = (discountCouponAddDiscountCouponResponse401) & {
+  headers: Headers;
+};
+
+export type discountCouponAddDiscountCouponResponse = (discountCouponAddDiscountCouponResponseSuccess | discountCouponAddDiscountCouponResponseError)
+
+export const getDiscountCouponAddDiscountCouponUrl = () => {
+
+
+  
+
+  return `/api/v1/billing/discountcoupons`
+}
+
+export const discountCouponAddDiscountCoupon = async (discountCouponAddDiscountCouponBody: DiscountCouponAddDiscountCouponBody, options?: RequestInit): Promise<discountCouponAddDiscountCouponResponse> => {
+  
+  return customFetch<discountCouponAddDiscountCouponResponse>(getDiscountCouponAddDiscountCouponUrl(),
+  {      
+    ...options,
+    method: 'POST',
+    headers: { 'Content-Type': 'application/json', ...options?.headers },
+    body: JSON.stringify(
+      discountCouponAddDiscountCouponBody,)
+  }
+);}
+
+
+/**
+ * @summary Add a usage entry for an add-on that bills for usage at the end of the month.
+ */
+export type usageAddUsageResponse200 = {
+  data: Usage
+  status: 200
+}
+
+export type usageAddUsageResponse401 = {
+  data: void
+  status: 401
+}
+    
+export type usageAddUsageResponseSuccess = (usageAddUsageResponse200) & {
+  headers: Headers;
+};
+export type usageAddUsageResponseError = (usageAddUsageResponse401) & {
+  headers: Headers;
+};
+
+export type usageAddUsageResponse = (usageAddUsageResponseSuccess | usageAddUsageResponseError)
+
+export const getUsageAddUsageUrl = () => {
+
+
+  
+
+  return `/api/v1/billing/usage`
+}
+
+export const usageAddUsage = async (usageAddUsageBody: UsageAddUsageBody, options?: RequestInit): Promise<usageAddUsageResponse> => {
+  
+  return customFetch<usageAddUsageResponse>(getUsageAddUsageUrl(),
+  {      
+    ...options,
+    method: 'POST',
+    headers: { 'Content-Type': 'application/json', ...options?.headers },
+    body: JSON.stringify(
+      usageAddUsageBody,)
+  }
+);}
+
+
+/**
+ * @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 type transactionsGetAllTransactionsByAccountIdResponse200 = {
+  data: Transaction[]
+  status: 200
+}
+
+export type transactionsGetAllTransactionsByAccountIdResponse400 = {
+  data: void
+  status: 400
+}
+
+export type transactionsGetAllTransactionsByAccountIdResponse401 = {
+  data: void
+  status: 401
+}
+    
+export type transactionsGetAllTransactionsByAccountIdResponseSuccess = (transactionsGetAllTransactionsByAccountIdResponse200) & {
+  headers: Headers;
+};
+export type transactionsGetAllTransactionsByAccountIdResponseError = (transactionsGetAllTransactionsByAccountIdResponse400 | transactionsGetAllTransactionsByAccountIdResponse401) & {
+  headers: Headers;
+};
+
+export type transactionsGetAllTransactionsByAccountIdResponse = (transactionsGetAllTransactionsByAccountIdResponseSuccess | transactionsGetAllTransactionsByAccountIdResponseError)
+
+export const getTransactionsGetAllTransactionsByAccountIdUrl = (accountUid: string | null,) => {
+
+
+  
+
+  return `/api/v1/billing/transactions/${accountUid}`
+}
+
+export const transactionsGetAllTransactionsByAccountId = async (accountUid: string | null, options?: RequestInit): Promise<transactionsGetAllTransactionsByAccountIdResponse> => {
+  
+  return customFetch<transactionsGetAllTransactionsByAccountIdResponse>(getTransactionsGetAllTransactionsByAccountIdUrl(accountUid),
+  {      
+    ...options,
+    method: 'GET'
+    
+    
+  }
+);}
+
+
+/**
+ * @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 type transactionsAddPaymentTransactionResponse200 = {
+  data: Transaction
+  status: 200
+}
+
+export type transactionsAddPaymentTransactionResponse401 = {
+  data: void
+  status: 401
+}
+    
+export type transactionsAddPaymentTransactionResponseSuccess = (transactionsAddPaymentTransactionResponse200) & {
+  headers: Headers;
+};
+export type transactionsAddPaymentTransactionResponseError = (transactionsAddPaymentTransactionResponse401) & {
+  headers: Headers;
+};
+
+export type transactionsAddPaymentTransactionResponse = (transactionsAddPaymentTransactionResponseSuccess | transactionsAddPaymentTransactionResponseError)
+
+export const getTransactionsAddPaymentTransactionUrl = () => {
+
+
+  
+
+  return `/api/v1/billing/transactions/payment`
+}
+
+export const transactionsAddPaymentTransaction = async (transactionsAddPaymentTransactionBody: TransactionsAddPaymentTransactionBody, options?: RequestInit): Promise<transactionsAddPaymentTransactionResponse> => {
+  
+  return customFetch<transactionsAddPaymentTransactionResponse>(getTransactionsAddPaymentTransactionUrl(),
+  {      
+    ...options,
+    method: 'POST',
+    headers: { 'Content-Type': 'application/json', ...options?.headers },
+    body: JSON.stringify(
+      transactionsAddPaymentTransactionBody,)
+  }
+);}
+
+
+/**
+ * @summary Update payment information for an account.
+ */
+export type paymentInformationSavePaymentInformationResponse200 = {
+  data: PaymentInformation
+  status: 200
+}
+
+export type paymentInformationSavePaymentInformationResponse401 = {
+  data: void
+  status: 401
+}
+    
+export type paymentInformationSavePaymentInformationResponseSuccess = (paymentInformationSavePaymentInformationResponse200) & {
+  headers: Headers;
+};
+export type paymentInformationSavePaymentInformationResponseError = (paymentInformationSavePaymentInformationResponse401) & {
+  headers: Headers;
+};
+
+export type paymentInformationSavePaymentInformationResponse = (paymentInformationSavePaymentInformationResponseSuccess | paymentInformationSavePaymentInformationResponseError)
+
+export const getPaymentInformationSavePaymentInformationUrl = () => {
+
+
+  
+
+  return `/api/v1/billing/paymentinformation`
+}
+
+export const paymentInformationSavePaymentInformation = async (paymentInformationSavePaymentInformationBody: PaymentInformationSavePaymentInformationBody, options?: RequestInit): Promise<paymentInformationSavePaymentInformationResponse> => {
+  
+  return customFetch<paymentInformationSavePaymentInformationResponse>(getPaymentInformationSavePaymentInformationUrl(),
+  {      
+    ...options,
+    method: 'POST',
+    headers: { 'Content-Type': 'application/json', ...options?.headers },
+    body: JSON.stringify(
+      paymentInformationSavePaymentInformationBody,)
+  }
+);}
+
+
+/**
+ * @summary Add an add-on to a subscription.
+ */
+export type subscriptionAddOnAddSubscriptionAddOnResponse200 = {
+  data: Blob
+  status: 200
+}
+
+export type subscriptionAddOnAddSubscriptionAddOnResponse401 = {
+  data: void
+  status: 401
+}
+    
+export type subscriptionAddOnAddSubscriptionAddOnResponseSuccess = (subscriptionAddOnAddSubscriptionAddOnResponse200) & {
+  headers: Headers;
+};
+export type subscriptionAddOnAddSubscriptionAddOnResponseError = (subscriptionAddOnAddSubscriptionAddOnResponse401) & {
+  headers: Headers;
+};
+
+export type subscriptionAddOnAddSubscriptionAddOnResponse = (subscriptionAddOnAddSubscriptionAddOnResponseSuccess | subscriptionAddOnAddSubscriptionAddOnResponseError)
+
+export const getSubscriptionAddOnAddSubscriptionAddOnUrl = () => {
+
+
+  
+
+  return `/api/v1/billing/subscriptionaddons`
+}
+
+export const subscriptionAddOnAddSubscriptionAddOn = async (subscriptionAddOnAddSubscriptionAddOnBody: SubscriptionAddOnAddSubscriptionAddOnBody, options?: RequestInit): Promise<subscriptionAddOnAddSubscriptionAddOnResponse> => {
+  
+  return customFetch<subscriptionAddOnAddSubscriptionAddOnResponse>(getSubscriptionAddOnAddSubscriptionAddOnUrl(),
+  {      
+    ...options,
+    method: 'POST',
+    headers: { 'Content-Type': 'application/json', ...options?.headers },
+    body: JSON.stringify(
+      subscriptionAddOnAddSubscriptionAddOnBody,)
+  }
+);}
+
+
+/**
+ * @summary Create an ad-hoc invoice for a given account.
+ */
+export type invoiceAddInvoiceResponse200 = {
+  data: Invoice
+  status: 200
+}
+
+export type invoiceAddInvoiceResponse401 = {
+  data: void
+  status: 401
+}
+    
+export type invoiceAddInvoiceResponseSuccess = (invoiceAddInvoiceResponse200) & {
+  headers: Headers;
+};
+export type invoiceAddInvoiceResponseError = (invoiceAddInvoiceResponse401) & {
+  headers: Headers;
+};
+
+export type invoiceAddInvoiceResponse = (invoiceAddInvoiceResponseSuccess | invoiceAddInvoiceResponseError)
+
+export const getInvoiceAddInvoiceUrl = () => {
+
+
+  
+
+  return `/api/v1/billing/invoices`
+}
+
+export const invoiceAddInvoice = async (invoiceAddInvoiceBody: InvoiceAddInvoiceBody, options?: RequestInit): Promise<invoiceAddInvoiceResponse> => {
+  
+  return customFetch<invoiceAddInvoiceResponse>(getInvoiceAddInvoiceUrl(),
+  {      
+    ...options,
+    method: 'POST',
+    headers: { 'Content-Type': 'application/json', ...options?.headers },
+    body: JSON.stringify(
+      invoiceAddInvoiceBody,)
+  }
+);}
+
+
+/**
+ * @summary Retrieves a subscription.
+ */
+export type subscriptionGetSubscriptionResponse200 = {
+  data: Subscription
+  status: 200
+}
+
+export type subscriptionGetSubscriptionResponse400 = {
+  data: void
+  status: 400
+}
+
+export type subscriptionGetSubscriptionResponse401 = {
+  data: void
+  status: 401
+}
+
+export type subscriptionGetSubscriptionResponse404 = {
+  data: void
+  status: 404
+}
+    
+export type subscriptionGetSubscriptionResponseSuccess = (subscriptionGetSubscriptionResponse200) & {
+  headers: Headers;
+};
+export type subscriptionGetSubscriptionResponseError = (subscriptionGetSubscriptionResponse400 | subscriptionGetSubscriptionResponse401 | subscriptionGetSubscriptionResponse404) & {
+  headers: Headers;
+};
+
+export type subscriptionGetSubscriptionResponse = (subscriptionGetSubscriptionResponseSuccess | subscriptionGetSubscriptionResponseError)
+
+export const getSubscriptionGetSubscriptionUrl = (subscriptionUid: string | null,) => {
+
+
+  
+
+  return `/api/v1/billing/subscriptions/${subscriptionUid}`
+}
+
+export const subscriptionGetSubscription = async (subscriptionUid: string | null, options?: RequestInit): Promise<subscriptionGetSubscriptionResponse> => {
+  
+  return customFetch<subscriptionGetSubscriptionResponse>(getSubscriptionGetSubscriptionUrl(subscriptionUid),
+  {      
+    ...options,
+    method: 'GET'
+    
+    
+  }
+);}
+
+
+/**
+ * @summary Add a discount to a subscription.
+ */
+export type subscriptionAddDiscountToSubscriptionResponse200 = {
+  data: Blob
+  status: 200
+}
+
+export type subscriptionAddDiscountToSubscriptionResponse400 = {
+  data: void
+  status: 400
+}
+
+export type subscriptionAddDiscountToSubscriptionResponse401 = {
+  data: void
+  status: 401
+}
+
+export type subscriptionAddDiscountToSubscriptionResponse404 = {
+  data: void
+  status: 404
+}
+    
+export type subscriptionAddDiscountToSubscriptionResponseSuccess = (subscriptionAddDiscountToSubscriptionResponse200) & {
+  headers: Headers;
+};
+export type subscriptionAddDiscountToSubscriptionResponseError = (subscriptionAddDiscountToSubscriptionResponse400 | subscriptionAddDiscountToSubscriptionResponse401 | subscriptionAddDiscountToSubscriptionResponse404) & {
+  headers: Headers;
+};
+
+export type subscriptionAddDiscountToSubscriptionResponse = (subscriptionAddDiscountToSubscriptionResponseSuccess | subscriptionAddDiscountToSubscriptionResponseError)
+
+export const getSubscriptionAddDiscountToSubscriptionUrl = (subscriptionUid: string | null,
+    discountUid: string | null,) => {
+
+
+  
+
+  return `/api/v1/billing/subscriptions/${subscriptionUid}/discounts/${discountUid}`
+}
+
+export const subscriptionAddDiscountToSubscription = async (subscriptionUid: string | null,
+    discountUid: string | null, options?: RequestInit): Promise<subscriptionAddDiscountToSubscriptionResponse> => {
+  
+  return customFetch<subscriptionAddDiscountToSubscriptionResponse>(getSubscriptionAddDiscountToSubscriptionUrl(subscriptionUid,discountUid),
+  {      
+    ...options,
+    method: 'POST'
+    
+    
+  }
+);}
+
+
+/**
+ * @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 type subscriptionSetSubscriptionUpgradeRequiredResponse200 = {
+  data: Subscription
+  status: 200
+}
+
+export type subscriptionSetSubscriptionUpgradeRequiredResponse400 = {
+  data: void
+  status: 400
+}
+
+export type subscriptionSetSubscriptionUpgradeRequiredResponse401 = {
+  data: void
+  status: 401
+}
+
+export type subscriptionSetSubscriptionUpgradeRequiredResponse404 = {
+  data: void
+  status: 404
+}
+    
+export type subscriptionSetSubscriptionUpgradeRequiredResponseSuccess = (subscriptionSetSubscriptionUpgradeRequiredResponse200) & {
+  headers: Headers;
+};
+export type subscriptionSetSubscriptionUpgradeRequiredResponseError = (subscriptionSetSubscriptionUpgradeRequiredResponse400 | subscriptionSetSubscriptionUpgradeRequiredResponse401 | subscriptionSetSubscriptionUpgradeRequiredResponse404) & {
+  headers: Headers;
+};
+
+export type subscriptionSetSubscriptionUpgradeRequiredResponse = (subscriptionSetSubscriptionUpgradeRequiredResponseSuccess | subscriptionSetSubscriptionUpgradeRequiredResponseError)
+
+export const getSubscriptionSetSubscriptionUpgradeRequiredUrl = (subscriptionUid: string | null,) => {
+
+
+  
+
+  return `/api/v1/billing/subscriptions/${subscriptionUid}/setsubscriptionupgraderequired`
+}
+
+export const subscriptionSetSubscriptionUpgradeRequired = async (subscriptionUid: string | null,
+    subscriptionSetSubscriptionUpgradeRequiredBody: SubscriptionSetSubscriptionUpgradeRequiredBody, options?: RequestInit): Promise<subscriptionSetSubscriptionUpgradeRequiredResponse> => {
+  
+  return customFetch<subscriptionSetSubscriptionUpgradeRequiredResponse>(getSubscriptionSetSubscriptionUpgradeRequiredUrl(subscriptionUid),
+  {      
+    ...options,
+    method: 'PUT',
+    headers: { 'Content-Type': 'application/json', ...options?.headers },
+    body: JSON.stringify(
+      subscriptionSetSubscriptionUpgradeRequiredBody,)
+  }
+);}
+
+
+/**
+ * @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 type subscriptionFirstTimeSubscriptionPreviewResponse200 = {
+  data: Invoice
+  status: 200
+}
+    
+export type subscriptionFirstTimeSubscriptionPreviewResponseSuccess = (subscriptionFirstTimeSubscriptionPreviewResponse200) & {
+  headers: Headers;
+};
+;
+
+export type subscriptionFirstTimeSubscriptionPreviewResponse = (subscriptionFirstTimeSubscriptionPreviewResponseSuccess)
+
+export const getSubscriptionFirstTimeSubscriptionPreviewUrl = (params?: SubscriptionFirstTimeSubscriptionPreviewParams,) => {
+  const normalizedParams = new URLSearchParams();
+
+  Object.entries(params || {}).forEach(([key, value]) => {
+    
+    if (value !== undefined) {
+      normalizedParams.append(key, value === null ? 'null' : value.toString())
+    }
+  });
+
+  const stringifiedParams = normalizedParams.toString();
+
+  return stringifiedParams.length > 0 ? `/api/v1/billing/subscriptions/compute-charge-summary?${stringifiedParams}` : `/api/v1/billing/subscriptions/compute-charge-summary`
+}
+
+export const subscriptionFirstTimeSubscriptionPreview = async (subscriptionFirstTimeSubscriptionPreviewBody: SubscriptionFirstTimeSubscriptionPreviewBody,
+    params?: SubscriptionFirstTimeSubscriptionPreviewParams, options?: RequestInit): Promise<subscriptionFirstTimeSubscriptionPreviewResponse> => {
+  
+  return customFetch<subscriptionFirstTimeSubscriptionPreviewResponse>(getSubscriptionFirstTimeSubscriptionPreviewUrl(params),
+  {      
+    ...options,
+    method: 'POST',
+    headers: { 'Content-Type': 'application/json', ...options?.headers },
+    body: JSON.stringify(
+      subscriptionFirstTimeSubscriptionPreviewBody,)
+  }
+);}
+
+
+/**
+ * @summary Add a subscription to an account for the first time. Returns an invoice object
+with information about the amount outstanding.
+ */
+export type subscriptionFirstTimeSubscriptionResponse200 = {
+  data: Invoice
+  status: 200
+}
+
+export type subscriptionFirstTimeSubscriptionResponse401 = {
+  data: void
+  status: 401
+}
+    
+export type subscriptionFirstTimeSubscriptionResponseSuccess = (subscriptionFirstTimeSubscriptionResponse200) & {
+  headers: Headers;
+};
+export type subscriptionFirstTimeSubscriptionResponseError = (subscriptionFirstTimeSubscriptionResponse401) & {
+  headers: Headers;
+};
+
+export type subscriptionFirstTimeSubscriptionResponse = (subscriptionFirstTimeSubscriptionResponseSuccess | subscriptionFirstTimeSubscriptionResponseError)
+
+export const getSubscriptionFirstTimeSubscriptionUrl = () => {
+
+
+  
+
+  return `/api/v1/billing/subscriptions/firsttimesubscription`
+}
+
+export const subscriptionFirstTimeSubscription = async (subscriptionFirstTimeSubscriptionBody: SubscriptionFirstTimeSubscriptionBody, options?: RequestInit): Promise<subscriptionFirstTimeSubscriptionResponse> => {
+  
+  return customFetch<subscriptionFirstTimeSubscriptionResponse>(getSubscriptionFirstTimeSubscriptionUrl(),
+  {      
+    ...options,
+    method: 'PUT',
+    headers: { 'Content-Type': 'application/json', ...options?.headers },
+    body: JSON.stringify(
+      subscriptionFirstTimeSubscriptionBody,)
+  }
+);}
+
+
+/**
+ * @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 type subscriptionChangeSubscriptionPreviewResponse200 = {
+  data: Invoice
+  status: 200
+}
+
+export type subscriptionChangeSubscriptionPreviewResponse400 = {
+  data: void
+  status: 400
+}
+
+export type subscriptionChangeSubscriptionPreviewResponse401 = {
+  data: void
+  status: 401
+}
+
+export type subscriptionChangeSubscriptionPreviewResponse404 = {
+  data: void
+  status: 404
+}
+    
+export type subscriptionChangeSubscriptionPreviewResponseSuccess = (subscriptionChangeSubscriptionPreviewResponse200) & {
+  headers: Headers;
+};
+export type subscriptionChangeSubscriptionPreviewResponseError = (subscriptionChangeSubscriptionPreviewResponse400 | subscriptionChangeSubscriptionPreviewResponse401 | subscriptionChangeSubscriptionPreviewResponse404) & {
+  headers: Headers;
+};
+
+export type subscriptionChangeSubscriptionPreviewResponse = (subscriptionChangeSubscriptionPreviewResponseSuccess | subscriptionChangeSubscriptionPreviewResponseError)
+
+export const getSubscriptionChangeSubscriptionPreviewUrl = (subscriptionUid: string | null,
+    params?: SubscriptionChangeSubscriptionPreviewParams,) => {
+  const normalizedParams = new URLSearchParams();
+
+  Object.entries(params || {}).forEach(([key, value]) => {
+    
+    if (value !== undefined) {
+      normalizedParams.append(key, value === null ? 'null' : value.toString())
+    }
+  });
+
+  const stringifiedParams = normalizedParams.toString();
+
+  return stringifiedParams.length > 0 ? `/api/v1/billing/subscriptions/${subscriptionUid}/changesubscriptionpreview?${stringifiedParams}` : `/api/v1/billing/subscriptions/${subscriptionUid}/changesubscriptionpreview`
+}
+
+export const subscriptionChangeSubscriptionPreview = async (subscriptionUid: string | null,
+    subscriptionChangeSubscriptionPreviewBody: SubscriptionChangeSubscriptionPreviewBody,
+    params?: SubscriptionChangeSubscriptionPreviewParams, options?: RequestInit): Promise<subscriptionChangeSubscriptionPreviewResponse> => {
+  
+  return customFetch<subscriptionChangeSubscriptionPreviewResponse>(getSubscriptionChangeSubscriptionPreviewUrl(subscriptionUid,params),
+  {      
+    ...options,
+    method: 'PUT',
+    headers: { 'Content-Type': 'application/json', ...options?.headers },
+    body: JSON.stringify(
+      subscriptionChangeSubscriptionPreviewBody,)
+  }
+);}
+
+
+/**
+ * @summary Change a subscription on an account. Returns an invoice object with information about
+the amount outstanding.
+ */
+export type subscriptionChangeSubscriptionResponse200 = {
+  data: Subscription
+  status: 200
+}
+
+export type subscriptionChangeSubscriptionResponse400 = {
+  data: void
+  status: 400
+}
+
+export type subscriptionChangeSubscriptionResponse401 = {
+  data: void
+  status: 401
+}
+
+export type subscriptionChangeSubscriptionResponse404 = {
+  data: void
+  status: 404
+}
+    
+export type subscriptionChangeSubscriptionResponseSuccess = (subscriptionChangeSubscriptionResponse200) & {
+  headers: Headers;
+};
+export type subscriptionChangeSubscriptionResponseError = (subscriptionChangeSubscriptionResponse400 | subscriptionChangeSubscriptionResponse401 | subscriptionChangeSubscriptionResponse404) & {
+  headers: Headers;
+};
+
+export type subscriptionChangeSubscriptionResponse = (subscriptionChangeSubscriptionResponseSuccess | subscriptionChangeSubscriptionResponseError)
+
+export const getSubscriptionChangeSubscriptionUrl = (subscriptionUid: string | null,
+    params?: SubscriptionChangeSubscriptionParams,) => {
+  const normalizedParams = new URLSearchParams();
+
+  Object.entries(params || {}).forEach(([key, value]) => {
+    
+    if (value !== undefined) {
+      normalizedParams.append(key, value === null ? 'null' : value.toString())
+    }
+  });
+
+  const stringifiedParams = normalizedParams.toString();
+
+  return stringifiedParams.length > 0 ? `/api/v1/billing/subscriptions/${subscriptionUid}/changesubscription?${stringifiedParams}` : `/api/v1/billing/subscriptions/${subscriptionUid}/changesubscription`
+}
+
+export const subscriptionChangeSubscription = async (subscriptionUid: string | null,
+    subscriptionChangeSubscriptionBody: SubscriptionChangeSubscriptionBody,
+    params?: SubscriptionChangeSubscriptionParams, options?: RequestInit): Promise<subscriptionChangeSubscriptionResponse> => {
+  
+  return customFetch<subscriptionChangeSubscriptionResponse>(getSubscriptionChangeSubscriptionUrl(subscriptionUid,params),
+  {      
+    ...options,
+    method: 'PUT',
+    headers: { 'Content-Type': 'application/json', ...options?.headers },
+    body: JSON.stringify(
+      subscriptionChangeSubscriptionBody,)
+  }
+);}
+
+
+/**
+ * @summary Retrieves all plans.
+ */
+export type planGetAllPlansResponse200 = {
+  data: Plan[]
+  status: 200
+}
+    
+export type planGetAllPlansResponseSuccess = (planGetAllPlansResponse200) & {
+  headers: Headers;
+};
+;
+
+export type planGetAllPlansResponse = (planGetAllPlansResponseSuccess)
+
+export const getPlanGetAllPlansUrl = () => {
+
+
+  
+
+  return `/api/v1/billing/plans`
+}
+
+export const planGetAllPlans = async ( options?: RequestInit): Promise<planGetAllPlansResponse> => {
+  
+  return customFetch<planGetAllPlansResponse>(getPlanGetAllPlansUrl(),
+  {      
+    ...options,
+    method: 'GET'
+    
+    
+  }
+);}
+
+
+/**
+ * @summary Retrieves all plan families.
+ */
+export type planFamilyGetAllPlanFamiliesResponse200 = {
+  data: PlanFamily[]
+  status: 200
+}
+    
+export type planFamilyGetAllPlanFamiliesResponseSuccess = (planFamilyGetAllPlanFamiliesResponse200) & {
+  headers: Headers;
+};
+;
+
+export type planFamilyGetAllPlanFamiliesResponse = (planFamilyGetAllPlanFamiliesResponseSuccess)
+
+export const getPlanFamilyGetAllPlanFamiliesUrl = () => {
+
+
+  
+
+  return `/api/v1/billing/planfamilies`
+}
+
+export const planFamilyGetAllPlanFamilies = async ( options?: RequestInit): Promise<planFamilyGetAllPlanFamiliesResponse> => {
+  
+  return customFetch<planFamilyGetAllPlanFamiliesResponse>(getPlanFamilyGetAllPlanFamiliesUrl(),
+  {      
+    ...options,
+    method: 'GET'
+    
+    
+  }
+);}
+
+