@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
package/dist/src/zod/index.js
CHANGED
|
@@ -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';
|
|
@@ -1309,8 +1309,8 @@ export const GetAddonQueryParams = zod.object({
|
|
|
1309
1309
|
});
|
|
1310
1310
|
/**
|
|
1311
1311
|
* Soft delete add-on by id.
|
|
1312
|
-
|
|
1313
|
-
Once a add-on is deleted it cannot be undeleted.
|
|
1312
|
+
*
|
|
1313
|
+
* Once a add-on is deleted it cannot be undeleted.
|
|
1314
1314
|
* @summary Delete add-on
|
|
1315
1315
|
*/
|
|
1316
1316
|
export const deleteAddonPathAddonIdRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
|
|
@@ -1587,8 +1587,8 @@ export const UninstallAppParams = zod.object({
|
|
|
1587
1587
|
});
|
|
1588
1588
|
/**
|
|
1589
1589
|
* Update the Stripe API key.
|
|
1590
|
-
|
|
1591
|
-
⚠️ __Deprecated__: Use [`PUT /api/v1/apps/{id}`](#tag/apps/put/api/v1/apps/{id}) instead.
|
|
1590
|
+
*
|
|
1591
|
+
* ⚠️ __Deprecated__: Use [`PUT /api/v1/apps/{id}`](#tag/apps/put/api/v1/apps/{id}) instead.
|
|
1592
1592
|
* @deprecated
|
|
1593
1593
|
* @summary Update Stripe API key
|
|
1594
1594
|
*/
|
|
@@ -1624,12 +1624,12 @@ export const AppStripeWebhookBody = zod
|
|
|
1624
1624
|
.describe('Stripe webhook event.');
|
|
1625
1625
|
/**
|
|
1626
1626
|
* List customer overrides using the specified filters.
|
|
1627
|
-
|
|
1628
|
-
The response will include the customer override values and the merged billing profile values.
|
|
1629
|
-
|
|
1630
|
-
If the includeAllCustomers is set to true, the list contains all customers. This mode is
|
|
1631
|
-
useful for getting the current effective billing workflow settings for all users regardless
|
|
1632
|
-
if they have customer orverrides or not.
|
|
1627
|
+
*
|
|
1628
|
+
* The response will include the customer override values and the merged billing profile values.
|
|
1629
|
+
*
|
|
1630
|
+
* If the includeAllCustomers is set to true, the list contains all customers. This mode is
|
|
1631
|
+
* useful for getting the current effective billing workflow settings for all users regardless
|
|
1632
|
+
* if they have customer orverrides or not.
|
|
1633
1633
|
* @summary List customer overrides
|
|
1634
1634
|
*/
|
|
1635
1635
|
export const listBillingProfileCustomerOverridesQueryBillingProfileItemRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
|
|
@@ -1709,10 +1709,10 @@ export const ListBillingProfileCustomerOverridesQueryParams = zod.object({
|
|
|
1709
1709
|
});
|
|
1710
1710
|
/**
|
|
1711
1711
|
* The customer override can be used to pin a given customer to a billing profile
|
|
1712
|
-
different from the default one.
|
|
1713
|
-
|
|
1714
|
-
This can be used to test the effect of different billing profiles before making them
|
|
1715
|
-
the default ones or have different workflow settings for example for enterprise customers.
|
|
1712
|
+
* different from the default one.
|
|
1713
|
+
*
|
|
1714
|
+
* This can be used to test the effect of different billing profiles before making them
|
|
1715
|
+
* the default ones or have different workflow settings for example for enterprise customers.
|
|
1716
1716
|
* @summary Create a new or update a customer override
|
|
1717
1717
|
*/
|
|
1718
1718
|
export const upsertBillingProfileCustomerOverridePathCustomerIdRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
|
|
@@ -1733,11 +1733,11 @@ export const UpsertBillingProfileCustomerOverrideBody = zod
|
|
|
1733
1733
|
.describe('Payload for creating a new or updating an existing customer override.');
|
|
1734
1734
|
/**
|
|
1735
1735
|
* Get a customer override by customer id.
|
|
1736
|
-
|
|
1737
|
-
The response will include the customer override values and the merged billing profile values.
|
|
1738
|
-
|
|
1739
|
-
If the customer override is not found, the default billing profile's values are returned. This behavior
|
|
1740
|
-
allows for getting a merged profile regardless of the customer override existence.
|
|
1736
|
+
*
|
|
1737
|
+
* The response will include the customer override values and the merged billing profile values.
|
|
1738
|
+
*
|
|
1739
|
+
* If the customer override is not found, the default billing profile's values are returned. This behavior
|
|
1740
|
+
* allows for getting a merged profile regardless of the customer override existence.
|
|
1741
1741
|
* @summary Get a customer override
|
|
1742
1742
|
*/
|
|
1743
1743
|
export const getBillingProfileCustomerOverridePathCustomerIdRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
|
|
@@ -1755,9 +1755,9 @@ export const GetBillingProfileCustomerOverrideQueryParams = zod.object({
|
|
|
1755
1755
|
});
|
|
1756
1756
|
/**
|
|
1757
1757
|
* Delete a customer override by customer id.
|
|
1758
|
-
|
|
1759
|
-
This will remove the customer override and the customer will be subject to the default
|
|
1760
|
-
billing profile's settings again.
|
|
1758
|
+
*
|
|
1759
|
+
* This will remove the customer override and the customer will be subject to the default
|
|
1760
|
+
* billing profile's settings again.
|
|
1761
1761
|
* @summary Delete a customer override
|
|
1762
1762
|
*/
|
|
1763
1763
|
export const deleteBillingProfileCustomerOverridePathCustomerIdRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
|
|
@@ -1768,13 +1768,13 @@ export const DeleteBillingProfileCustomerOverrideParams = zod.object({
|
|
|
1768
1768
|
});
|
|
1769
1769
|
/**
|
|
1770
1770
|
* Create a new pending line item (charge).
|
|
1771
|
-
|
|
1772
|
-
This call is used to create a new pending line item for the customer if required a new
|
|
1773
|
-
gathering invoice will be created.
|
|
1774
|
-
|
|
1775
|
-
A new invoice will be created if:
|
|
1776
|
-
- there is no invoice in gathering state
|
|
1777
|
-
- the currency of the line item doesn't match the currency of any invoices in gathering state
|
|
1771
|
+
*
|
|
1772
|
+
* This call is used to create a new pending line item for the customer if required a new
|
|
1773
|
+
* gathering invoice will be created.
|
|
1774
|
+
*
|
|
1775
|
+
* A new invoice will be created if:
|
|
1776
|
+
* - there is no invoice in gathering state
|
|
1777
|
+
* - the currency of the line item doesn't match the currency of any invoices in gathering state
|
|
1778
1778
|
* @summary Create pending line items
|
|
1779
1779
|
*/
|
|
1780
1780
|
export const createPendingInvoiceLinePathCustomerIdRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
|
|
@@ -2333,10 +2333,10 @@ export const CreatePendingInvoiceLineBody = zod
|
|
|
2333
2333
|
.describe('InvoicePendingLineCreate represents the create model for a pending invoice line.');
|
|
2334
2334
|
/**
|
|
2335
2335
|
* Simulate an invoice for a customer.
|
|
2336
|
-
|
|
2337
|
-
This call will simulate an invoice for a customer based on the pending line items.
|
|
2338
|
-
|
|
2339
|
-
The call will return the total amount of the invoice and the line items that will be included in the invoice.
|
|
2336
|
+
*
|
|
2337
|
+
* This call will simulate an invoice for a customer based on the pending line items.
|
|
2338
|
+
*
|
|
2339
|
+
* The call will return the total amount of the invoice and the line items that will be included in the invoice.
|
|
2340
2340
|
* @summary Simulate an invoice for a customer
|
|
2341
2341
|
*/
|
|
2342
2342
|
export const simulateInvoicePathCustomerIdRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
|
|
@@ -2919,11 +2919,11 @@ export const SimulateInvoiceBody = zod
|
|
|
2919
2919
|
.describe('InvoiceSimulationInput is the input for simulating an invoice.');
|
|
2920
2920
|
/**
|
|
2921
2921
|
* List invoices based on the specified filters.
|
|
2922
|
-
|
|
2923
|
-
The expand option can be used to include additional information (besides the invoice header and totals)
|
|
2924
|
-
in the response. For example by adding the expand=lines option the invoice lines will be included in the response.
|
|
2925
|
-
|
|
2926
|
-
Gathering invoices will always show the current usage calculated on the fly.
|
|
2922
|
+
*
|
|
2923
|
+
* The expand option can be used to include additional information (besides the invoice header and totals)
|
|
2924
|
+
* in the response. For example by adding the expand=lines option the invoice lines will be included in the response.
|
|
2925
|
+
*
|
|
2926
|
+
* Gathering invoices will always show the current usage calculated on the fly.
|
|
2927
2927
|
* @summary List invoices
|
|
2928
2928
|
*/
|
|
2929
2929
|
export const listInvoicesQueryCustomersItemRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
|
|
@@ -3023,14 +3023,14 @@ export const ListInvoicesQueryParams = zod.object({
|
|
|
3023
3023
|
});
|
|
3024
3024
|
/**
|
|
3025
3025
|
* Create a new invoice from the pending line items.
|
|
3026
|
-
|
|
3027
|
-
This should be only called if for some reason we need to invoice a customer outside of the normal billing cycle.
|
|
3028
|
-
|
|
3029
|
-
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.
|
|
3030
|
-
|
|
3031
|
-
New pending line items will be created for the period between now() and the next billing cycle's begining date for any metered item.
|
|
3032
|
-
|
|
3033
|
-
The call can return multiple invoices if the pending line items are in different currencies.
|
|
3026
|
+
*
|
|
3027
|
+
* This should be only called if for some reason we need to invoice a customer outside of the normal billing cycle.
|
|
3028
|
+
*
|
|
3029
|
+
* 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.
|
|
3030
|
+
*
|
|
3031
|
+
* New pending line items will be created for the period between now() and the next billing cycle's begining date for any metered item.
|
|
3032
|
+
*
|
|
3033
|
+
* The call can return multiple invoices if the pending line items are in different currencies.
|
|
3034
3034
|
* @summary Invoice a customer based on the pending line items
|
|
3035
3035
|
*/
|
|
3036
3036
|
export const invoicePendingLinesActionBodyFiltersOneLineIdsItemRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
|
|
@@ -3066,8 +3066,8 @@ export const InvoicePendingLinesActionBody = zod
|
|
|
3066
3066
|
.describe('BillingInvoiceActionInput is the input for creating an invoice.\n\nInvoice creation is always based on already pending line items created by the billingCreateLineByCustomer\noperation. Empty invoices are not allowed.');
|
|
3067
3067
|
/**
|
|
3068
3068
|
* Get an invoice by ID.
|
|
3069
|
-
|
|
3070
|
-
Gathering invoices will always show the current usage calculated on the fly.
|
|
3069
|
+
*
|
|
3070
|
+
* Gathering invoices will always show the current usage calculated on the fly.
|
|
3071
3071
|
* @summary Get an invoice
|
|
3072
3072
|
*/
|
|
3073
3073
|
export const getInvoicePathInvoiceIdRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
|
|
@@ -3087,10 +3087,10 @@ export const GetInvoiceQueryParams = zod.object({
|
|
|
3087
3087
|
});
|
|
3088
3088
|
/**
|
|
3089
3089
|
* Delete an invoice
|
|
3090
|
-
|
|
3091
|
-
Only invoices that are in the draft (or earlier) status can be deleted.
|
|
3092
|
-
|
|
3093
|
-
Invoices that are post finalization can only be voided.
|
|
3090
|
+
*
|
|
3091
|
+
* Only invoices that are in the draft (or earlier) status can be deleted.
|
|
3092
|
+
*
|
|
3093
|
+
* Invoices that are post finalization can only be voided.
|
|
3094
3094
|
* @summary Delete an invoice
|
|
3095
3095
|
*/
|
|
3096
3096
|
export const deleteInvoicePathInvoiceIdRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
|
|
@@ -3099,8 +3099,8 @@ export const DeleteInvoiceParams = zod.object({
|
|
|
3099
3099
|
});
|
|
3100
3100
|
/**
|
|
3101
3101
|
* Update an invoice
|
|
3102
|
-
|
|
3103
|
-
Only invoices in draft or earlier status can be updated.
|
|
3102
|
+
*
|
|
3103
|
+
* Only invoices in draft or earlier status can be updated.
|
|
3104
3104
|
* @summary Update an invoice
|
|
3105
3105
|
*/
|
|
3106
3106
|
export const updateInvoicePathInvoiceIdRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
|
|
@@ -3173,6 +3173,7 @@ export const updateInvoiceBodyLinesItemIdRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkm
|
|
|
3173
3173
|
export const updateInvoiceBodyWorkflowOneWorkflowOneInvoicingOneAutoAdvanceDefault = true;
|
|
3174
3174
|
export const updateInvoiceBodyWorkflowOneWorkflowOneInvoicingOneDraftPeriodDefault = 'P0D';
|
|
3175
3175
|
export const updateInvoiceBodyWorkflowOneWorkflowOneInvoicingOneDueAfterDefault = 'P30D';
|
|
3176
|
+
export const updateInvoiceBodyWorkflowOneWorkflowOneInvoicingOneSubscriptionEndProrationModeDefault = 'bill_actual_period';
|
|
3176
3177
|
export const updateInvoiceBodyWorkflowOneWorkflowOneInvoicingOneDefaultTaxConfigOneStripeOneCodeRegExp = /^txcd_\d{8}$/;
|
|
3177
3178
|
export const updateInvoiceBodyWorkflowOneWorkflowOneInvoicingOneDefaultTaxConfigOneTaxCodeIdRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
|
|
3178
3179
|
export const updateInvoiceBodyWorkflowOneWorkflowOnePaymentOneCollectionMethodDefault = 'charge_automatically';
|
|
@@ -3851,7 +3852,7 @@ export const UpdateInvoiceBody = zod
|
|
|
3851
3852
|
})
|
|
3852
3853
|
.describe('Set of provider specific tax configs.')
|
|
3853
3854
|
.optional()
|
|
3854
|
-
.describe(
|
|
3855
|
+
.describe("Default tax configuration to apply to the invoices.\n\nSetting a tax code (`stripe.code` / `taxCodeId`) on a profile's default tax config is\ndeprecated and can no longer be added or changed: the organization default tax code is\nused instead. Existing tax-code values may still be removed, and `behavior` remains\nfully supported."),
|
|
3855
3856
|
draftPeriod: zod.coerce
|
|
3856
3857
|
.string()
|
|
3857
3858
|
.default(updateInvoiceBodyWorkflowOneWorkflowOneInvoicingOneDraftPeriodDefault)
|
|
@@ -3860,6 +3861,11 @@ export const UpdateInvoiceBody = zod
|
|
|
3860
3861
|
.string()
|
|
3861
3862
|
.default(updateInvoiceBodyWorkflowOneWorkflowOneInvoicingOneDueAfterDefault)
|
|
3862
3863
|
.describe("The period after which the invoice is due.\nWith some payment solutions it's only applicable for manual collection method."),
|
|
3864
|
+
subscriptionEndProrationMode: zod
|
|
3865
|
+
.enum(['bill_full_period', 'bill_actual_period'])
|
|
3866
|
+
.describe('Billing workflow subscription end proration mode.')
|
|
3867
|
+
.default(updateInvoiceBodyWorkflowOneWorkflowOneInvoicingOneSubscriptionEndProrationModeDefault)
|
|
3868
|
+
.describe('Controls how subscription-ending shortened service periods are billed.'),
|
|
3863
3869
|
})
|
|
3864
3870
|
.describe('InvoiceWorkflowInvoicingSettingsReplaceUpdate represents the update model for the invoicing settings of an invoice workflow.')
|
|
3865
3871
|
.describe('The invoicing settings for this workflow'),
|
|
@@ -3883,10 +3889,10 @@ export const UpdateInvoiceBody = zod
|
|
|
3883
3889
|
.describe('InvoiceReplaceUpdate represents the update model for an invoice.');
|
|
3884
3890
|
/**
|
|
3885
3891
|
* Advance the invoice's state to the next status.
|
|
3886
|
-
|
|
3887
|
-
The call doesn't "approve the invoice", it only advances the invoice to the next status if the transition would be automatic.
|
|
3888
|
-
|
|
3889
|
-
The action can be called when the invoice's statusDetails' actions field contain the "advance" action.
|
|
3892
|
+
*
|
|
3893
|
+
* The call doesn't "approve the invoice", it only advances the invoice to the next status if the transition would be automatic.
|
|
3894
|
+
*
|
|
3895
|
+
* The action can be called when the invoice's statusDetails' actions field contain the "advance" action.
|
|
3890
3896
|
* @summary Advance the invoice's state to the next status
|
|
3891
3897
|
*/
|
|
3892
3898
|
export const advanceInvoiceActionPathInvoiceIdRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
|
|
@@ -3895,12 +3901,12 @@ export const AdvanceInvoiceActionParams = zod.object({
|
|
|
3895
3901
|
});
|
|
3896
3902
|
/**
|
|
3897
3903
|
* Approve an invoice and start executing the payment workflow.
|
|
3898
|
-
|
|
3899
|
-
This call instantly sends the invoice to the customer using the configured billing profile app.
|
|
3900
|
-
|
|
3901
|
-
This call is valid in two invoice statuses:
|
|
3902
|
-
- `draft`: the invoice will be sent to the customer, the invluce state becomes issued
|
|
3903
|
-
- `manual_approval_needed`: the invoice will be sent to the customer, the invoice state becomes issued
|
|
3904
|
+
*
|
|
3905
|
+
* This call instantly sends the invoice to the customer using the configured billing profile app.
|
|
3906
|
+
*
|
|
3907
|
+
* This call is valid in two invoice statuses:
|
|
3908
|
+
* - `draft`: the invoice will be sent to the customer, the invluce state becomes issued
|
|
3909
|
+
* - `manual_approval_needed`: the invoice will be sent to the customer, the invoice state becomes issued
|
|
3904
3910
|
* @summary Send the invoice to the customer
|
|
3905
3911
|
*/
|
|
3906
3912
|
export const approveInvoiceActionPathInvoiceIdRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
|
|
@@ -3909,8 +3915,8 @@ export const ApproveInvoiceActionParams = zod.object({
|
|
|
3909
3915
|
});
|
|
3910
3916
|
/**
|
|
3911
3917
|
* Retry advancing the invoice after a failed attempt.
|
|
3912
|
-
|
|
3913
|
-
The action can be called when the invoice's statusDetails' actions field contain the "retry" action.
|
|
3918
|
+
*
|
|
3919
|
+
* The action can be called when the invoice's statusDetails' actions field contain the "retry" action.
|
|
3914
3920
|
* @summary Retry advancing the invoice after a failed attempt.
|
|
3915
3921
|
*/
|
|
3916
3922
|
export const retryInvoiceActionPathInvoiceIdRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
|
|
@@ -3919,11 +3925,11 @@ export const RetryInvoiceActionParams = zod.object({
|
|
|
3919
3925
|
});
|
|
3920
3926
|
/**
|
|
3921
3927
|
* Snapshot quantities for usage based line items.
|
|
3922
|
-
|
|
3923
|
-
This call will snapshot the quantities for all usage based line items in the invoice.
|
|
3924
|
-
|
|
3925
|
-
This call is only valid in `draft.waiting_for_collection` status, where the collection period
|
|
3926
|
-
can be skipped using this action.
|
|
3928
|
+
*
|
|
3929
|
+
* This call will snapshot the quantities for all usage based line items in the invoice.
|
|
3930
|
+
*
|
|
3931
|
+
* This call is only valid in `draft.waiting_for_collection` status, where the collection period
|
|
3932
|
+
* can be skipped using this action.
|
|
3927
3933
|
* @summary Snapshot quantities for usage based line items
|
|
3928
3934
|
*/
|
|
3929
3935
|
export const snapshotQuantitiesInvoiceActionPathInvoiceIdRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
|
|
@@ -3934,8 +3940,8 @@ export const SnapshotQuantitiesInvoiceActionParams = zod.object({
|
|
|
3934
3940
|
});
|
|
3935
3941
|
/**
|
|
3936
3942
|
* Recalculate an invoice's tax amounts (using the app set in the customer's billing profile)
|
|
3937
|
-
|
|
3938
|
-
Note: charges might apply, depending on the tax provider.
|
|
3943
|
+
*
|
|
3944
|
+
* Note: charges might apply, depending on the tax provider.
|
|
3939
3945
|
* @summary Recalculate an invoice's tax amounts
|
|
3940
3946
|
*/
|
|
3941
3947
|
export const recalculateInvoiceTaxActionPathInvoiceIdRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
|
|
@@ -3946,10 +3952,10 @@ export const RecalculateInvoiceTaxActionParams = zod.object({
|
|
|
3946
3952
|
});
|
|
3947
3953
|
/**
|
|
3948
3954
|
* Void an invoice
|
|
3949
|
-
|
|
3950
|
-
Only invoices that have been alread issued can be voided.
|
|
3951
|
-
|
|
3952
|
-
Voiding an invoice will mark it as voided, the user can specify how to handle the voided line items.
|
|
3955
|
+
*
|
|
3956
|
+
* Only invoices that have been alread issued can be voided.
|
|
3957
|
+
*
|
|
3958
|
+
* Voiding an invoice will mark it as voided, the user can specify how to handle the voided line items.
|
|
3953
3959
|
* @summary Void an invoice
|
|
3954
3960
|
*/
|
|
3955
3961
|
export const voidInvoiceActionPathInvoiceIdRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
|
|
@@ -4039,10 +4045,10 @@ export const VoidInvoiceActionBody = zod
|
|
|
4039
4045
|
.describe('Request to void an invoice');
|
|
4040
4046
|
/**
|
|
4041
4047
|
* List all billing profiles matching the specified filters.
|
|
4042
|
-
|
|
4043
|
-
The expand option can be used to include additional information (besides the billing profile)
|
|
4044
|
-
in the response. For example by adding the expand=apps option the apps used by the billing profile
|
|
4045
|
-
will be included in the response.
|
|
4048
|
+
*
|
|
4049
|
+
* The expand option can be used to include additional information (besides the billing profile)
|
|
4050
|
+
* in the response. For example by adding the expand=apps option the apps used by the billing profile
|
|
4051
|
+
* will be included in the response.
|
|
4046
4052
|
* @summary List billing profiles
|
|
4047
4053
|
*/
|
|
4048
4054
|
export const listBillingProfilesQueryIncludeArchivedDefault = false;
|
|
@@ -4082,9 +4088,9 @@ export const ListBillingProfilesQueryParams = zod.object({
|
|
|
4082
4088
|
});
|
|
4083
4089
|
/**
|
|
4084
4090
|
* Create a new billing profile
|
|
4085
|
-
|
|
4086
|
-
Billing profiles are representations of a customer's billing information. Customer overrides
|
|
4087
|
-
can be applied to a billing profile to customize the billing behavior for a specific customer.
|
|
4091
|
+
*
|
|
4092
|
+
* Billing profiles are representations of a customer's billing information. Customer overrides
|
|
4093
|
+
* can be applied to a billing profile to customize the billing behavior for a specific customer.
|
|
4088
4094
|
* @summary Create a new billing profile
|
|
4089
4095
|
*/
|
|
4090
4096
|
export const createBillingProfileBodyNameMax = 256;
|
|
@@ -4102,6 +4108,7 @@ export const createBillingProfileBodyWorkflowOneInvoicingOneAutoAdvanceDefault =
|
|
|
4102
4108
|
export const createBillingProfileBodyWorkflowOneInvoicingOneDraftPeriodDefault = 'P0D';
|
|
4103
4109
|
export const createBillingProfileBodyWorkflowOneInvoicingOneDueAfterDefault = 'P30D';
|
|
4104
4110
|
export const createBillingProfileBodyWorkflowOneInvoicingOneProgressiveBillingDefault = true;
|
|
4111
|
+
export const createBillingProfileBodyWorkflowOneInvoicingOneSubscriptionEndProrationModeDefault = 'bill_actual_period';
|
|
4105
4112
|
export const createBillingProfileBodyWorkflowOneInvoicingOneDefaultTaxConfigOneStripeOneCodeRegExp = /^txcd_\d{8}$/;
|
|
4106
4113
|
export const createBillingProfileBodyWorkflowOneInvoicingOneDefaultTaxConfigOneTaxCodeIdRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
|
|
4107
4114
|
export const createBillingProfileBodyWorkflowOnePaymentOneCollectionMethodDefault = 'charge_automatically';
|
|
@@ -4305,7 +4312,7 @@ export const CreateBillingProfileBody = zod
|
|
|
4305
4312
|
})
|
|
4306
4313
|
.describe('Set of provider specific tax configs.')
|
|
4307
4314
|
.optional()
|
|
4308
|
-
.describe(
|
|
4315
|
+
.describe("Default tax configuration to apply to the invoices.\n\nSetting a tax code (`stripe.code` / `taxCodeId`) on a profile's default tax config is\ndeprecated and can no longer be added or changed: the organization default tax code is\nused instead. Existing tax-code values may still be removed, and `behavior` remains\nfully supported."),
|
|
4309
4316
|
draftPeriod: zod.coerce
|
|
4310
4317
|
.string()
|
|
4311
4318
|
.default(createBillingProfileBodyWorkflowOneInvoicingOneDraftPeriodDefault)
|
|
@@ -4318,6 +4325,11 @@ export const CreateBillingProfileBody = zod
|
|
|
4318
4325
|
.boolean()
|
|
4319
4326
|
.default(createBillingProfileBodyWorkflowOneInvoicingOneProgressiveBillingDefault)
|
|
4320
4327
|
.describe('Should progressive billing be allowed for this workflow?'),
|
|
4328
|
+
subscriptionEndProrationMode: zod
|
|
4329
|
+
.enum(['bill_full_period', 'bill_actual_period'])
|
|
4330
|
+
.describe('Billing workflow subscription end proration mode.')
|
|
4331
|
+
.default(createBillingProfileBodyWorkflowOneInvoicingOneSubscriptionEndProrationModeDefault)
|
|
4332
|
+
.describe('Controls how subscription-ending shortened service periods are billed.'),
|
|
4321
4333
|
})
|
|
4322
4334
|
.describe('BillingWorkflowInvoicingSettings represents the invoice settings for a billing workflow')
|
|
4323
4335
|
.optional()
|
|
@@ -4354,11 +4366,11 @@ export const CreateBillingProfileBody = zod
|
|
|
4354
4366
|
.describe('BillingProfileCreate represents the input for creating a billing profile');
|
|
4355
4367
|
/**
|
|
4356
4368
|
* Delete a billing profile by id.
|
|
4357
|
-
|
|
4358
|
-
Only such billing profiles can be deleted that are:
|
|
4359
|
-
- not the default one
|
|
4360
|
-
- not pinned to any customer using customer overrides
|
|
4361
|
-
- only have finalized invoices
|
|
4369
|
+
*
|
|
4370
|
+
* Only such billing profiles can be deleted that are:
|
|
4371
|
+
* - not the default one
|
|
4372
|
+
* - not pinned to any customer using customer overrides
|
|
4373
|
+
* - only have finalized invoices
|
|
4362
4374
|
* @summary Delete a billing profile
|
|
4363
4375
|
*/
|
|
4364
4376
|
export const deleteBillingProfilePathIdRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
|
|
@@ -4367,10 +4379,10 @@ export const DeleteBillingProfileParams = zod.object({
|
|
|
4367
4379
|
});
|
|
4368
4380
|
/**
|
|
4369
4381
|
* Get a billing profile by id.
|
|
4370
|
-
|
|
4371
|
-
The expand option can be used to include additional information (besides the billing profile)
|
|
4372
|
-
in the response. For example by adding the expand=apps option the apps used by the billing profile
|
|
4373
|
-
will be included in the response.
|
|
4382
|
+
*
|
|
4383
|
+
* The expand option can be used to include additional information (besides the billing profile)
|
|
4384
|
+
* in the response. For example by adding the expand=apps option the apps used by the billing profile
|
|
4385
|
+
* will be included in the response.
|
|
4374
4386
|
* @summary Get a billing profile
|
|
4375
4387
|
*/
|
|
4376
4388
|
export const getBillingProfilePathIdRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
|
|
@@ -4386,9 +4398,9 @@ export const GetBillingProfileQueryParams = zod.object({
|
|
|
4386
4398
|
});
|
|
4387
4399
|
/**
|
|
4388
4400
|
* Update a billing profile by id.
|
|
4389
|
-
|
|
4390
|
-
The apps field cannot be updated directly, if an app change is desired a new
|
|
4391
|
-
profile should be created.
|
|
4401
|
+
*
|
|
4402
|
+
* The apps field cannot be updated directly, if an app change is desired a new
|
|
4403
|
+
* profile should be created.
|
|
4392
4404
|
* @summary Update a billing profile
|
|
4393
4405
|
*/
|
|
4394
4406
|
export const updateBillingProfilePathIdRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
|
|
@@ -4410,6 +4422,7 @@ export const updateBillingProfileBodyWorkflowOneInvoicingOneAutoAdvanceDefault =
|
|
|
4410
4422
|
export const updateBillingProfileBodyWorkflowOneInvoicingOneDraftPeriodDefault = 'P0D';
|
|
4411
4423
|
export const updateBillingProfileBodyWorkflowOneInvoicingOneDueAfterDefault = 'P30D';
|
|
4412
4424
|
export const updateBillingProfileBodyWorkflowOneInvoicingOneProgressiveBillingDefault = true;
|
|
4425
|
+
export const updateBillingProfileBodyWorkflowOneInvoicingOneSubscriptionEndProrationModeDefault = 'bill_actual_period';
|
|
4413
4426
|
export const updateBillingProfileBodyWorkflowOneInvoicingOneDefaultTaxConfigOneStripeOneCodeRegExp = /^txcd_\d{8}$/;
|
|
4414
4427
|
export const updateBillingProfileBodyWorkflowOneInvoicingOneDefaultTaxConfigOneTaxCodeIdRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
|
|
4415
4428
|
export const updateBillingProfileBodyWorkflowOnePaymentOneCollectionMethodDefault = 'charge_automatically';
|
|
@@ -4593,7 +4606,7 @@ export const UpdateBillingProfileBody = zod
|
|
|
4593
4606
|
})
|
|
4594
4607
|
.describe('Set of provider specific tax configs.')
|
|
4595
4608
|
.optional()
|
|
4596
|
-
.describe(
|
|
4609
|
+
.describe("Default tax configuration to apply to the invoices.\n\nSetting a tax code (`stripe.code` / `taxCodeId`) on a profile's default tax config is\ndeprecated and can no longer be added or changed: the organization default tax code is\nused instead. Existing tax-code values may still be removed, and `behavior` remains\nfully supported."),
|
|
4597
4610
|
draftPeriod: zod.coerce
|
|
4598
4611
|
.string()
|
|
4599
4612
|
.default(updateBillingProfileBodyWorkflowOneInvoicingOneDraftPeriodDefault)
|
|
@@ -4606,6 +4619,11 @@ export const UpdateBillingProfileBody = zod
|
|
|
4606
4619
|
.boolean()
|
|
4607
4620
|
.default(updateBillingProfileBodyWorkflowOneInvoicingOneProgressiveBillingDefault)
|
|
4608
4621
|
.describe('Should progressive billing be allowed for this workflow?'),
|
|
4622
|
+
subscriptionEndProrationMode: zod
|
|
4623
|
+
.enum(['bill_full_period', 'bill_actual_period'])
|
|
4624
|
+
.describe('Billing workflow subscription end proration mode.')
|
|
4625
|
+
.default(updateBillingProfileBodyWorkflowOneInvoicingOneSubscriptionEndProrationModeDefault)
|
|
4626
|
+
.describe('Controls how subscription-ending shortened service periods are billed.'),
|
|
4609
4627
|
})
|
|
4610
4628
|
.describe('BillingWorkflowInvoicingSettings represents the invoice settings for a billing workflow')
|
|
4611
4629
|
.optional()
|
|
@@ -5319,7 +5337,7 @@ export const GetCustomerEntitlementValueQueryParams = zod.object({
|
|
|
5319
5337
|
});
|
|
5320
5338
|
/**
|
|
5321
5339
|
* Get stripe app data for a customer.
|
|
5322
|
-
Only returns data if the customer billing profile is linked to a stripe app.
|
|
5340
|
+
* Only returns data if the customer billing profile is linked to a stripe app.
|
|
5323
5341
|
* @summary Get customer stripe app data
|
|
5324
5342
|
*/
|
|
5325
5343
|
export const getCustomerStripeAppDataPathCustomerIdOrKeyOneRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
|
|
@@ -5339,7 +5357,7 @@ export const GetCustomerStripeAppDataParams = zod.object({
|
|
|
5339
5357
|
});
|
|
5340
5358
|
/**
|
|
5341
5359
|
* Upsert stripe app data for a customer.
|
|
5342
|
-
Only updates data if the customer billing profile is linked to a stripe app.
|
|
5360
|
+
* Only updates data if the customer billing profile is linked to a stripe app.
|
|
5343
5361
|
* @summary Upsert customer stripe app data
|
|
5344
5362
|
*/
|
|
5345
5363
|
export const upsertCustomerStripeAppDataPathCustomerIdOrKeyOneRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
|
|
@@ -5368,10 +5386,10 @@ export const UpsertCustomerStripeAppDataBody = zod
|
|
|
5368
5386
|
.describe('Stripe Customer App Data Base.');
|
|
5369
5387
|
/**
|
|
5370
5388
|
* Create Stripe customer portal session.
|
|
5371
|
-
Only returns URL if the customer billing profile is linked to a stripe app and customer.
|
|
5372
|
-
|
|
5373
|
-
Useful to redirect the customer to the Stripe customer portal to manage their payment methods,
|
|
5374
|
-
change their billing address and access their invoice history.
|
|
5389
|
+
* Only returns URL if the customer billing profile is linked to a stripe app and customer.
|
|
5390
|
+
*
|
|
5391
|
+
* Useful to redirect the customer to the Stripe customer portal to manage their payment methods,
|
|
5392
|
+
* change their billing address and access their invoice history.
|
|
5375
5393
|
* @summary Create Stripe customer portal session
|
|
5376
5394
|
*/
|
|
5377
5395
|
export const createCustomerStripePortalSessionPathCustomerIdOrKeyOneRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
|
|
@@ -5457,10 +5475,10 @@ export const ListCustomerSubscriptionsQueryParams = zod.object({
|
|
|
5457
5475
|
});
|
|
5458
5476
|
/**
|
|
5459
5477
|
* List all entitlements for all the subjects and features. This endpoint is intended for administrative purposes only.
|
|
5460
|
-
To fetch the entitlements of a specific subject please use the /api/v1/subjects/{subjectKeyOrID}/entitlements endpoint.
|
|
5461
|
-
If page is provided that takes precedence and the paginated response is returned.
|
|
5462
|
-
|
|
5463
|
-
⚠️ __Deprecated__: Use [`GET /api/v2/entitlements`](#tag/entitlements/get/api/v2/entitlements) instead.
|
|
5478
|
+
* To fetch the entitlements of a specific subject please use the /api/v1/subjects/{subjectKeyOrID}/entitlements endpoint.
|
|
5479
|
+
* If page is provided that takes precedence and the paginated response is returned.
|
|
5480
|
+
*
|
|
5481
|
+
* ⚠️ __Deprecated__: Use [`GET /api/v2/entitlements`](#tag/entitlements/get/api/v2/entitlements) instead.
|
|
5464
5482
|
* @deprecated
|
|
5465
5483
|
* @summary List all entitlements
|
|
5466
5484
|
*/
|
|
@@ -5526,8 +5544,8 @@ export const ListEntitlementsQueryParams = zod.object({
|
|
|
5526
5544
|
});
|
|
5527
5545
|
/**
|
|
5528
5546
|
* Get entitlement by ID.
|
|
5529
|
-
|
|
5530
|
-
⚠️ __Deprecated__: Use [`GET /api/v2/entitlements/{entitlementId}`](#tag/entitlements/get/api/v2/entitlements/{entitlementId}) instead.
|
|
5547
|
+
*
|
|
5548
|
+
* ⚠️ __Deprecated__: Use [`GET /api/v2/entitlements/{entitlementId}`](#tag/entitlements/get/api/v2/entitlements/{entitlementId}) instead.
|
|
5531
5549
|
* @deprecated
|
|
5532
5550
|
* @summary Get entitlement by ID
|
|
5533
5551
|
*/
|
|
@@ -5539,8 +5557,8 @@ export const GetEntitlementByIdParams = zod.object({
|
|
|
5539
5557
|
});
|
|
5540
5558
|
/**
|
|
5541
5559
|
* List ingested events within a time range.
|
|
5542
|
-
|
|
5543
|
-
If the from query param is not provided it defaults to last 72 hours.
|
|
5560
|
+
*
|
|
5561
|
+
* If the from query param is not provided it defaults to last 72 hours.
|
|
5544
5562
|
* @summary List ingested events
|
|
5545
5563
|
*/
|
|
5546
5564
|
export const listEventsQueryClientIdMax = 36;
|
|
@@ -5596,90 +5614,46 @@ export const ListEventsQueryParams = zod.object({
|
|
|
5596
5614
|
* Ingests an event or batch of events following the CloudEvents specification.
|
|
5597
5615
|
* @summary Ingest events
|
|
5598
5616
|
*/
|
|
5599
|
-
export const
|
|
5600
|
-
export const ingestEventsBodyTwoItemSpecversionDefault = '1.0';
|
|
5617
|
+
export const ingestEventsBodySpecversionDefault = '1.0';
|
|
5601
5618
|
export const IngestEventsBody = zod
|
|
5602
|
-
.
|
|
5603
|
-
zod
|
|
5604
|
-
.
|
|
5605
|
-
|
|
5606
|
-
|
|
5607
|
-
|
|
5608
|
-
|
|
5609
|
-
|
|
5610
|
-
|
|
5611
|
-
|
|
5612
|
-
|
|
5613
|
-
|
|
5614
|
-
|
|
5615
|
-
|
|
5616
|
-
|
|
5617
|
-
|
|
5618
|
-
|
|
5619
|
-
|
|
5620
|
-
|
|
5621
|
-
|
|
5622
|
-
|
|
5623
|
-
|
|
5624
|
-
|
|
5625
|
-
|
|
5626
|
-
|
|
5627
|
-
|
|
5628
|
-
|
|
5629
|
-
|
|
5630
|
-
|
|
5631
|
-
|
|
5632
|
-
|
|
5633
|
-
|
|
5634
|
-
|
|
5635
|
-
|
|
5636
|
-
|
|
5637
|
-
|
|
5638
|
-
|
|
5639
|
-
|
|
5640
|
-
})
|
|
5641
|
-
.describe('CloudEvents Specification JSON Schema\n\nOptional properties are nullable according to the CloudEvents specification:\nOPTIONAL not omitted attributes MAY be represented as a null JSON value.'),
|
|
5642
|
-
zod.array(zod
|
|
5643
|
-
.object({
|
|
5644
|
-
data: zod
|
|
5645
|
-
.record(zod.string(), zod.unknown())
|
|
5646
|
-
.nullish()
|
|
5647
|
-
.describe('The event payload.\nOptional, if present it must be a JSON object.'),
|
|
5648
|
-
datacontenttype: zod
|
|
5649
|
-
.enum(['application/json'])
|
|
5650
|
-
.nullish()
|
|
5651
|
-
.describe('Content type of the CloudEvents data value. Only the value "application/json" is allowed over HTTP.'),
|
|
5652
|
-
dataschema: zod
|
|
5653
|
-
.url()
|
|
5654
|
-
.min(1)
|
|
5655
|
-
.nullish()
|
|
5656
|
-
.describe('Identifies the schema that data adheres to.'),
|
|
5657
|
-
id: zod.coerce.string().min(1).describe('Identifies the event.'),
|
|
5658
|
-
source: zod.coerce
|
|
5659
|
-
.string()
|
|
5660
|
-
.min(1)
|
|
5661
|
-
.describe('Identifies the context in which an event happened.'),
|
|
5662
|
-
specversion: zod.coerce
|
|
5663
|
-
.string()
|
|
5664
|
-
.min(1)
|
|
5665
|
-
.default(ingestEventsBodyTwoItemSpecversionDefault)
|
|
5666
|
-
.describe('The version of the CloudEvents specification which the event uses.'),
|
|
5667
|
-
subject: zod.coerce
|
|
5668
|
-
.string()
|
|
5669
|
-
.min(1)
|
|
5670
|
-
.describe('Describes the subject of the event in the context of the event producer (identified by source).'),
|
|
5671
|
-
time: zod.coerce
|
|
5672
|
-
.date()
|
|
5673
|
-
.nullish()
|
|
5674
|
-
.describe('Timestamp of when the occurrence happened. Must adhere to RFC 3339.'),
|
|
5675
|
-
type: zod.coerce
|
|
5676
|
-
.string()
|
|
5677
|
-
.min(1)
|
|
5678
|
-
.describe('Contains a value describing the type of event related to the originating occurrence.'),
|
|
5679
|
-
})
|
|
5680
|
-
.describe('CloudEvents Specification JSON Schema\n\nOptional properties are nullable according to the CloudEvents specification:\nOPTIONAL not omitted attributes MAY be represented as a null JSON value.')),
|
|
5681
|
-
])
|
|
5682
|
-
.describe('The body of the events request.\nEither a single event or a batch of events.');
|
|
5619
|
+
.object({
|
|
5620
|
+
data: zod
|
|
5621
|
+
.record(zod.string(), zod.unknown())
|
|
5622
|
+
.nullish()
|
|
5623
|
+
.describe('The event payload.\nOptional, if present it must be a JSON object.'),
|
|
5624
|
+
datacontenttype: zod
|
|
5625
|
+
.enum(['application/json'])
|
|
5626
|
+
.nullish()
|
|
5627
|
+
.describe('Content type of the CloudEvents data value. Only the value "application/json" is allowed over HTTP.'),
|
|
5628
|
+
dataschema: zod
|
|
5629
|
+
.url()
|
|
5630
|
+
.min(1)
|
|
5631
|
+
.nullish()
|
|
5632
|
+
.describe('Identifies the schema that data adheres to.'),
|
|
5633
|
+
id: zod.coerce.string().min(1).describe('Identifies the event.'),
|
|
5634
|
+
source: zod.coerce
|
|
5635
|
+
.string()
|
|
5636
|
+
.min(1)
|
|
5637
|
+
.describe('Identifies the context in which an event happened.'),
|
|
5638
|
+
specversion: zod.coerce
|
|
5639
|
+
.string()
|
|
5640
|
+
.min(1)
|
|
5641
|
+
.default(ingestEventsBodySpecversionDefault)
|
|
5642
|
+
.describe('The version of the CloudEvents specification which the event uses.'),
|
|
5643
|
+
subject: zod.coerce
|
|
5644
|
+
.string()
|
|
5645
|
+
.min(1)
|
|
5646
|
+
.describe('Describes the subject of the event in the context of the event producer (identified by source).'),
|
|
5647
|
+
time: zod.coerce
|
|
5648
|
+
.date()
|
|
5649
|
+
.nullish()
|
|
5650
|
+
.describe('Timestamp of when the occurrence happened. Must adhere to RFC 3339.'),
|
|
5651
|
+
type: zod.coerce
|
|
5652
|
+
.string()
|
|
5653
|
+
.min(1)
|
|
5654
|
+
.describe('Contains a value describing the type of event related to the originating occurrence.'),
|
|
5655
|
+
})
|
|
5656
|
+
.describe('CloudEvents Specification JSON Schema\n\nOptional properties are nullable according to the CloudEvents specification:\nOPTIONAL not omitted attributes MAY be represented as a null JSON value.');
|
|
5683
5657
|
/**
|
|
5684
5658
|
* List features.
|
|
5685
5659
|
* @summary List features
|
|
@@ -5736,8 +5710,8 @@ export const ListFeaturesQueryParams = zod.object({
|
|
|
5736
5710
|
});
|
|
5737
5711
|
/**
|
|
5738
5712
|
* Features are either metered or static. A feature is metered if meterSlug is provided at creation.
|
|
5739
|
-
For metered features you can pass additional filters that will be applied when calculating feature usage, based on the meter's groupBy fields.
|
|
5740
|
-
Meters with SUM, COUNT, UNIQUE_COUNT and LATEST aggregations are supported for features.
|
|
5713
|
+
* For metered features you can pass additional filters that will be applied when calculating feature usage, based on the meter's groupBy fields.
|
|
5714
|
+
* Meters with SUM, COUNT, UNIQUE_COUNT and LATEST aggregations are supported for features.
|
|
5741
5715
|
* @summary Create feature
|
|
5742
5716
|
*/
|
|
5743
5717
|
export const createFeatureBodyKeyMax = 64;
|
|
@@ -5927,9 +5901,9 @@ export const GetFeatureParams = zod.object({
|
|
|
5927
5901
|
});
|
|
5928
5902
|
/**
|
|
5929
5903
|
* Archive a feature by ID.
|
|
5930
|
-
|
|
5931
|
-
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.
|
|
5932
|
-
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.
|
|
5904
|
+
*
|
|
5905
|
+
* 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.
|
|
5906
|
+
* 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.
|
|
5933
5907
|
* @summary Delete feature
|
|
5934
5908
|
*/
|
|
5935
5909
|
export const DeleteFeatureParams = zod.object({
|
|
@@ -5937,10 +5911,10 @@ export const DeleteFeatureParams = zod.object({
|
|
|
5937
5911
|
});
|
|
5938
5912
|
/**
|
|
5939
5913
|
* List all grants for all the subjects and entitlements. This endpoint is intended for administrative purposes only.
|
|
5940
|
-
To fetch the grants of a specific entitlement please use the /api/v1/subjects/{subjectKeyOrID}/entitlements/{entitlementOrFeatureID}/grants endpoint.
|
|
5941
|
-
If page is provided that takes precedence and the paginated response is returned.
|
|
5942
|
-
|
|
5943
|
-
⚠️ __Deprecated__: Use [`GET /api/v2/grants`](#tag/entitlements/get/api/v2/grants) instead.
|
|
5914
|
+
* To fetch the grants of a specific entitlement please use the /api/v1/subjects/{subjectKeyOrID}/entitlements/{entitlementOrFeatureID}/grants endpoint.
|
|
5915
|
+
* If page is provided that takes precedence and the paginated response is returned.
|
|
5916
|
+
*
|
|
5917
|
+
* ⚠️ __Deprecated__: Use [`GET /api/v2/grants`](#tag/entitlements/get/api/v2/grants) instead.
|
|
5944
5918
|
* @deprecated
|
|
5945
5919
|
* @summary List grants
|
|
5946
5920
|
*/
|
|
@@ -6000,7 +5974,7 @@ export const ListGrantsQueryParams = zod.object({
|
|
|
6000
5974
|
});
|
|
6001
5975
|
/**
|
|
6002
5976
|
* 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.
|
|
6003
|
-
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.
|
|
5977
|
+
* 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.
|
|
6004
5978
|
* @summary Void grant
|
|
6005
5979
|
*/
|
|
6006
5980
|
export const VoidGrantParams = zod.object({
|
|
@@ -6093,7 +6067,7 @@ export const MarketplaceAppAPIKeyInstallBody = zod.object({
|
|
|
6093
6067
|
});
|
|
6094
6068
|
/**
|
|
6095
6069
|
* Install an app via OAuth.
|
|
6096
|
-
Returns a URL to start the OAuth 2.0 flow.
|
|
6070
|
+
* Returns a URL to start the OAuth 2.0 flow.
|
|
6097
6071
|
* @summary Get OAuth2 install URL
|
|
6098
6072
|
*/
|
|
6099
6073
|
export const MarketplaceOAuth2InstallGetURLParams = zod.object({
|
|
@@ -6101,7 +6075,7 @@ export const MarketplaceOAuth2InstallGetURLParams = zod.object({
|
|
|
6101
6075
|
});
|
|
6102
6076
|
/**
|
|
6103
6077
|
* Authorize OAuth2 code.
|
|
6104
|
-
Verifies the OAuth code and exchanges it for a token and refresh token
|
|
6078
|
+
* Verifies the OAuth code and exchanges it for a token and refresh token
|
|
6105
6079
|
* @summary Install app via OAuth2
|
|
6106
6080
|
*/
|
|
6107
6081
|
export const MarketplaceOAuth2InstallAuthorizeParams = zod.object({
|
|
@@ -6660,8 +6634,8 @@ export const GetNotificationChannelParams = zod.object({
|
|
|
6660
6634
|
});
|
|
6661
6635
|
/**
|
|
6662
6636
|
* Soft delete notification channel by id.
|
|
6663
|
-
|
|
6664
|
-
Once a notification channel is deleted it cannot be undeleted.
|
|
6637
|
+
*
|
|
6638
|
+
* Once a notification channel is deleted it cannot be undeleted.
|
|
6665
6639
|
* @summary Delete a notification channel
|
|
6666
6640
|
*/
|
|
6667
6641
|
export const deleteNotificationChannelPathChannelIdRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
|
|
@@ -7171,8 +7145,8 @@ export const GetNotificationRuleParams = zod.object({
|
|
|
7171
7145
|
});
|
|
7172
7146
|
/**
|
|
7173
7147
|
* Soft delete notification rule by id.
|
|
7174
|
-
|
|
7175
|
-
Once a notification rule is deleted it cannot be undeleted.
|
|
7148
|
+
*
|
|
7149
|
+
* Once a notification rule is deleted it cannot be undeleted.
|
|
7176
7150
|
* @summary Delete a notification rule
|
|
7177
7151
|
*/
|
|
7178
7152
|
export const deleteNotificationRulePathRuleIdRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
|
|
@@ -7949,7 +7923,7 @@ export const CreatePlanBody = zod
|
|
|
7949
7923
|
.describe('Resource create operation model.');
|
|
7950
7924
|
/**
|
|
7951
7925
|
* Create a new draft version from plan.
|
|
7952
|
-
It returns error if there is already a plan in draft or planId does not reference the latest published version.
|
|
7926
|
+
* It returns error if there is already a plan in draft or planId does not reference the latest published version.
|
|
7953
7927
|
* @deprecated
|
|
7954
7928
|
* @summary New draft plan
|
|
7955
7929
|
*/
|
|
@@ -8652,8 +8626,8 @@ export const GetPlanQueryParams = zod.object({
|
|
|
8652
8626
|
});
|
|
8653
8627
|
/**
|
|
8654
8628
|
* Soft delete plan by plan.id.
|
|
8655
|
-
|
|
8656
|
-
Once a plan is deleted it cannot be undeleted.
|
|
8629
|
+
*
|
|
8630
|
+
* Once a plan is deleted it cannot be undeleted.
|
|
8657
8631
|
* @summary Delete plan
|
|
8658
8632
|
*/
|
|
8659
8633
|
export const deletePlanPathPlanIdRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
|
|
@@ -8804,8 +8778,8 @@ export const GetPlanAddonParams = zod.object({
|
|
|
8804
8778
|
});
|
|
8805
8779
|
/**
|
|
8806
8780
|
* Delete add-on assignment for plan.
|
|
8807
|
-
|
|
8808
|
-
Once a plan is deleted it cannot be undeleted.
|
|
8781
|
+
*
|
|
8782
|
+
* Once a plan is deleted it cannot be undeleted.
|
|
8809
8783
|
* @summary Delete add-on assignment for plan
|
|
8810
8784
|
*/
|
|
8811
8785
|
export const deletePlanAddonPathPlanIdRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
|
|
@@ -9223,11 +9197,11 @@ export const CreateStripeCheckoutSessionBody = zod
|
|
|
9223
9197
|
.describe('Create Stripe checkout session request.');
|
|
9224
9198
|
/**
|
|
9225
9199
|
* Upserts a subject. Creates or updates subject.
|
|
9226
|
-
|
|
9227
|
-
If the subject doesn't exist, it will be created.
|
|
9228
|
-
If the subject exists, it will be partially updated with the provided fields.
|
|
9229
|
-
|
|
9230
|
-
⚠️ __Deprecated__: Subjects as managable entities are being depracated, use customers with subject key usage attribution instead.
|
|
9200
|
+
*
|
|
9201
|
+
* If the subject doesn't exist, it will be created.
|
|
9202
|
+
* If the subject exists, it will be partially updated with the provided fields.
|
|
9203
|
+
*
|
|
9204
|
+
* ⚠️ __Deprecated__: Subjects as managable entities are being depracated, use customers with subject key usage attribution instead.
|
|
9231
9205
|
* @deprecated
|
|
9232
9206
|
* @summary Upsert subject
|
|
9233
9207
|
*/
|
|
@@ -9261,8 +9235,8 @@ export const UpsertSubjectBodyItem = zod
|
|
|
9261
9235
|
export const UpsertSubjectBody = zod.array(UpsertSubjectBodyItem);
|
|
9262
9236
|
/**
|
|
9263
9237
|
* Get subject by ID or key.
|
|
9264
|
-
|
|
9265
|
-
⚠️ __Deprecated__: Subjects as managable entities are being depracated, use customers with subject key usage attribution instead.
|
|
9238
|
+
*
|
|
9239
|
+
* ⚠️ __Deprecated__: Subjects as managable entities are being depracated, use customers with subject key usage attribution instead.
|
|
9266
9240
|
* @deprecated
|
|
9267
9241
|
* @summary Get subject
|
|
9268
9242
|
*/
|
|
@@ -9271,8 +9245,8 @@ export const GetSubjectParams = zod.object({
|
|
|
9271
9245
|
});
|
|
9272
9246
|
/**
|
|
9273
9247
|
* Delete subject by ID or key.
|
|
9274
|
-
|
|
9275
|
-
⚠️ __Deprecated__: Subjects as managable entities are being depracated, use customers with subject key usage attribution instead.
|
|
9248
|
+
*
|
|
9249
|
+
* ⚠️ __Deprecated__: Subjects as managable entities are being depracated, use customers with subject key usage attribution instead.
|
|
9276
9250
|
* @deprecated
|
|
9277
9251
|
* @summary Delete subject
|
|
9278
9252
|
*/
|
|
@@ -9281,16 +9255,16 @@ export const DeleteSubjectParams = zod.object({
|
|
|
9281
9255
|
});
|
|
9282
9256
|
/**
|
|
9283
9257
|
* 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).
|
|
9284
|
-
|
|
9285
|
-
- Boolean entitlements define static feature access, e.g. "Can use SSO authentication".
|
|
9286
|
-
- Static entitlements let you pass along a configuration while granting access, e.g. "Using this feature with X Y settings" (passed in the config).
|
|
9287
|
-
- 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.
|
|
9288
|
-
|
|
9289
|
-
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.
|
|
9290
|
-
|
|
9291
|
-
Once an entitlement is created you cannot modify it, only delete it.
|
|
9292
|
-
|
|
9293
|
-
⚠️ __Deprecated__: Use [`POST /api/v2/customers/{customerIdOrKey}/entitlements`](#tag/entitlements/post/api/v2/customers/{customerIdOrKey}/entitlements) instead.
|
|
9258
|
+
*
|
|
9259
|
+
* - Boolean entitlements define static feature access, e.g. "Can use SSO authentication".
|
|
9260
|
+
* - Static entitlements let you pass along a configuration while granting access, e.g. "Using this feature with X Y settings" (passed in the config).
|
|
9261
|
+
* - 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.
|
|
9262
|
+
*
|
|
9263
|
+
* 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.
|
|
9264
|
+
*
|
|
9265
|
+
* Once an entitlement is created you cannot modify it, only delete it.
|
|
9266
|
+
*
|
|
9267
|
+
* ⚠️ __Deprecated__: Use [`POST /api/v2/customers/{customerIdOrKey}/entitlements`](#tag/entitlements/post/api/v2/customers/{customerIdOrKey}/entitlements) instead.
|
|
9294
9268
|
* @deprecated
|
|
9295
9269
|
* @summary Create a subject entitlement
|
|
9296
9270
|
*/
|
|
@@ -9487,8 +9461,8 @@ export const CreateEntitlementBody = zod
|
|
|
9487
9461
|
.describe('Create inputs for entitlement');
|
|
9488
9462
|
/**
|
|
9489
9463
|
* List all entitlements for a subject. For checking entitlement access, use the /value endpoint instead.
|
|
9490
|
-
|
|
9491
|
-
⚠️ __Deprecated__: Use [`GET /api/v2/customers/{customerIdOrKey}/entitlements`](#tag/entitlements/get/api/v2/customers/{customerIdOrKey}/entitlements) instead.
|
|
9464
|
+
*
|
|
9465
|
+
* ⚠️ __Deprecated__: Use [`GET /api/v2/customers/{customerIdOrKey}/entitlements`](#tag/entitlements/get/api/v2/customers/{customerIdOrKey}/entitlements) instead.
|
|
9492
9466
|
* @deprecated
|
|
9493
9467
|
* @summary List subject entitlements
|
|
9494
9468
|
*/
|
|
@@ -9503,8 +9477,8 @@ export const ListSubjectEntitlementsQueryParams = zod.object({
|
|
|
9503
9477
|
});
|
|
9504
9478
|
/**
|
|
9505
9479
|
* List all grants issued for an entitlement. The entitlement can be defined either by its id or featureKey.
|
|
9506
|
-
|
|
9507
|
-
⚠️ __Deprecated__: Use [`GET /api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/grants`](#tag/entitlements/get/api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/grants) instead.
|
|
9480
|
+
*
|
|
9481
|
+
* ⚠️ __Deprecated__: Use [`GET /api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/grants`](#tag/entitlements/get/api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/grants) instead.
|
|
9508
9482
|
* @deprecated
|
|
9509
9483
|
* @summary List subject entitlement grants
|
|
9510
9484
|
*/
|
|
@@ -9525,18 +9499,18 @@ export const ListEntitlementGrantsQueryParams = zod.object({
|
|
|
9525
9499
|
});
|
|
9526
9500
|
/**
|
|
9527
9501
|
* 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.
|
|
9528
|
-
|
|
9529
|
-
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.
|
|
9530
|
-
|
|
9531
|
-
Grants have a priority setting that determines their order of use. Lower numbers have higher priority, with 0 being the highest priority.
|
|
9532
|
-
|
|
9533
|
-
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).
|
|
9534
|
-
|
|
9535
|
-
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))
|
|
9536
|
-
|
|
9537
|
-
Grants cannot be changed once created, only deleted. This is to ensure that balance is deterministic regardless of when it is queried.
|
|
9538
|
-
|
|
9539
|
-
⚠️ __Deprecated__: Use [`POST /api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/grants`](#tag/entitlements/post/api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/grants) instead.
|
|
9502
|
+
*
|
|
9503
|
+
* 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.
|
|
9504
|
+
*
|
|
9505
|
+
* Grants have a priority setting that determines their order of use. Lower numbers have higher priority, with 0 being the highest priority.
|
|
9506
|
+
*
|
|
9507
|
+
* 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).
|
|
9508
|
+
*
|
|
9509
|
+
* 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))
|
|
9510
|
+
*
|
|
9511
|
+
* Grants cannot be changed once created, only deleted. This is to ensure that balance is deterministic regardless of when it is queried.
|
|
9512
|
+
*
|
|
9513
|
+
* ⚠️ __Deprecated__: Use [`POST /api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/grants`](#tag/entitlements/post/api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/grants) instead.
|
|
9540
9514
|
* @deprecated
|
|
9541
9515
|
* @summary Create subject entitlement grant
|
|
9542
9516
|
*/
|
|
@@ -9617,10 +9591,10 @@ export const CreateGrantBody = zod
|
|
|
9617
9591
|
.describe('The grant creation input.');
|
|
9618
9592
|
/**
|
|
9619
9593
|
* 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.
|
|
9620
|
-
|
|
9621
|
-
This endpoint is useful for upgrades, downgrades, or other changes to entitlements that require a new entitlement to be created with zero downtime.
|
|
9622
|
-
|
|
9623
|
-
⚠️ __Deprecated__: Use [`PUT /api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/override`](#tag/entitlements/put/api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/override) instead.
|
|
9594
|
+
*
|
|
9595
|
+
* This endpoint is useful for upgrades, downgrades, or other changes to entitlements that require a new entitlement to be created with zero downtime.
|
|
9596
|
+
*
|
|
9597
|
+
* ⚠️ __Deprecated__: Use [`PUT /api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/override`](#tag/entitlements/put/api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/override) instead.
|
|
9624
9598
|
* @deprecated
|
|
9625
9599
|
* @summary Override subject entitlement
|
|
9626
9600
|
*/
|
|
@@ -9818,10 +9792,10 @@ export const OverrideEntitlementBody = zod
|
|
|
9818
9792
|
.describe('Create inputs for entitlement');
|
|
9819
9793
|
/**
|
|
9820
9794
|
* 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.
|
|
9821
|
-
|
|
9822
|
-
For convenience reasons, /value works with both entitlementId and featureKey.
|
|
9823
|
-
|
|
9824
|
-
⚠️ __Deprecated__: Use [`GET /api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/value`](#tag/entitlements/get/api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/value) instead.
|
|
9795
|
+
*
|
|
9796
|
+
* For convenience reasons, /value works with both entitlementId and featureKey.
|
|
9797
|
+
*
|
|
9798
|
+
* ⚠️ __Deprecated__: Use [`GET /api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/value`](#tag/entitlements/get/api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/value) instead.
|
|
9825
9799
|
* @deprecated
|
|
9826
9800
|
* @summary Get subject entitlement value
|
|
9827
9801
|
*/
|
|
@@ -9834,8 +9808,8 @@ export const GetEntitlementValueQueryParams = zod.object({
|
|
|
9834
9808
|
});
|
|
9835
9809
|
/**
|
|
9836
9810
|
* Get entitlement by id. For checking entitlement access, use the /value endpoint instead.
|
|
9837
|
-
|
|
9838
|
-
⚠️ __Deprecated__: Use [`GET /api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}`](#tag/entitlements/get/api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}) instead.
|
|
9811
|
+
*
|
|
9812
|
+
* ⚠️ __Deprecated__: Use [`GET /api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}`](#tag/entitlements/get/api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}) instead.
|
|
9839
9813
|
* @deprecated
|
|
9840
9814
|
* @summary Get subject entitlement
|
|
9841
9815
|
*/
|
|
@@ -9845,9 +9819,9 @@ export const GetEntitlementParams = zod.object({
|
|
|
9845
9819
|
});
|
|
9846
9820
|
/**
|
|
9847
9821
|
* 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.
|
|
9848
|
-
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.
|
|
9849
|
-
|
|
9850
|
-
⚠️ __Deprecated__: Use [`DELETE /api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}`](#tag/entitlements/delete/api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}) instead.
|
|
9822
|
+
* 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.
|
|
9823
|
+
*
|
|
9824
|
+
* ⚠️ __Deprecated__: Use [`DELETE /api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}`](#tag/entitlements/delete/api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}) instead.
|
|
9851
9825
|
* @deprecated
|
|
9852
9826
|
* @summary Delete subject entitlement
|
|
9853
9827
|
*/
|
|
@@ -9857,12 +9831,12 @@ export const DeleteEntitlementParams = zod.object({
|
|
|
9857
9831
|
});
|
|
9858
9832
|
/**
|
|
9859
9833
|
* Returns historical balance and usage data for the entitlement. The queried history can span accross multiple reset events.
|
|
9860
|
-
|
|
9861
|
-
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.
|
|
9862
|
-
|
|
9863
|
-
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.
|
|
9864
|
-
|
|
9865
|
-
⚠️ __Deprecated__: Use [`GET /api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/history`](#tag/entitlements/get/api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/history) instead.
|
|
9834
|
+
*
|
|
9835
|
+
* 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.
|
|
9836
|
+
*
|
|
9837
|
+
* 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.
|
|
9838
|
+
*
|
|
9839
|
+
* ⚠️ __Deprecated__: Use [`GET /api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/history`](#tag/entitlements/get/api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/history) instead.
|
|
9866
9840
|
* @deprecated
|
|
9867
9841
|
* @summary Get subject entitlement history
|
|
9868
9842
|
*/
|
|
@@ -9890,10 +9864,10 @@ export const GetEntitlementHistoryQueryParams = zod.object({
|
|
|
9890
9864
|
});
|
|
9891
9865
|
/**
|
|
9892
9866
|
* 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.
|
|
9893
|
-
|
|
9894
|
-
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.
|
|
9895
|
-
|
|
9896
|
-
⚠️ __Deprecated__: Use [`POST /api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/reset`](#tag/entitlements/post/api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/reset) instead.
|
|
9867
|
+
*
|
|
9868
|
+
* 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.
|
|
9869
|
+
*
|
|
9870
|
+
* ⚠️ __Deprecated__: Use [`POST /api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/reset`](#tag/entitlements/post/api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/reset) instead.
|
|
9897
9871
|
* @deprecated
|
|
9898
9872
|
* @summary Reset subject entitlement
|
|
9899
9873
|
*/
|
|
@@ -10733,7 +10707,7 @@ export const GetSubscriptionQueryParams = zod.object({
|
|
|
10733
10707
|
});
|
|
10734
10708
|
/**
|
|
10735
10709
|
* Batch processing commands for manipulating running subscriptions.
|
|
10736
|
-
The key format is `/phases/{phaseKey}` or `/phases/{phaseKey}/items/{itemKey}`.
|
|
10710
|
+
* The key format is `/phases/{phaseKey}` or `/phases/{phaseKey}/items/{itemKey}`.
|
|
10737
10711
|
* @summary Edit subscription
|
|
10738
10712
|
*/
|
|
10739
10713
|
export const editSubscriptionPathSubscriptionIdRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
|
|
@@ -11567,7 +11541,7 @@ export const UpdateSubscriptionAddonBody = zod
|
|
|
11567
11541
|
.describe('Resource create or update operation model.');
|
|
11568
11542
|
/**
|
|
11569
11543
|
* Cancels the subscription.
|
|
11570
|
-
Will result in a scheduling conflict if there are other subscriptions scheduled to start after the cancellation time.
|
|
11544
|
+
* Will result in a scheduling conflict if there are other subscriptions scheduled to start after the cancellation time.
|
|
11571
11545
|
* @summary Cancel subscription
|
|
11572
11546
|
*/
|
|
11573
11547
|
export const cancelSubscriptionPathSubscriptionIdRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
|
|
@@ -11592,7 +11566,7 @@ export const CancelSubscriptionBody = zod.object({
|
|
|
11592
11566
|
});
|
|
11593
11567
|
/**
|
|
11594
11568
|
* Closes a running subscription and starts a new one according to the specification.
|
|
11595
|
-
Can be used for upgrades, downgrades, and plan changes.
|
|
11569
|
+
* Can be used for upgrades, downgrades, and plan changes.
|
|
11596
11570
|
* @summary Change subscription
|
|
11597
11571
|
*/
|
|
11598
11572
|
export const changeSubscriptionPathSubscriptionIdRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
|
|
@@ -11714,6 +11688,11 @@ export const ChangeSubscriptionBody = zod
|
|
|
11714
11688
|
})
|
|
11715
11689
|
.describe('References an exact plan defaulting to the current active version.')
|
|
11716
11690
|
.describe('The plan reference to change to.'),
|
|
11691
|
+
settlementMode: zod
|
|
11692
|
+
.enum(['credit_then_invoice', 'credit_only'])
|
|
11693
|
+
.describe('The settlement mode of a plan.\nIt determines how the billing system generates invoices and credits for the subscriptions using this plan.\n- credit_then_invoice: credits from the previous billing period are applied first, then the remaining balance is invoiced. This is the default and most common settlement mode.\n- credit_only: only credits from the previous billing period are generated and applied. No invoices are generated for the subscription.')
|
|
11694
|
+
.optional()
|
|
11695
|
+
.describe('The settlement mode of the subscription.'),
|
|
11717
11696
|
startingPhase: zod.coerce
|
|
11718
11697
|
.string()
|
|
11719
11698
|
.min(1)
|
|
@@ -12364,8 +12343,8 @@ export const ChangeSubscriptionBody = zod
|
|
|
12364
12343
|
.describe('Change a subscription.');
|
|
12365
12344
|
/**
|
|
12366
12345
|
* Migrates the subscripiton to the provided version of the current plan.
|
|
12367
|
-
If possible, the migration will be done immediately.
|
|
12368
|
-
If not, the migration will be scheduled to the end of the current billing period.
|
|
12346
|
+
* If possible, the migration will be done immediately.
|
|
12347
|
+
* If not, the migration will be scheduled to the end of the current billing period.
|
|
12369
12348
|
* @summary Migrate subscription
|
|
12370
12349
|
*/
|
|
12371
12350
|
export const migrateSubscriptionPathSubscriptionIdRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
|
|
@@ -12405,7 +12384,7 @@ export const MigrateSubscriptionBody = zod.object({
|
|
|
12405
12384
|
});
|
|
12406
12385
|
/**
|
|
12407
12386
|
* Restores a canceled subscription.
|
|
12408
|
-
Any subscription scheduled to start later will be deleted and this subscription will be continued indefinitely.
|
|
12387
|
+
* Any subscription scheduled to start later will be deleted and this subscription will be continued indefinitely.
|
|
12409
12388
|
* @deprecated
|
|
12410
12389
|
* @summary Restore subscription
|
|
12411
12390
|
*/
|
|
@@ -12427,14 +12406,14 @@ export const UnscheduleCancelationParams = zod.object({
|
|
|
12427
12406
|
});
|
|
12428
12407
|
/**
|
|
12429
12408
|
* 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).
|
|
12430
|
-
|
|
12431
|
-
- Boolean entitlements define static feature access, e.g. "Can use SSO authentication".
|
|
12432
|
-
- Static entitlements let you pass along a configuration while granting access, e.g. "Using this feature with X Y settings" (passed in the config).
|
|
12433
|
-
- 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.
|
|
12434
|
-
|
|
12435
|
-
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.
|
|
12436
|
-
|
|
12437
|
-
Once an entitlement is created you cannot modify it, only delete it.
|
|
12409
|
+
*
|
|
12410
|
+
* - Boolean entitlements define static feature access, e.g. "Can use SSO authentication".
|
|
12411
|
+
* - Static entitlements let you pass along a configuration while granting access, e.g. "Using this feature with X Y settings" (passed in the config).
|
|
12412
|
+
* - 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.
|
|
12413
|
+
*
|
|
12414
|
+
* 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.
|
|
12415
|
+
*
|
|
12416
|
+
* Once an entitlement is created you cannot modify it, only delete it.
|
|
12438
12417
|
* @summary Create a customer entitlement
|
|
12439
12418
|
*/
|
|
12440
12419
|
export const createCustomerEntitlementV2PathCustomerIdOrKeyOneRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
|
|
@@ -12784,7 +12763,7 @@ export const ListCustomerEntitlementsV2QueryParams = zod.object({
|
|
|
12784
12763
|
});
|
|
12785
12764
|
/**
|
|
12786
12765
|
* Get entitlement by feature key. For checking entitlement access, use the /value endpoint instead.
|
|
12787
|
-
If featureKey is used, the entitlement is resolved for the current timestamp.
|
|
12766
|
+
* If featureKey is used, the entitlement is resolved for the current timestamp.
|
|
12788
12767
|
* @summary Get customer entitlement
|
|
12789
12768
|
*/
|
|
12790
12769
|
export const getCustomerEntitlementV2PathCustomerIdOrKeyOneRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
|
|
@@ -12811,7 +12790,7 @@ export const GetCustomerEntitlementV2Params = zod.object({
|
|
|
12811
12790
|
});
|
|
12812
12791
|
/**
|
|
12813
12792
|
* 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.
|
|
12814
|
-
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.
|
|
12793
|
+
* 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.
|
|
12815
12794
|
* @summary Delete customer entitlement
|
|
12816
12795
|
*/
|
|
12817
12796
|
export const deleteCustomerEntitlementV2PathCustomerIdOrKeyOneRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
|
|
@@ -12909,16 +12888,16 @@ export const ListCustomerEntitlementGrantsV2QueryParams = zod.object({
|
|
|
12909
12888
|
});
|
|
12910
12889
|
/**
|
|
12911
12890
|
* 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.
|
|
12912
|
-
|
|
12913
|
-
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.
|
|
12914
|
-
|
|
12915
|
-
Grants have a priority setting that determines their order of use. Lower numbers have higher priority, with 0 being the highest priority.
|
|
12916
|
-
|
|
12917
|
-
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).
|
|
12918
|
-
|
|
12919
|
-
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))
|
|
12920
|
-
|
|
12921
|
-
Grants cannot be changed once created, only deleted. This is to ensure that balance is deterministic regardless of when it is queried.
|
|
12891
|
+
*
|
|
12892
|
+
* 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.
|
|
12893
|
+
*
|
|
12894
|
+
* Grants have a priority setting that determines their order of use. Lower numbers have higher priority, with 0 being the highest priority.
|
|
12895
|
+
*
|
|
12896
|
+
* 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).
|
|
12897
|
+
*
|
|
12898
|
+
* 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))
|
|
12899
|
+
*
|
|
12900
|
+
* Grants cannot be changed once created, only deleted. This is to ensure that balance is deterministic regardless of when it is queried.
|
|
12922
12901
|
* @summary Create customer entitlement grant
|
|
12923
12902
|
*/
|
|
12924
12903
|
export const createCustomerEntitlementGrantV2PathCustomerIdOrKeyOneRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
|
|
@@ -13021,10 +13000,10 @@ export const CreateCustomerEntitlementGrantV2Body = zod
|
|
|
13021
13000
|
.describe('The grant creation input.');
|
|
13022
13001
|
/**
|
|
13023
13002
|
* Returns historical balance and usage data for the entitlement. The queried history can span accross multiple reset events.
|
|
13024
|
-
|
|
13025
|
-
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.
|
|
13026
|
-
|
|
13027
|
-
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.
|
|
13003
|
+
*
|
|
13004
|
+
* 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.
|
|
13005
|
+
*
|
|
13006
|
+
* 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.
|
|
13028
13007
|
* @summary Get customer entitlement history
|
|
13029
13008
|
*/
|
|
13030
13009
|
export const getCustomerEntitlementHistoryV2PathCustomerIdOrKeyOneRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
|
|
@@ -13069,8 +13048,8 @@ export const GetCustomerEntitlementHistoryV2QueryParams = zod.object({
|
|
|
13069
13048
|
});
|
|
13070
13049
|
/**
|
|
13071
13050
|
* 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.
|
|
13072
|
-
|
|
13073
|
-
This endpoint is useful for upgrades, downgrades, or other changes to entitlements that require a new entitlement to be created with zero downtime.
|
|
13051
|
+
*
|
|
13052
|
+
* This endpoint is useful for upgrades, downgrades, or other changes to entitlements that require a new entitlement to be created with zero downtime.
|
|
13074
13053
|
* @summary Override customer entitlement
|
|
13075
13054
|
*/
|
|
13076
13055
|
export const overrideCustomerEntitlementV2PathCustomerIdOrKeyOneRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
|
|
@@ -13384,8 +13363,8 @@ export const OverrideCustomerEntitlementV2Body = zod
|
|
|
13384
13363
|
.describe('Create inputs for entitlement');
|
|
13385
13364
|
/**
|
|
13386
13365
|
* 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.
|
|
13387
|
-
|
|
13388
|
-
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.
|
|
13366
|
+
*
|
|
13367
|
+
* 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.
|
|
13389
13368
|
* @summary Reset customer entitlement
|
|
13390
13369
|
*/
|
|
13391
13370
|
export const resetCustomerEntitlementUsageV2PathCustomerIdOrKeyOneRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
|
|
@@ -13457,7 +13436,7 @@ export const GetCustomerEntitlementValueV2QueryParams = zod.object({
|
|
|
13457
13436
|
});
|
|
13458
13437
|
/**
|
|
13459
13438
|
* List all entitlements for all the customers and features. This endpoint is intended for administrative purposes only.
|
|
13460
|
-
To fetch the entitlements of a specific subject please use the /api/v2/customers/{customerIdOrKey}/entitlements endpoint.
|
|
13439
|
+
* To fetch the entitlements of a specific subject please use the /api/v2/customers/{customerIdOrKey}/entitlements endpoint.
|
|
13461
13440
|
* @summary List all entitlements
|
|
13462
13441
|
*/
|
|
13463
13442
|
export const listEntitlementsV2QueryExcludeInactiveDefault = false;
|
|
@@ -13561,8 +13540,8 @@ export const ListEventsV2QueryParams = zod.object({
|
|
|
13561
13540
|
});
|
|
13562
13541
|
/**
|
|
13563
13542
|
* List all grants for all the customers and entitlements. This endpoint is intended for administrative purposes only.
|
|
13564
|
-
To fetch the grants of a specific entitlement please use the /api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/grants endpoint.
|
|
13565
|
-
If page is provided that takes precedence and the paginated response is returned.
|
|
13543
|
+
* To fetch the grants of a specific entitlement please use the /api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/grants endpoint.
|
|
13544
|
+
* If page is provided that takes precedence and the paginated response is returned.
|
|
13566
13545
|
* @summary List grants
|
|
13567
13546
|
*/
|
|
13568
13547
|
export const listGrantsV2QueryCustomerItemOneRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
|