@openmeter/sdk 1.0.0-beta.229 → 1.0.0-beta.230
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/src/client/schemas.d.cts +40 -5
- package/dist/cjs/src/react/context.d.cts +1 -1
- package/dist/cjs/src/zod/index.cjs +316 -337
- package/dist/cjs/src/zod/index.cjs.map +1 -1
- package/dist/cjs/src/zod/index.d.cts +250 -244
- package/dist/src/client/schemas.d.ts +40 -5
- package/dist/src/react/context.d.ts +1 -1
- package/dist/src/zod/index.d.ts +250 -244
- package/dist/src/zod/index.js +293 -314
- package/dist/src/zod/index.js.map +1 -1
- package/dist/tsconfig.tsbuildinfo +1 -1
- package/package.json +15 -12
- package/Makefile +0 -42
- package/biome.json +0 -67
- package/orval.config.ts +0 -38
- package/patches/openapi-typescript.patch +0 -7122
- package/pnpm-workspace.yaml +0 -3
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* Generated by orval v8.
|
|
2
|
+
* Generated by orval v8.15.0 🍺
|
|
3
3
|
* Do not edit manually.
|
|
4
4
|
* OpenMeter Cloud API
|
|
5
5
|
* OpenMeter is a cloud native usage metering service.
|
|
6
|
-
The OpenMeter API allows you to ingest events, query meter usage, and manage resources.
|
|
6
|
+
* The OpenMeter API allows you to ingest events, query meter usage, and manage resources.
|
|
7
7
|
* OpenAPI spec version: 1.0.0
|
|
8
8
|
*/
|
|
9
9
|
import * as zod from 'zod';
|
|
@@ -548,8 +548,8 @@ export declare const GetAddonQueryParams: zod.ZodObject<{
|
|
|
548
548
|
}, zod.z.core.$strip>;
|
|
549
549
|
/**
|
|
550
550
|
* Soft delete add-on by id.
|
|
551
|
-
|
|
552
|
-
Once a add-on is deleted it cannot be undeleted.
|
|
551
|
+
*
|
|
552
|
+
* Once a add-on is deleted it cannot be undeleted.
|
|
553
553
|
* @summary Delete add-on
|
|
554
554
|
*/
|
|
555
555
|
export declare const deleteAddonPathAddonIdRegExp: RegExp;
|
|
@@ -698,8 +698,8 @@ export declare const UninstallAppParams: zod.ZodObject<{
|
|
|
698
698
|
}, zod.z.core.$strip>;
|
|
699
699
|
/**
|
|
700
700
|
* Update the Stripe API key.
|
|
701
|
-
|
|
702
|
-
⚠️ __Deprecated__: Use [`PUT /api/v1/apps/{id}`](#tag/apps/put/api/v1/apps/{id}) instead.
|
|
701
|
+
*
|
|
702
|
+
* ⚠️ __Deprecated__: Use [`PUT /api/v1/apps/{id}`](#tag/apps/put/api/v1/apps/{id}) instead.
|
|
703
703
|
* @deprecated
|
|
704
704
|
* @summary Update Stripe API key
|
|
705
705
|
*/
|
|
@@ -729,12 +729,12 @@ export declare const AppStripeWebhookBody: zod.ZodObject<{
|
|
|
729
729
|
}, zod.z.core.$strip>;
|
|
730
730
|
/**
|
|
731
731
|
* List customer overrides using the specified filters.
|
|
732
|
-
|
|
733
|
-
The response will include the customer override values and the merged billing profile values.
|
|
734
|
-
|
|
735
|
-
If the includeAllCustomers is set to true, the list contains all customers. This mode is
|
|
736
|
-
useful for getting the current effective billing workflow settings for all users regardless
|
|
737
|
-
if they have customer orverrides or not.
|
|
732
|
+
*
|
|
733
|
+
* The response will include the customer override values and the merged billing profile values.
|
|
734
|
+
*
|
|
735
|
+
* If the includeAllCustomers is set to true, the list contains all customers. This mode is
|
|
736
|
+
* useful for getting the current effective billing workflow settings for all users regardless
|
|
737
|
+
* if they have customer orverrides or not.
|
|
738
738
|
* @summary List customer overrides
|
|
739
739
|
*/
|
|
740
740
|
export declare const listBillingProfileCustomerOverridesQueryBillingProfileItemRegExp: RegExp;
|
|
@@ -772,10 +772,10 @@ export declare const ListBillingProfileCustomerOverridesQueryParams: zod.ZodObje
|
|
|
772
772
|
}, zod.z.core.$strip>;
|
|
773
773
|
/**
|
|
774
774
|
* The customer override can be used to pin a given customer to a billing profile
|
|
775
|
-
different from the default one.
|
|
776
|
-
|
|
777
|
-
This can be used to test the effect of different billing profiles before making them
|
|
778
|
-
the default ones or have different workflow settings for example for enterprise customers.
|
|
775
|
+
* different from the default one.
|
|
776
|
+
*
|
|
777
|
+
* This can be used to test the effect of different billing profiles before making them
|
|
778
|
+
* the default ones or have different workflow settings for example for enterprise customers.
|
|
779
779
|
* @summary Create a new or update a customer override
|
|
780
780
|
*/
|
|
781
781
|
export declare const upsertBillingProfileCustomerOverridePathCustomerIdRegExp: RegExp;
|
|
@@ -788,11 +788,11 @@ export declare const UpsertBillingProfileCustomerOverrideBody: zod.ZodObject<{
|
|
|
788
788
|
}, zod.z.core.$strip>;
|
|
789
789
|
/**
|
|
790
790
|
* Get a customer override by customer id.
|
|
791
|
-
|
|
792
|
-
The response will include the customer override values and the merged billing profile values.
|
|
793
|
-
|
|
794
|
-
If the customer override is not found, the default billing profile's values are returned. This behavior
|
|
795
|
-
allows for getting a merged profile regardless of the customer override existence.
|
|
791
|
+
*
|
|
792
|
+
* The response will include the customer override values and the merged billing profile values.
|
|
793
|
+
*
|
|
794
|
+
* If the customer override is not found, the default billing profile's values are returned. This behavior
|
|
795
|
+
* allows for getting a merged profile regardless of the customer override existence.
|
|
796
796
|
* @summary Get a customer override
|
|
797
797
|
*/
|
|
798
798
|
export declare const getBillingProfileCustomerOverridePathCustomerIdRegExp: RegExp;
|
|
@@ -807,9 +807,9 @@ export declare const GetBillingProfileCustomerOverrideQueryParams: zod.ZodObject
|
|
|
807
807
|
}, zod.z.core.$strip>;
|
|
808
808
|
/**
|
|
809
809
|
* Delete a customer override by customer id.
|
|
810
|
-
|
|
811
|
-
This will remove the customer override and the customer will be subject to the default
|
|
812
|
-
billing profile's settings again.
|
|
810
|
+
*
|
|
811
|
+
* This will remove the customer override and the customer will be subject to the default
|
|
812
|
+
* billing profile's settings again.
|
|
813
813
|
* @summary Delete a customer override
|
|
814
814
|
*/
|
|
815
815
|
export declare const deleteBillingProfileCustomerOverridePathCustomerIdRegExp: RegExp;
|
|
@@ -818,13 +818,13 @@ export declare const DeleteBillingProfileCustomerOverrideParams: zod.ZodObject<{
|
|
|
818
818
|
}, zod.z.core.$strip>;
|
|
819
819
|
/**
|
|
820
820
|
* Create a new pending line item (charge).
|
|
821
|
-
|
|
822
|
-
This call is used to create a new pending line item for the customer if required a new
|
|
823
|
-
gathering invoice will be created.
|
|
824
|
-
|
|
825
|
-
A new invoice will be created if:
|
|
826
|
-
- there is no invoice in gathering state
|
|
827
|
-
- the currency of the line item doesn't match the currency of any invoices in gathering state
|
|
821
|
+
*
|
|
822
|
+
* This call is used to create a new pending line item for the customer if required a new
|
|
823
|
+
* gathering invoice will be created.
|
|
824
|
+
*
|
|
825
|
+
* A new invoice will be created if:
|
|
826
|
+
* - there is no invoice in gathering state
|
|
827
|
+
* - the currency of the line item doesn't match the currency of any invoices in gathering state
|
|
828
828
|
* @summary Create pending line items
|
|
829
829
|
*/
|
|
830
830
|
export declare const createPendingInvoiceLinePathCustomerIdRegExp: RegExp;
|
|
@@ -1052,10 +1052,10 @@ export declare const CreatePendingInvoiceLineBody: zod.ZodObject<{
|
|
|
1052
1052
|
}, zod.z.core.$strip>;
|
|
1053
1053
|
/**
|
|
1054
1054
|
* Simulate an invoice for a customer.
|
|
1055
|
-
|
|
1056
|
-
This call will simulate an invoice for a customer based on the pending line items.
|
|
1057
|
-
|
|
1058
|
-
The call will return the total amount of the invoice and the line items that will be included in the invoice.
|
|
1055
|
+
*
|
|
1056
|
+
* This call will simulate an invoice for a customer based on the pending line items.
|
|
1057
|
+
*
|
|
1058
|
+
* The call will return the total amount of the invoice and the line items that will be included in the invoice.
|
|
1059
1059
|
* @summary Simulate an invoice for a customer
|
|
1060
1060
|
*/
|
|
1061
1061
|
export declare const simulateInvoicePathCustomerIdRegExp: RegExp;
|
|
@@ -1291,11 +1291,11 @@ export declare const SimulateInvoiceBody: zod.ZodObject<{
|
|
|
1291
1291
|
}, zod.z.core.$strip>;
|
|
1292
1292
|
/**
|
|
1293
1293
|
* List invoices based on the specified filters.
|
|
1294
|
-
|
|
1295
|
-
The expand option can be used to include additional information (besides the invoice header and totals)
|
|
1296
|
-
in the response. For example by adding the expand=lines option the invoice lines will be included in the response.
|
|
1297
|
-
|
|
1298
|
-
Gathering invoices will always show the current usage calculated on the fly.
|
|
1294
|
+
*
|
|
1295
|
+
* The expand option can be used to include additional information (besides the invoice header and totals)
|
|
1296
|
+
* in the response. For example by adding the expand=lines option the invoice lines will be included in the response.
|
|
1297
|
+
*
|
|
1298
|
+
* Gathering invoices will always show the current usage calculated on the fly.
|
|
1299
1299
|
* @summary List invoices
|
|
1300
1300
|
*/
|
|
1301
1301
|
export declare const listInvoicesQueryCustomersItemRegExp: RegExp;
|
|
@@ -1346,14 +1346,14 @@ export declare const ListInvoicesQueryParams: zod.ZodObject<{
|
|
|
1346
1346
|
}, zod.z.core.$strip>;
|
|
1347
1347
|
/**
|
|
1348
1348
|
* Create a new invoice from the pending line items.
|
|
1349
|
-
|
|
1350
|
-
This should be only called if for some reason we need to invoice a customer outside of the normal billing cycle.
|
|
1351
|
-
|
|
1352
|
-
When creating an invoice, the pending line items will be marked as invoiced and the invoice will be created with the total amount of the pending items.
|
|
1353
|
-
|
|
1354
|
-
New pending line items will be created for the period between now() and the next billing cycle's begining date for any metered item.
|
|
1355
|
-
|
|
1356
|
-
The call can return multiple invoices if the pending line items are in different currencies.
|
|
1349
|
+
*
|
|
1350
|
+
* This should be only called if for some reason we need to invoice a customer outside of the normal billing cycle.
|
|
1351
|
+
*
|
|
1352
|
+
* When creating an invoice, the pending line items will be marked as invoiced and the invoice will be created with the total amount of the pending items.
|
|
1353
|
+
*
|
|
1354
|
+
* New pending line items will be created for the period between now() and the next billing cycle's begining date for any metered item.
|
|
1355
|
+
*
|
|
1356
|
+
* The call can return multiple invoices if the pending line items are in different currencies.
|
|
1357
1357
|
* @summary Invoice a customer based on the pending line items
|
|
1358
1358
|
*/
|
|
1359
1359
|
export declare const invoicePendingLinesActionBodyFiltersOneLineIdsItemRegExp: RegExp;
|
|
@@ -1368,8 +1368,8 @@ export declare const InvoicePendingLinesActionBody: zod.ZodObject<{
|
|
|
1368
1368
|
}, zod.z.core.$strip>;
|
|
1369
1369
|
/**
|
|
1370
1370
|
* Get an invoice by ID.
|
|
1371
|
-
|
|
1372
|
-
Gathering invoices will always show the current usage calculated on the fly.
|
|
1371
|
+
*
|
|
1372
|
+
* Gathering invoices will always show the current usage calculated on the fly.
|
|
1373
1373
|
* @summary Get an invoice
|
|
1374
1374
|
*/
|
|
1375
1375
|
export declare const getInvoicePathInvoiceIdRegExp: RegExp;
|
|
@@ -1387,10 +1387,10 @@ export declare const GetInvoiceQueryParams: zod.ZodObject<{
|
|
|
1387
1387
|
}, zod.z.core.$strip>;
|
|
1388
1388
|
/**
|
|
1389
1389
|
* Delete an invoice
|
|
1390
|
-
|
|
1391
|
-
Only invoices that are in the draft (or earlier) status can be deleted.
|
|
1392
|
-
|
|
1393
|
-
Invoices that are post finalization can only be voided.
|
|
1390
|
+
*
|
|
1391
|
+
* Only invoices that are in the draft (or earlier) status can be deleted.
|
|
1392
|
+
*
|
|
1393
|
+
* Invoices that are post finalization can only be voided.
|
|
1394
1394
|
* @summary Delete an invoice
|
|
1395
1395
|
*/
|
|
1396
1396
|
export declare const deleteInvoicePathInvoiceIdRegExp: RegExp;
|
|
@@ -1399,8 +1399,8 @@ export declare const DeleteInvoiceParams: zod.ZodObject<{
|
|
|
1399
1399
|
}, zod.z.core.$strip>;
|
|
1400
1400
|
/**
|
|
1401
1401
|
* Update an invoice
|
|
1402
|
-
|
|
1403
|
-
Only invoices in draft or earlier status can be updated.
|
|
1402
|
+
*
|
|
1403
|
+
* Only invoices in draft or earlier status can be updated.
|
|
1404
1404
|
* @summary Update an invoice
|
|
1405
1405
|
*/
|
|
1406
1406
|
export declare const updateInvoicePathInvoiceIdRegExp: RegExp;
|
|
@@ -1473,6 +1473,7 @@ export declare const updateInvoiceBodyLinesItemIdRegExp: RegExp;
|
|
|
1473
1473
|
export declare const updateInvoiceBodyWorkflowOneWorkflowOneInvoicingOneAutoAdvanceDefault = true;
|
|
1474
1474
|
export declare const updateInvoiceBodyWorkflowOneWorkflowOneInvoicingOneDraftPeriodDefault = "P0D";
|
|
1475
1475
|
export declare const updateInvoiceBodyWorkflowOneWorkflowOneInvoicingOneDueAfterDefault = "P30D";
|
|
1476
|
+
export declare const updateInvoiceBodyWorkflowOneWorkflowOneInvoicingOneSubscriptionEndProrationModeDefault = "bill_actual_period";
|
|
1476
1477
|
export declare const updateInvoiceBodyWorkflowOneWorkflowOneInvoicingOneDefaultTaxConfigOneStripeOneCodeRegExp: RegExp;
|
|
1477
1478
|
export declare const updateInvoiceBodyWorkflowOneWorkflowOneInvoicingOneDefaultTaxConfigOneTaxCodeIdRegExp: RegExp;
|
|
1478
1479
|
export declare const updateInvoiceBodyWorkflowOneWorkflowOnePaymentOneCollectionMethodDefault = "charge_automatically";
|
|
@@ -1695,6 +1696,10 @@ export declare const UpdateInvoiceBody: zod.ZodObject<{
|
|
|
1695
1696
|
}, zod.z.core.$strip>>;
|
|
1696
1697
|
draftPeriod: zod.ZodDefault<zod.z.ZodCoercedString<unknown>>;
|
|
1697
1698
|
dueAfter: zod.ZodDefault<zod.z.ZodCoercedString<unknown>>;
|
|
1699
|
+
subscriptionEndProrationMode: zod.ZodDefault<zod.ZodEnum<{
|
|
1700
|
+
bill_full_period: "bill_full_period";
|
|
1701
|
+
bill_actual_period: "bill_actual_period";
|
|
1702
|
+
}>>;
|
|
1698
1703
|
}, zod.z.core.$strip>;
|
|
1699
1704
|
payment: zod.ZodObject<{
|
|
1700
1705
|
collectionMethod: zod.ZodDefault<zod.ZodEnum<{
|
|
@@ -1707,10 +1712,10 @@ export declare const UpdateInvoiceBody: zod.ZodObject<{
|
|
|
1707
1712
|
}, zod.z.core.$strip>;
|
|
1708
1713
|
/**
|
|
1709
1714
|
* Advance the invoice's state to the next status.
|
|
1710
|
-
|
|
1711
|
-
The call doesn't "approve the invoice", it only advances the invoice to the next status if the transition would be automatic.
|
|
1712
|
-
|
|
1713
|
-
The action can be called when the invoice's statusDetails' actions field contain the "advance" action.
|
|
1715
|
+
*
|
|
1716
|
+
* The call doesn't "approve the invoice", it only advances the invoice to the next status if the transition would be automatic.
|
|
1717
|
+
*
|
|
1718
|
+
* The action can be called when the invoice's statusDetails' actions field contain the "advance" action.
|
|
1714
1719
|
* @summary Advance the invoice's state to the next status
|
|
1715
1720
|
*/
|
|
1716
1721
|
export declare const advanceInvoiceActionPathInvoiceIdRegExp: RegExp;
|
|
@@ -1719,12 +1724,12 @@ export declare const AdvanceInvoiceActionParams: zod.ZodObject<{
|
|
|
1719
1724
|
}, zod.z.core.$strip>;
|
|
1720
1725
|
/**
|
|
1721
1726
|
* Approve an invoice and start executing the payment workflow.
|
|
1722
|
-
|
|
1723
|
-
This call instantly sends the invoice to the customer using the configured billing profile app.
|
|
1724
|
-
|
|
1725
|
-
This call is valid in two invoice statuses:
|
|
1726
|
-
- `draft`: the invoice will be sent to the customer, the invluce state becomes issued
|
|
1727
|
-
- `manual_approval_needed`: the invoice will be sent to the customer, the invoice state becomes issued
|
|
1727
|
+
*
|
|
1728
|
+
* This call instantly sends the invoice to the customer using the configured billing profile app.
|
|
1729
|
+
*
|
|
1730
|
+
* This call is valid in two invoice statuses:
|
|
1731
|
+
* - `draft`: the invoice will be sent to the customer, the invluce state becomes issued
|
|
1732
|
+
* - `manual_approval_needed`: the invoice will be sent to the customer, the invoice state becomes issued
|
|
1728
1733
|
* @summary Send the invoice to the customer
|
|
1729
1734
|
*/
|
|
1730
1735
|
export declare const approveInvoiceActionPathInvoiceIdRegExp: RegExp;
|
|
@@ -1733,8 +1738,8 @@ export declare const ApproveInvoiceActionParams: zod.ZodObject<{
|
|
|
1733
1738
|
}, zod.z.core.$strip>;
|
|
1734
1739
|
/**
|
|
1735
1740
|
* Retry advancing the invoice after a failed attempt.
|
|
1736
|
-
|
|
1737
|
-
The action can be called when the invoice's statusDetails' actions field contain the "retry" action.
|
|
1741
|
+
*
|
|
1742
|
+
* The action can be called when the invoice's statusDetails' actions field contain the "retry" action.
|
|
1738
1743
|
* @summary Retry advancing the invoice after a failed attempt.
|
|
1739
1744
|
*/
|
|
1740
1745
|
export declare const retryInvoiceActionPathInvoiceIdRegExp: RegExp;
|
|
@@ -1743,11 +1748,11 @@ export declare const RetryInvoiceActionParams: zod.ZodObject<{
|
|
|
1743
1748
|
}, zod.z.core.$strip>;
|
|
1744
1749
|
/**
|
|
1745
1750
|
* Snapshot quantities for usage based line items.
|
|
1746
|
-
|
|
1747
|
-
This call will snapshot the quantities for all usage based line items in the invoice.
|
|
1748
|
-
|
|
1749
|
-
This call is only valid in `draft.waiting_for_collection` status, where the collection period
|
|
1750
|
-
can be skipped using this action.
|
|
1751
|
+
*
|
|
1752
|
+
* This call will snapshot the quantities for all usage based line items in the invoice.
|
|
1753
|
+
*
|
|
1754
|
+
* This call is only valid in `draft.waiting_for_collection` status, where the collection period
|
|
1755
|
+
* can be skipped using this action.
|
|
1751
1756
|
* @summary Snapshot quantities for usage based line items
|
|
1752
1757
|
*/
|
|
1753
1758
|
export declare const snapshotQuantitiesInvoiceActionPathInvoiceIdRegExp: RegExp;
|
|
@@ -1756,8 +1761,8 @@ export declare const SnapshotQuantitiesInvoiceActionParams: zod.ZodObject<{
|
|
|
1756
1761
|
}, zod.z.core.$strip>;
|
|
1757
1762
|
/**
|
|
1758
1763
|
* Recalculate an invoice's tax amounts (using the app set in the customer's billing profile)
|
|
1759
|
-
|
|
1760
|
-
Note: charges might apply, depending on the tax provider.
|
|
1764
|
+
*
|
|
1765
|
+
* Note: charges might apply, depending on the tax provider.
|
|
1761
1766
|
* @summary Recalculate an invoice's tax amounts
|
|
1762
1767
|
*/
|
|
1763
1768
|
export declare const recalculateInvoiceTaxActionPathInvoiceIdRegExp: RegExp;
|
|
@@ -1766,10 +1771,10 @@ export declare const RecalculateInvoiceTaxActionParams: zod.ZodObject<{
|
|
|
1766
1771
|
}, zod.z.core.$strip>;
|
|
1767
1772
|
/**
|
|
1768
1773
|
* Void an invoice
|
|
1769
|
-
|
|
1770
|
-
Only invoices that have been alread issued can be voided.
|
|
1771
|
-
|
|
1772
|
-
Voiding an invoice will mark it as voided, the user can specify how to handle the voided line items.
|
|
1774
|
+
*
|
|
1775
|
+
* Only invoices that have been alread issued can be voided.
|
|
1776
|
+
*
|
|
1777
|
+
* Voiding an invoice will mark it as voided, the user can specify how to handle the voided line items.
|
|
1773
1778
|
* @summary Void an invoice
|
|
1774
1779
|
*/
|
|
1775
1780
|
export declare const voidInvoiceActionPathInvoiceIdRegExp: RegExp;
|
|
@@ -1811,10 +1816,10 @@ export declare const VoidInvoiceActionBody: zod.ZodObject<{
|
|
|
1811
1816
|
}, zod.z.core.$strip>;
|
|
1812
1817
|
/**
|
|
1813
1818
|
* List all billing profiles matching the specified filters.
|
|
1814
|
-
|
|
1815
|
-
The expand option can be used to include additional information (besides the billing profile)
|
|
1816
|
-
in the response. For example by adding the expand=apps option the apps used by the billing profile
|
|
1817
|
-
will be included in the response.
|
|
1819
|
+
*
|
|
1820
|
+
* The expand option can be used to include additional information (besides the billing profile)
|
|
1821
|
+
* in the response. For example by adding the expand=apps option the apps used by the billing profile
|
|
1822
|
+
* will be included in the response.
|
|
1818
1823
|
* @summary List billing profiles
|
|
1819
1824
|
*/
|
|
1820
1825
|
export declare const listBillingProfilesQueryIncludeArchivedDefault = false;
|
|
@@ -1842,9 +1847,9 @@ export declare const ListBillingProfilesQueryParams: zod.ZodObject<{
|
|
|
1842
1847
|
}, zod.z.core.$strip>;
|
|
1843
1848
|
/**
|
|
1844
1849
|
* Create a new billing profile
|
|
1845
|
-
|
|
1846
|
-
Billing profiles are representations of a customer's billing information. Customer overrides
|
|
1847
|
-
can be applied to a billing profile to customize the billing behavior for a specific customer.
|
|
1850
|
+
*
|
|
1851
|
+
* Billing profiles are representations of a customer's billing information. Customer overrides
|
|
1852
|
+
* can be applied to a billing profile to customize the billing behavior for a specific customer.
|
|
1848
1853
|
* @summary Create a new billing profile
|
|
1849
1854
|
*/
|
|
1850
1855
|
export declare const createBillingProfileBodyNameMax = 256;
|
|
@@ -1864,6 +1869,7 @@ export declare const createBillingProfileBodyWorkflowOneInvoicingOneAutoAdvanceD
|
|
|
1864
1869
|
export declare const createBillingProfileBodyWorkflowOneInvoicingOneDraftPeriodDefault = "P0D";
|
|
1865
1870
|
export declare const createBillingProfileBodyWorkflowOneInvoicingOneDueAfterDefault = "P30D";
|
|
1866
1871
|
export declare const createBillingProfileBodyWorkflowOneInvoicingOneProgressiveBillingDefault = true;
|
|
1872
|
+
export declare const createBillingProfileBodyWorkflowOneInvoicingOneSubscriptionEndProrationModeDefault = "bill_actual_period";
|
|
1867
1873
|
export declare const createBillingProfileBodyWorkflowOneInvoicingOneDefaultTaxConfigOneStripeOneCodeRegExp: RegExp;
|
|
1868
1874
|
export declare const createBillingProfileBodyWorkflowOneInvoicingOneDefaultTaxConfigOneTaxCodeIdRegExp: RegExp;
|
|
1869
1875
|
export declare const createBillingProfileBodyWorkflowOnePaymentOneCollectionMethodDefault = "charge_automatically";
|
|
@@ -1939,6 +1945,10 @@ export declare const CreateBillingProfileBody: zod.ZodObject<{
|
|
|
1939
1945
|
draftPeriod: zod.ZodDefault<zod.z.ZodCoercedString<unknown>>;
|
|
1940
1946
|
dueAfter: zod.ZodDefault<zod.z.ZodCoercedString<unknown>>;
|
|
1941
1947
|
progressiveBilling: zod.ZodDefault<zod.z.ZodCoercedBoolean<unknown>>;
|
|
1948
|
+
subscriptionEndProrationMode: zod.ZodDefault<zod.ZodEnum<{
|
|
1949
|
+
bill_full_period: "bill_full_period";
|
|
1950
|
+
bill_actual_period: "bill_actual_period";
|
|
1951
|
+
}>>;
|
|
1942
1952
|
}, zod.z.core.$strip>>;
|
|
1943
1953
|
payment: zod.ZodOptional<zod.ZodObject<{
|
|
1944
1954
|
collectionMethod: zod.ZodDefault<zod.ZodEnum<{
|
|
@@ -1954,11 +1964,11 @@ export declare const CreateBillingProfileBody: zod.ZodObject<{
|
|
|
1954
1964
|
}, zod.z.core.$strip>;
|
|
1955
1965
|
/**
|
|
1956
1966
|
* Delete a billing profile by id.
|
|
1957
|
-
|
|
1958
|
-
Only such billing profiles can be deleted that are:
|
|
1959
|
-
- not the default one
|
|
1960
|
-
- not pinned to any customer using customer overrides
|
|
1961
|
-
- only have finalized invoices
|
|
1967
|
+
*
|
|
1968
|
+
* Only such billing profiles can be deleted that are:
|
|
1969
|
+
* - not the default one
|
|
1970
|
+
* - not pinned to any customer using customer overrides
|
|
1971
|
+
* - only have finalized invoices
|
|
1962
1972
|
* @summary Delete a billing profile
|
|
1963
1973
|
*/
|
|
1964
1974
|
export declare const deleteBillingProfilePathIdRegExp: RegExp;
|
|
@@ -1967,10 +1977,10 @@ export declare const DeleteBillingProfileParams: zod.ZodObject<{
|
|
|
1967
1977
|
}, zod.z.core.$strip>;
|
|
1968
1978
|
/**
|
|
1969
1979
|
* Get a billing profile by id.
|
|
1970
|
-
|
|
1971
|
-
The expand option can be used to include additional information (besides the billing profile)
|
|
1972
|
-
in the response. For example by adding the expand=apps option the apps used by the billing profile
|
|
1973
|
-
will be included in the response.
|
|
1980
|
+
*
|
|
1981
|
+
* The expand option can be used to include additional information (besides the billing profile)
|
|
1982
|
+
* in the response. For example by adding the expand=apps option the apps used by the billing profile
|
|
1983
|
+
* will be included in the response.
|
|
1974
1984
|
* @summary Get a billing profile
|
|
1975
1985
|
*/
|
|
1976
1986
|
export declare const getBillingProfilePathIdRegExp: RegExp;
|
|
@@ -1984,9 +1994,9 @@ export declare const GetBillingProfileQueryParams: zod.ZodObject<{
|
|
|
1984
1994
|
}, zod.z.core.$strip>;
|
|
1985
1995
|
/**
|
|
1986
1996
|
* Update a billing profile by id.
|
|
1987
|
-
|
|
1988
|
-
The apps field cannot be updated directly, if an app change is desired a new
|
|
1989
|
-
profile should be created.
|
|
1997
|
+
*
|
|
1998
|
+
* The apps field cannot be updated directly, if an app change is desired a new
|
|
1999
|
+
* profile should be created.
|
|
1990
2000
|
* @summary Update a billing profile
|
|
1991
2001
|
*/
|
|
1992
2002
|
export declare const updateBillingProfilePathIdRegExp: RegExp;
|
|
@@ -2010,6 +2020,7 @@ export declare const updateBillingProfileBodyWorkflowOneInvoicingOneAutoAdvanceD
|
|
|
2010
2020
|
export declare const updateBillingProfileBodyWorkflowOneInvoicingOneDraftPeriodDefault = "P0D";
|
|
2011
2021
|
export declare const updateBillingProfileBodyWorkflowOneInvoicingOneDueAfterDefault = "P30D";
|
|
2012
2022
|
export declare const updateBillingProfileBodyWorkflowOneInvoicingOneProgressiveBillingDefault = true;
|
|
2023
|
+
export declare const updateBillingProfileBodyWorkflowOneInvoicingOneSubscriptionEndProrationModeDefault = "bill_actual_period";
|
|
2013
2024
|
export declare const updateBillingProfileBodyWorkflowOneInvoicingOneDefaultTaxConfigOneStripeOneCodeRegExp: RegExp;
|
|
2014
2025
|
export declare const updateBillingProfileBodyWorkflowOneInvoicingOneDefaultTaxConfigOneTaxCodeIdRegExp: RegExp;
|
|
2015
2026
|
export declare const updateBillingProfileBodyWorkflowOnePaymentOneCollectionMethodDefault = "charge_automatically";
|
|
@@ -2077,6 +2088,10 @@ export declare const UpdateBillingProfileBody: zod.ZodObject<{
|
|
|
2077
2088
|
draftPeriod: zod.ZodDefault<zod.z.ZodCoercedString<unknown>>;
|
|
2078
2089
|
dueAfter: zod.ZodDefault<zod.z.ZodCoercedString<unknown>>;
|
|
2079
2090
|
progressiveBilling: zod.ZodDefault<zod.z.ZodCoercedBoolean<unknown>>;
|
|
2091
|
+
subscriptionEndProrationMode: zod.ZodDefault<zod.ZodEnum<{
|
|
2092
|
+
bill_full_period: "bill_full_period";
|
|
2093
|
+
bill_actual_period: "bill_actual_period";
|
|
2094
|
+
}>>;
|
|
2080
2095
|
}, zod.z.core.$strip>>;
|
|
2081
2096
|
payment: zod.ZodOptional<zod.ZodObject<{
|
|
2082
2097
|
collectionMethod: zod.ZodDefault<zod.ZodEnum<{
|
|
@@ -2507,7 +2522,7 @@ export declare const GetCustomerEntitlementValueQueryParams: zod.ZodObject<{
|
|
|
2507
2522
|
}, zod.z.core.$strip>;
|
|
2508
2523
|
/**
|
|
2509
2524
|
* Get stripe app data for a customer.
|
|
2510
|
-
Only returns data if the customer billing profile is linked to a stripe app.
|
|
2525
|
+
* Only returns data if the customer billing profile is linked to a stripe app.
|
|
2511
2526
|
* @summary Get customer stripe app data
|
|
2512
2527
|
*/
|
|
2513
2528
|
export declare const getCustomerStripeAppDataPathCustomerIdOrKeyOneRegExp: RegExp;
|
|
@@ -2517,7 +2532,7 @@ export declare const GetCustomerStripeAppDataParams: zod.ZodObject<{
|
|
|
2517
2532
|
}, zod.z.core.$strip>;
|
|
2518
2533
|
/**
|
|
2519
2534
|
* Upsert stripe app data for a customer.
|
|
2520
|
-
Only updates data if the customer billing profile is linked to a stripe app.
|
|
2535
|
+
* Only updates data if the customer billing profile is linked to a stripe app.
|
|
2521
2536
|
* @summary Upsert customer stripe app data
|
|
2522
2537
|
*/
|
|
2523
2538
|
export declare const upsertCustomerStripeAppDataPathCustomerIdOrKeyOneRegExp: RegExp;
|
|
@@ -2531,10 +2546,10 @@ export declare const UpsertCustomerStripeAppDataBody: zod.ZodObject<{
|
|
|
2531
2546
|
}, zod.z.core.$strip>;
|
|
2532
2547
|
/**
|
|
2533
2548
|
* Create Stripe customer portal session.
|
|
2534
|
-
Only returns URL if the customer billing profile is linked to a stripe app and customer.
|
|
2535
|
-
|
|
2536
|
-
Useful to redirect the customer to the Stripe customer portal to manage their payment methods,
|
|
2537
|
-
change their billing address and access their invoice history.
|
|
2549
|
+
* Only returns URL if the customer billing profile is linked to a stripe app and customer.
|
|
2550
|
+
*
|
|
2551
|
+
* Useful to redirect the customer to the Stripe customer portal to manage their payment methods,
|
|
2552
|
+
* change their billing address and access their invoice history.
|
|
2538
2553
|
* @summary Create Stripe customer portal session
|
|
2539
2554
|
*/
|
|
2540
2555
|
export declare const createCustomerStripePortalSessionPathCustomerIdOrKeyOneRegExp: RegExp;
|
|
@@ -2580,10 +2595,10 @@ export declare const ListCustomerSubscriptionsQueryParams: zod.ZodObject<{
|
|
|
2580
2595
|
}, zod.z.core.$strip>;
|
|
2581
2596
|
/**
|
|
2582
2597
|
* List all entitlements for all the subjects and features. This endpoint is intended for administrative purposes only.
|
|
2583
|
-
To fetch the entitlements of a specific subject please use the /api/v1/subjects/{subjectKeyOrID}/entitlements endpoint.
|
|
2584
|
-
If page is provided that takes precedence and the paginated response is returned.
|
|
2585
|
-
|
|
2586
|
-
⚠️ __Deprecated__: Use [`GET /api/v2/entitlements`](#tag/entitlements/get/api/v2/entitlements) instead.
|
|
2598
|
+
* To fetch the entitlements of a specific subject please use the /api/v1/subjects/{subjectKeyOrID}/entitlements endpoint.
|
|
2599
|
+
* If page is provided that takes precedence and the paginated response is returned.
|
|
2600
|
+
*
|
|
2601
|
+
* ⚠️ __Deprecated__: Use [`GET /api/v2/entitlements`](#tag/entitlements/get/api/v2/entitlements) instead.
|
|
2587
2602
|
* @deprecated
|
|
2588
2603
|
* @summary List all entitlements
|
|
2589
2604
|
*/
|
|
@@ -2620,8 +2635,8 @@ export declare const ListEntitlementsQueryParams: zod.ZodObject<{
|
|
|
2620
2635
|
}, zod.z.core.$strip>;
|
|
2621
2636
|
/**
|
|
2622
2637
|
* Get entitlement by ID.
|
|
2623
|
-
|
|
2624
|
-
⚠️ __Deprecated__: Use [`GET /api/v2/entitlements/{entitlementId}`](#tag/entitlements/get/api/v2/entitlements/{entitlementId}) instead.
|
|
2638
|
+
*
|
|
2639
|
+
* ⚠️ __Deprecated__: Use [`GET /api/v2/entitlements/{entitlementId}`](#tag/entitlements/get/api/v2/entitlements/{entitlementId}) instead.
|
|
2625
2640
|
* @deprecated
|
|
2626
2641
|
* @summary Get entitlement by ID
|
|
2627
2642
|
*/
|
|
@@ -2631,8 +2646,8 @@ export declare const GetEntitlementByIdParams: zod.ZodObject<{
|
|
|
2631
2646
|
}, zod.z.core.$strip>;
|
|
2632
2647
|
/**
|
|
2633
2648
|
* List ingested events within a time range.
|
|
2634
|
-
|
|
2635
|
-
If the from query param is not provided it defaults to last 72 hours.
|
|
2649
|
+
*
|
|
2650
|
+
* If the from query param is not provided it defaults to last 72 hours.
|
|
2636
2651
|
* @summary List ingested events
|
|
2637
2652
|
*/
|
|
2638
2653
|
export declare const listEventsQueryClientIdMax = 36;
|
|
@@ -2654,9 +2669,8 @@ export declare const ListEventsQueryParams: zod.ZodObject<{
|
|
|
2654
2669
|
* Ingests an event or batch of events following the CloudEvents specification.
|
|
2655
2670
|
* @summary Ingest events
|
|
2656
2671
|
*/
|
|
2657
|
-
export declare const
|
|
2658
|
-
export declare const
|
|
2659
|
-
export declare const IngestEventsBody: zod.ZodUnion<readonly [zod.ZodObject<{
|
|
2672
|
+
export declare const ingestEventsBodySpecversionDefault = "1.0";
|
|
2673
|
+
export declare const IngestEventsBody: zod.ZodObject<{
|
|
2660
2674
|
data: zod.ZodOptional<zod.ZodNullable<zod.ZodRecord<zod.ZodString, zod.ZodUnknown>>>;
|
|
2661
2675
|
datacontenttype: zod.ZodOptional<zod.ZodNullable<zod.ZodEnum<{
|
|
2662
2676
|
"application/json": "application/json";
|
|
@@ -2668,19 +2682,7 @@ export declare const IngestEventsBody: zod.ZodUnion<readonly [zod.ZodObject<{
|
|
|
2668
2682
|
subject: zod.z.ZodCoercedString<unknown>;
|
|
2669
2683
|
time: zod.ZodOptional<zod.ZodNullable<zod.z.ZodCoercedDate<unknown>>>;
|
|
2670
2684
|
type: zod.z.ZodCoercedString<unknown>;
|
|
2671
|
-
}, zod.z.core.$strip
|
|
2672
|
-
data: zod.ZodOptional<zod.ZodNullable<zod.ZodRecord<zod.ZodString, zod.ZodUnknown>>>;
|
|
2673
|
-
datacontenttype: zod.ZodOptional<zod.ZodNullable<zod.ZodEnum<{
|
|
2674
|
-
"application/json": "application/json";
|
|
2675
|
-
}>>>;
|
|
2676
|
-
dataschema: zod.ZodOptional<zod.ZodNullable<zod.ZodURL>>;
|
|
2677
|
-
id: zod.z.ZodCoercedString<unknown>;
|
|
2678
|
-
source: zod.z.ZodCoercedString<unknown>;
|
|
2679
|
-
specversion: zod.ZodDefault<zod.z.ZodCoercedString<unknown>>;
|
|
2680
|
-
subject: zod.z.ZodCoercedString<unknown>;
|
|
2681
|
-
time: zod.ZodOptional<zod.ZodNullable<zod.z.ZodCoercedDate<unknown>>>;
|
|
2682
|
-
type: zod.z.ZodCoercedString<unknown>;
|
|
2683
|
-
}, zod.z.core.$strip>>]>;
|
|
2685
|
+
}, zod.z.core.$strip>;
|
|
2684
2686
|
/**
|
|
2685
2687
|
* List features.
|
|
2686
2688
|
* @summary List features
|
|
@@ -2715,8 +2717,8 @@ export declare const ListFeaturesQueryParams: zod.ZodObject<{
|
|
|
2715
2717
|
}, zod.z.core.$strip>;
|
|
2716
2718
|
/**
|
|
2717
2719
|
* Features are either metered or static. A feature is metered if meterSlug is provided at creation.
|
|
2718
|
-
For metered features you can pass additional filters that will be applied when calculating feature usage, based on the meter's groupBy fields.
|
|
2719
|
-
Meters with SUM, COUNT, UNIQUE_COUNT and LATEST aggregations are supported for features.
|
|
2720
|
+
* For metered features you can pass additional filters that will be applied when calculating feature usage, based on the meter's groupBy fields.
|
|
2721
|
+
* Meters with SUM, COUNT, UNIQUE_COUNT and LATEST aggregations are supported for features.
|
|
2720
2722
|
* @summary Create feature
|
|
2721
2723
|
*/
|
|
2722
2724
|
export declare const createFeatureBodyKeyMax = 64;
|
|
@@ -2784,9 +2786,9 @@ export declare const GetFeatureParams: zod.ZodObject<{
|
|
|
2784
2786
|
}, zod.z.core.$strip>;
|
|
2785
2787
|
/**
|
|
2786
2788
|
* Archive a feature by ID.
|
|
2787
|
-
|
|
2788
|
-
Once a feature is archived it cannot be unarchived. If a feature is archived, new entitlements cannot be created for it, but archiving the feature does not affect existing entitlements.
|
|
2789
|
-
This means, if you want to create a new feature with the same key, and then create entitlements for it, the previous entitlements have to be deleted first on a per subject basis.
|
|
2789
|
+
*
|
|
2790
|
+
* Once a feature is archived it cannot be unarchived. If a feature is archived, new entitlements cannot be created for it, but archiving the feature does not affect existing entitlements.
|
|
2791
|
+
* This means, if you want to create a new feature with the same key, and then create entitlements for it, the previous entitlements have to be deleted first on a per subject basis.
|
|
2790
2792
|
* @summary Delete feature
|
|
2791
2793
|
*/
|
|
2792
2794
|
export declare const DeleteFeatureParams: zod.ZodObject<{
|
|
@@ -2794,10 +2796,10 @@ export declare const DeleteFeatureParams: zod.ZodObject<{
|
|
|
2794
2796
|
}, zod.z.core.$strip>;
|
|
2795
2797
|
/**
|
|
2796
2798
|
* List all grants for all the subjects and entitlements. This endpoint is intended for administrative purposes only.
|
|
2797
|
-
To fetch the grants of a specific entitlement please use the /api/v1/subjects/{subjectKeyOrID}/entitlements/{entitlementOrFeatureID}/grants endpoint.
|
|
2798
|
-
If page is provided that takes precedence and the paginated response is returned.
|
|
2799
|
-
|
|
2800
|
-
⚠️ __Deprecated__: Use [`GET /api/v2/grants`](#tag/entitlements/get/api/v2/grants) instead.
|
|
2799
|
+
* To fetch the grants of a specific entitlement please use the /api/v1/subjects/{subjectKeyOrID}/entitlements/{entitlementOrFeatureID}/grants endpoint.
|
|
2800
|
+
* If page is provided that takes precedence and the paginated response is returned.
|
|
2801
|
+
*
|
|
2802
|
+
* ⚠️ __Deprecated__: Use [`GET /api/v2/grants`](#tag/entitlements/get/api/v2/grants) instead.
|
|
2801
2803
|
* @deprecated
|
|
2802
2804
|
* @summary List grants
|
|
2803
2805
|
*/
|
|
@@ -2830,7 +2832,7 @@ export declare const ListGrantsQueryParams: zod.ZodObject<{
|
|
|
2830
2832
|
}, zod.z.core.$strip>;
|
|
2831
2833
|
/**
|
|
2832
2834
|
* Voiding a grant means it is no longer valid, it doesn't take part in further balance calculations. Voiding a grant does not retroactively take effect, meaning any usage that has already been attributed to the grant will remain, but future usage cannot be burnt down from the grant.
|
|
2833
|
-
For example, if you have a single grant for your metered entitlement with an initial amount of 100, and so far 60 usage has been metered, the grant (and the entitlement itself) would have a balance of 40. If you then void that grant, balance becomes 0, but the 60 previous usage will not be affected.
|
|
2835
|
+
* For example, if you have a single grant for your metered entitlement with an initial amount of 100, and so far 60 usage has been metered, the grant (and the entitlement itself) would have a balance of 40. If you then void that grant, balance becomes 0, but the 60 previous usage will not be affected.
|
|
2834
2836
|
* @summary Void grant
|
|
2835
2837
|
*/
|
|
2836
2838
|
export declare const VoidGrantParams: zod.ZodObject<{
|
|
@@ -2903,7 +2905,7 @@ export declare const MarketplaceAppAPIKeyInstallBody: zod.ZodObject<{
|
|
|
2903
2905
|
}, zod.z.core.$strip>;
|
|
2904
2906
|
/**
|
|
2905
2907
|
* Install an app via OAuth.
|
|
2906
|
-
Returns a URL to start the OAuth 2.0 flow.
|
|
2908
|
+
* Returns a URL to start the OAuth 2.0 flow.
|
|
2907
2909
|
* @summary Get OAuth2 install URL
|
|
2908
2910
|
*/
|
|
2909
2911
|
export declare const MarketplaceOAuth2InstallGetURLParams: zod.ZodObject<{
|
|
@@ -2915,7 +2917,7 @@ export declare const MarketplaceOAuth2InstallGetURLParams: zod.ZodObject<{
|
|
|
2915
2917
|
}, zod.z.core.$strip>;
|
|
2916
2918
|
/**
|
|
2917
2919
|
* Authorize OAuth2 code.
|
|
2918
|
-
Verifies the OAuth code and exchanges it for a token and refresh token
|
|
2920
|
+
* Verifies the OAuth code and exchanges it for a token and refresh token
|
|
2919
2921
|
* @summary Install app via OAuth2
|
|
2920
2922
|
*/
|
|
2921
2923
|
export declare const MarketplaceOAuth2InstallAuthorizeParams: zod.ZodObject<{
|
|
@@ -3203,8 +3205,8 @@ export declare const GetNotificationChannelParams: zod.ZodObject<{
|
|
|
3203
3205
|
}, zod.z.core.$strip>;
|
|
3204
3206
|
/**
|
|
3205
3207
|
* Soft delete notification channel by id.
|
|
3206
|
-
|
|
3207
|
-
Once a notification channel is deleted it cannot be undeleted.
|
|
3208
|
+
*
|
|
3209
|
+
* Once a notification channel is deleted it cannot be undeleted.
|
|
3208
3210
|
* @summary Delete a notification channel
|
|
3209
3211
|
*/
|
|
3210
3212
|
export declare const deleteNotificationChannelPathChannelIdRegExp: RegExp;
|
|
@@ -3433,8 +3435,8 @@ export declare const GetNotificationRuleParams: zod.ZodObject<{
|
|
|
3433
3435
|
}, zod.z.core.$strip>;
|
|
3434
3436
|
/**
|
|
3435
3437
|
* Soft delete notification rule by id.
|
|
3436
|
-
|
|
3437
|
-
Once a notification rule is deleted it cannot be undeleted.
|
|
3438
|
+
*
|
|
3439
|
+
* Once a notification rule is deleted it cannot be undeleted.
|
|
3438
3440
|
* @summary Delete a notification rule
|
|
3439
3441
|
*/
|
|
3440
3442
|
export declare const deleteNotificationRulePathRuleIdRegExp: RegExp;
|
|
@@ -3765,7 +3767,7 @@ export declare const CreatePlanBody: zod.ZodObject<{
|
|
|
3765
3767
|
}, zod.z.core.$strip>;
|
|
3766
3768
|
/**
|
|
3767
3769
|
* Create a new draft version from plan.
|
|
3768
|
-
It returns error if there is already a plan in draft or planId does not reference the latest published version.
|
|
3770
|
+
* It returns error if there is already a plan in draft or planId does not reference the latest published version.
|
|
3769
3771
|
* @deprecated
|
|
3770
3772
|
* @summary New draft plan
|
|
3771
3773
|
*/
|
|
@@ -4058,8 +4060,8 @@ export declare const GetPlanQueryParams: zod.ZodObject<{
|
|
|
4058
4060
|
}, zod.z.core.$strip>;
|
|
4059
4061
|
/**
|
|
4060
4062
|
* Soft delete plan by plan.id.
|
|
4061
|
-
|
|
4062
|
-
Once a plan is deleted it cannot be undeleted.
|
|
4063
|
+
*
|
|
4064
|
+
* Once a plan is deleted it cannot be undeleted.
|
|
4063
4065
|
* @summary Delete plan
|
|
4064
4066
|
*/
|
|
4065
4067
|
export declare const deletePlanPathPlanIdRegExp: RegExp;
|
|
@@ -4146,8 +4148,8 @@ export declare const GetPlanAddonParams: zod.ZodObject<{
|
|
|
4146
4148
|
}, zod.z.core.$strip>;
|
|
4147
4149
|
/**
|
|
4148
4150
|
* Delete add-on assignment for plan.
|
|
4149
|
-
|
|
4150
|
-
Once a plan is deleted it cannot be undeleted.
|
|
4151
|
+
*
|
|
4152
|
+
* Once a plan is deleted it cannot be undeleted.
|
|
4151
4153
|
* @summary Delete add-on assignment for plan
|
|
4152
4154
|
*/
|
|
4153
4155
|
export declare const deletePlanAddonPathPlanIdRegExp: RegExp;
|
|
@@ -4352,11 +4354,11 @@ export declare const CreateStripeCheckoutSessionBody: zod.ZodObject<{
|
|
|
4352
4354
|
}, zod.z.core.$strip>;
|
|
4353
4355
|
/**
|
|
4354
4356
|
* Upserts a subject. Creates or updates subject.
|
|
4355
|
-
|
|
4356
|
-
If the subject doesn't exist, it will be created.
|
|
4357
|
-
If the subject exists, it will be partially updated with the provided fields.
|
|
4358
|
-
|
|
4359
|
-
⚠️ __Deprecated__: Subjects as managable entities are being depracated, use customers with subject key usage attribution instead.
|
|
4357
|
+
*
|
|
4358
|
+
* If the subject doesn't exist, it will be created.
|
|
4359
|
+
* If the subject exists, it will be partially updated with the provided fields.
|
|
4360
|
+
*
|
|
4361
|
+
* ⚠️ __Deprecated__: Subjects as managable entities are being depracated, use customers with subject key usage attribution instead.
|
|
4360
4362
|
* @deprecated
|
|
4361
4363
|
* @summary Upsert subject
|
|
4362
4364
|
*/
|
|
@@ -4378,8 +4380,8 @@ export declare const UpsertSubjectBody: zod.ZodArray<zod.ZodObject<{
|
|
|
4378
4380
|
}, zod.z.core.$strip>>;
|
|
4379
4381
|
/**
|
|
4380
4382
|
* Get subject by ID or key.
|
|
4381
|
-
|
|
4382
|
-
⚠️ __Deprecated__: Subjects as managable entities are being depracated, use customers with subject key usage attribution instead.
|
|
4383
|
+
*
|
|
4384
|
+
* ⚠️ __Deprecated__: Subjects as managable entities are being depracated, use customers with subject key usage attribution instead.
|
|
4383
4385
|
* @deprecated
|
|
4384
4386
|
* @summary Get subject
|
|
4385
4387
|
*/
|
|
@@ -4388,8 +4390,8 @@ export declare const GetSubjectParams: zod.ZodObject<{
|
|
|
4388
4390
|
}, zod.z.core.$strip>;
|
|
4389
4391
|
/**
|
|
4390
4392
|
* Delete subject by ID or key.
|
|
4391
|
-
|
|
4392
|
-
⚠️ __Deprecated__: Subjects as managable entities are being depracated, use customers with subject key usage attribution instead.
|
|
4393
|
+
*
|
|
4394
|
+
* ⚠️ __Deprecated__: Subjects as managable entities are being depracated, use customers with subject key usage attribution instead.
|
|
4393
4395
|
* @deprecated
|
|
4394
4396
|
* @summary Delete subject
|
|
4395
4397
|
*/
|
|
@@ -4398,16 +4400,16 @@ export declare const DeleteSubjectParams: zod.ZodObject<{
|
|
|
4398
4400
|
}, zod.z.core.$strip>;
|
|
4399
4401
|
/**
|
|
4400
4402
|
* OpenMeter has three types of entitlements: metered, boolean, and static. The type property determines the type of entitlement. The underlying feature has to be compatible with the entitlement type specified in the request (e.g., a metered entitlement needs a feature associated with a meter).
|
|
4401
|
-
|
|
4402
|
-
- Boolean entitlements define static feature access, e.g. "Can use SSO authentication".
|
|
4403
|
-
- Static entitlements let you pass along a configuration while granting access, e.g. "Using this feature with X Y settings" (passed in the config).
|
|
4404
|
-
- Metered entitlements have many use cases, from setting up usage-based access to implementing complex credit systems. Example: The customer can use 10000 AI tokens during the usage period of the entitlement.
|
|
4405
|
-
|
|
4406
|
-
A given subject can only have one active (non-deleted) entitlement per featureKey. If you try to create a new entitlement for a featureKey that already has an active entitlement, the request will fail with a 409 error.
|
|
4407
|
-
|
|
4408
|
-
Once an entitlement is created you cannot modify it, only delete it.
|
|
4409
|
-
|
|
4410
|
-
⚠️ __Deprecated__: Use [`POST /api/v2/customers/{customerIdOrKey}/entitlements`](#tag/entitlements/post/api/v2/customers/{customerIdOrKey}/entitlements) instead.
|
|
4403
|
+
*
|
|
4404
|
+
* - Boolean entitlements define static feature access, e.g. "Can use SSO authentication".
|
|
4405
|
+
* - Static entitlements let you pass along a configuration while granting access, e.g. "Using this feature with X Y settings" (passed in the config).
|
|
4406
|
+
* - Metered entitlements have many use cases, from setting up usage-based access to implementing complex credit systems. Example: The customer can use 10000 AI tokens during the usage period of the entitlement.
|
|
4407
|
+
*
|
|
4408
|
+
* A given subject can only have one active (non-deleted) entitlement per featureKey. If you try to create a new entitlement for a featureKey that already has an active entitlement, the request will fail with a 409 error.
|
|
4409
|
+
*
|
|
4410
|
+
* Once an entitlement is created you cannot modify it, only delete it.
|
|
4411
|
+
*
|
|
4412
|
+
* ⚠️ __Deprecated__: Use [`POST /api/v2/customers/{customerIdOrKey}/entitlements`](#tag/entitlements/post/api/v2/customers/{customerIdOrKey}/entitlements) instead.
|
|
4411
4413
|
* @deprecated
|
|
4412
4414
|
* @summary Create a subject entitlement
|
|
4413
4415
|
*/
|
|
@@ -4493,8 +4495,8 @@ export declare const CreateEntitlementBody: zod.ZodUnion<readonly [zod.ZodObject
|
|
|
4493
4495
|
}, zod.z.core.$strip>]>;
|
|
4494
4496
|
/**
|
|
4495
4497
|
* List all entitlements for a subject. For checking entitlement access, use the /value endpoint instead.
|
|
4496
|
-
|
|
4497
|
-
⚠️ __Deprecated__: Use [`GET /api/v2/customers/{customerIdOrKey}/entitlements`](#tag/entitlements/get/api/v2/customers/{customerIdOrKey}/entitlements) instead.
|
|
4498
|
+
*
|
|
4499
|
+
* ⚠️ __Deprecated__: Use [`GET /api/v2/customers/{customerIdOrKey}/entitlements`](#tag/entitlements/get/api/v2/customers/{customerIdOrKey}/entitlements) instead.
|
|
4498
4500
|
* @deprecated
|
|
4499
4501
|
* @summary List subject entitlements
|
|
4500
4502
|
*/
|
|
@@ -4507,8 +4509,8 @@ export declare const ListSubjectEntitlementsQueryParams: zod.ZodObject<{
|
|
|
4507
4509
|
}, zod.z.core.$strip>;
|
|
4508
4510
|
/**
|
|
4509
4511
|
* List all grants issued for an entitlement. The entitlement can be defined either by its id or featureKey.
|
|
4510
|
-
|
|
4511
|
-
⚠️ __Deprecated__: Use [`GET /api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/grants`](#tag/entitlements/get/api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/grants) instead.
|
|
4512
|
+
*
|
|
4513
|
+
* ⚠️ __Deprecated__: Use [`GET /api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/grants`](#tag/entitlements/get/api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/grants) instead.
|
|
4512
4514
|
* @deprecated
|
|
4513
4515
|
* @summary List subject entitlement grants
|
|
4514
4516
|
*/
|
|
@@ -4528,18 +4530,18 @@ export declare const ListEntitlementGrantsQueryParams: zod.ZodObject<{
|
|
|
4528
4530
|
}, zod.z.core.$strip>;
|
|
4529
4531
|
/**
|
|
4530
4532
|
* Grants define a behavior of granting usage for a metered entitlement. They can have complicated recurrence and rollover rules, thanks to which you can define a wide range of access patterns with a single grant, in most cases you don't have to periodically create new grants. You can only issue grants for active metered entitlements.
|
|
4531
|
-
|
|
4532
|
-
A grant defines a given amount of usage that can be consumed for the entitlement. The grant is in effect between its effective date and its expiration date. Specifying both is mandatory for new grants.
|
|
4533
|
-
|
|
4534
|
-
Grants have a priority setting that determines their order of use. Lower numbers have higher priority, with 0 being the highest priority.
|
|
4535
|
-
|
|
4536
|
-
Grants can have a recurrence setting intended to automate the manual reissuing of grants. For example, a daily recurrence is equal to reissuing that same grant every day (ignoring rollover settings).
|
|
4537
|
-
|
|
4538
|
-
Rollover settings define what happens to the remaining balance of a grant at a reset. Balance_After_Reset = MIN(MaxRolloverAmount, MAX(Balance_Before_Reset, MinRolloverAmount))
|
|
4539
|
-
|
|
4540
|
-
Grants cannot be changed once created, only deleted. This is to ensure that balance is deterministic regardless of when it is queried.
|
|
4541
|
-
|
|
4542
|
-
⚠️ __Deprecated__: Use [`POST /api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/grants`](#tag/entitlements/post/api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/grants) instead.
|
|
4533
|
+
*
|
|
4534
|
+
* A grant defines a given amount of usage that can be consumed for the entitlement. The grant is in effect between its effective date and its expiration date. Specifying both is mandatory for new grants.
|
|
4535
|
+
*
|
|
4536
|
+
* Grants have a priority setting that determines their order of use. Lower numbers have higher priority, with 0 being the highest priority.
|
|
4537
|
+
*
|
|
4538
|
+
* Grants can have a recurrence setting intended to automate the manual reissuing of grants. For example, a daily recurrence is equal to reissuing that same grant every day (ignoring rollover settings).
|
|
4539
|
+
*
|
|
4540
|
+
* Rollover settings define what happens to the remaining balance of a grant at a reset. Balance_After_Reset = MIN(MaxRolloverAmount, MAX(Balance_Before_Reset, MinRolloverAmount))
|
|
4541
|
+
*
|
|
4542
|
+
* Grants cannot be changed once created, only deleted. This is to ensure that balance is deterministic regardless of when it is queried.
|
|
4543
|
+
*
|
|
4544
|
+
* ⚠️ __Deprecated__: Use [`POST /api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/grants`](#tag/entitlements/post/api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/grants) instead.
|
|
4543
4545
|
* @deprecated
|
|
4544
4546
|
* @summary Create subject entitlement grant
|
|
4545
4547
|
*/
|
|
@@ -4582,10 +4584,10 @@ export declare const CreateGrantBody: zod.ZodObject<{
|
|
|
4582
4584
|
}, zod.z.core.$strip>;
|
|
4583
4585
|
/**
|
|
4584
4586
|
* Overriding an entitlement creates a new entitlement from the provided inputs and soft deletes the previous entitlement for the provided subject-feature pair. If the previous entitlement is already deleted or otherwise doesnt exist, the override will fail.
|
|
4585
|
-
|
|
4586
|
-
This endpoint is useful for upgrades, downgrades, or other changes to entitlements that require a new entitlement to be created with zero downtime.
|
|
4587
|
-
|
|
4588
|
-
⚠️ __Deprecated__: Use [`PUT /api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/override`](#tag/entitlements/put/api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/override) instead.
|
|
4587
|
+
*
|
|
4588
|
+
* This endpoint is useful for upgrades, downgrades, or other changes to entitlements that require a new entitlement to be created with zero downtime.
|
|
4589
|
+
*
|
|
4590
|
+
* ⚠️ __Deprecated__: Use [`PUT /api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/override`](#tag/entitlements/put/api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/override) instead.
|
|
4589
4591
|
* @deprecated
|
|
4590
4592
|
* @summary Override subject entitlement
|
|
4591
4593
|
*/
|
|
@@ -4672,10 +4674,10 @@ export declare const OverrideEntitlementBody: zod.ZodUnion<readonly [zod.ZodObje
|
|
|
4672
4674
|
}, zod.z.core.$strip>]>;
|
|
4673
4675
|
/**
|
|
4674
4676
|
* This endpoint should be used for access checks and enforcement. All entitlement types share the hasAccess property in their value response, but multiple other properties are returned based on the entitlement type.
|
|
4675
|
-
|
|
4676
|
-
For convenience reasons, /value works with both entitlementId and featureKey.
|
|
4677
|
-
|
|
4678
|
-
⚠️ __Deprecated__: Use [`GET /api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/value`](#tag/entitlements/get/api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/value) instead.
|
|
4677
|
+
*
|
|
4678
|
+
* For convenience reasons, /value works with both entitlementId and featureKey.
|
|
4679
|
+
*
|
|
4680
|
+
* ⚠️ __Deprecated__: Use [`GET /api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/value`](#tag/entitlements/get/api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/value) instead.
|
|
4679
4681
|
* @deprecated
|
|
4680
4682
|
* @summary Get subject entitlement value
|
|
4681
4683
|
*/
|
|
@@ -4688,8 +4690,8 @@ export declare const GetEntitlementValueQueryParams: zod.ZodObject<{
|
|
|
4688
4690
|
}, zod.z.core.$strip>;
|
|
4689
4691
|
/**
|
|
4690
4692
|
* Get entitlement by id. For checking entitlement access, use the /value endpoint instead.
|
|
4691
|
-
|
|
4692
|
-
⚠️ __Deprecated__: Use [`GET /api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}`](#tag/entitlements/get/api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}) instead.
|
|
4693
|
+
*
|
|
4694
|
+
* ⚠️ __Deprecated__: Use [`GET /api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}`](#tag/entitlements/get/api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}) instead.
|
|
4693
4695
|
* @deprecated
|
|
4694
4696
|
* @summary Get subject entitlement
|
|
4695
4697
|
*/
|
|
@@ -4699,9 +4701,9 @@ export declare const GetEntitlementParams: zod.ZodObject<{
|
|
|
4699
4701
|
}, zod.z.core.$strip>;
|
|
4700
4702
|
/**
|
|
4701
4703
|
* Deleting an entitlement revokes access to the associated feature. As a single subject can only have one entitlement per featureKey, when "migrating" features you have to delete the old entitlements as well.
|
|
4702
|
-
As access and status checks can be historical queries, deleting an entitlement populates the deletedAt timestamp. When queried for a time before that, the entitlement is still considered active, you cannot have retroactive changes to access, which is important for, among other things, auditing.
|
|
4703
|
-
|
|
4704
|
-
⚠️ __Deprecated__: Use [`DELETE /api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}`](#tag/entitlements/delete/api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}) instead.
|
|
4704
|
+
* As access and status checks can be historical queries, deleting an entitlement populates the deletedAt timestamp. When queried for a time before that, the entitlement is still considered active, you cannot have retroactive changes to access, which is important for, among other things, auditing.
|
|
4705
|
+
*
|
|
4706
|
+
* ⚠️ __Deprecated__: Use [`DELETE /api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}`](#tag/entitlements/delete/api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}) instead.
|
|
4705
4707
|
* @deprecated
|
|
4706
4708
|
* @summary Delete subject entitlement
|
|
4707
4709
|
*/
|
|
@@ -4711,12 +4713,12 @@ export declare const DeleteEntitlementParams: zod.ZodObject<{
|
|
|
4711
4713
|
}, zod.z.core.$strip>;
|
|
4712
4714
|
/**
|
|
4713
4715
|
* Returns historical balance and usage data for the entitlement. The queried history can span accross multiple reset events.
|
|
4714
|
-
|
|
4715
|
-
BurndownHistory returns a continous history of segments, where the segments are seperated by events that changed either the grant burndown priority or the usage period.
|
|
4716
|
-
|
|
4717
|
-
WindowedHistory returns windowed usage data for the period enriched with balance information and the list of grants that were being burnt down in that window.
|
|
4718
|
-
|
|
4719
|
-
⚠️ __Deprecated__: Use [`GET /api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/history`](#tag/entitlements/get/api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/history) instead.
|
|
4716
|
+
*
|
|
4717
|
+
* BurndownHistory returns a continous history of segments, where the segments are seperated by events that changed either the grant burndown priority or the usage period.
|
|
4718
|
+
*
|
|
4719
|
+
* WindowedHistory returns windowed usage data for the period enriched with balance information and the list of grants that were being burnt down in that window.
|
|
4720
|
+
*
|
|
4721
|
+
* ⚠️ __Deprecated__: Use [`GET /api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/history`](#tag/entitlements/get/api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/history) instead.
|
|
4720
4722
|
* @deprecated
|
|
4721
4723
|
* @summary Get subject entitlement history
|
|
4722
4724
|
*/
|
|
@@ -4738,10 +4740,10 @@ export declare const GetEntitlementHistoryQueryParams: zod.ZodObject<{
|
|
|
4738
4740
|
}, zod.z.core.$strip>;
|
|
4739
4741
|
/**
|
|
4740
4742
|
* Reset marks the start of a new usage period for the entitlement and initiates grant rollover. At the start of a period usage is zerod out and grants are rolled over based on their rollover settings. It would typically be synced with the subjects billing period to enforce usage based on their subscription.
|
|
4741
|
-
|
|
4742
|
-
Usage is automatically reset for metered entitlements based on their usage period, but this endpoint allows to manually reset it at any time. When doing so the period anchor of the entitlement can be changed if needed.
|
|
4743
|
-
|
|
4744
|
-
⚠️ __Deprecated__: Use [`POST /api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/reset`](#tag/entitlements/post/api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/reset) instead.
|
|
4743
|
+
*
|
|
4744
|
+
* Usage is automatically reset for metered entitlements based on their usage period, but this endpoint allows to manually reset it at any time. When doing so the period anchor of the entitlement can be changed if needed.
|
|
4745
|
+
*
|
|
4746
|
+
* ⚠️ __Deprecated__: Use [`POST /api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/reset`](#tag/entitlements/post/api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/reset) instead.
|
|
4745
4747
|
* @deprecated
|
|
4746
4748
|
* @summary Reset subject entitlement
|
|
4747
4749
|
*/
|
|
@@ -5075,7 +5077,7 @@ export declare const GetSubscriptionQueryParams: zod.ZodObject<{
|
|
|
5075
5077
|
}, zod.z.core.$strip>;
|
|
5076
5078
|
/**
|
|
5077
5079
|
* Batch processing commands for manipulating running subscriptions.
|
|
5078
|
-
The key format is `/phases/{phaseKey}` or `/phases/{phaseKey}/items/{itemKey}`.
|
|
5080
|
+
* The key format is `/phases/{phaseKey}` or `/phases/{phaseKey}/items/{itemKey}`.
|
|
5079
5081
|
* @summary Edit subscription
|
|
5080
5082
|
*/
|
|
5081
5083
|
export declare const editSubscriptionPathSubscriptionIdRegExp: RegExp;
|
|
@@ -5440,7 +5442,7 @@ export declare const UpdateSubscriptionAddonBody: zod.ZodObject<{
|
|
|
5440
5442
|
}, zod.z.core.$strip>;
|
|
5441
5443
|
/**
|
|
5442
5444
|
* Cancels the subscription.
|
|
5443
|
-
Will result in a scheduling conflict if there are other subscriptions scheduled to start after the cancellation time.
|
|
5445
|
+
* Will result in a scheduling conflict if there are other subscriptions scheduled to start after the cancellation time.
|
|
5444
5446
|
* @summary Cancel subscription
|
|
5445
5447
|
*/
|
|
5446
5448
|
export declare const cancelSubscriptionPathSubscriptionIdRegExp: RegExp;
|
|
@@ -5455,7 +5457,7 @@ export declare const CancelSubscriptionBody: zod.ZodObject<{
|
|
|
5455
5457
|
}, zod.z.core.$strip>;
|
|
5456
5458
|
/**
|
|
5457
5459
|
* Closes a running subscription and starts a new one according to the specification.
|
|
5458
|
-
Can be used for upgrades, downgrades, and plan changes.
|
|
5460
|
+
* Can be used for upgrades, downgrades, and plan changes.
|
|
5459
5461
|
* @summary Change subscription
|
|
5460
5462
|
*/
|
|
5461
5463
|
export declare const changeSubscriptionPathSubscriptionIdRegExp: RegExp;
|
|
@@ -5541,6 +5543,10 @@ export declare const ChangeSubscriptionBody: zod.ZodUnion<readonly [zod.ZodObjec
|
|
|
5541
5543
|
key: zod.z.ZodCoercedString<unknown>;
|
|
5542
5544
|
version: zod.ZodOptional<zod.z.ZodCoercedNumber<unknown>>;
|
|
5543
5545
|
}, zod.z.core.$strip>;
|
|
5546
|
+
settlementMode: zod.ZodOptional<zod.ZodEnum<{
|
|
5547
|
+
credit_then_invoice: "credit_then_invoice";
|
|
5548
|
+
credit_only: "credit_only";
|
|
5549
|
+
}>>;
|
|
5544
5550
|
startingPhase: zod.ZodOptional<zod.z.ZodCoercedString<unknown>>;
|
|
5545
5551
|
timing: zod.ZodUnion<readonly [zod.ZodEnum<{
|
|
5546
5552
|
immediate: "immediate";
|
|
@@ -5756,8 +5762,8 @@ export declare const ChangeSubscriptionBody: zod.ZodUnion<readonly [zod.ZodObjec
|
|
|
5756
5762
|
}, zod.z.core.$strip>]>;
|
|
5757
5763
|
/**
|
|
5758
5764
|
* Migrates the subscripiton to the provided version of the current plan.
|
|
5759
|
-
If possible, the migration will be done immediately.
|
|
5760
|
-
If not, the migration will be scheduled to the end of the current billing period.
|
|
5765
|
+
* If possible, the migration will be done immediately.
|
|
5766
|
+
* If not, the migration will be scheduled to the end of the current billing period.
|
|
5761
5767
|
* @summary Migrate subscription
|
|
5762
5768
|
*/
|
|
5763
5769
|
export declare const migrateSubscriptionPathSubscriptionIdRegExp: RegExp;
|
|
@@ -5776,7 +5782,7 @@ export declare const MigrateSubscriptionBody: zod.ZodObject<{
|
|
|
5776
5782
|
}, zod.z.core.$strip>;
|
|
5777
5783
|
/**
|
|
5778
5784
|
* Restores a canceled subscription.
|
|
5779
|
-
Any subscription scheduled to start later will be deleted and this subscription will be continued indefinitely.
|
|
5785
|
+
* Any subscription scheduled to start later will be deleted and this subscription will be continued indefinitely.
|
|
5780
5786
|
* @deprecated
|
|
5781
5787
|
* @summary Restore subscription
|
|
5782
5788
|
*/
|
|
@@ -5794,14 +5800,14 @@ export declare const UnscheduleCancelationParams: zod.ZodObject<{
|
|
|
5794
5800
|
}, zod.z.core.$strip>;
|
|
5795
5801
|
/**
|
|
5796
5802
|
* OpenMeter has three types of entitlements: metered, boolean, and static. The type property determines the type of entitlement. The underlying feature has to be compatible with the entitlement type specified in the request (e.g., a metered entitlement needs a feature associated with a meter).
|
|
5797
|
-
|
|
5798
|
-
- Boolean entitlements define static feature access, e.g. "Can use SSO authentication".
|
|
5799
|
-
- Static entitlements let you pass along a configuration while granting access, e.g. "Using this feature with X Y settings" (passed in the config).
|
|
5800
|
-
- Metered entitlements have many use cases, from setting up usage-based access to implementing complex credit systems. Example: The customer can use 10000 AI tokens during the usage period of the entitlement.
|
|
5801
|
-
|
|
5802
|
-
A given customer can only have one active (non-deleted) entitlement per featureKey. If you try to create a new entitlement for a featureKey that already has an active entitlement, the request will fail with a 409 error.
|
|
5803
|
-
|
|
5804
|
-
Once an entitlement is created you cannot modify it, only delete it.
|
|
5803
|
+
*
|
|
5804
|
+
* - Boolean entitlements define static feature access, e.g. "Can use SSO authentication".
|
|
5805
|
+
* - Static entitlements let you pass along a configuration while granting access, e.g. "Using this feature with X Y settings" (passed in the config).
|
|
5806
|
+
* - Metered entitlements have many use cases, from setting up usage-based access to implementing complex credit systems. Example: The customer can use 10000 AI tokens during the usage period of the entitlement.
|
|
5807
|
+
*
|
|
5808
|
+
* A given customer can only have one active (non-deleted) entitlement per featureKey. If you try to create a new entitlement for a featureKey that already has an active entitlement, the request will fail with a 409 error.
|
|
5809
|
+
*
|
|
5810
|
+
* Once an entitlement is created you cannot modify it, only delete it.
|
|
5805
5811
|
* @summary Create a customer entitlement
|
|
5806
5812
|
*/
|
|
5807
5813
|
export declare const createCustomerEntitlementV2PathCustomerIdOrKeyOneRegExp: RegExp;
|
|
@@ -5953,7 +5959,7 @@ export declare const ListCustomerEntitlementsV2QueryParams: zod.ZodObject<{
|
|
|
5953
5959
|
}, zod.z.core.$strip>;
|
|
5954
5960
|
/**
|
|
5955
5961
|
* Get entitlement by feature key. For checking entitlement access, use the /value endpoint instead.
|
|
5956
|
-
If featureKey is used, the entitlement is resolved for the current timestamp.
|
|
5962
|
+
* If featureKey is used, the entitlement is resolved for the current timestamp.
|
|
5957
5963
|
* @summary Get customer entitlement
|
|
5958
5964
|
*/
|
|
5959
5965
|
export declare const getCustomerEntitlementV2PathCustomerIdOrKeyOneRegExp: RegExp;
|
|
@@ -5966,7 +5972,7 @@ export declare const GetCustomerEntitlementV2Params: zod.ZodObject<{
|
|
|
5966
5972
|
}, zod.z.core.$strip>;
|
|
5967
5973
|
/**
|
|
5968
5974
|
* Deleting an entitlement revokes access to the associated feature. As a single customer can only have one entitlement per featureKey, when "migrating" features you have to delete the old entitlements as well.
|
|
5969
|
-
As access and status checks can be historical queries, deleting an entitlement populates the deletedAt timestamp. When queried for a time before that, the entitlement is still considered active, you cannot have retroactive changes to access, which is important for, among other things, auditing.
|
|
5975
|
+
* As access and status checks can be historical queries, deleting an entitlement populates the deletedAt timestamp. When queried for a time before that, the entitlement is still considered active, you cannot have retroactive changes to access, which is important for, among other things, auditing.
|
|
5970
5976
|
* @summary Delete customer entitlement
|
|
5971
5977
|
*/
|
|
5972
5978
|
export declare const deleteCustomerEntitlementV2PathCustomerIdOrKeyOneRegExp: RegExp;
|
|
@@ -6016,16 +6022,16 @@ export declare const ListCustomerEntitlementGrantsV2QueryParams: zod.ZodObject<{
|
|
|
6016
6022
|
}, zod.z.core.$strip>;
|
|
6017
6023
|
/**
|
|
6018
6024
|
* Grants define a behavior of granting usage for a metered entitlement. They can have complicated recurrence and rollover rules, thanks to which you can define a wide range of access patterns with a single grant, in most cases you don't have to periodically create new grants. You can only issue grants for active metered entitlements.
|
|
6019
|
-
|
|
6020
|
-
A grant defines a given amount of usage that can be consumed for the entitlement. The grant is in effect between its effective date and its expiration date. Specifying both is mandatory for new grants.
|
|
6021
|
-
|
|
6022
|
-
Grants have a priority setting that determines their order of use. Lower numbers have higher priority, with 0 being the highest priority.
|
|
6023
|
-
|
|
6024
|
-
Grants can have a recurrence setting intended to automate the manual reissuing of grants. For example, a daily recurrence is equal to reissuing that same grant every day (ignoring rollover settings).
|
|
6025
|
-
|
|
6026
|
-
Rollover settings define what happens to the remaining balance of a grant at a reset. Balance_After_Reset = MIN(MaxRolloverAmount, MAX(Balance_Before_Reset, MinRolloverAmount))
|
|
6027
|
-
|
|
6028
|
-
Grants cannot be changed once created, only deleted. This is to ensure that balance is deterministic regardless of when it is queried.
|
|
6025
|
+
*
|
|
6026
|
+
* A grant defines a given amount of usage that can be consumed for the entitlement. The grant is in effect between its effective date and its expiration date. Specifying both is mandatory for new grants.
|
|
6027
|
+
*
|
|
6028
|
+
* Grants have a priority setting that determines their order of use. Lower numbers have higher priority, with 0 being the highest priority.
|
|
6029
|
+
*
|
|
6030
|
+
* Grants can have a recurrence setting intended to automate the manual reissuing of grants. For example, a daily recurrence is equal to reissuing that same grant every day (ignoring rollover settings).
|
|
6031
|
+
*
|
|
6032
|
+
* Rollover settings define what happens to the remaining balance of a grant at a reset. Balance_After_Reset = MIN(MaxRolloverAmount, MAX(Balance_Before_Reset, MinRolloverAmount))
|
|
6033
|
+
*
|
|
6034
|
+
* Grants cannot be changed once created, only deleted. This is to ensure that balance is deterministic regardless of when it is queried.
|
|
6029
6035
|
* @summary Create customer entitlement grant
|
|
6030
6036
|
*/
|
|
6031
6037
|
export declare const createCustomerEntitlementGrantV2PathCustomerIdOrKeyOneRegExp: RegExp;
|
|
@@ -6071,10 +6077,10 @@ export declare const CreateCustomerEntitlementGrantV2Body: zod.ZodObject<{
|
|
|
6071
6077
|
}, zod.z.core.$strip>;
|
|
6072
6078
|
/**
|
|
6073
6079
|
* Returns historical balance and usage data for the entitlement. The queried history can span accross multiple reset events.
|
|
6074
|
-
|
|
6075
|
-
BurndownHistory returns a continous history of segments, where the segments are seperated by events that changed either the grant burndown priority or the usage period.
|
|
6076
|
-
|
|
6077
|
-
WindowedHistory returns windowed usage data for the period enriched with balance information and the list of grants that were being burnt down in that window.
|
|
6080
|
+
*
|
|
6081
|
+
* BurndownHistory returns a continous history of segments, where the segments are seperated by events that changed either the grant burndown priority or the usage period.
|
|
6082
|
+
*
|
|
6083
|
+
* WindowedHistory returns windowed usage data for the period enriched with balance information and the list of grants that were being burnt down in that window.
|
|
6078
6084
|
* @summary Get customer entitlement history
|
|
6079
6085
|
*/
|
|
6080
6086
|
export declare const getCustomerEntitlementHistoryV2PathCustomerIdOrKeyOneRegExp: RegExp;
|
|
@@ -6099,8 +6105,8 @@ export declare const GetCustomerEntitlementHistoryV2QueryParams: zod.ZodObject<{
|
|
|
6099
6105
|
}, zod.z.core.$strip>;
|
|
6100
6106
|
/**
|
|
6101
6107
|
* Overriding an entitlement creates a new entitlement from the provided inputs and soft deletes the previous entitlement for the provided customer-feature pair. If the previous entitlement is already deleted or otherwise doesnt exist, the override will fail.
|
|
6102
|
-
|
|
6103
|
-
This endpoint is useful for upgrades, downgrades, or other changes to entitlements that require a new entitlement to be created with zero downtime.
|
|
6108
|
+
*
|
|
6109
|
+
* This endpoint is useful for upgrades, downgrades, or other changes to entitlements that require a new entitlement to be created with zero downtime.
|
|
6104
6110
|
* @summary Override customer entitlement
|
|
6105
6111
|
*/
|
|
6106
6112
|
export declare const overrideCustomerEntitlementV2PathCustomerIdOrKeyOneRegExp: RegExp;
|
|
@@ -6228,8 +6234,8 @@ export declare const OverrideCustomerEntitlementV2Body: zod.ZodUnion<readonly [z
|
|
|
6228
6234
|
}, zod.z.core.$strip>]>;
|
|
6229
6235
|
/**
|
|
6230
6236
|
* Reset marks the start of a new usage period for the entitlement and initiates grant rollover. At the start of a period usage is zerod out and grants are rolled over based on their rollover settings. It would typically be synced with the customers billing period to enforce usage based on their subscription.
|
|
6231
|
-
|
|
6232
|
-
Usage is automatically reset for metered entitlements based on their usage period, but this endpoint allows to manually reset it at any time. When doing so the period anchor of the entitlement can be changed if needed.
|
|
6237
|
+
*
|
|
6238
|
+
* Usage is automatically reset for metered entitlements based on their usage period, but this endpoint allows to manually reset it at any time. When doing so the period anchor of the entitlement can be changed if needed.
|
|
6233
6239
|
* @summary Reset customer entitlement
|
|
6234
6240
|
*/
|
|
6235
6241
|
export declare const resetCustomerEntitlementUsageV2PathCustomerIdOrKeyOneRegExp: RegExp;
|
|
@@ -6262,7 +6268,7 @@ export declare const GetCustomerEntitlementValueV2QueryParams: zod.ZodObject<{
|
|
|
6262
6268
|
}, zod.z.core.$strip>;
|
|
6263
6269
|
/**
|
|
6264
6270
|
* List all entitlements for all the customers and features. This endpoint is intended for administrative purposes only.
|
|
6265
|
-
To fetch the entitlements of a specific subject please use the /api/v2/customers/{customerIdOrKey}/entitlements endpoint.
|
|
6271
|
+
* To fetch the entitlements of a specific subject please use the /api/v2/customers/{customerIdOrKey}/entitlements endpoint.
|
|
6266
6272
|
* @summary List all entitlements
|
|
6267
6273
|
*/
|
|
6268
6274
|
export declare const listEntitlementsV2QueryExcludeInactiveDefault = false;
|
|
@@ -6319,8 +6325,8 @@ export declare const ListEventsV2QueryParams: zod.ZodObject<{
|
|
|
6319
6325
|
}, zod.z.core.$strip>;
|
|
6320
6326
|
/**
|
|
6321
6327
|
* List all grants for all the customers and entitlements. This endpoint is intended for administrative purposes only.
|
|
6322
|
-
To fetch the grants of a specific entitlement please use the /api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/grants endpoint.
|
|
6323
|
-
If page is provided that takes precedence and the paginated response is returned.
|
|
6328
|
+
* To fetch the grants of a specific entitlement please use the /api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/grants endpoint.
|
|
6329
|
+
* If page is provided that takes precedence and the paginated response is returned.
|
|
6324
6330
|
* @summary List grants
|
|
6325
6331
|
*/
|
|
6326
6332
|
export declare const listGrantsV2QueryCustomerItemOneRegExp: RegExp;
|