orb-billing

import { type Agent } from "./_shims/index.js"; import * as Core from "./core.js"; import * as Errors from "./error.js"; import * as Pagination from "./pagination.js"; import { type PageParams, PageResponse } from "./pagination.js"; import * as Uploads from "./uploads.js"; import * as API from "./resources/index.js"; import { Alert, AlertCreateForCustomerParams, AlertCreateForExternalCustomerParams, AlertCreateForSubscriptionParams, AlertDisableParams, AlertEnableParams, AlertListParams, AlertUpdateParams, Alerts, AlertsPage, Threshold } from "./resources/alerts.js"; import { CreditBlockListInvoicesResponse, CreditBlockRetrieveResponse, CreditBlocks } from "./resources/credit-blocks.js"; import { CreditNoteCreateParams, CreditNoteListParams, CreditNotes } from "./resources/credit-notes.js"; import { InvoiceLineItemCreateParams, InvoiceLineItemCreateResponse, InvoiceLineItems } from "./resources/invoice-line-items.js"; import { InvoiceCreateParams, InvoiceFetchUpcomingParams, InvoiceFetchUpcomingResponse, InvoiceIssueParams, InvoiceIssueSummaryParams, InvoiceIssueSummaryResponse, InvoiceListParams, InvoiceListSummaryParams, InvoiceListSummaryResponse, InvoiceListSummaryResponsesPage, InvoiceMarkPaidParams, InvoicePayParams, InvoiceUpdateParams, Invoices } from "./resources/invoices.js"; import { Item, ItemCreateParams, ItemListParams, ItemUpdateParams, Items, ItemsPage } from "./resources/items.js"; import { LicenseTypeCreateParams, LicenseTypeCreateResponse, LicenseTypeListParams, LicenseTypeListResponse, LicenseTypeListResponsesPage, LicenseTypeRetrieveResponse, LicenseTypes } from "./resources/license-types.js"; import { BillableMetric, BillableMetricsPage, MetricCreateParams, MetricListParams, MetricUpdateParams, Metrics } from "./resources/metrics.js"; import { MutatedSubscription, SubscriptionChangeApplyParams, SubscriptionChangeApplyResponse, SubscriptionChangeCancelResponse, SubscriptionChangeListParams, SubscriptionChangeListResponse, SubscriptionChangeListResponsesPage, SubscriptionChangeRetrieveResponse, SubscriptionChanges } from "./resources/subscription-changes.js"; import { DiscountOverride, NewSubscriptionBulkPrice, NewSubscriptionBulkWithProrationPrice, NewSubscriptionCumulativeGroupedBulkPrice, NewSubscriptionGroupedAllocationPrice, NewSubscriptionGroupedTieredPackagePrice, NewSubscriptionGroupedTieredPrice, NewSubscriptionGroupedWithMeteredMinimumPrice, NewSubscriptionGroupedWithProratedMinimumPrice, NewSubscriptionMatrixPrice, NewSubscriptionMatrixWithAllocationPrice, NewSubscriptionMatrixWithDisplayNamePrice, NewSubscriptionMaxGroupTieredPackagePrice, NewSubscriptionMinimumCompositePrice, NewSubscriptionPackagePrice, NewSubscriptionPackageWithAllocationPrice, NewSubscriptionScalableMatrixWithTieredPricingPrice, NewSubscriptionScalableMatrixWithUnitPricingPrice, NewSubscriptionThresholdTotalAmountPrice, NewSubscriptionTieredPackagePrice, NewSubscriptionTieredPackageWithMinimumPrice, NewSubscriptionTieredPrice, NewSubscriptionTieredWithMinimumPrice, NewSubscriptionUnitPrice, NewSubscriptionUnitWithPercentPrice, NewSubscriptionUnitWithProrationPrice, Subscription, SubscriptionCancelParams, SubscriptionCreateParams, SubscriptionFetchCostsParams, SubscriptionFetchCostsResponse, SubscriptionFetchScheduleParams, SubscriptionFetchScheduleResponse, SubscriptionFetchScheduleResponsesPage, SubscriptionFetchUsageParams, SubscriptionListParams, SubscriptionPriceIntervalsParams, SubscriptionRedeemCouponParams, SubscriptionSchedulePlanChangeParams, SubscriptionTriggerPhaseParams, SubscriptionUnscheduleFixedFeeQuantityUpdatesParams, SubscriptionUpdateFixedFeeQuantityParams, SubscriptionUpdateParams, SubscriptionUpdateTrialParams, SubscriptionUsage, Subscriptions, SubscriptionsPage } from "./resources/subscriptions.js"; import { TopLevel, TopLevelPingResponse } from "./resources/top-level.js"; import { Beta, BetaCreatePlanVersionParams, BetaSetDefaultPlanVersionParams, PlanVersion, PlanVersionPhase } from "./resources/beta/beta.js"; import { Coupon, CouponCreateParams, CouponListParams, Coupons, CouponsPage } from "./resources/coupons/coupons.js"; import { AccountingProviderConfig, AddressInput, Customer, CustomerCreateParams, CustomerHierarchyConfig, CustomerListParams, CustomerUpdateByExternalIDParams, CustomerUpdateParams, Customers, CustomersPage, NewAccountingSyncConfiguration, NewAvalaraTaxConfiguration, NewReportingConfiguration, NewSphereConfiguration, NewTaxJarConfiguration } from "./resources/customers/customers.js"; import { DimensionalPriceGroup, DimensionalPriceGroupCreateParams, DimensionalPriceGroupListParams, DimensionalPriceGroupUpdateParams, DimensionalPriceGroups, DimensionalPriceGroupsPage } from "./resources/dimensional-price-groups/dimensional-price-groups.js"; import { EventDeprecateResponse, EventIngestParams, EventIngestResponse, EventSearchParams, EventSearchResponse, EventUpdateParams, EventUpdateResponse, Events } from "./resources/events/events.js"; import { LicenseCreateParams, LicenseCreateResponse, LicenseDeactivateParams, LicenseDeactivateResponse, LicenseListParams, LicenseListResponse, LicenseListResponsesPage, LicenseRetrieveByExternalIDParams, LicenseRetrieveByExternalIDResponse, LicenseRetrieveResponse, Licenses } from "./resources/licenses/licenses.js"; import { Plan, PlanCreateParams, PlanListParams, PlanUpdateParams, Plans, PlansPage } from "./resources/plans/plans.js"; import { EvaluatePriceGroup, PriceCreateParams, PriceEvaluateMultipleParams, PriceEvaluateMultipleResponse, PriceEvaluateParams, PriceEvaluatePreviewEventsParams, PriceEvaluatePreviewEventsResponse, PriceEvaluateResponse, PriceListParams, PriceUpdateParams, Prices } from "./resources/prices/prices.js"; export interface ClientOptions { /** * Defaults to process.env['ORB_API_KEY']. */ apiKey?: string | undefined; /** * Defaults to process.env['ORB_WEBHOOK_SECRET']. */ webhookSecret?: string | null | undefined; /** * Override the default base URL for the API, e.g., "https://api.example.com/v2/" * * Defaults to process.env['ORB_BASE_URL']. */ baseURL?: string | null | undefined; /** * The maximum amount of time (in milliseconds) that the client should wait for a response * from the server before timing out a single request. * * Note that request timeouts are retried by default, so in a worst-case scenario you may wait * much longer than this timeout before the promise succeeds or fails. * * @unit milliseconds */ timeout?: number | undefined; /** * An HTTP agent used to manage HTTP(S) connections. * * If not provided, an agent will be constructed by default in the Node.js environment, * otherwise no agent is used. */ httpAgent?: Agent | undefined; /** * Specify a custom `fetch` function implementation. * * If not provided, we use `node-fetch` on Node.js and otherwise expect that `fetch` is * defined globally. */ fetch?: Core.Fetch | undefined; /** * The maximum number of times that the client will retry a request in case of a * temporary failure, like a network error or a 5XX error from the server. * * @default 2 */ maxRetries?: number | undefined; /** * Default headers to include with every request to the API. * * These can be removed in individual requests by explicitly setting the * header to `undefined` or `null` in request options. */ defaultHeaders?: Core.Headers | undefined; /** * Default query parameters to include with every request to the API. * * These can be removed in individual requests by explicitly setting the * param to `undefined` in request options. */ defaultQuery?: Core.DefaultQuery | undefined; } /** * API Client for interfacing with the Orb API. */ export declare class Orb extends Core.APIClient { #private; apiKey: string; webhookSecret: string | null; private _options; /** * API Client for interfacing with the Orb API. * * @param {string | undefined} [opts.apiKey=process.env['ORB_API_KEY'] ?? undefined] * @param {string | null | undefined} [opts.webhookSecret=process.env['ORB_WEBHOOK_SECRET'] ?? null] * @param {string} [opts.baseURL=process.env['ORB_BASE_URL'] ?? https://api.withorb.com/v1] - Override the default base URL for the API. * @param {number} [opts.timeout=1 minute] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out. * @param {number} [opts.httpAgent] - An HTTP agent used to manage HTTP(s) connections. * @param {Core.Fetch} [opts.fetch] - Specify a custom `fetch` function implementation. * @param {number} [opts.maxRetries=2] - The maximum number of times the client will retry a request. * @param {Core.Headers} opts.defaultHeaders - Default headers to include with every request to the API. * @param {Core.DefaultQuery} opts.defaultQuery - Default query parameters to include with every request to the API. */ constructor({ baseURL, apiKey, webhookSecret, ...opts }?: ClientOptions); topLevel: API.TopLevel; /** * The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be subscribed to by a * customer. Plans define the billing behavior of the subscription. You can see more about how to configure prices * in the [Price resource](/reference/price). */ beta: API.Beta; /** * A coupon represents a reusable discount configuration that can be applied either as a fixed or percentage amount to an invoice or subscription. Coupons are activated using a redemption code, which applies the discount to a subscription or invoice. The duration of a coupon determines how long it remains available for use by end users. */ coupons: API.Coupons; /** * The [Credit Note](/invoicing/credit-notes) resource represents a credit that has been applied to a * particular invoice. */ creditNotes: API.CreditNotes; /** * A customer is a buyer of your products, and the other party to the billing relationship. * * In Orb, customers are assigned system generated identifiers automatically, but it's often desirable to have these * match existing identifiers in your system. To avoid having to denormalize Orb ID information, you can pass in an * `external_customer_id` with your own identifier. See * [Customer ID Aliases](/events-and-metrics/customer-aliases) for further information about how these * aliases work in Orb. * * In addition to having an identifier in your system, a customer may exist in a payment provider solution like * Stripe. Use the `payment_provider_id` and the `payment_provider` enum field to express this mapping. * * A customer also has a timezone (from the standard [IANA timezone database](https://www.iana.org/time-zones)), which * defaults to your account's timezone. See [Timezone localization](/essentials/timezones) for * information on what this timezone parameter influences within Orb. */ customers: API.Customers; /** * The [Event](/core-concepts#event) resource represents a usage event that has been created for a * customer. Events are the core of Orb's usage-based billing model, and are used to calculate the usage charges for * a given billing period. */ events: API.Events; /** * An [`Invoice`](/core-concepts#invoice) is a fundamental billing entity, representing the request for payment for * a single subscription. This includes a set of line items, which correspond to prices in the subscription's plan and * can represent fixed recurring fees or usage-based fees. They are generated at the end of a billing period, or as * the result of an action, such as a cancellation. */ invoiceLineItems: API.InvoiceLineItems; /** * An [`Invoice`](/core-concepts#invoice) is a fundamental billing entity, representing the request for payment for * a single subscription. This includes a set of line items, which correspond to prices in the subscription's plan and * can represent fixed recurring fees or usage-based fees. They are generated at the end of a billing period, or as * the result of an action, such as a cancellation. */ invoices: API.Invoices; /** * The Item resource represents a sellable product or good. Items are associated with all line items, billable metrics, * and prices and are used for defining external sync behavior for invoices and tax calculation purposes. */ items: API.Items; /** * The Metric resource represents a calculation of a quantity based on events. * Metrics are defined by the query that transforms raw usage events into meaningful values for your customers. */ metrics: API.Metrics; /** * The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be subscribed to by a * customer. Plans define the billing behavior of the subscription. You can see more about how to configure prices * in the [Price resource](/reference/price). */ plans: API.Plans; /** * The Price resource represents a price that can be billed on a subscription, resulting in a charge on an invoice in * the form of an invoice line item. Prices take a quantity and determine an amount to bill. * * Orb supports a few different pricing models out of the box. Each of these models is serialized differently in a * given Price object. The model_type field determines the key for the configuration object that is present. * * For more on the types of prices, see [the core concepts documentation](/core-concepts#plan-and-price) */ prices: API.Prices; subscriptions: API.Subscriptions; webhooks: API.Webhooks; /** * [Alerts within Orb](/product-catalog/configuring-alerts) monitor spending, * usage, or credit balance and trigger webhooks when a threshold is exceeded. * * Alerts created through the API can be scoped to either customers or subscriptions. */ alerts: API.Alerts; dimensionalPriceGroups: API.DimensionalPriceGroups; subscriptionChanges: API.SubscriptionChanges; /** * The [Credit Ledger Entry resource](/product-catalog/prepurchase) models prepaid credits within Orb. */ creditBlocks: API.CreditBlocks; /** * The LicenseType resource represents a type of license that can be assigned to users. * License types are used during billing by grouping metrics on the configured grouping key. */ licenseTypes: API.LicenseTypes; licenses: API.Licenses; protected defaultQuery(): Core.DefaultQuery | undefined; protected defaultHeaders(opts: Core.FinalRequestOptions): Core.Headers; protected authHeaders(opts: Core.FinalRequestOptions): Core.Headers; protected stringifyQuery(query: object | Record<string, unknown>): string; static Orb: typeof Orb; static DEFAULT_TIMEOUT: number; static OrbError: typeof Errors.OrbError; static APIError: typeof Errors.APIError; static APIConnectionError: typeof Errors.APIConnectionError; static APIConnectionTimeoutError: typeof Errors.APIConnectionTimeoutError; static APIUserAbortError: typeof Errors.APIUserAbortError; static URLNotFound: typeof Errors.URLNotFound; static NotFoundError: typeof Errors.NotFoundError; static ConflictError: typeof Errors.ConflictError; static RateLimitError: typeof Errors.RateLimitError; static BadRequestError: typeof Errors.BadRequestError; static RequestTooLarge: typeof Errors.RequestTooLarge; static TooManyRequests: typeof Errors.TooManyRequests; static ResourceNotFound: typeof Errors.ResourceNotFound; static ResourceConflict: typeof Errors.ResourceConflict; static ResourceTooLarge: typeof Errors.ResourceTooLarge; static AuthenticationError: typeof Errors.AuthenticationError; static InternalServerError: typeof Errors.InternalServerError; static ConstraintViolation: typeof Errors.ConstraintViolation; static FeatureNotAvailable: typeof Errors.FeatureNotAvailable; static PermissionDeniedError: typeof Errors.PermissionDeniedError; static RequestValidationError: typeof Errors.RequestValidationError; static OrbAuthenticationError: typeof Errors.OrbAuthenticationError; static OrbInternalServerError: typeof Errors.OrbInternalServerError; static UnprocessableEntityError: typeof Errors.UnprocessableEntityError; static DuplicateResourceCreation: typeof Errors.DuplicateResourceCreation; static toFile: typeof Uploads.toFile; static fileFromPath: typeof Uploads.fileFromPath; } export declare namespace Orb { export type RequestOptions = Core.RequestOptions; export import Page = Pagination.Page; export { type PageParams as PageParams, type PageResponse as PageResponse }; export { TopLevel as TopLevel, type TopLevelPingResponse as TopLevelPingResponse }; export { Beta as Beta, type PlanVersion as PlanVersion, type PlanVersionPhase as PlanVersionPhase, type BetaCreatePlanVersionParams as BetaCreatePlanVersionParams, type BetaSetDefaultPlanVersionParams as BetaSetDefaultPlanVersionParams, }; export { Coupons as Coupons, type Coupon as Coupon, CouponsPage as CouponsPage, type CouponCreateParams as CouponCreateParams, type CouponListParams as CouponListParams, }; export { CreditNotes as CreditNotes, type CreditNoteCreateParams as CreditNoteCreateParams, type CreditNoteListParams as CreditNoteListParams, }; export { Customers as Customers, type AccountingProviderConfig as AccountingProviderConfig, type AddressInput as AddressInput, type Customer as Customer, type CustomerHierarchyConfig as CustomerHierarchyConfig, type NewAccountingSyncConfiguration as NewAccountingSyncConfiguration, type NewAvalaraTaxConfiguration as NewAvalaraTaxConfiguration, type NewReportingConfiguration as NewReportingConfiguration, type NewSphereConfiguration as NewSphereConfiguration, type NewTaxJarConfiguration as NewTaxJarConfiguration, CustomersPage as CustomersPage, type CustomerCreateParams as CustomerCreateParams, type CustomerUpdateParams as CustomerUpdateParams, type CustomerListParams as CustomerListParams, type CustomerUpdateByExternalIDParams as CustomerUpdateByExternalIDParams, }; export { Events as Events, type EventUpdateResponse as EventUpdateResponse, type EventDeprecateResponse as EventDeprecateResponse, type EventIngestResponse as EventIngestResponse, type EventSearchResponse as EventSearchResponse, type EventUpdateParams as EventUpdateParams, type EventIngestParams as EventIngestParams, type EventSearchParams as EventSearchParams, }; export { InvoiceLineItems as InvoiceLineItems, type InvoiceLineItemCreateResponse as InvoiceLineItemCreateResponse, type InvoiceLineItemCreateParams as InvoiceLineItemCreateParams, }; export { Invoices as Invoices, type InvoiceFetchUpcomingResponse as InvoiceFetchUpcomingResponse, type InvoiceIssueSummaryResponse as InvoiceIssueSummaryResponse, type InvoiceListSummaryResponse as InvoiceListSummaryResponse, InvoiceListSummaryResponsesPage as InvoiceListSummaryResponsesPage, type InvoiceCreateParams as InvoiceCreateParams, type InvoiceUpdateParams as InvoiceUpdateParams, type InvoiceListParams as InvoiceListParams, type InvoiceFetchUpcomingParams as InvoiceFetchUpcomingParams, type InvoiceIssueParams as InvoiceIssueParams, type InvoiceIssueSummaryParams as InvoiceIssueSummaryParams, type InvoiceListSummaryParams as InvoiceListSummaryParams, type InvoiceMarkPaidParams as InvoiceMarkPaidParams, type InvoicePayParams as InvoicePayParams, }; export { Items as Items, type Item as Item, ItemsPage as ItemsPage, type ItemCreateParams as ItemCreateParams, type ItemUpdateParams as ItemUpdateParams, type ItemListParams as ItemListParams, }; export { Metrics as Metrics, type BillableMetric as BillableMetric, BillableMetricsPage as BillableMetricsPage, type MetricCreateParams as MetricCreateParams, type MetricUpdateParams as MetricUpdateParams, type MetricListParams as MetricListParams, }; export { Plans as Plans, type Plan as Plan, PlansPage as PlansPage, type PlanCreateParams as PlanCreateParams, type PlanUpdateParams as PlanUpdateParams, type PlanListParams as PlanListParams, }; export { Prices as Prices, type EvaluatePriceGroup as EvaluatePriceGroup, type PriceEvaluateResponse as PriceEvaluateResponse, type PriceEvaluateMultipleResponse as PriceEvaluateMultipleResponse, type PriceEvaluatePreviewEventsResponse as PriceEvaluatePreviewEventsResponse, type PriceCreateParams as PriceCreateParams, type PriceUpdateParams as PriceUpdateParams, type PriceListParams as PriceListParams, type PriceEvaluateParams as PriceEvaluateParams, type PriceEvaluateMultipleParams as PriceEvaluateMultipleParams, type PriceEvaluatePreviewEventsParams as PriceEvaluatePreviewEventsParams, }; export { type Subscriptions as Subscriptions, type DiscountOverride as DiscountOverride, type NewSubscriptionBulkPrice as NewSubscriptionBulkPrice, type NewSubscriptionBulkWithProrationPrice as NewSubscriptionBulkWithProrationPrice, type NewSubscriptionCumulativeGroupedBulkPrice as NewSubscriptionCumulativeGroupedBulkPrice, type NewSubscriptionGroupedAllocationPrice as NewSubscriptionGroupedAllocationPrice, type NewSubscriptionGroupedTieredPackagePrice as NewSubscriptionGroupedTieredPackagePrice, type NewSubscriptionGroupedTieredPrice as NewSubscriptionGroupedTieredPrice, type NewSubscriptionGroupedWithMeteredMinimumPrice as NewSubscriptionGroupedWithMeteredMinimumPrice, type NewSubscriptionGroupedWithProratedMinimumPrice as NewSubscriptionGroupedWithProratedMinimumPrice, type NewSubscriptionMatrixPrice as NewSubscriptionMatrixPrice, type NewSubscriptionMatrixWithAllocationPrice as NewSubscriptionMatrixWithAllocationPrice, type NewSubscriptionMatrixWithDisplayNamePrice as NewSubscriptionMatrixWithDisplayNamePrice, type NewSubscriptionMaxGroupTieredPackagePrice as NewSubscriptionMaxGroupTieredPackagePrice, type NewSubscriptionMinimumCompositePrice as NewSubscriptionMinimumCompositePrice, type NewSubscriptionPackagePrice as NewSubscriptionPackagePrice, type NewSubscriptionPackageWithAllocationPrice as NewSubscriptionPackageWithAllocationPrice, type NewSubscriptionScalableMatrixWithTieredPricingPrice as NewSubscriptionScalableMatrixWithTieredPricingPrice, type NewSubscriptionScalableMatrixWithUnitPricingPrice as NewSubscriptionScalableMatrixWithUnitPricingPrice, type NewSubscriptionThresholdTotalAmountPrice as NewSubscriptionThresholdTotalAmountPrice, type NewSubscriptionTieredPackagePrice as NewSubscriptionTieredPackagePrice, type NewSubscriptionTieredPackageWithMinimumPrice as NewSubscriptionTieredPackageWithMinimumPrice, type NewSubscriptionTieredPrice as NewSubscriptionTieredPrice, type NewSubscriptionTieredWithMinimumPrice as NewSubscriptionTieredWithMinimumPrice, type NewSubscriptionUnitPrice as NewSubscriptionUnitPrice, type NewSubscriptionUnitWithPercentPrice as NewSubscriptionUnitWithPercentPrice, type NewSubscriptionUnitWithProrationPrice as NewSubscriptionUnitWithProrationPrice, type Subscription as Subscription, type SubscriptionUsage as SubscriptionUsage, type SubscriptionFetchCostsResponse as SubscriptionFetchCostsResponse, type SubscriptionFetchScheduleResponse as SubscriptionFetchScheduleResponse, SubscriptionsPage as SubscriptionsPage, SubscriptionFetchScheduleResponsesPage as SubscriptionFetchScheduleResponsesPage, type SubscriptionCreateParams as SubscriptionCreateParams, type SubscriptionUpdateParams as SubscriptionUpdateParams, type SubscriptionListParams as SubscriptionListParams, type SubscriptionCancelParams as SubscriptionCancelParams, type SubscriptionFetchCostsParams as SubscriptionFetchCostsParams, type SubscriptionFetchScheduleParams as SubscriptionFetchScheduleParams, type SubscriptionFetchUsageParams as SubscriptionFetchUsageParams, type SubscriptionPriceIntervalsParams as SubscriptionPriceIntervalsParams, type SubscriptionRedeemCouponParams as SubscriptionRedeemCouponParams, type SubscriptionSchedulePlanChangeParams as SubscriptionSchedulePlanChangeParams, type SubscriptionTriggerPhaseParams as SubscriptionTriggerPhaseParams, type SubscriptionUnscheduleFixedFeeQuantityUpdatesParams as SubscriptionUnscheduleFixedFeeQuantityUpdatesParams, type SubscriptionUpdateFixedFeeQuantityParams as SubscriptionUpdateFixedFeeQuantityParams, type SubscriptionUpdateTrialParams as SubscriptionUpdateTrialParams, }; export { Alerts as Alerts, type Alert as Alert, type Threshold as Threshold, AlertsPage as AlertsPage, type AlertUpdateParams as AlertUpdateParams, type AlertListParams as AlertListParams, type AlertCreateForCustomerParams as AlertCreateForCustomerParams, type AlertCreateForExternalCustomerParams as AlertCreateForExternalCustomerParams, type AlertCreateForSubscriptionParams as AlertCreateForSubscriptionParams, type AlertDisableParams as AlertDisableParams, type AlertEnableParams as AlertEnableParams, }; export { type DimensionalPriceGroups as DimensionalPriceGroups, type DimensionalPriceGroup as DimensionalPriceGroup, DimensionalPriceGroupsPage as DimensionalPriceGroupsPage, type DimensionalPriceGroupCreateParams as DimensionalPriceGroupCreateParams, type DimensionalPriceGroupUpdateParams as DimensionalPriceGroupUpdateParams, type DimensionalPriceGroupListParams as DimensionalPriceGroupListParams, }; export { SubscriptionChanges as SubscriptionChanges, type MutatedSubscription as MutatedSubscription, type SubscriptionChangeRetrieveResponse as SubscriptionChangeRetrieveResponse, type SubscriptionChangeListResponse as SubscriptionChangeListResponse, type SubscriptionChangeApplyResponse as SubscriptionChangeApplyResponse, type SubscriptionChangeCancelResponse as SubscriptionChangeCancelResponse, SubscriptionChangeListResponsesPage as SubscriptionChangeListResponsesPage, type SubscriptionChangeListParams as SubscriptionChangeListParams, type SubscriptionChangeApplyParams as SubscriptionChangeApplyParams, }; export { CreditBlocks as CreditBlocks, type CreditBlockRetrieveResponse as CreditBlockRetrieveResponse, type CreditBlockListInvoicesResponse as CreditBlockListInvoicesResponse, }; export { LicenseTypes as LicenseTypes, type LicenseTypeCreateResponse as LicenseTypeCreateResponse, type LicenseTypeRetrieveResponse as LicenseTypeRetrieveResponse, type LicenseTypeListResponse as LicenseTypeListResponse, LicenseTypeListResponsesPage as LicenseTypeListResponsesPage, type LicenseTypeCreateParams as LicenseTypeCreateParams, type LicenseTypeListParams as LicenseTypeListParams, }; export { Licenses as Licenses, type LicenseCreateResponse as LicenseCreateResponse, type LicenseRetrieveResponse as LicenseRetrieveResponse, type LicenseListResponse as LicenseListResponse, type LicenseDeactivateResponse as LicenseDeactivateResponse, type LicenseRetrieveByExternalIDResponse as LicenseRetrieveByExternalIDResponse, LicenseListResponsesPage as LicenseListResponsesPage, type LicenseCreateParams as LicenseCreateParams, type LicenseListParams as LicenseListParams, type LicenseDeactivateParams as LicenseDeactivateParams, type LicenseRetrieveByExternalIDParams as LicenseRetrieveByExternalIDParams, }; export type Address = API.Address; export type AdjustmentInterval = API.AdjustmentInterval; export type AggregatedCost = API.AggregatedCost; export type Allocation = API.Allocation; export type AmountDiscount = API.AmountDiscount; export type AmountDiscountInterval = API.AmountDiscountInterval; export type BillableMetricTiny = API.BillableMetricTiny; export type BillingCycleAnchorConfiguration = API.BillingCycleAnchorConfiguration; export type BillingCycleConfiguration = API.BillingCycleConfiguration; export type BillingCycleRelativeDate = API.BillingCycleRelativeDate; export type BulkConfig = API.BulkConfig; export type BulkTier = API.BulkTier; export type ChangedSubscriptionResources = API.ChangedSubscriptionResources; export type ConversionRateTier = API.ConversionRateTier; export type ConversionRateTieredConfig = API.ConversionRateTieredConfig; export type ConversionRateUnitConfig = API.ConversionRateUnitConfig; export type CouponRedemption = API.CouponRedemption; export type CreditNote = API.CreditNote; export type CreditNoteTiny = API.CreditNoteTiny; export type CustomExpiration = API.CustomExpiration; export type CustomerMinified = API.CustomerMinified; export type CustomerTaxID = API.CustomerTaxID; export type DimensionalPriceConfiguration = API.DimensionalPriceConfiguration; export type Discount = API.Discount; export type FixedFeeQuantityScheduleEntry = API.FixedFeeQuantityScheduleEntry; export type FixedFeeQuantityTransition = API.FixedFeeQuantityTransition; export type Invoice = API.Invoice; export type InvoiceLevelDiscount = API.InvoiceLevelDiscount; export type InvoiceTiny = API.InvoiceTiny; export type ItemSlim = API.ItemSlim; export type MatrixConfig = API.MatrixConfig; export type MatrixSubLineItem = API.MatrixSubLineItem; export type MatrixValue = API.MatrixValue; export type MatrixWithAllocationConfig = API.MatrixWithAllocationConfig; export type Maximum = API.Maximum; export type MaximumInterval = API.MaximumInterval; export type Minimum = API.Minimum; export type MinimumInterval = API.MinimumInterval; export type MonetaryAmountDiscountAdjustment = API.MonetaryAmountDiscountAdjustment; export type MonetaryMaximumAdjustment = API.MonetaryMaximumAdjustment; export type MonetaryMinimumAdjustment = API.MonetaryMinimumAdjustment; export type MonetaryPercentageDiscountAdjustment = API.MonetaryPercentageDiscountAdjustment; export type MonetaryUsageDiscountAdjustment = API.MonetaryUsageDiscountAdjustment; export type NewAllocationPrice = API.NewAllocationPrice; export type NewAmountDiscount = API.NewAmountDiscount; export type NewBillingCycleConfiguration = API.NewBillingCycleConfiguration; export type NewDimensionalPriceConfiguration = API.NewDimensionalPriceConfiguration; export type NewFloatingBulkPrice = API.NewFloatingBulkPrice; export type NewFloatingBulkWithProrationPrice = API.NewFloatingBulkWithProrationPrice; export type NewFloatingCumulativeGroupedBulkPrice = API.NewFloatingCumulativeGroupedBulkPrice; export type NewFloatingGroupedAllocationPrice = API.NewFloatingGroupedAllocationPrice; export type NewFloatingGroupedTieredPackagePrice = API.NewFloatingGroupedTieredPackagePrice; export type NewFloatingGroupedTieredPrice = API.NewFloatingGroupedTieredPrice; export type NewFloatingGroupedWithMeteredMinimumPrice = API.NewFloatingGroupedWithMeteredMinimumPrice; export type NewFloatingGroupedWithProratedMinimumPrice = API.NewFloatingGroupedWithProratedMinimumPrice; export type NewFloatingMatrixPrice = API.NewFloatingMatrixPrice; export type NewFloatingMatrixWithAllocationPrice = API.NewFloatingMatrixWithAllocationPrice; export type NewFloatingMatrixWithDisplayNamePrice = API.NewFloatingMatrixWithDisplayNamePrice; export type NewFloatingMaxGroupTieredPackagePrice = API.NewFloatingMaxGroupTieredPackagePrice; export type NewFloatingMinimumCompositePrice = API.NewFloatingMinimumCompositePrice; export type NewFloatingPackagePrice = API.NewFloatingPackagePrice; export type NewFloatingPackageWithAllocationPrice = API.NewFloatingPackageWithAllocationPrice; export type NewFloatingScalableMatrixWithTieredPricingPrice = API.NewFloatingScalableMatrixWithTieredPricingPrice; export type NewFloatingScalableMatrixWithUnitPricingPrice = API.NewFloatingScalableMatrixWithUnitPricingPrice; export type NewFloatingThresholdTotalAmountPrice = API.NewFloatingThresholdTotalAmountPrice; export type NewFloatingTieredPackagePrice = API.NewFloatingTieredPackagePrice; export type NewFloatingTieredPackageWithMinimumPrice = API.NewFloatingTieredPackageWithMinimumPrice; export type NewFloatingTieredPrice = API.NewFloatingTieredPrice; export type NewFloatingTieredWithMinimumPrice = API.NewFloatingTieredWithMinimumPrice; export type NewFloatingTieredWithProrationPrice = API.NewFloatingTieredWithProrationPrice; export type NewFloatingUnitPrice = API.NewFloatingUnitPrice; export type NewFloatingUnitWithPercentPrice = API.NewFloatingUnitWithPercentPrice; export type NewFloatingUnitWithProrationPrice = API.NewFloatingUnitWithProrationPrice; export type NewMaximum = API.NewMaximum; export type NewMinimum = API.NewMinimum; export type NewPercentageDiscount = API.NewPercentageDiscount; export type NewPlanBulkPrice = API.NewPlanBulkPrice; export type NewPlanBulkWithProrationPrice = API.NewPlanBulkWithProrationPrice; export type NewPlanCumulativeGroupedBulkPrice = API.NewPlanCumulativeGroupedBulkPrice; export type NewPlanGroupedAllocationPrice = API.NewPlanGroupedAllocationPrice; export type NewPlanGroupedTieredPackagePrice = API.NewPlanGroupedTieredPackagePrice; export type NewPlanGroupedTieredPrice = API.NewPlanGroupedTieredPrice; export type NewPlanGroupedWithMeteredMinimumPrice = API.NewPlanGroupedWithMeteredMinimumPrice; export type NewPlanGroupedWithProratedMinimumPrice = API.NewPlanGroupedWithProratedMinimumPrice; export type NewPlanMatrixPrice = API.NewPlanMatrixPrice; export type NewPlanMatrixWithAllocationPrice = API.NewPlanMatrixWithAllocationPrice; export type NewPlanMatrixWithDisplayNamePrice = API.NewPlanMatrixWithDisplayNamePrice; export type NewPlanMaxGroupTieredPackagePrice = API.NewPlanMaxGroupTieredPackagePrice; export type NewPlanMinimumCompositePrice = API.NewPlanMinimumCompositePrice; export type NewPlanPackagePrice = API.NewPlanPackagePrice; export type NewPlanPackageWithAllocationPrice = API.NewPlanPackageWithAllocationPrice; export type NewPlanScalableMatrixWithTieredPricingPrice = API.NewPlanScalableMatrixWithTieredPricingPrice; export type NewPlanScalableMatrixWithUnitPricingPrice = API.NewPlanScalableMatrixWithUnitPricingPrice; export type NewPlanThresholdTotalAmountPrice = API.NewPlanThresholdTotalAmountPrice; export type NewPlanTieredPackagePrice = API.NewPlanTieredPackagePrice; export type NewPlanTieredPackageWithMinimumPrice = API.NewPlanTieredPackageWithMinimumPrice; export type NewPlanTieredPrice = API.NewPlanTieredPrice; export type NewPlanTieredWithMinimumPrice = API.NewPlanTieredWithMinimumPrice; export type NewPlanUnitPrice = API.NewPlanUnitPrice; export type NewPlanUnitWithPercentPrice = API.NewPlanUnitWithPercentPrice; export type NewPlanUnitWithProrationPrice = API.NewPlanUnitWithProrationPrice; export type NewUsageDiscount = API.NewUsageDiscount; export type OtherSubLineItem = API.OtherSubLineItem; export type PackageConfig = API.PackageConfig; export type PaginationMetadata = API.PaginationMetadata; export type PerPriceCost = API.PerPriceCost; export type PercentageDiscount = API.PercentageDiscount; export type PercentageDiscountInterval = API.PercentageDiscountInterval; export type PlanPhaseAmountDiscountAdjustment = API.PlanPhaseAmountDiscountAdjustment; export type PlanPhaseMaximumAdjustment = API.PlanPhaseMaximumAdjustment; export type PlanPhaseMinimumAdjustment = API.PlanPhaseMinimumAdjustment; export type PlanPhasePercentageDiscountAdjustment = API.PlanPhasePercentageDiscountAdjustment; export type PlanPhaseUsageDiscountAdjustment = API.PlanPhaseUsageDiscountAdjustment; export type Price = API.Price; export type PriceInterval = API.PriceInterval; export type SubLineItemGrouping = API.SubLineItemGrouping; export type SubLineItemMatrixConfig = API.SubLineItemMatrixConfig; export type SubscriptionChangeMinified = API.SubscriptionChangeMinified; export type SubscriptionMinified = API.SubscriptionMinified; export type SubscriptionTrialInfo = API.SubscriptionTrialInfo; export type TaxAmount = API.TaxAmount; export type Tier = API.Tier; export type TierSubLineItem = API.TierSubLineItem; export type TieredConfig = API.TieredConfig; export type TieredConversionRateConfig = API.TieredConversionRateConfig; export type TrialDiscount = API.TrialDiscount; export type UnitConfig = API.UnitConfig; export type UnitConversionRateConfig = API.UnitConversionRateConfig; export type UsageDiscount = API.UsageDiscount; export type UsageDiscountInterval = API.UsageDiscountInterval; } export { toFile, fileFromPath } from "./uploads.js"; export { OrbError, APIError, APIConnectionError, APIConnectionTimeoutError, APIUserAbortError, URLNotFound, NotFoundError, ConflictError, RateLimitError, BadRequestError, RequestTooLarge, TooManyRequests, ResourceNotFound, ResourceConflict, ResourceTooLarge, AuthenticationError, InternalServerError, ConstraintViolation, FeatureNotAvailable, PermissionDeniedError, RequestValidationError, OrbAuthenticationError, OrbInternalServerError, UnprocessableEntityError, DuplicateResourceCreation, } from "./error.js"; export default Orb; //# sourceMappingURL=index.d.ts.map