@openmeter/sdk 1.0.0-beta.225 → 1.0.0-beta.227
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/index.cjs +1 -1
- package/dist/cjs/index.cjs.map +1 -0
- package/dist/cjs/src/client/addons.cjs +1 -1
- package/dist/cjs/src/client/addons.cjs.map +1 -0
- package/dist/cjs/src/client/apps.cjs +1 -1
- package/dist/cjs/src/client/apps.cjs.map +1 -0
- package/dist/cjs/src/client/billing.cjs +15 -1
- package/dist/cjs/src/client/billing.cjs.map +1 -0
- package/dist/cjs/src/client/billing.d.cts +37 -0
- package/dist/cjs/src/client/common.cjs +1 -1
- package/dist/cjs/src/client/common.cjs.map +1 -0
- package/dist/cjs/src/client/customers.cjs +2 -2
- package/dist/cjs/src/client/customers.cjs.map +1 -0
- package/dist/cjs/src/client/customers.d.cts +10 -7
- package/dist/cjs/src/client/debug.cjs +1 -1
- package/dist/cjs/src/client/debug.cjs.map +1 -0
- package/dist/cjs/src/client/entitlements.cjs +1 -1
- package/dist/cjs/src/client/entitlements.cjs.map +1 -0
- package/dist/cjs/src/client/entitlements.d.cts +1 -0
- package/dist/cjs/src/client/events.cjs +1 -1
- package/dist/cjs/src/client/events.cjs.map +1 -0
- package/dist/cjs/src/client/features.cjs +1 -1
- package/dist/cjs/src/client/features.cjs.map +1 -0
- package/dist/cjs/src/client/index.cjs +1 -1
- package/dist/cjs/src/client/index.cjs.map +1 -0
- package/dist/cjs/src/client/info.cjs +1 -1
- package/dist/cjs/src/client/info.cjs.map +1 -0
- package/dist/cjs/src/client/meters.cjs +46 -1
- package/dist/cjs/src/client/meters.cjs.map +1 -0
- package/dist/cjs/src/client/meters.d.cts +28 -0
- package/dist/cjs/src/client/notifications.cjs +21 -1
- package/dist/cjs/src/client/notifications.cjs.map +1 -0
- package/dist/cjs/src/client/notifications.d.cts +9 -0
- package/dist/cjs/src/client/plans.cjs +1 -1
- package/dist/cjs/src/client/plans.cjs.map +1 -0
- package/dist/cjs/src/client/portal.cjs +1 -1
- package/dist/cjs/src/client/portal.cjs.map +1 -0
- package/dist/cjs/src/client/schemas.cjs +1 -1
- package/dist/cjs/src/client/schemas.cjs.map +1 -0
- package/dist/cjs/src/client/schemas.d.cts +1376 -655
- package/dist/cjs/src/client/subjects.cjs +1 -1
- package/dist/cjs/src/client/subjects.cjs.map +1 -0
- package/dist/cjs/src/client/subscription-addons.cjs +1 -1
- package/dist/cjs/src/client/subscription-addons.cjs.map +1 -0
- package/dist/cjs/src/client/subscriptions.cjs +1 -1
- package/dist/cjs/src/client/subscriptions.cjs.map +1 -0
- package/dist/cjs/src/client/utils.cjs +1 -1
- package/dist/cjs/src/client/utils.cjs.map +1 -0
- package/dist/cjs/src/portal/index.cjs +1 -1
- package/dist/cjs/src/portal/index.cjs.map +1 -0
- package/dist/cjs/src/react/context.cjs +1 -1
- package/dist/cjs/src/react/context.cjs.map +1 -0
- package/dist/cjs/src/zod/index.cjs +4658 -4565
- package/dist/cjs/src/zod/index.cjs.map +1 -0
- package/dist/cjs/src/zod/index.d.cts +4765 -18526
- package/dist/src/client/billing.d.ts +37 -0
- package/dist/src/client/billing.js +14 -0
- package/dist/src/client/billing.js.map +1 -1
- package/dist/src/client/customers.d.ts +10 -7
- package/dist/src/client/customers.js +1 -1
- package/dist/src/client/customers.js.map +1 -1
- package/dist/src/client/entitlements.d.ts +1 -0
- package/dist/src/client/meters.d.ts +28 -0
- package/dist/src/client/meters.js +45 -0
- package/dist/src/client/meters.js.map +1 -1
- package/dist/src/client/notifications.d.ts +9 -0
- package/dist/src/client/notifications.js +20 -0
- package/dist/src/client/notifications.js.map +1 -1
- package/dist/src/client/schemas.d.ts +1376 -655
- package/dist/src/zod/index.d.ts +4765 -18526
- package/dist/src/zod/index.js +1942 -1881
- package/dist/src/zod/index.js.map +1 -1
- package/dist/tsconfig.tsbuildinfo +1 -1
- package/package.json +18 -18
- package/patches/openapi-typescript.patch +871 -16
- package/dist/cjs/index.js.map +0 -1
- package/dist/cjs/src/client/addons.js.map +0 -1
- package/dist/cjs/src/client/apps.js.map +0 -1
- package/dist/cjs/src/client/billing.js.map +0 -1
- package/dist/cjs/src/client/common.js.map +0 -1
- package/dist/cjs/src/client/customers.js.map +0 -1
- package/dist/cjs/src/client/debug.js.map +0 -1
- package/dist/cjs/src/client/entitlements.js.map +0 -1
- package/dist/cjs/src/client/events.js.map +0 -1
- package/dist/cjs/src/client/features.js.map +0 -1
- package/dist/cjs/src/client/index.js.map +0 -1
- package/dist/cjs/src/client/info.js.map +0 -1
- package/dist/cjs/src/client/meters.js.map +0 -1
- package/dist/cjs/src/client/notifications.js.map +0 -1
- package/dist/cjs/src/client/plans.js.map +0 -1
- package/dist/cjs/src/client/portal.js.map +0 -1
- package/dist/cjs/src/client/schemas.js.map +0 -1
- package/dist/cjs/src/client/subjects.js.map +0 -1
- package/dist/cjs/src/client/subscription-addons.js.map +0 -1
- package/dist/cjs/src/client/subscriptions.js.map +0 -1
- package/dist/cjs/src/client/utils.js.map +0 -1
- package/dist/cjs/src/portal/index.js.map +0 -1
- package/dist/cjs/src/react/context.js.map +0 -1
- package/dist/cjs/src/zod/index.js.map +0 -1
- package/dist/cjs/tsconfig.7db92107.tsbuildinfo +0 -1
- package/dist/cjs/tsconfig.94dd8c51.tsbuildinfo +0 -1
|
@@ -204,6 +204,8 @@ export interface paths {
|
|
|
204
204
|
* Update Stripe API key
|
|
205
205
|
* @deprecated
|
|
206
206
|
* @description Update the Stripe API key.
|
|
207
|
+
*
|
|
208
|
+
* ⚠️ __Deprecated__: Use [`PUT /api/v1/apps/{id}`](#tag/apps/put/api/v1/apps/{id}) instead.
|
|
207
209
|
*/
|
|
208
210
|
put: operations['updateStripeAPIKey'];
|
|
209
211
|
post?: never;
|
|
@@ -890,9 +892,12 @@ export interface paths {
|
|
|
890
892
|
};
|
|
891
893
|
/**
|
|
892
894
|
* List all entitlements
|
|
895
|
+
* @deprecated
|
|
893
896
|
* @description List all entitlements for all the subjects and features. This endpoint is intended for administrative purposes only.
|
|
894
897
|
* To fetch the entitlements of a specific subject please use the /api/v1/subjects/{subjectKeyOrID}/entitlements endpoint.
|
|
895
898
|
* If page is provided that takes precedence and the paginated response is returned.
|
|
899
|
+
*
|
|
900
|
+
* ⚠️ __Deprecated__: Use [`GET /api/v2/entitlements`](#tag/entitlements/get/api/v2/entitlements) instead.
|
|
896
901
|
*/
|
|
897
902
|
get: operations['listEntitlements'];
|
|
898
903
|
put?: never;
|
|
@@ -911,8 +916,11 @@ export interface paths {
|
|
|
911
916
|
cookie?: never;
|
|
912
917
|
};
|
|
913
918
|
/**
|
|
914
|
-
* Get entitlement by
|
|
915
|
-
* @
|
|
919
|
+
* Get entitlement by ID
|
|
920
|
+
* @deprecated
|
|
921
|
+
* @description Get entitlement by ID.
|
|
922
|
+
*
|
|
923
|
+
* ⚠️ __Deprecated__: Use [`GET /api/v2/entitlements/{entitlementId}`](#tag/entitlements/get/api/v2/entitlements/{entitlementId}) instead.
|
|
916
924
|
*/
|
|
917
925
|
get: operations['getEntitlementById'];
|
|
918
926
|
put?: never;
|
|
@@ -966,7 +974,7 @@ export interface paths {
|
|
|
966
974
|
* Create feature
|
|
967
975
|
* @description Features are either metered or static. A feature is metered if meterSlug is provided at creation.
|
|
968
976
|
* For metered features you can pass additional filters that will be applied when calculating feature usage, based on the meter's groupBy fields.
|
|
969
|
-
*
|
|
977
|
+
* Meters with SUM, COUNT, UNIQUE_COUNT and LATEST aggregations are supported for features.
|
|
970
978
|
* Features cannot be updated later, only archived.
|
|
971
979
|
*/
|
|
972
980
|
post: operations['createFeature'];
|
|
@@ -1012,9 +1020,12 @@ export interface paths {
|
|
|
1012
1020
|
};
|
|
1013
1021
|
/**
|
|
1014
1022
|
* List grants
|
|
1023
|
+
* @deprecated
|
|
1015
1024
|
* @description List all grants for all the subjects and entitlements. This endpoint is intended for administrative purposes only.
|
|
1016
1025
|
* To fetch the grants of a specific entitlement please use the /api/v1/subjects/{subjectKeyOrID}/entitlements/{entitlementOrFeatureID}/grants endpoint.
|
|
1017
1026
|
* If page is provided that takes precedence and the paginated response is returned.
|
|
1027
|
+
*
|
|
1028
|
+
* ⚠️ __Deprecated__: Use [`GET /api/v2/grants`](#tag/entitlements/get/api/v2/grants) instead.
|
|
1018
1029
|
*/
|
|
1019
1030
|
get: operations['listGrants'];
|
|
1020
1031
|
put?: never;
|
|
@@ -1769,16 +1780,22 @@ export interface paths {
|
|
|
1769
1780
|
};
|
|
1770
1781
|
/**
|
|
1771
1782
|
* List subjects
|
|
1783
|
+
* @deprecated
|
|
1772
1784
|
* @description List subjects.
|
|
1785
|
+
*
|
|
1786
|
+
* ⚠️ __Deprecated__: Subjects as managable entities are being depracated, use customers with subject key usage attribution instead.
|
|
1773
1787
|
*/
|
|
1774
1788
|
get: operations['listSubjects'];
|
|
1775
1789
|
put?: never;
|
|
1776
1790
|
/**
|
|
1777
1791
|
* Upsert subject
|
|
1792
|
+
* @deprecated
|
|
1778
1793
|
* @description Upserts a subject. Creates or updates subject.
|
|
1779
1794
|
*
|
|
1780
1795
|
* If the subject doesn't exist, it will be created.
|
|
1781
1796
|
* If the subject exists, it will be partially updated with the provided fields.
|
|
1797
|
+
*
|
|
1798
|
+
* ⚠️ __Deprecated__: Subjects as managable entities are being depracated, use customers with subject key usage attribution instead.
|
|
1782
1799
|
*/
|
|
1783
1800
|
post: operations['upsertSubject'];
|
|
1784
1801
|
delete?: never;
|
|
@@ -1796,14 +1813,20 @@ export interface paths {
|
|
|
1796
1813
|
};
|
|
1797
1814
|
/**
|
|
1798
1815
|
* Get subject
|
|
1816
|
+
* @deprecated
|
|
1799
1817
|
* @description Get subject by ID or key.
|
|
1818
|
+
*
|
|
1819
|
+
* ⚠️ __Deprecated__: Subjects as managable entities are being depracated, use customers with subject key usage attribution instead.
|
|
1800
1820
|
*/
|
|
1801
1821
|
get: operations['getSubject'];
|
|
1802
1822
|
put?: never;
|
|
1803
1823
|
post?: never;
|
|
1804
1824
|
/**
|
|
1805
1825
|
* Delete subject
|
|
1826
|
+
* @deprecated
|
|
1806
1827
|
* @description Delete subject by ID or key.
|
|
1828
|
+
*
|
|
1829
|
+
* ⚠️ __Deprecated__: Subjects as managable entities are being depracated, use customers with subject key usage attribution instead.
|
|
1807
1830
|
*/
|
|
1808
1831
|
delete: operations['deleteSubject'];
|
|
1809
1832
|
options?: never;
|
|
@@ -1820,12 +1843,16 @@ export interface paths {
|
|
|
1820
1843
|
};
|
|
1821
1844
|
/**
|
|
1822
1845
|
* List subject entitlements
|
|
1846
|
+
* @deprecated
|
|
1823
1847
|
* @description List all entitlements for a subject. For checking entitlement access, use the /value endpoint instead.
|
|
1848
|
+
*
|
|
1849
|
+
* ⚠️ __Deprecated__: Use [`GET /api/v2/customers/{customerIdOrKey}/entitlements`](#tag/entitlements/get/api/v2/customers/{customerIdOrKey}/entitlements) instead.
|
|
1824
1850
|
*/
|
|
1825
1851
|
get: operations['listSubjectEntitlements'];
|
|
1826
1852
|
put?: never;
|
|
1827
1853
|
/**
|
|
1828
1854
|
* Create a subject entitlement
|
|
1855
|
+
* @deprecated
|
|
1829
1856
|
* @description 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).
|
|
1830
1857
|
*
|
|
1831
1858
|
* - Boolean entitlements define static feature access, e.g. "Can use SSO authentication".
|
|
@@ -1835,6 +1862,8 @@ export interface paths {
|
|
|
1835
1862
|
* 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.
|
|
1836
1863
|
*
|
|
1837
1864
|
* Once an entitlement is created you cannot modify it, only delete it.
|
|
1865
|
+
*
|
|
1866
|
+
* ⚠️ __Deprecated__: Use [`POST /api/v2/customers/{customerIdOrKey}/entitlements`](#tag/entitlements/post/api/v2/customers/{customerIdOrKey}/entitlements) instead.
|
|
1838
1867
|
*/
|
|
1839
1868
|
post: operations['createEntitlement'];
|
|
1840
1869
|
delete?: never;
|
|
@@ -1852,12 +1881,16 @@ export interface paths {
|
|
|
1852
1881
|
};
|
|
1853
1882
|
/**
|
|
1854
1883
|
* List subject entitlement grants
|
|
1884
|
+
* @deprecated
|
|
1855
1885
|
* @description List all grants issued for an entitlement. The entitlement can be defined either by its id or featureKey.
|
|
1886
|
+
*
|
|
1887
|
+
* ⚠️ __Deprecated__: Use [`GET /api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/grants`](#tag/entitlements/get/api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/grants) instead.
|
|
1856
1888
|
*/
|
|
1857
1889
|
get: operations['listEntitlementGrants'];
|
|
1858
1890
|
put?: never;
|
|
1859
1891
|
/**
|
|
1860
1892
|
* Create subject entitlement grant
|
|
1893
|
+
* @deprecated
|
|
1861
1894
|
* @description 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.
|
|
1862
1895
|
*
|
|
1863
1896
|
* 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.
|
|
@@ -1869,6 +1902,8 @@ export interface paths {
|
|
|
1869
1902
|
* 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))
|
|
1870
1903
|
*
|
|
1871
1904
|
* Grants cannot be changed once created, only deleted. This is to ensure that balance is deterministic regardless of when it is queried.
|
|
1905
|
+
*
|
|
1906
|
+
* ⚠️ __Deprecated__: Use [`POST /api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/grants`](#tag/entitlements/post/api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/grants) instead.
|
|
1872
1907
|
*/
|
|
1873
1908
|
post: operations['createGrant'];
|
|
1874
1909
|
delete?: never;
|
|
@@ -1887,9 +1922,12 @@ export interface paths {
|
|
|
1887
1922
|
get?: never;
|
|
1888
1923
|
/**
|
|
1889
1924
|
* Override subject entitlement
|
|
1925
|
+
* @deprecated
|
|
1890
1926
|
* @description 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.
|
|
1891
1927
|
*
|
|
1892
1928
|
* This endpoint is useful for upgrades, downgrades, or other changes to entitlements that require a new entitlement to be created with zero downtime.
|
|
1929
|
+
*
|
|
1930
|
+
* ⚠️ __Deprecated__: Use [`PUT /api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/override`](#tag/entitlements/put/api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/override) instead.
|
|
1893
1931
|
*/
|
|
1894
1932
|
put: operations['overrideEntitlement'];
|
|
1895
1933
|
post?: never;
|
|
@@ -1908,9 +1946,12 @@ export interface paths {
|
|
|
1908
1946
|
};
|
|
1909
1947
|
/**
|
|
1910
1948
|
* Get subject entitlement value
|
|
1949
|
+
* @deprecated
|
|
1911
1950
|
* @description 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.
|
|
1912
1951
|
*
|
|
1913
1952
|
* For convenience reasons, /value works with both entitlementId and featureKey.
|
|
1953
|
+
*
|
|
1954
|
+
* ⚠️ __Deprecated__: Use [`GET /api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/value`](#tag/entitlements/get/api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/value) instead.
|
|
1914
1955
|
*/
|
|
1915
1956
|
get: operations['getEntitlementValue'];
|
|
1916
1957
|
put?: never;
|
|
@@ -1930,15 +1971,21 @@ export interface paths {
|
|
|
1930
1971
|
};
|
|
1931
1972
|
/**
|
|
1932
1973
|
* Get subject entitlement
|
|
1974
|
+
* @deprecated
|
|
1933
1975
|
* @description Get entitlement by id. For checking entitlement access, use the /value endpoint instead.
|
|
1976
|
+
*
|
|
1977
|
+
* ⚠️ __Deprecated__: Use [`GET /api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}`](#tag/entitlements/get/api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}) instead.
|
|
1934
1978
|
*/
|
|
1935
1979
|
get: operations['getEntitlement'];
|
|
1936
1980
|
put?: never;
|
|
1937
1981
|
post?: never;
|
|
1938
1982
|
/**
|
|
1939
1983
|
* Delete subject entitlement
|
|
1984
|
+
* @deprecated
|
|
1940
1985
|
* @description 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.
|
|
1941
1986
|
* 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.
|
|
1987
|
+
*
|
|
1988
|
+
* ⚠️ __Deprecated__: Use [`DELETE /api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}`](#tag/entitlements/delete/api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}) instead.
|
|
1942
1989
|
*/
|
|
1943
1990
|
delete: operations['deleteEntitlement'];
|
|
1944
1991
|
options?: never;
|
|
@@ -1955,11 +2002,14 @@ export interface paths {
|
|
|
1955
2002
|
};
|
|
1956
2003
|
/**
|
|
1957
2004
|
* Get subject entitlement history
|
|
2005
|
+
* @deprecated
|
|
1958
2006
|
* @description Returns historical balance and usage data for the entitlement. The queried history can span accross multiple reset events.
|
|
1959
2007
|
*
|
|
1960
2008
|
* 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.
|
|
1961
2009
|
*
|
|
1962
2010
|
* 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.
|
|
2011
|
+
*
|
|
2012
|
+
* ⚠️ __Deprecated__: Use [`GET /api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/history`](#tag/entitlements/get/api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/history) instead.
|
|
1963
2013
|
*/
|
|
1964
2014
|
get: operations['getEntitlementHistory'];
|
|
1965
2015
|
put?: never;
|
|
@@ -1981,9 +2031,12 @@ export interface paths {
|
|
|
1981
2031
|
put?: never;
|
|
1982
2032
|
/**
|
|
1983
2033
|
* Reset subject entitlement
|
|
2034
|
+
* @deprecated
|
|
1984
2035
|
* @description 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.
|
|
1985
2036
|
*
|
|
1986
2037
|
* 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.
|
|
2038
|
+
*
|
|
2039
|
+
* ⚠️ __Deprecated__: Use [`POST /api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/reset`](#tag/entitlements/post/api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/reset) instead.
|
|
1987
2040
|
*/
|
|
1988
2041
|
post: operations['resetEntitlementUsage'];
|
|
1989
2042
|
delete?: never;
|
|
@@ -2398,8 +2451,8 @@ export interface paths {
|
|
|
2398
2451
|
cookie?: never;
|
|
2399
2452
|
};
|
|
2400
2453
|
/**
|
|
2401
|
-
* Get entitlement by
|
|
2402
|
-
* @description Get entitlement by
|
|
2454
|
+
* Get entitlement by ID
|
|
2455
|
+
* @description Get entitlement by ID.
|
|
2403
2456
|
*/
|
|
2404
2457
|
get: operations['getEntitlementByIdV2'];
|
|
2405
2458
|
put?: never;
|
|
@@ -2702,8 +2755,10 @@ export interface components {
|
|
|
2702
2755
|
Annotations: {
|
|
2703
2756
|
[key: string]: unknown;
|
|
2704
2757
|
};
|
|
2705
|
-
/**
|
|
2706
|
-
*
|
|
2758
|
+
/**
|
|
2759
|
+
* @description App.
|
|
2760
|
+
* One of: stripe
|
|
2761
|
+
*/
|
|
2707
2762
|
App: components['schemas']['StripeApp'] | components['schemas']['SandboxApp'] | components['schemas']['CustomInvoicingApp'];
|
|
2708
2763
|
/**
|
|
2709
2764
|
* @description App capability.
|
|
@@ -2751,9 +2806,11 @@ export interface components {
|
|
|
2751
2806
|
/** @description The items in the current page. */
|
|
2752
2807
|
items: components['schemas']['App'][];
|
|
2753
2808
|
};
|
|
2754
|
-
/**
|
|
2809
|
+
/**
|
|
2810
|
+
* @description App reference
|
|
2755
2811
|
*
|
|
2756
|
-
* Can be used as a short reference to an app if the full app object is not needed.
|
|
2812
|
+
* Can be used as a short reference to an app if the full app object is not needed.
|
|
2813
|
+
*/
|
|
2757
2814
|
AppReference: {
|
|
2758
2815
|
/**
|
|
2759
2816
|
* @description The ID of the app.
|
|
@@ -2791,19 +2848,23 @@ export interface components {
|
|
|
2791
2848
|
*/
|
|
2792
2849
|
readonly balanceAtStart: number;
|
|
2793
2850
|
};
|
|
2794
|
-
/**
|
|
2851
|
+
/**
|
|
2852
|
+
* @description Customer specific merged profile.
|
|
2795
2853
|
*
|
|
2796
2854
|
* This profile is calculated from the customer override and the billing profile it references or the default.
|
|
2797
2855
|
*
|
|
2798
|
-
* Thus this does not have any kind of resource fields, only the calculated values.
|
|
2856
|
+
* Thus this does not have any kind of resource fields, only the calculated values.
|
|
2857
|
+
*/
|
|
2799
2858
|
BillingCustomerProfile: {
|
|
2800
2859
|
/** @description The name and contact information for the supplier this billing profile represents */
|
|
2801
2860
|
readonly supplier: components['schemas']['BillingParty'];
|
|
2802
2861
|
/** @description The billing workflow settings for this profile */
|
|
2803
2862
|
readonly workflow: components['schemas']['BillingWorkflow'];
|
|
2804
|
-
/**
|
|
2863
|
+
/**
|
|
2864
|
+
* @description The applications used by this billing profile.
|
|
2805
2865
|
*
|
|
2806
|
-
* Expand settings govern if this includes the whole app object or just the ID references.
|
|
2866
|
+
* Expand settings govern if this includes the whole app object or just the ID references.
|
|
2867
|
+
*/
|
|
2807
2868
|
readonly apps: components['schemas']['BillingProfileAppsOrReference'];
|
|
2808
2869
|
};
|
|
2809
2870
|
/** @description A percentage discount. */
|
|
@@ -2855,9 +2916,11 @@ export interface components {
|
|
|
2855
2916
|
/** @description The usage discount. */
|
|
2856
2917
|
usage?: components['schemas']['BillingDiscountUsage'];
|
|
2857
2918
|
};
|
|
2858
|
-
/**
|
|
2919
|
+
/**
|
|
2920
|
+
* @description BillingInvoiceCustomerExtendedDetails is a collection of fields that are used to extend the billing party details for invoices.
|
|
2859
2921
|
*
|
|
2860
|
-
* These fields contain the OpenMeter specific details for the customer, that are not strictly required for the invoice itself.
|
|
2922
|
+
* These fields contain the OpenMeter specific details for the customer, that are not strictly required for the invoice itself.
|
|
2923
|
+
*/
|
|
2861
2924
|
BillingInvoiceCustomerExtendedDetails: {
|
|
2862
2925
|
/** @description Unique identifier for the party (if available) */
|
|
2863
2926
|
readonly id?: string;
|
|
@@ -2868,8 +2931,10 @@ export interface components {
|
|
|
2868
2931
|
key?: string;
|
|
2869
2932
|
/** @description Legal name or representation of the organization. */
|
|
2870
2933
|
name?: string;
|
|
2871
|
-
/**
|
|
2872
|
-
*
|
|
2934
|
+
/**
|
|
2935
|
+
* @description The entity's legal ID code used for tax purposes. They may have
|
|
2936
|
+
* other numbers, but we're only interested in those valid for tax purposes.
|
|
2937
|
+
*/
|
|
2873
2938
|
taxId?: components['schemas']['BillingPartyTaxIdentity'];
|
|
2874
2939
|
/** @description Regular post addresses for where information should be sent if needed. */
|
|
2875
2940
|
addresses?: components['schemas']['Address'][];
|
|
@@ -2890,8 +2955,10 @@ export interface components {
|
|
|
2890
2955
|
key?: string;
|
|
2891
2956
|
/** @description Legal name or representation of the organization. */
|
|
2892
2957
|
name?: string;
|
|
2893
|
-
/**
|
|
2894
|
-
*
|
|
2958
|
+
/**
|
|
2959
|
+
* @description The entity's legal ID code used for tax purposes. They may have
|
|
2960
|
+
* other numbers, but we're only interested in those valid for tax purposes.
|
|
2961
|
+
*/
|
|
2895
2962
|
taxId?: components['schemas']['BillingPartyTaxIdentity'];
|
|
2896
2963
|
/** @description Regular post addresses for where information should be sent if needed. */
|
|
2897
2964
|
addresses?: components['schemas']['Address'][];
|
|
@@ -2905,8 +2972,10 @@ export interface components {
|
|
|
2905
2972
|
key?: string;
|
|
2906
2973
|
/** @description Legal name or representation of the organization. */
|
|
2907
2974
|
name?: string;
|
|
2908
|
-
/**
|
|
2909
|
-
*
|
|
2975
|
+
/**
|
|
2976
|
+
* @description The entity's legal ID code used for tax purposes. They may have
|
|
2977
|
+
* other numbers, but we're only interested in those valid for tax purposes.
|
|
2978
|
+
*/
|
|
2910
2979
|
taxId?: components['schemas']['BillingPartyTaxIdentity'];
|
|
2911
2980
|
/** @description Regular post addresses for where information should be sent if needed. */
|
|
2912
2981
|
addresses?: components['schemas']['Address'][];
|
|
@@ -2964,9 +3033,11 @@ export interface components {
|
|
|
2964
3033
|
supplier: components['schemas']['BillingParty'];
|
|
2965
3034
|
/** @description The billing workflow settings for this profile */
|
|
2966
3035
|
readonly workflow: components['schemas']['BillingWorkflow'];
|
|
2967
|
-
/**
|
|
3036
|
+
/**
|
|
3037
|
+
* @description The applications used by this billing profile.
|
|
2968
3038
|
*
|
|
2969
|
-
* Expand settings govern if this includes the whole app object or just the ID references.
|
|
3039
|
+
* Expand settings govern if this includes the whole app object or just the ID references.
|
|
3040
|
+
*/
|
|
2970
3041
|
readonly apps: components['schemas']['BillingProfileAppsOrReference'];
|
|
2971
3042
|
/** @description Is this the default profile? */
|
|
2972
3043
|
default: boolean;
|
|
@@ -3007,8 +3078,10 @@ export interface components {
|
|
|
3007
3078
|
*/
|
|
3008
3079
|
payment: string;
|
|
3009
3080
|
};
|
|
3010
|
-
/**
|
|
3011
|
-
*
|
|
3081
|
+
/**
|
|
3082
|
+
* @description ProfileAppsOrReference represents the union of ProfileApps and ProfileAppReferences
|
|
3083
|
+
* for a billing profile.
|
|
3084
|
+
*/
|
|
3012
3085
|
BillingProfileAppsOrReference: components['schemas']['BillingProfileApps'] | components['schemas']['BillingProfileAppReferences'];
|
|
3013
3086
|
/** @description BillingProfileCreate represents the input for creating a billing profile */
|
|
3014
3087
|
BillingProfileCreate: {
|
|
@@ -3087,9 +3160,11 @@ export interface components {
|
|
|
3087
3160
|
BillingProfileCustomerOverrideOrderBy: 'customerId' | 'customerName' | 'customerKey' | 'customerPrimaryEmail' | 'customerCreatedAt';
|
|
3088
3161
|
/** @description Customer specific workflow overrides. */
|
|
3089
3162
|
BillingProfileCustomerOverrideWithDetails: {
|
|
3090
|
-
/**
|
|
3163
|
+
/**
|
|
3164
|
+
* @description The customer override values.
|
|
3091
3165
|
*
|
|
3092
|
-
* If empty the merged values are calculated based on the default profile.
|
|
3166
|
+
* If empty the merged values are calculated based on the default profile.
|
|
3167
|
+
*/
|
|
3093
3168
|
customerOverride?: components['schemas']['BillingProfileCustomerOverride'];
|
|
3094
3169
|
/**
|
|
3095
3170
|
* @description The billing profile the customerProfile is associated with at the time of query.
|
|
@@ -3154,10 +3229,12 @@ export interface components {
|
|
|
3154
3229
|
/** @description The items in the current page. */
|
|
3155
3230
|
items: components['schemas']['BillingProfile'][];
|
|
3156
3231
|
};
|
|
3157
|
-
/**
|
|
3232
|
+
/**
|
|
3233
|
+
* @description BillingProfileReplaceUpdate represents the input for updating a billing profile
|
|
3158
3234
|
*
|
|
3159
3235
|
* The apps field cannot be updated directly, if an app change is desired a new
|
|
3160
|
-
* profile should be created.
|
|
3236
|
+
* profile should be created.
|
|
3237
|
+
*/
|
|
3161
3238
|
BillingProfileReplaceUpdateWithWorkflow: {
|
|
3162
3239
|
/**
|
|
3163
3240
|
* Display name
|
|
@@ -3194,13 +3271,17 @@ export interface components {
|
|
|
3194
3271
|
/** @description The tax settings for this workflow */
|
|
3195
3272
|
tax?: components['schemas']['BillingWorkflowTaxSettings'];
|
|
3196
3273
|
};
|
|
3197
|
-
/**
|
|
3274
|
+
/**
|
|
3275
|
+
* @description The alignment for collecting the pending line items into an invoice.
|
|
3198
3276
|
*
|
|
3199
3277
|
* Defaults to subscription, which means that we are to create a new invoice every time the
|
|
3200
|
-
* a subscription period starts (for in advance items) or ends (for in arrears items).
|
|
3278
|
+
* a subscription period starts (for in advance items) or ends (for in arrears items).
|
|
3279
|
+
*/
|
|
3201
3280
|
BillingWorkflowCollectionAlignment: components['schemas']['BillingWorkflowCollectionAlignmentSubscription'] | components['schemas']['BillingWorkflowCollectionAlignmentAnchored'];
|
|
3202
|
-
/**
|
|
3203
|
-
*
|
|
3281
|
+
/**
|
|
3282
|
+
* @description BillingWorkflowCollectionAlignmentAnchored specifies the alignment for collecting the pending line items
|
|
3283
|
+
* into an invoice.
|
|
3284
|
+
*/
|
|
3204
3285
|
BillingWorkflowCollectionAlignmentAnchored: {
|
|
3205
3286
|
/**
|
|
3206
3287
|
* @description The type of alignment. (enum property replaced by openapi-typescript)
|
|
@@ -3210,8 +3291,10 @@ export interface components {
|
|
|
3210
3291
|
/** @description The recurring period for the alignment. */
|
|
3211
3292
|
recurringPeriod: components['schemas']['RecurringPeriodV2'];
|
|
3212
3293
|
};
|
|
3213
|
-
/**
|
|
3214
|
-
*
|
|
3294
|
+
/**
|
|
3295
|
+
* @description BillingWorkflowCollectionAlignmentSubscription specifies the alignment for collecting the pending line items
|
|
3296
|
+
* into an invoice.
|
|
3297
|
+
*/
|
|
3215
3298
|
BillingWorkflowCollectionAlignmentSubscription: {
|
|
3216
3299
|
/**
|
|
3217
3300
|
* @description The type of alignment. (enum property replaced by openapi-typescript)
|
|
@@ -3277,7 +3360,7 @@ export interface components {
|
|
|
3277
3360
|
dueAfter?: string;
|
|
3278
3361
|
/**
|
|
3279
3362
|
* @description Should progressive billing be allowed for this workflow?
|
|
3280
|
-
* @default
|
|
3363
|
+
* @default true
|
|
3281
3364
|
*/
|
|
3282
3365
|
progressiveBilling?: boolean;
|
|
3283
3366
|
/** @description Default tax configuration to apply to the invoices. */
|
|
@@ -3376,16 +3459,22 @@ export interface components {
|
|
|
3376
3459
|
CreateStripeCheckoutSessionBillingAddressCollection: 'auto' | 'required';
|
|
3377
3460
|
/** @description Configure fields for the Checkout Session to gather active consent from customers. */
|
|
3378
3461
|
CreateStripeCheckoutSessionConsentCollection: {
|
|
3379
|
-
/**
|
|
3380
|
-
*
|
|
3462
|
+
/**
|
|
3463
|
+
* @description Determines the position and visibility of the payment method reuse agreement in the UI.
|
|
3464
|
+
* When set to auto, Stripe’s defaults will be used. When set to hidden, the payment method reuse agreement text will always be hidden in the UI.
|
|
3465
|
+
*/
|
|
3381
3466
|
paymentMethodReuseAgreement?: components['schemas']['CreateStripeCheckoutSessionConsentCollectionPaymentMethodReuseAgreement'];
|
|
3382
|
-
/**
|
|
3467
|
+
/**
|
|
3468
|
+
* @description If set to auto, enables the collection of customer consent for promotional communications.
|
|
3383
3469
|
* The Checkout Session will determine whether to display an option to opt into promotional
|
|
3384
|
-
* communication from the merchant depending on the customer’s locale. Only available to US merchants.
|
|
3470
|
+
* communication from the merchant depending on the customer’s locale. Only available to US merchants.
|
|
3471
|
+
*/
|
|
3385
3472
|
promotions?: components['schemas']['CreateStripeCheckoutSessionConsentCollectionPromotions'];
|
|
3386
|
-
/**
|
|
3473
|
+
/**
|
|
3474
|
+
* @description If set to required, it requires customers to check a terms of service checkbox before being able to pay.
|
|
3387
3475
|
* There must be a valid terms of service URL set in your Stripe Dashboard settings.
|
|
3388
|
-
* https://dashboard.stripe.com/settings/public
|
|
3476
|
+
* https://dashboard.stripe.com/settings/public
|
|
3477
|
+
*/
|
|
3389
3478
|
termsOfService?: components['schemas']['CreateStripeCheckoutSessionConsentCollectionTermsOfService'];
|
|
3390
3479
|
};
|
|
3391
3480
|
/** @description Create Stripe checkout session payment method reuse agreement. */
|
|
@@ -3409,16 +3498,22 @@ export interface components {
|
|
|
3409
3498
|
CreateStripeCheckoutSessionConsentCollectionTermsOfService: 'none' | 'required';
|
|
3410
3499
|
/** @description Controls what fields on Customer can be updated by the Checkout Session. */
|
|
3411
3500
|
CreateStripeCheckoutSessionCustomerUpdate: {
|
|
3412
|
-
/**
|
|
3501
|
+
/**
|
|
3502
|
+
* @description Describes whether Checkout saves the billing address onto customer.address.
|
|
3413
3503
|
* To always collect a full billing address, use billing_address_collection.
|
|
3414
|
-
* Defaults to never.
|
|
3504
|
+
* Defaults to never.
|
|
3505
|
+
*/
|
|
3415
3506
|
address?: components['schemas']['CreateStripeCheckoutSessionCustomerUpdateBehavior'];
|
|
3416
|
-
/**
|
|
3417
|
-
*
|
|
3507
|
+
/**
|
|
3508
|
+
* @description Describes whether Checkout saves the name onto customer.name.
|
|
3509
|
+
* Defaults to never.
|
|
3510
|
+
*/
|
|
3418
3511
|
name?: components['schemas']['CreateStripeCheckoutSessionCustomerUpdateBehavior'];
|
|
3419
|
-
/**
|
|
3512
|
+
/**
|
|
3513
|
+
* @description Describes whether Checkout saves shipping information onto customer.shipping.
|
|
3420
3514
|
* To collect shipping information, use shipping_address_collection.
|
|
3421
|
-
* Defaults to never.
|
|
3515
|
+
* Defaults to never.
|
|
3516
|
+
*/
|
|
3422
3517
|
shipping?: components['schemas']['CreateStripeCheckoutSessionCustomerUpdateBehavior'];
|
|
3423
3518
|
};
|
|
3424
3519
|
/**
|
|
@@ -3464,23 +3559,31 @@ export interface components {
|
|
|
3464
3559
|
* @example 01G65Z755AFWAKHE12NY0CQ9FH
|
|
3465
3560
|
*/
|
|
3466
3561
|
appId?: string;
|
|
3467
|
-
/**
|
|
3468
|
-
*
|
|
3562
|
+
/**
|
|
3563
|
+
* @description Provide a customer ID or key to use an existing OpenMeter customer.
|
|
3564
|
+
* or provide a customer object to create a new customer.
|
|
3565
|
+
*/
|
|
3469
3566
|
customer: components['schemas']['CustomerId'] | components['schemas']['CustomerKey'] | components['schemas']['CustomerCreate'];
|
|
3470
|
-
/**
|
|
3567
|
+
/**
|
|
3568
|
+
* @description Stripe customer ID.
|
|
3471
3569
|
* If not provided OpenMeter creates a new Stripe customer or
|
|
3472
|
-
* uses the OpenMeter customer's default Stripe customer ID.
|
|
3570
|
+
* uses the OpenMeter customer's default Stripe customer ID.
|
|
3571
|
+
*/
|
|
3473
3572
|
stripeCustomerId?: string;
|
|
3474
3573
|
/** @description Options passed to Stripe when creating the checkout session. */
|
|
3475
3574
|
options: components['schemas']['CreateStripeCheckoutSessionRequestOptions'];
|
|
3476
3575
|
};
|
|
3477
|
-
/**
|
|
3478
|
-
*
|
|
3576
|
+
/**
|
|
3577
|
+
* @description Create Stripe checkout session options
|
|
3578
|
+
* See https://docs.stripe.com/api/checkout/sessions/create
|
|
3579
|
+
*/
|
|
3479
3580
|
CreateStripeCheckoutSessionRequestOptions: {
|
|
3480
3581
|
/** @description Specify whether Checkout should collect the customer’s billing address. Defaults to auto. */
|
|
3481
3582
|
billingAddressCollection?: components['schemas']['CreateStripeCheckoutSessionBillingAddressCollection'];
|
|
3482
|
-
/**
|
|
3483
|
-
*
|
|
3583
|
+
/**
|
|
3584
|
+
* @description If set, Checkout displays a back button and customers will be directed to this URL if they decide to cancel payment and return to your website.
|
|
3585
|
+
* This parameter is not allowed if ui_mode is embedded.
|
|
3586
|
+
*/
|
|
3484
3587
|
cancelURL?: string;
|
|
3485
3588
|
/** @description A unique string to reference the Checkout Session. This can be a customer ID, a cart ID, or similar, and can be used to reconcile the session with your internal systems. */
|
|
3486
3589
|
clientReferenceID?: string;
|
|
@@ -3499,28 +3602,36 @@ export interface components {
|
|
|
3499
3602
|
*/
|
|
3500
3603
|
expiresAt?: number;
|
|
3501
3604
|
locale?: string;
|
|
3502
|
-
/**
|
|
3605
|
+
/**
|
|
3606
|
+
* @description Set of key-value pairs that you can attach to an object.
|
|
3503
3607
|
* This can be useful for storing additional information about the object in a structured format.
|
|
3504
3608
|
* Individual keys can be unset by posting an empty value to them.
|
|
3505
|
-
* All keys can be unset by posting an empty value to metadata.
|
|
3609
|
+
* All keys can be unset by posting an empty value to metadata.
|
|
3610
|
+
*/
|
|
3506
3611
|
metadata?: {
|
|
3507
3612
|
[key: string]: string;
|
|
3508
3613
|
};
|
|
3509
|
-
/**
|
|
3510
|
-
*
|
|
3614
|
+
/**
|
|
3615
|
+
* @description The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method’s app or site.
|
|
3616
|
+
* This parameter is required if ui_mode is embedded and redirect-based payment methods are enabled on the session.
|
|
3617
|
+
*/
|
|
3511
3618
|
returnURL?: string;
|
|
3512
|
-
/**
|
|
3619
|
+
/**
|
|
3620
|
+
* @description The URL to which Stripe should send customers when payment or setup is complete.
|
|
3513
3621
|
* This parameter is not allowed if ui_mode is embedded.
|
|
3514
3622
|
* If you’d like to use information from the successful Checkout Session on your page, read the guide on customizing your success page:
|
|
3515
|
-
* https://docs.stripe.com/payments/checkout/custom-success-page
|
|
3623
|
+
* https://docs.stripe.com/payments/checkout/custom-success-page
|
|
3624
|
+
*/
|
|
3516
3625
|
successURL?: string;
|
|
3517
3626
|
/** @description The UI mode of the Session. Defaults to hosted. */
|
|
3518
3627
|
uiMode?: components['schemas']['CheckoutSessionUIMode'];
|
|
3519
3628
|
/** @description A list of the types of payment methods (e.g., card) this Checkout Session can accept. */
|
|
3520
3629
|
paymentMethodTypes?: string[];
|
|
3521
|
-
/**
|
|
3630
|
+
/**
|
|
3631
|
+
* @description This parameter applies to ui_mode: embedded. Defaults to always.
|
|
3522
3632
|
* Learn more about the redirect behavior of embedded sessions at
|
|
3523
|
-
* https://docs.stripe.com/payments/checkout/custom-success-page?payment-ui=embedded-form
|
|
3633
|
+
* https://docs.stripe.com/payments/checkout/custom-success-page?payment-ui=embedded-form
|
|
3634
|
+
*/
|
|
3524
3635
|
redirectOnCompletion?: components['schemas']['CreateStripeCheckoutSessionRedirectOnCompletion'];
|
|
3525
3636
|
/** @description Controls tax ID collection during checkout. */
|
|
3526
3637
|
taxIdCollection?: components['schemas']['CreateCheckoutSessionTaxIdCollection'];
|
|
@@ -3538,11 +3649,15 @@ export interface components {
|
|
|
3538
3649
|
sessionId: string;
|
|
3539
3650
|
/** @description The checkout session setup intent ID. */
|
|
3540
3651
|
setupIntentId: string;
|
|
3541
|
-
/**
|
|
3542
|
-
*
|
|
3652
|
+
/**
|
|
3653
|
+
* @description The client secret of the checkout session.
|
|
3654
|
+
* This can be used to initialize Stripe.js for your client-side implementation.
|
|
3655
|
+
*/
|
|
3543
3656
|
clientSecret?: string;
|
|
3544
|
-
/**
|
|
3545
|
-
*
|
|
3657
|
+
/**
|
|
3658
|
+
* @description A unique string to reference the Checkout Session.
|
|
3659
|
+
* This can be a customer ID, a cart ID, or similar, and can be used to reconcile the session with your internal systems.
|
|
3660
|
+
*/
|
|
3546
3661
|
clientReferenceId?: string;
|
|
3547
3662
|
/** @description Customer's email address provided to Stripe. */
|
|
3548
3663
|
customerEmail?: string;
|
|
@@ -3568,8 +3683,10 @@ export interface components {
|
|
|
3568
3683
|
status?: string;
|
|
3569
3684
|
/** @description URL to show the checkout session. */
|
|
3570
3685
|
url?: string;
|
|
3571
|
-
/**
|
|
3572
|
-
*
|
|
3686
|
+
/**
|
|
3687
|
+
* @description Mode
|
|
3688
|
+
* Always `setup` for now.
|
|
3689
|
+
*/
|
|
3573
3690
|
mode: components['schemas']['StripeCheckoutSessionMode'];
|
|
3574
3691
|
/** @description Cancel URL. */
|
|
3575
3692
|
cancelURL?: string;
|
|
@@ -3647,10 +3764,12 @@ export interface components {
|
|
|
3647
3764
|
* @example USD
|
|
3648
3765
|
*/
|
|
3649
3766
|
CurrencyCode: string;
|
|
3650
|
-
/**
|
|
3767
|
+
/**
|
|
3768
|
+
* @description Custom Invoicing app can be used for interface with any invoicing or payment system.
|
|
3651
3769
|
*
|
|
3652
3770
|
* This app provides ways to manipulate invoices and payments, however the integration
|
|
3653
|
-
* must rely on Notifications API to get notified about invoice changes.
|
|
3771
|
+
* must rely on Notifications API to get notified about invoice changes.
|
|
3772
|
+
*/
|
|
3654
3773
|
CustomInvoicingApp: {
|
|
3655
3774
|
/**
|
|
3656
3775
|
* ID
|
|
@@ -3703,13 +3822,17 @@ export interface components {
|
|
|
3703
3822
|
* @enum {string}
|
|
3704
3823
|
*/
|
|
3705
3824
|
type: 'custom_invoicing';
|
|
3706
|
-
/**
|
|
3825
|
+
/**
|
|
3826
|
+
* @description Enable draft.sync hook.
|
|
3707
3827
|
*
|
|
3708
|
-
* If the hook is not enabled, the invoice will be progressed to the next state automatically.
|
|
3828
|
+
* If the hook is not enabled, the invoice will be progressed to the next state automatically.
|
|
3829
|
+
*/
|
|
3709
3830
|
enableDraftSyncHook: boolean;
|
|
3710
|
-
/**
|
|
3831
|
+
/**
|
|
3832
|
+
* @description Enable issuing.sync hook.
|
|
3711
3833
|
*
|
|
3712
|
-
* If the hook is not enabled, the invoice will be progressed to the next state automatically.
|
|
3834
|
+
* If the hook is not enabled, the invoice will be progressed to the next state automatically.
|
|
3835
|
+
*/
|
|
3713
3836
|
enableIssuingSyncHook: boolean;
|
|
3714
3837
|
};
|
|
3715
3838
|
/** @description Resource update operation model. */
|
|
@@ -3734,13 +3857,17 @@ export interface components {
|
|
|
3734
3857
|
* @enum {string}
|
|
3735
3858
|
*/
|
|
3736
3859
|
type: 'custom_invoicing';
|
|
3737
|
-
/**
|
|
3860
|
+
/**
|
|
3861
|
+
* @description Enable draft.sync hook.
|
|
3738
3862
|
*
|
|
3739
|
-
* If the hook is not enabled, the invoice will be progressed to the next state automatically.
|
|
3863
|
+
* If the hook is not enabled, the invoice will be progressed to the next state automatically.
|
|
3864
|
+
*/
|
|
3740
3865
|
enableDraftSyncHook: boolean;
|
|
3741
|
-
/**
|
|
3866
|
+
/**
|
|
3867
|
+
* @description Enable issuing.sync hook.
|
|
3742
3868
|
*
|
|
3743
|
-
* If the hook is not enabled, the invoice will be progressed to the next state automatically.
|
|
3869
|
+
* If the hook is not enabled, the invoice will be progressed to the next state automatically.
|
|
3870
|
+
*/
|
|
3744
3871
|
enableIssuingSyncHook: boolean;
|
|
3745
3872
|
};
|
|
3746
3873
|
/** @description Custom Invoicing Customer App Data. */
|
|
@@ -3783,9 +3910,11 @@ export interface components {
|
|
|
3783
3910
|
/** @description If set the invoice's payment external ID will be set to this value. */
|
|
3784
3911
|
externalId?: string;
|
|
3785
3912
|
};
|
|
3786
|
-
/**
|
|
3913
|
+
/**
|
|
3914
|
+
* @description Information to finalize the invoice.
|
|
3787
3915
|
*
|
|
3788
|
-
* If invoicing.invoiceNumber is not set, then a new invoice number will be generated (INV- prefix).
|
|
3916
|
+
* If invoicing.invoiceNumber is not set, then a new invoice number will be generated (INV- prefix).
|
|
3917
|
+
*/
|
|
3789
3918
|
CustomInvoicingFinalizedRequest: {
|
|
3790
3919
|
/** @description The result of the synchronization. */
|
|
3791
3920
|
invoicing?: components['schemas']['CustomInvoicingFinalizedInvoicingRequest'];
|
|
@@ -3817,23 +3946,29 @@ export interface components {
|
|
|
3817
3946
|
* @enum {string}
|
|
3818
3947
|
*/
|
|
3819
3948
|
CustomInvoicingPaymentTrigger: 'paid' | 'payment_failed' | 'payment_uncollectible' | 'payment_overdue' | 'action_required' | 'void';
|
|
3820
|
-
/**
|
|
3949
|
+
/**
|
|
3950
|
+
* @description Information to synchronize the invoice.
|
|
3821
3951
|
*
|
|
3822
|
-
* Can be used to store external app's IDs on the invoice or lines.
|
|
3952
|
+
* Can be used to store external app's IDs on the invoice or lines.
|
|
3953
|
+
*/
|
|
3823
3954
|
CustomInvoicingSyncResult: {
|
|
3824
3955
|
/** @description If set the invoice's number will be set to this value. */
|
|
3825
3956
|
invoiceNumber?: components['schemas']['InvoiceNumber'];
|
|
3826
3957
|
/** @description If set the invoice's invoicing external ID will be set to this value. */
|
|
3827
3958
|
externalId?: string;
|
|
3828
|
-
/**
|
|
3959
|
+
/**
|
|
3960
|
+
* @description If set the invoice's line external IDs will be set to this value.
|
|
3829
3961
|
*
|
|
3830
3962
|
* This can be used to reference the external system's entities in the
|
|
3831
|
-
* invoice.
|
|
3963
|
+
* invoice.
|
|
3964
|
+
*/
|
|
3832
3965
|
lineExternalIds?: components['schemas']['CustomInvoicingLineExternalIdMapping'][];
|
|
3833
|
-
/**
|
|
3966
|
+
/**
|
|
3967
|
+
* @description If set the invoice's line discount external IDs will be set to this value.
|
|
3834
3968
|
*
|
|
3835
3969
|
* This can be used to reference the external system's entities in the
|
|
3836
|
-
* invoice.
|
|
3970
|
+
* invoice.
|
|
3971
|
+
*/
|
|
3837
3972
|
lineDiscountExternalIds?: components['schemas']['CustomInvoicingLineDiscountExternalIdMapping'][];
|
|
3838
3973
|
};
|
|
3839
3974
|
/** @description Custom invoicing tax config. */
|
|
@@ -3846,9 +3981,11 @@ export interface components {
|
|
|
3846
3981
|
*/
|
|
3847
3982
|
code: string;
|
|
3848
3983
|
};
|
|
3849
|
-
/**
|
|
3984
|
+
/**
|
|
3985
|
+
* @description Update payment status request.
|
|
3850
3986
|
*
|
|
3851
|
-
* Can be used to manipulate invoice's payment status (when custominvoicing app is being used).
|
|
3987
|
+
* Can be used to manipulate invoice's payment status (when custominvoicing app is being used).
|
|
3988
|
+
*/
|
|
3852
3989
|
CustomInvoicingUpdatePaymentStatusRequest: {
|
|
3853
3990
|
/** @description The trigger to be executed on the invoice. */
|
|
3854
3991
|
trigger: components['schemas']['CustomInvoicingPaymentTrigger'];
|
|
@@ -3905,8 +4042,10 @@ export interface components {
|
|
|
3905
4042
|
};
|
|
3906
4043
|
/** @description Change a custom subscription. */
|
|
3907
4044
|
CustomSubscriptionChange: {
|
|
3908
|
-
/**
|
|
3909
|
-
*
|
|
4045
|
+
/**
|
|
4046
|
+
* @description Timing configuration for the change, when the change should take effect.
|
|
4047
|
+
* For changing a subscription, the accepted values depend on the subscription configuration.
|
|
4048
|
+
*/
|
|
3910
4049
|
timing: components['schemas']['SubscriptionTiming'];
|
|
3911
4050
|
/**
|
|
3912
4051
|
* Format: date-time
|
|
@@ -4004,6 +4143,7 @@ export interface components {
|
|
|
4004
4143
|
/**
|
|
4005
4144
|
* Key
|
|
4006
4145
|
* @description An optional unique key of the customer.
|
|
4146
|
+
* Either key or usageAttribution.subjectKeys must be provided.
|
|
4007
4147
|
* Useful to reference the customer in external systems.
|
|
4008
4148
|
* For example, your database ID.
|
|
4009
4149
|
*/
|
|
@@ -4011,8 +4151,9 @@ export interface components {
|
|
|
4011
4151
|
/**
|
|
4012
4152
|
* Usage Attribution
|
|
4013
4153
|
* @description Mapping to attribute metered usage to the customer
|
|
4154
|
+
* Either key or usageAttribution.subjectKeys must be provided.
|
|
4014
4155
|
*/
|
|
4015
|
-
usageAttribution
|
|
4156
|
+
usageAttribution?: components['schemas']['CustomerUsageAttribution'];
|
|
4016
4157
|
/**
|
|
4017
4158
|
* Primary Email
|
|
4018
4159
|
* @description The primary email address of the customer.
|
|
@@ -4050,19 +4191,25 @@ export interface components {
|
|
|
4050
4191
|
};
|
|
4051
4192
|
/** @description CustomerAccess describes what features the customer has access to. */
|
|
4052
4193
|
CustomerAccess: {
|
|
4053
|
-
/**
|
|
4054
|
-
*
|
|
4194
|
+
/**
|
|
4195
|
+
* @description Map of entitlements the customer has access to.
|
|
4196
|
+
* The key is the feature key, the value is the entitlement value + the entitlement ID.
|
|
4197
|
+
*/
|
|
4055
4198
|
readonly entitlements: {
|
|
4056
4199
|
[key: string]: components['schemas']['EntitlementValue'];
|
|
4057
4200
|
};
|
|
4058
4201
|
};
|
|
4059
|
-
/**
|
|
4202
|
+
/**
|
|
4203
|
+
* @description CustomerAppData
|
|
4060
4204
|
* Stores the app specific data for the customer.
|
|
4061
|
-
* One of: stripe, sandbox, custom_invoicing
|
|
4205
|
+
* One of: stripe, sandbox, custom_invoicing
|
|
4206
|
+
*/
|
|
4062
4207
|
CustomerAppData: components['schemas']['StripeCustomerAppData'] | components['schemas']['SandboxCustomerAppData'] | components['schemas']['CustomInvoicingCustomerAppData'];
|
|
4063
|
-
/**
|
|
4208
|
+
/**
|
|
4209
|
+
* @description CustomerAppData
|
|
4064
4210
|
* Stores the app specific data for the customer.
|
|
4065
|
-
* One of: stripe, sandbox, custom_invoicing
|
|
4211
|
+
* One of: stripe, sandbox, custom_invoicing
|
|
4212
|
+
*/
|
|
4066
4213
|
CustomerAppDataCreateOrUpdateItem: components['schemas']['StripeCustomerAppDataCreateOrUpdateItem'] | components['schemas']['SandboxCustomerAppData'] | components['schemas']['CustomInvoicingCustomerAppData'];
|
|
4067
4214
|
/** @description Paginated response */
|
|
4068
4215
|
CustomerAppDataPaginatedResponse: {
|
|
@@ -4104,6 +4251,7 @@ export interface components {
|
|
|
4104
4251
|
/**
|
|
4105
4252
|
* Key
|
|
4106
4253
|
* @description An optional unique key of the customer.
|
|
4254
|
+
* Either key or usageAttribution.subjectKeys must be provided.
|
|
4107
4255
|
* Useful to reference the customer in external systems.
|
|
4108
4256
|
* For example, your database ID.
|
|
4109
4257
|
*/
|
|
@@ -4111,8 +4259,9 @@ export interface components {
|
|
|
4111
4259
|
/**
|
|
4112
4260
|
* Usage Attribution
|
|
4113
4261
|
* @description Mapping to attribute metered usage to the customer
|
|
4262
|
+
* Either key or usageAttribution.subjectKeys must be provided.
|
|
4114
4263
|
*/
|
|
4115
|
-
usageAttribution
|
|
4264
|
+
usageAttribution?: components['schemas']['CustomerUsageAttribution'];
|
|
4116
4265
|
/**
|
|
4117
4266
|
* Primary Email
|
|
4118
4267
|
* @description The primary email address of the customer.
|
|
@@ -4193,6 +4342,7 @@ export interface components {
|
|
|
4193
4342
|
/**
|
|
4194
4343
|
* Key
|
|
4195
4344
|
* @description An optional unique key of the customer.
|
|
4345
|
+
* Either key or usageAttribution.subjectKeys must be provided.
|
|
4196
4346
|
* Useful to reference the customer in external systems.
|
|
4197
4347
|
* For example, your database ID.
|
|
4198
4348
|
*/
|
|
@@ -4200,8 +4350,9 @@ export interface components {
|
|
|
4200
4350
|
/**
|
|
4201
4351
|
* Usage Attribution
|
|
4202
4352
|
* @description Mapping to attribute metered usage to the customer
|
|
4353
|
+
* Either key or usageAttribution.subjectKeys must be provided.
|
|
4203
4354
|
*/
|
|
4204
|
-
usageAttribution
|
|
4355
|
+
usageAttribution?: components['schemas']['CustomerUsageAttribution'];
|
|
4205
4356
|
/**
|
|
4206
4357
|
* Primary Email
|
|
4207
4358
|
* @description The primary email address of the customer.
|
|
@@ -4225,13 +4376,16 @@ export interface components {
|
|
|
4225
4376
|
* @enum {string}
|
|
4226
4377
|
*/
|
|
4227
4378
|
CustomerSubscriptionOrderBy: 'activeFrom' | 'activeTo';
|
|
4228
|
-
/**
|
|
4229
|
-
*
|
|
4230
|
-
*
|
|
4379
|
+
/**
|
|
4380
|
+
* @description Mapping to attribute metered usage to the customer.
|
|
4381
|
+
* One customer can have zero or more subjects,
|
|
4382
|
+
* but one subject can only belong to one customer.
|
|
4383
|
+
*/
|
|
4231
4384
|
CustomerUsageAttribution: {
|
|
4232
4385
|
/**
|
|
4233
4386
|
* SubjectKeys
|
|
4234
4387
|
* @description The subjects that are attributed to the customer.
|
|
4388
|
+
* Can be empty when no subjects are associated with the customer.
|
|
4235
4389
|
*/
|
|
4236
4390
|
subjectKeys: string[];
|
|
4237
4391
|
};
|
|
@@ -4301,11 +4455,13 @@ export interface components {
|
|
|
4301
4455
|
*/
|
|
4302
4456
|
correlationId?: string;
|
|
4303
4457
|
};
|
|
4304
|
-
/**
|
|
4458
|
+
/**
|
|
4459
|
+
* @description Usage discount.
|
|
4305
4460
|
*
|
|
4306
4461
|
* Usage discount means that the first N items are free. From billing perspective
|
|
4307
4462
|
* this means that any usage on a specific feature is considered 0 until this discount
|
|
4308
|
-
* is exhausted.
|
|
4463
|
+
* is exhausted.
|
|
4464
|
+
*/
|
|
4309
4465
|
DiscountUsage: {
|
|
4310
4466
|
/**
|
|
4311
4467
|
* Usage
|
|
@@ -4410,10 +4566,16 @@ export interface components {
|
|
|
4410
4566
|
*/
|
|
4411
4567
|
op: 'unschedule_edit';
|
|
4412
4568
|
};
|
|
4413
|
-
/**
|
|
4414
|
-
*
|
|
4569
|
+
/**
|
|
4570
|
+
* @deprecated
|
|
4571
|
+
* @description Entitlement templates are used to define the entitlements of a plan.
|
|
4572
|
+
* Features are omitted from the entitlement template, as they are defined in the rate card.
|
|
4573
|
+
*/
|
|
4415
4574
|
Entitlement: components['schemas']['EntitlementMetered'] | components['schemas']['EntitlementStatic'] | components['schemas']['EntitlementBoolean'];
|
|
4416
|
-
/**
|
|
4575
|
+
/**
|
|
4576
|
+
* @deprecated
|
|
4577
|
+
* @description Entitlement template of a boolean entitlement.
|
|
4578
|
+
*/
|
|
4417
4579
|
EntitlementBoolean: {
|
|
4418
4580
|
/**
|
|
4419
4581
|
* @description discriminator enum property added by openapi-typescript
|
|
@@ -4488,7 +4650,10 @@ export interface components {
|
|
|
4488
4650
|
/** @description The defined usage period of the entitlement */
|
|
4489
4651
|
usagePeriod?: components['schemas']['RecurringPeriod'];
|
|
4490
4652
|
};
|
|
4491
|
-
/**
|
|
4653
|
+
/**
|
|
4654
|
+
* @deprecated
|
|
4655
|
+
* @description Create inputs for boolean entitlement
|
|
4656
|
+
*/
|
|
4492
4657
|
EntitlementBooleanCreateInputs: {
|
|
4493
4658
|
/**
|
|
4494
4659
|
* @description The feature the subject is entitled to use.
|
|
@@ -4593,7 +4758,10 @@ export interface components {
|
|
|
4593
4758
|
};
|
|
4594
4759
|
/** @description Create inputs for entitlement */
|
|
4595
4760
|
EntitlementCreateInputs: components['schemas']['EntitlementMeteredCreateInputs'] | components['schemas']['EntitlementStaticCreateInputs'] | components['schemas']['EntitlementBooleanCreateInputs'];
|
|
4596
|
-
/**
|
|
4761
|
+
/**
|
|
4762
|
+
* @deprecated
|
|
4763
|
+
* @description The grant.
|
|
4764
|
+
*/
|
|
4597
4765
|
EntitlementGrant: {
|
|
4598
4766
|
/**
|
|
4599
4767
|
* Creation Time
|
|
@@ -4702,7 +4870,10 @@ export interface components {
|
|
|
4702
4870
|
*/
|
|
4703
4871
|
annotations?: components['schemas']['Annotations'];
|
|
4704
4872
|
};
|
|
4705
|
-
/**
|
|
4873
|
+
/**
|
|
4874
|
+
* @deprecated
|
|
4875
|
+
* @description The grant creation input.
|
|
4876
|
+
*/
|
|
4706
4877
|
EntitlementGrantCreateInput: {
|
|
4707
4878
|
/**
|
|
4708
4879
|
* Format: double
|
|
@@ -4922,8 +5093,11 @@ export interface components {
|
|
|
4922
5093
|
/** @description The recurrence period of the grant. */
|
|
4923
5094
|
recurrence?: components['schemas']['RecurringPeriod'];
|
|
4924
5095
|
};
|
|
4925
|
-
/**
|
|
4926
|
-
*
|
|
5096
|
+
/**
|
|
5097
|
+
* @deprecated
|
|
5098
|
+
* @description Metered entitlements are useful for many different use cases, from setting up usage based access to implementing complex credit systems.
|
|
5099
|
+
* Access is determined based on feature usage using a balance calculation (the "usage allowance" provided by the issued grants is "burnt down" by the usage).
|
|
5100
|
+
*/
|
|
4927
5101
|
EntitlementMetered: {
|
|
4928
5102
|
/**
|
|
4929
5103
|
* @description discriminator enum property added by openapi-typescript
|
|
@@ -5044,7 +5218,10 @@ export interface components {
|
|
|
5044
5218
|
/** @description THe usage period of the entitlement. */
|
|
5045
5219
|
readonly usagePeriod: components['schemas']['RecurringPeriod'];
|
|
5046
5220
|
};
|
|
5047
|
-
/**
|
|
5221
|
+
/**
|
|
5222
|
+
* @deprecated
|
|
5223
|
+
* @description Create inpurs for metered entitlement
|
|
5224
|
+
*/
|
|
5048
5225
|
EntitlementMeteredCreateInputs: {
|
|
5049
5226
|
/**
|
|
5050
5227
|
* @description The feature the subject is entitled to use.
|
|
@@ -5104,8 +5281,10 @@ export interface components {
|
|
|
5104
5281
|
*/
|
|
5105
5282
|
preserveOverageAtReset?: boolean;
|
|
5106
5283
|
};
|
|
5107
|
-
/**
|
|
5108
|
-
*
|
|
5284
|
+
/**
|
|
5285
|
+
* @description Metered entitlements are useful for many different use cases, from setting up usage based access to implementing complex credit systems.
|
|
5286
|
+
* Access is determined based on feature usage using a balance calculation (the "usage allowance" provided by the issued grants is "burnt down" by the usage).
|
|
5287
|
+
*/
|
|
5109
5288
|
EntitlementMeteredV2: {
|
|
5110
5289
|
/**
|
|
5111
5290
|
* @description discriminator enum property added by openapi-typescript
|
|
@@ -5322,7 +5501,10 @@ export interface components {
|
|
|
5322
5501
|
/** @description The items in the current page. */
|
|
5323
5502
|
items: components['schemas']['Entitlement'][];
|
|
5324
5503
|
};
|
|
5325
|
-
/**
|
|
5504
|
+
/**
|
|
5505
|
+
* @deprecated
|
|
5506
|
+
* @description A static entitlement.
|
|
5507
|
+
*/
|
|
5326
5508
|
EntitlementStatic: {
|
|
5327
5509
|
/**
|
|
5328
5510
|
* @description discriminator enum property added by openapi-typescript
|
|
@@ -5403,7 +5585,10 @@ export interface components {
|
|
|
5403
5585
|
/** @description The defined usage period of the entitlement */
|
|
5404
5586
|
usagePeriod?: components['schemas']['RecurringPeriod'];
|
|
5405
5587
|
};
|
|
5406
|
-
/**
|
|
5588
|
+
/**
|
|
5589
|
+
* @deprecated
|
|
5590
|
+
* @description Create inputs for static entitlement
|
|
5591
|
+
*/
|
|
5407
5592
|
EntitlementStaticCreateInputs: {
|
|
5408
5593
|
/**
|
|
5409
5594
|
* @description The feature the subject is entitled to use.
|
|
@@ -5519,12 +5704,15 @@ export interface components {
|
|
|
5519
5704
|
customerId: string;
|
|
5520
5705
|
};
|
|
5521
5706
|
/**
|
|
5707
|
+
* @deprecated
|
|
5522
5708
|
* @description Type of the entitlement.
|
|
5523
5709
|
* @enum {string}
|
|
5524
5710
|
*/
|
|
5525
5711
|
EntitlementType: 'metered' | 'boolean' | 'static';
|
|
5526
|
-
/**
|
|
5527
|
-
*
|
|
5712
|
+
/**
|
|
5713
|
+
* @description Entitlement templates are used to define the entitlements of a plan.
|
|
5714
|
+
* Features are omitted from the entitlement template, as they are defined in the rate card.
|
|
5715
|
+
*/
|
|
5528
5716
|
EntitlementV2: components['schemas']['EntitlementMeteredV2'] | components['schemas']['EntitlementStaticV2'] | components['schemas']['EntitlementBooleanV2'];
|
|
5529
5717
|
/** @description Create inputs for entitlement */
|
|
5530
5718
|
EntitlementV2CreateInputs: components['schemas']['EntitlementMeteredV2CreateInputs'] | components['schemas']['EntitlementStaticCreateInputs'] | components['schemas']['EntitlementBooleanCreateInputs'];
|
|
@@ -5573,6 +5761,12 @@ export interface components {
|
|
|
5573
5761
|
* @example 0
|
|
5574
5762
|
*/
|
|
5575
5763
|
readonly overage?: number;
|
|
5764
|
+
/**
|
|
5765
|
+
* Format: double
|
|
5766
|
+
* @description Only available for metered entitlements. The summed amount of all grant active at query time PLUS the used amount of since inactive grants.
|
|
5767
|
+
* @example 100
|
|
5768
|
+
*/
|
|
5769
|
+
readonly totalAvailableGrantAmount?: number;
|
|
5576
5770
|
/**
|
|
5577
5771
|
* @description Only available for static entitlements. The JSON parsable config of the entitlement.
|
|
5578
5772
|
* @example { key: "value" }
|
|
@@ -5658,8 +5852,10 @@ export interface components {
|
|
|
5658
5852
|
* @example 2023-01-01T01:01:01.001Z
|
|
5659
5853
|
*/
|
|
5660
5854
|
time?: Date | null;
|
|
5661
|
-
/**
|
|
5662
|
-
*
|
|
5855
|
+
/**
|
|
5856
|
+
* @description The event payload.
|
|
5857
|
+
* Optional, if present it must be a JSON object.
|
|
5858
|
+
*/
|
|
5663
5859
|
data?: {
|
|
5664
5860
|
[key: string]: unknown;
|
|
5665
5861
|
} | null;
|
|
@@ -5703,8 +5899,10 @@ export interface components {
|
|
|
5703
5899
|
*/
|
|
5704
5900
|
count: number;
|
|
5705
5901
|
};
|
|
5706
|
-
/**
|
|
5707
|
-
*
|
|
5902
|
+
/**
|
|
5903
|
+
* @description Represents a feature that can be enabled or disabled for a plan.
|
|
5904
|
+
* Used both for product catalog and entitlements.
|
|
5905
|
+
*/
|
|
5708
5906
|
Feature: {
|
|
5709
5907
|
/**
|
|
5710
5908
|
* Creation Time
|
|
@@ -5761,6 +5959,8 @@ export interface components {
|
|
|
5761
5959
|
* Useful if the meter scope is broader than what feature tracks.
|
|
5762
5960
|
* Example scenario would be a meter tracking all token use with groupBy fields for the model,
|
|
5763
5961
|
* then the feature could filter for model=gpt-4.
|
|
5962
|
+
*
|
|
5963
|
+
* ⚠️ __Deprecated__: Use advancedMeterGroupByFilters instead
|
|
5764
5964
|
* @example {
|
|
5765
5965
|
* "model": "gpt-4",
|
|
5766
5966
|
* "type": "input"
|
|
@@ -5794,8 +5994,10 @@ export interface components {
|
|
|
5794
5994
|
*/
|
|
5795
5995
|
readonly id: string;
|
|
5796
5996
|
};
|
|
5797
|
-
/**
|
|
5798
|
-
*
|
|
5997
|
+
/**
|
|
5998
|
+
* @description Represents a feature that can be enabled or disabled for a plan.
|
|
5999
|
+
* Used both for product catalog and entitlements.
|
|
6000
|
+
*/
|
|
5799
6001
|
FeatureCreateInputs: {
|
|
5800
6002
|
/**
|
|
5801
6003
|
* The unique key of the feature
|
|
@@ -5824,6 +6026,8 @@ export interface components {
|
|
|
5824
6026
|
* Useful if the meter scope is broader than what feature tracks.
|
|
5825
6027
|
* Example scenario would be a meter tracking all token use with groupBy fields for the model,
|
|
5826
6028
|
* then the feature could filter for model=gpt-4.
|
|
6029
|
+
*
|
|
6030
|
+
* ⚠️ __Deprecated__: Use advancedMeterGroupByFilters instead
|
|
5827
6031
|
* @example {
|
|
5828
6032
|
* "model": "gpt-4",
|
|
5829
6033
|
* "type": "input"
|
|
@@ -5986,9 +6190,11 @@ export interface components {
|
|
|
5986
6190
|
ForbiddenProblemResponse: components['schemas']['UnexpectedProblemResponse'];
|
|
5987
6191
|
/** @description The server, while acting as a gateway or proxy, did not receive a timely response from an upstream server it needed to access in order to complete the request. */
|
|
5988
6192
|
GatewayTimeoutProblemResponse: components['schemas']['UnexpectedProblemResponse'];
|
|
5989
|
-
/**
|
|
6193
|
+
/**
|
|
6194
|
+
* @description A segment of the grant burn down history.
|
|
5990
6195
|
*
|
|
5991
|
-
* A given segment represents the usage of a grant between events that changed either the grant burn down priority order or the usag period.
|
|
6196
|
+
* A given segment represents the usage of a grant between events that changed either the grant burn down priority order or the usag period.
|
|
6197
|
+
*/
|
|
5992
6198
|
GrantBurnDownHistorySegment: {
|
|
5993
6199
|
/** @description The period of the segment. */
|
|
5994
6200
|
period: components['schemas']['Period'];
|
|
@@ -6105,8 +6311,10 @@ export interface components {
|
|
|
6105
6311
|
*/
|
|
6106
6312
|
readonly id: string;
|
|
6107
6313
|
};
|
|
6108
|
-
/**
|
|
6109
|
-
*
|
|
6314
|
+
/**
|
|
6315
|
+
* @description The body of the events request.
|
|
6316
|
+
* Either a single event or a batch of events.
|
|
6317
|
+
*/
|
|
6110
6318
|
IngestEventsBody: components['schemas']['Event'] | components['schemas']['Event'][];
|
|
6111
6319
|
/**
|
|
6112
6320
|
* @description An ingested event with optional validation error.
|
|
@@ -6199,38 +6407,46 @@ export interface components {
|
|
|
6199
6407
|
* @example 2024-01-01T01:01:01.001Z
|
|
6200
6408
|
*/
|
|
6201
6409
|
readonly deletedAt?: Date;
|
|
6202
|
-
/**
|
|
6410
|
+
/**
|
|
6411
|
+
* @description Type of the invoice.
|
|
6203
6412
|
*
|
|
6204
6413
|
* The type of invoice determines the purpose of the invoice and how it should be handled.
|
|
6205
6414
|
*
|
|
6206
6415
|
* Supported types:
|
|
6207
6416
|
* - standard: A regular commercial invoice document between a supplier and customer.
|
|
6208
|
-
* - credit_note: Reflects a refund either partial or complete of the preceding document. A credit note effectively *extends* the previous document.
|
|
6417
|
+
* - credit_note: Reflects a refund either partial or complete of the preceding document. A credit note effectively *extends* the previous document.
|
|
6418
|
+
*/
|
|
6209
6419
|
readonly type: components['schemas']['InvoiceType'];
|
|
6210
6420
|
/** @description The taxable entity supplying the goods or services. */
|
|
6211
6421
|
supplier: components['schemas']['BillingParty'];
|
|
6212
6422
|
/** @description Legal entity receiving the goods or services. */
|
|
6213
6423
|
customer: components['schemas']['BillingInvoiceCustomerExtendedDetails'];
|
|
6214
|
-
/**
|
|
6424
|
+
/**
|
|
6425
|
+
* @description Number specifies the human readable key used to reference this Invoice.
|
|
6215
6426
|
*
|
|
6216
6427
|
* The invoice number can change in the draft phases, as we are allocating temporary draft
|
|
6217
6428
|
* invoice numbers, but it's final as soon as the invoice gets finalized (issued state).
|
|
6218
6429
|
*
|
|
6219
6430
|
* Please note that the number is (depending on the upstream settings) either unique for the
|
|
6220
6431
|
* whole organization or unique for the customer, or in multi (stripe) account setups unique for the
|
|
6221
|
-
* account.
|
|
6432
|
+
* account.
|
|
6433
|
+
*/
|
|
6222
6434
|
readonly number: components['schemas']['InvoiceNumber'];
|
|
6223
|
-
/**
|
|
6435
|
+
/**
|
|
6436
|
+
* @description Currency for all invoice line items.
|
|
6224
6437
|
*
|
|
6225
|
-
* Multi currency invoices are not supported yet.
|
|
6438
|
+
* Multi currency invoices are not supported yet.
|
|
6439
|
+
*/
|
|
6226
6440
|
currency: components['schemas']['CurrencyCode'];
|
|
6227
6441
|
/** @description Key information regarding previous invoices and potentially details as to why they were corrected. */
|
|
6228
6442
|
readonly preceding?: components['schemas']['InvoiceDocumentRef'][];
|
|
6229
6443
|
/** @description Summary of all the invoice totals, including taxes (calculated). */
|
|
6230
6444
|
readonly totals: components['schemas']['InvoiceTotals'];
|
|
6231
|
-
/**
|
|
6445
|
+
/**
|
|
6446
|
+
* @description The status of the invoice.
|
|
6232
6447
|
*
|
|
6233
|
-
* This field only conatins a simplified status, for more detailed information use the statusDetails field.
|
|
6448
|
+
* This field only conatins a simplified status, for more detailed information use the statusDetails field.
|
|
6449
|
+
*/
|
|
6234
6450
|
readonly status: components['schemas']['InvoiceStatus'];
|
|
6235
6451
|
/** @description The details of the current invoice status. */
|
|
6236
6452
|
readonly statusDetails: components['schemas']['InvoiceStatusDetails'];
|
|
@@ -6288,10 +6504,12 @@ export interface components {
|
|
|
6288
6504
|
* @example 2023-01-01T01:01:01.001Z
|
|
6289
6505
|
*/
|
|
6290
6506
|
readonly sentToCustomerAt?: Date;
|
|
6291
|
-
/**
|
|
6507
|
+
/**
|
|
6508
|
+
* @description The workflow associated with the invoice.
|
|
6292
6509
|
*
|
|
6293
6510
|
* It is always a snapshot of the workflow settings at the time of invoice creation. The
|
|
6294
|
-
* field is optional as it should be explicitly requested with expand options.
|
|
6511
|
+
* field is optional as it should be explicitly requested with expand options.
|
|
6512
|
+
*/
|
|
6295
6513
|
workflow: components['schemas']['InvoiceWorkflowSettings'];
|
|
6296
6514
|
/** @description List of invoice lines representing each of the items sold to the customer. */
|
|
6297
6515
|
lines?: components['schemas']['InvoiceLine'][];
|
|
@@ -6311,17 +6529,23 @@ export interface components {
|
|
|
6311
6529
|
/** @description The external ID of the invoice in the payment app if available. */
|
|
6312
6530
|
readonly payment?: string;
|
|
6313
6531
|
};
|
|
6314
|
-
/**
|
|
6315
|
-
*
|
|
6532
|
+
/**
|
|
6533
|
+
* @description InvoiceAvailableActionInvoiceDetails represents the details of the invoice action for
|
|
6534
|
+
* non-gathering invoices.
|
|
6535
|
+
*/
|
|
6316
6536
|
InvoiceAvailableActionDetails: {
|
|
6317
|
-
/**
|
|
6537
|
+
/**
|
|
6538
|
+
* @description The state the invoice will reach if the action is activated and
|
|
6318
6539
|
* all intermediate steps are successful.
|
|
6319
6540
|
*
|
|
6320
|
-
* For example advancing a draft_created invoice will result in a draft_manual_approval_needed invoice.
|
|
6541
|
+
* For example advancing a draft_created invoice will result in a draft_manual_approval_needed invoice.
|
|
6542
|
+
*/
|
|
6321
6543
|
readonly resultingState: string;
|
|
6322
6544
|
};
|
|
6323
|
-
/**
|
|
6324
|
-
*
|
|
6545
|
+
/**
|
|
6546
|
+
* @description InvoiceAvailableActionInvoiceDetails represents the details of the invoice action for
|
|
6547
|
+
* gathering invoices.
|
|
6548
|
+
*/
|
|
6325
6549
|
InvoiceAvailableActionInvoiceDetails: Record<string, never>;
|
|
6326
6550
|
/** @description InvoiceAvailableActions represents the actions that can be performed on the invoice. */
|
|
6327
6551
|
InvoiceAvailableActions: {
|
|
@@ -6385,15 +6609,19 @@ export interface components {
|
|
|
6385
6609
|
id: string;
|
|
6386
6610
|
/** @description managedBy specifies if the line is manually added via the api or managed by OpenMeter. */
|
|
6387
6611
|
readonly managedBy: components['schemas']['InvoiceLineManagedBy'];
|
|
6388
|
-
/**
|
|
6612
|
+
/**
|
|
6613
|
+
* @description Status of the line.
|
|
6389
6614
|
*
|
|
6390
6615
|
* External calls always create valid lines, other line types are managed by the
|
|
6391
|
-
* billing engine of OpenMeter.
|
|
6616
|
+
* billing engine of OpenMeter.
|
|
6617
|
+
*/
|
|
6392
6618
|
readonly status: components['schemas']['InvoiceLineStatus'];
|
|
6393
|
-
/**
|
|
6619
|
+
/**
|
|
6620
|
+
* @description Discounts detailes applied to this line.
|
|
6394
6621
|
*
|
|
6395
6622
|
* New discounts can be added via the invoice's discounts API, to facilitate
|
|
6396
|
-
* discounts that are affecting multiple lines.
|
|
6623
|
+
* discounts that are affecting multiple lines.
|
|
6624
|
+
*/
|
|
6397
6625
|
readonly discounts?: components['schemas']['InvoiceLineDiscounts'];
|
|
6398
6626
|
/** @description The invoice this item belongs to. */
|
|
6399
6627
|
invoice?: components['schemas']['InvoiceReference'];
|
|
@@ -6408,9 +6636,11 @@ export interface components {
|
|
|
6408
6636
|
taxConfig?: components['schemas']['TaxConfig'];
|
|
6409
6637
|
/** @description Totals for this line. */
|
|
6410
6638
|
readonly totals: components['schemas']['InvoiceTotals'];
|
|
6411
|
-
/**
|
|
6639
|
+
/**
|
|
6640
|
+
* @description Period of the line item applies to for revenue recognition pruposes.
|
|
6412
6641
|
*
|
|
6413
|
-
* Billing always treats periods as start being inclusive and end being exclusive.
|
|
6642
|
+
* Billing always treats periods as start being inclusive and end being exclusive.
|
|
6643
|
+
*/
|
|
6414
6644
|
period: components['schemas']['Period'];
|
|
6415
6645
|
/** @description External IDs of the invoice in other apps such as Stripe. */
|
|
6416
6646
|
readonly externalIds?: components['schemas']['InvoiceLineAppExternalIds'];
|
|
@@ -6478,9 +6708,11 @@ export interface components {
|
|
|
6478
6708
|
* }
|
|
6479
6709
|
*/
|
|
6480
6710
|
price: components['schemas']['FlatPriceWithPaymentTerm'] | null;
|
|
6481
|
-
/**
|
|
6711
|
+
/**
|
|
6712
|
+
* @description Quantity of the item being sold.
|
|
6482
6713
|
*
|
|
6483
|
-
* Default: 1
|
|
6714
|
+
* Default: 1
|
|
6715
|
+
*/
|
|
6484
6716
|
quantity?: components['schemas']['Numeric'];
|
|
6485
6717
|
/** @description The discounts that are applied to the line. */
|
|
6486
6718
|
discounts?: components['schemas']['BillingDiscounts'];
|
|
@@ -6557,15 +6789,19 @@ export interface components {
|
|
|
6557
6789
|
id: string;
|
|
6558
6790
|
/** @description managedBy specifies if the line is manually added via the api or managed by OpenMeter. */
|
|
6559
6791
|
readonly managedBy: components['schemas']['InvoiceLineManagedBy'];
|
|
6560
|
-
/**
|
|
6792
|
+
/**
|
|
6793
|
+
* @description Status of the line.
|
|
6561
6794
|
*
|
|
6562
6795
|
* External calls always create valid lines, other line types are managed by the
|
|
6563
|
-
* billing engine of OpenMeter.
|
|
6796
|
+
* billing engine of OpenMeter.
|
|
6797
|
+
*/
|
|
6564
6798
|
readonly status: components['schemas']['InvoiceLineStatus'];
|
|
6565
|
-
/**
|
|
6799
|
+
/**
|
|
6800
|
+
* @description Discounts detailes applied to this line.
|
|
6566
6801
|
*
|
|
6567
6802
|
* New discounts can be added via the invoice's discounts API, to facilitate
|
|
6568
|
-
* discounts that are affecting multiple lines.
|
|
6803
|
+
* discounts that are affecting multiple lines.
|
|
6804
|
+
*/
|
|
6569
6805
|
readonly discounts?: components['schemas']['InvoiceLineDiscounts'];
|
|
6570
6806
|
/** @description The invoice this item belongs to. */
|
|
6571
6807
|
invoice?: components['schemas']['InvoiceReference'];
|
|
@@ -6580,9 +6816,11 @@ export interface components {
|
|
|
6580
6816
|
taxConfig?: components['schemas']['TaxConfig'];
|
|
6581
6817
|
/** @description Totals for this line. */
|
|
6582
6818
|
readonly totals: components['schemas']['InvoiceTotals'];
|
|
6583
|
-
/**
|
|
6819
|
+
/**
|
|
6820
|
+
* @description Period of the line item applies to for revenue recognition pruposes.
|
|
6584
6821
|
*
|
|
6585
|
-
* Billing always treats periods as start being inclusive and end being exclusive.
|
|
6822
|
+
* Billing always treats periods as start being inclusive and end being exclusive.
|
|
6823
|
+
*/
|
|
6586
6824
|
period: components['schemas']['Period'];
|
|
6587
6825
|
/**
|
|
6588
6826
|
* Format: date-time
|
|
@@ -6612,25 +6850,33 @@ export interface components {
|
|
|
6612
6850
|
featureKey?: string;
|
|
6613
6851
|
/** @description The lines detailing the item or service sold. */
|
|
6614
6852
|
readonly children?: components['schemas']['InvoiceDetailedLine'][];
|
|
6615
|
-
/**
|
|
6853
|
+
/**
|
|
6854
|
+
* @description The rate card that is used for this line.
|
|
6616
6855
|
*
|
|
6617
|
-
* The rate card captures the intent of the price and discounts for the usage-based item.
|
|
6856
|
+
* The rate card captures the intent of the price and discounts for the usage-based item.
|
|
6857
|
+
*/
|
|
6618
6858
|
rateCard?: components['schemas']['InvoiceUsageBasedRateCard'];
|
|
6619
|
-
/**
|
|
6859
|
+
/**
|
|
6860
|
+
* @description The quantity of the item being sold.
|
|
6620
6861
|
*
|
|
6621
|
-
* Any usage discounts applied previously are deducted from this quantity.
|
|
6862
|
+
* Any usage discounts applied previously are deducted from this quantity.
|
|
6863
|
+
*/
|
|
6622
6864
|
readonly quantity?: components['schemas']['Numeric'];
|
|
6623
6865
|
/** @description The quantity of the item that has been metered for the period before any discounts were applied. */
|
|
6624
6866
|
readonly meteredQuantity?: components['schemas']['Numeric'];
|
|
6625
|
-
/**
|
|
6867
|
+
/**
|
|
6868
|
+
* @description The quantity of the item used before this line's period.
|
|
6626
6869
|
*
|
|
6627
6870
|
* It is non-zero in case of progressive billing, when this shows how much of the usage was already billed.
|
|
6628
6871
|
*
|
|
6629
|
-
* Any usage discounts applied previously are deducted from this quantity.
|
|
6872
|
+
* Any usage discounts applied previously are deducted from this quantity.
|
|
6873
|
+
*/
|
|
6630
6874
|
readonly preLinePeriodQuantity?: components['schemas']['Numeric'];
|
|
6631
|
-
/**
|
|
6875
|
+
/**
|
|
6876
|
+
* @description The metered quantity of the item used in before this line's period without any discounts applied.
|
|
6632
6877
|
*
|
|
6633
|
-
* It is non-zero in case of progressive billing, when this shows how much of the usage was already billed.
|
|
6878
|
+
* It is non-zero in case of progressive billing, when this shows how much of the usage was already billed.
|
|
6879
|
+
*/
|
|
6634
6880
|
readonly meteredPreLinePeriodQuantity?: components['schemas']['Numeric'];
|
|
6635
6881
|
};
|
|
6636
6882
|
/** @description InvoiceLineAmountDiscount represents an amount deducted from the line, and will be applied before taxes. */
|
|
@@ -6682,13 +6928,17 @@ export interface components {
|
|
|
6682
6928
|
};
|
|
6683
6929
|
/** @description InvoiceLineDiscounts represents the discounts applied to the invoice line by type. */
|
|
6684
6930
|
InvoiceLineDiscounts: {
|
|
6685
|
-
/**
|
|
6931
|
+
/**
|
|
6932
|
+
* @description Amount based discounts applied to the line.
|
|
6686
6933
|
*
|
|
6687
|
-
* Amount based discounts are deduced from the total price of the line.
|
|
6934
|
+
* Amount based discounts are deduced from the total price of the line.
|
|
6935
|
+
*/
|
|
6688
6936
|
amount?: components['schemas']['InvoiceLineAmountDiscount'][];
|
|
6689
|
-
/**
|
|
6937
|
+
/**
|
|
6938
|
+
* @description Usage based discounts applied to the line.
|
|
6690
6939
|
*
|
|
6691
|
-
* Usage based discounts are deduced from the usage of the line before price calculations are applied.
|
|
6940
|
+
* Usage based discounts are deduced from the usage of the line before price calculations are applied.
|
|
6941
|
+
*/
|
|
6692
6942
|
usage?: components['schemas']['InvoiceLineUsageDiscount'][];
|
|
6693
6943
|
};
|
|
6694
6944
|
/**
|
|
@@ -6696,9 +6946,11 @@ export interface components {
|
|
|
6696
6946
|
* @enum {string}
|
|
6697
6947
|
*/
|
|
6698
6948
|
InvoiceLineManagedBy: 'subscription' | 'system' | 'manual';
|
|
6699
|
-
/**
|
|
6949
|
+
/**
|
|
6950
|
+
* @description InvoiceLineReplaceUpdate represents the update model for an UBP invoice line.
|
|
6700
6951
|
*
|
|
6701
|
-
* This type makes ID optional to allow for creating new lines as part of the update.
|
|
6952
|
+
* This type makes ID optional to allow for creating new lines as part of the update.
|
|
6953
|
+
*/
|
|
6702
6954
|
InvoiceLineReplaceUpdate: {
|
|
6703
6955
|
/**
|
|
6704
6956
|
* Display name
|
|
@@ -6720,9 +6972,11 @@ export interface components {
|
|
|
6720
6972
|
* @description Tax config specify the tax configuration for this line.
|
|
6721
6973
|
*/
|
|
6722
6974
|
taxConfig?: components['schemas']['TaxConfig'];
|
|
6723
|
-
/**
|
|
6975
|
+
/**
|
|
6976
|
+
* @description Period of the line item applies to for revenue recognition pruposes.
|
|
6724
6977
|
*
|
|
6725
|
-
* Billing always treats periods as start being inclusive and end being exclusive.
|
|
6978
|
+
* Billing always treats periods as start being inclusive and end being exclusive.
|
|
6979
|
+
*/
|
|
6726
6980
|
period: components['schemas']['Period'];
|
|
6727
6981
|
/**
|
|
6728
6982
|
* Format: date-time
|
|
@@ -6740,9 +6994,11 @@ export interface components {
|
|
|
6740
6994
|
* @description The feature that the usage is based on.
|
|
6741
6995
|
*/
|
|
6742
6996
|
featureKey?: string;
|
|
6743
|
-
/**
|
|
6997
|
+
/**
|
|
6998
|
+
* @description The rate card that is used for this line.
|
|
6744
6999
|
*
|
|
6745
|
-
* The rate card captures the intent of the price and discounts for the usage-based item.
|
|
7000
|
+
* The rate card captures the intent of the price and discounts for the usage-based item.
|
|
7001
|
+
*/
|
|
6746
7002
|
rateCard?: components['schemas']['InvoiceUsageBasedRateCard'];
|
|
6747
7003
|
/**
|
|
6748
7004
|
* @description The ID of the line.
|
|
@@ -6763,7 +7019,8 @@ export interface components {
|
|
|
6763
7019
|
readonly phase: components['schemas']['IDResource'];
|
|
6764
7020
|
/** @description The item this line is related to. */
|
|
6765
7021
|
readonly item: components['schemas']['IDResource'];
|
|
6766
|
-
/**
|
|
7022
|
+
/**
|
|
7023
|
+
* @description The billing period of the subscription. In case the subscription item's billing period is different
|
|
6767
7024
|
* from the subscription's billing period, this field will contain the billing period of the subscription itself.
|
|
6768
7025
|
*
|
|
6769
7026
|
* For example, in case of:
|
|
@@ -6771,7 +7028,8 @@ export interface components {
|
|
|
6771
7028
|
* - A subscription item billed daily
|
|
6772
7029
|
*
|
|
6773
7030
|
* An example line would have the period of 2025-01-02 to 2025-01-03 as the item is billed daily, but the subscription's billing period
|
|
6774
|
-
* will be 2025-01-01 to 2025-01-31.
|
|
7031
|
+
* will be 2025-01-01 to 2025-01-31.
|
|
7032
|
+
*/
|
|
6775
7033
|
readonly billingPeriod: components['schemas']['Period'];
|
|
6776
7034
|
};
|
|
6777
7035
|
/**
|
|
@@ -6786,18 +7044,22 @@ export interface components {
|
|
|
6786
7044
|
InvoiceLineTaxItem: {
|
|
6787
7045
|
/** @description Tax provider configuration. */
|
|
6788
7046
|
readonly config?: components['schemas']['TaxConfig'];
|
|
6789
|
-
/**
|
|
7047
|
+
/**
|
|
7048
|
+
* @description Percent defines the percentage set manually or determined from
|
|
6790
7049
|
* the rate key (calculated if rate present). A nil percent implies that
|
|
6791
|
-
* this tax combo is **exempt** from tax.")
|
|
7050
|
+
* this tax combo is **exempt** from tax.")
|
|
7051
|
+
*/
|
|
6792
7052
|
readonly percent?: components['schemas']['Percentage'];
|
|
6793
7053
|
/** @description Some countries require an additional surcharge (calculated if rate present). */
|
|
6794
7054
|
readonly surcharge?: components['schemas']['Numeric'];
|
|
6795
7055
|
/** @description Is the tax item inclusive or exclusive of the base amount. */
|
|
6796
7056
|
readonly behavior?: components['schemas']['InvoiceLineTaxBehavior'];
|
|
6797
7057
|
};
|
|
6798
|
-
/**
|
|
7058
|
+
/**
|
|
7059
|
+
* @description InvoiceLineUsageDiscount represents an usage-based discount applied to the line.
|
|
6799
7060
|
*
|
|
6800
|
-
* The deduction is done before the pricing algorithm is applied.
|
|
7061
|
+
* The deduction is done before the pricing algorithm is applied.
|
|
7062
|
+
*/
|
|
6801
7063
|
InvoiceLineUsageDiscount: {
|
|
6802
7064
|
/**
|
|
6803
7065
|
* Creation Time
|
|
@@ -6906,9 +7168,11 @@ export interface components {
|
|
|
6906
7168
|
* @description Tax config specify the tax configuration for this line.
|
|
6907
7169
|
*/
|
|
6908
7170
|
taxConfig?: components['schemas']['TaxConfig'];
|
|
6909
|
-
/**
|
|
7171
|
+
/**
|
|
7172
|
+
* @description Period of the line item applies to for revenue recognition pruposes.
|
|
6910
7173
|
*
|
|
6911
|
-
* Billing always treats periods as start being inclusive and end being exclusive.
|
|
7174
|
+
* Billing always treats periods as start being inclusive and end being exclusive.
|
|
7175
|
+
*/
|
|
6912
7176
|
period: components['schemas']['Period'];
|
|
6913
7177
|
/**
|
|
6914
7178
|
* Format: date-time
|
|
@@ -6926,9 +7190,11 @@ export interface components {
|
|
|
6926
7190
|
* @description The feature that the usage is based on.
|
|
6927
7191
|
*/
|
|
6928
7192
|
featureKey?: string;
|
|
6929
|
-
/**
|
|
7193
|
+
/**
|
|
7194
|
+
* @description The rate card that is used for this line.
|
|
6930
7195
|
*
|
|
6931
|
-
* The rate card captures the intent of the price and discounts for the usage-based item.
|
|
7196
|
+
* The rate card captures the intent of the price and discounts for the usage-based item.
|
|
7197
|
+
*/
|
|
6932
7198
|
rateCard?: components['schemas']['InvoiceUsageBasedRateCard'];
|
|
6933
7199
|
};
|
|
6934
7200
|
/** @description InvoicePendingLineCreate represents the create model for a pending invoice line. */
|
|
@@ -6949,18 +7215,22 @@ export interface components {
|
|
|
6949
7215
|
};
|
|
6950
7216
|
/** @description InvoicePendingLinesActionFiltersInput specifies which lines to include in the invoice. */
|
|
6951
7217
|
InvoicePendingLinesActionFiltersInput: {
|
|
6952
|
-
/**
|
|
7218
|
+
/**
|
|
7219
|
+
* @description The pending line items to include in the invoice, if not provided:
|
|
6953
7220
|
* - all line items that have invoice_at < asOf will be included
|
|
6954
7221
|
* - [progressive billing only] all usage based line items will be included up to asOf, new
|
|
6955
7222
|
* usage-based line items will be staged for the rest of the billing cycle
|
|
6956
7223
|
*
|
|
6957
|
-
* All lineIDs present in the list, must exists and must be invoicable as of asOf, or the action will fail.
|
|
7224
|
+
* All lineIDs present in the list, must exists and must be invoicable as of asOf, or the action will fail.
|
|
7225
|
+
*/
|
|
6958
7226
|
lineIds?: string[];
|
|
6959
7227
|
};
|
|
6960
|
-
/**
|
|
7228
|
+
/**
|
|
7229
|
+
* @description BillingInvoiceActionInput is the input for creating an invoice.
|
|
6961
7230
|
*
|
|
6962
7231
|
* Invoice creation is always based on already pending line items created by the billingCreateLineByCustomer
|
|
6963
|
-
* operation. Empty invoices are not allowed.
|
|
7232
|
+
* operation. Empty invoices are not allowed.
|
|
7233
|
+
*/
|
|
6964
7234
|
InvoicePendingLinesActionInput: {
|
|
6965
7235
|
/** @description Filters to apply when creating the invoice. */
|
|
6966
7236
|
filters?: components['schemas']['InvoicePendingLinesActionFiltersInput'];
|
|
@@ -6977,10 +7247,12 @@ export interface components {
|
|
|
6977
7247
|
* @example 01G65Z755AFWAKHE12NY0CQ9FH
|
|
6978
7248
|
*/
|
|
6979
7249
|
customerId: string;
|
|
6980
|
-
/**
|
|
7250
|
+
/**
|
|
7251
|
+
* @description Override the progressive billing setting of the customer.
|
|
6981
7252
|
*
|
|
6982
7253
|
* Can be used to disable/enable progressive billing in case the business logic
|
|
6983
|
-
* requires it, if not provided the billing profile's progressive billing setting will be used.
|
|
7254
|
+
* requires it, if not provided the billing profile's progressive billing setting will be used.
|
|
7255
|
+
*/
|
|
6984
7256
|
progressiveBillingOverride?: boolean;
|
|
6985
7257
|
};
|
|
6986
7258
|
/** @description Reference to an invoice. */
|
|
@@ -7018,9 +7290,11 @@ export interface components {
|
|
|
7018
7290
|
InvoiceSimulationInput: {
|
|
7019
7291
|
/** @description The number of the invoice. */
|
|
7020
7292
|
number?: components['schemas']['InvoiceNumber'];
|
|
7021
|
-
/**
|
|
7293
|
+
/**
|
|
7294
|
+
* @description Currency for all invoice line items.
|
|
7022
7295
|
*
|
|
7023
|
-
* Multi currency invoices are not supported yet.
|
|
7296
|
+
* Multi currency invoices are not supported yet.
|
|
7297
|
+
*/
|
|
7024
7298
|
currency: components['schemas']['CurrencyCode'];
|
|
7025
7299
|
/** @description Lines to be included in the generated invoice. */
|
|
7026
7300
|
lines: components['schemas']['InvoiceSimulationLine'][];
|
|
@@ -7047,9 +7321,11 @@ export interface components {
|
|
|
7047
7321
|
* @description Tax config specify the tax configuration for this line.
|
|
7048
7322
|
*/
|
|
7049
7323
|
taxConfig?: components['schemas']['TaxConfig'];
|
|
7050
|
-
/**
|
|
7324
|
+
/**
|
|
7325
|
+
* @description Period of the line item applies to for revenue recognition pruposes.
|
|
7051
7326
|
*
|
|
7052
|
-
* Billing always treats periods as start being inclusive and end being exclusive.
|
|
7327
|
+
* Billing always treats periods as start being inclusive and end being exclusive.
|
|
7328
|
+
*/
|
|
7053
7329
|
period: components['schemas']['Period'];
|
|
7054
7330
|
/**
|
|
7055
7331
|
* Format: date-time
|
|
@@ -7067,9 +7343,11 @@ export interface components {
|
|
|
7067
7343
|
* @description The feature that the usage is based on.
|
|
7068
7344
|
*/
|
|
7069
7345
|
featureKey?: string;
|
|
7070
|
-
/**
|
|
7346
|
+
/**
|
|
7347
|
+
* @description The rate card that is used for this line.
|
|
7071
7348
|
*
|
|
7072
|
-
* The rate card captures the intent of the price and discounts for the usage-based item.
|
|
7349
|
+
* The rate card captures the intent of the price and discounts for the usage-based item.
|
|
7350
|
+
*/
|
|
7073
7351
|
rateCard?: components['schemas']['InvoiceUsageBasedRateCard'];
|
|
7074
7352
|
/** @description The quantity of the item being sold. */
|
|
7075
7353
|
quantity: components['schemas']['Numeric'];
|
|
@@ -7088,10 +7366,12 @@ export interface components {
|
|
|
7088
7366
|
* @enum {string}
|
|
7089
7367
|
*/
|
|
7090
7368
|
InvoiceStatus: 'gathering' | 'draft' | 'issuing' | 'issued' | 'payment_processing' | 'overdue' | 'paid' | 'uncollectible' | 'voided';
|
|
7091
|
-
/**
|
|
7369
|
+
/**
|
|
7370
|
+
* @description InvoiceStatusDetails represents the details of the invoice status.
|
|
7092
7371
|
*
|
|
7093
7372
|
* API users are encouraged to rely on the immutable/failed/avaliableActions fields to determine
|
|
7094
|
-
* the next steps of the invoice instead of the extendedStatus field.
|
|
7373
|
+
* the next steps of the invoice instead of the extendedStatus field.
|
|
7374
|
+
*/
|
|
7095
7375
|
InvoiceStatusDetails: {
|
|
7096
7376
|
/** @description Is the invoice editable? */
|
|
7097
7377
|
readonly immutable: boolean;
|
|
@@ -7139,8 +7419,10 @@ export interface components {
|
|
|
7139
7419
|
* When undefined, the tax config of the feature or the default tax config of the plan is used.
|
|
7140
7420
|
*/
|
|
7141
7421
|
taxConfig?: components['schemas']['TaxConfig'];
|
|
7142
|
-
/**
|
|
7143
|
-
*
|
|
7422
|
+
/**
|
|
7423
|
+
* @description The price of the rate card.
|
|
7424
|
+
* When null, the feature or service is free.
|
|
7425
|
+
*/
|
|
7144
7426
|
price: components['schemas']['RateCardUsageBasedPrice'] | null;
|
|
7145
7427
|
/** @description The discounts that are applied to the line. */
|
|
7146
7428
|
discounts?: components['schemas']['BillingDiscounts'];
|
|
@@ -7170,17 +7452,21 @@ export interface components {
|
|
|
7170
7452
|
/** @description Default tax configuration to apply to the invoices. */
|
|
7171
7453
|
defaultTaxConfig?: components['schemas']['TaxConfig'];
|
|
7172
7454
|
};
|
|
7173
|
-
/**
|
|
7455
|
+
/**
|
|
7456
|
+
* @description InvoiceWorkflowReplaceUpdate represents the update model for an invoice workflow.
|
|
7174
7457
|
*
|
|
7175
|
-
* Fields that are immutable a re removed from the model. This is based on InvoiceWorkflowSettings.
|
|
7458
|
+
* Fields that are immutable a re removed from the model. This is based on InvoiceWorkflowSettings.
|
|
7459
|
+
*/
|
|
7176
7460
|
InvoiceWorkflowReplaceUpdate: {
|
|
7177
7461
|
/** @description The workflow used for this invoice. */
|
|
7178
7462
|
workflow: components['schemas']['InvoiceWorkflowSettingsReplaceUpdate'];
|
|
7179
7463
|
};
|
|
7180
|
-
/**
|
|
7464
|
+
/**
|
|
7465
|
+
* @description InvoiceWorkflowSettings represents the workflow settings used by the invoice.
|
|
7181
7466
|
*
|
|
7182
7467
|
* This is a clone of the billing profile's workflow settings at the time of invoice creation
|
|
7183
|
-
* with customer overrides considered.
|
|
7468
|
+
* with customer overrides considered.
|
|
7469
|
+
*/
|
|
7184
7470
|
InvoiceWorkflowSettings: {
|
|
7185
7471
|
/** @description The apps that will be used to orchestrate the invoice's workflow. */
|
|
7186
7472
|
readonly apps?: components['schemas']['BillingProfileAppsOrReference'];
|
|
@@ -7195,10 +7481,12 @@ export interface components {
|
|
|
7195
7481
|
/** @description The workflow details used by this invoice. */
|
|
7196
7482
|
workflow: components['schemas']['BillingWorkflow'];
|
|
7197
7483
|
};
|
|
7198
|
-
/**
|
|
7484
|
+
/**
|
|
7485
|
+
* @description Mutable workflow settings for an invoice.
|
|
7199
7486
|
*
|
|
7200
7487
|
* Other fields on the invoice's workflow are not mutable, they serve as a history of the invoice's workflow
|
|
7201
|
-
* at creation time.
|
|
7488
|
+
* at creation time.
|
|
7489
|
+
*/
|
|
7202
7490
|
InvoiceWorkflowSettingsReplaceUpdate: {
|
|
7203
7491
|
/** @description The invoicing settings for this workflow */
|
|
7204
7492
|
invoicing: components['schemas']['InvoiceWorkflowInvoicingSettingsReplaceUpdate'];
|
|
@@ -7227,9 +7515,11 @@ export interface components {
|
|
|
7227
7515
|
ListFeaturesResult: components['schemas']['Feature'][] | components['schemas']['FeaturePaginatedResponse'];
|
|
7228
7516
|
/** @description Marketplace install request payload. */
|
|
7229
7517
|
MarketplaceInstallRequestPayload: {
|
|
7230
|
-
/**
|
|
7518
|
+
/**
|
|
7519
|
+
* @description Name of the application to install.
|
|
7231
7520
|
*
|
|
7232
|
-
* If name is not provided defaults to the marketplace listing's name.
|
|
7521
|
+
* If name is not provided defaults to the marketplace listing's name.
|
|
7522
|
+
*/
|
|
7233
7523
|
name?: string;
|
|
7234
7524
|
/**
|
|
7235
7525
|
* @description If true, a billing profile will be created for the app.
|
|
@@ -7252,7 +7542,7 @@ export interface components {
|
|
|
7252
7542
|
* @example {
|
|
7253
7543
|
* "type": "stripe",
|
|
7254
7544
|
* "name": "Stripe",
|
|
7255
|
-
* "description": "Stripe
|
|
7545
|
+
* "description": "Stripe integration allows you to collect payments with Stripe.",
|
|
7256
7546
|
* "capabilities": [
|
|
7257
7547
|
* {
|
|
7258
7548
|
* "type": "calculateTax",
|
|
@@ -7288,9 +7578,11 @@ export interface components {
|
|
|
7288
7578
|
description: string;
|
|
7289
7579
|
/** @description The app's capabilities. */
|
|
7290
7580
|
capabilities: components['schemas']['AppCapability'][];
|
|
7291
|
-
/**
|
|
7581
|
+
/**
|
|
7582
|
+
* @description Install methods.
|
|
7292
7583
|
*
|
|
7293
|
-
* List of methods to install the app.
|
|
7584
|
+
* List of methods to install the app.
|
|
7585
|
+
*/
|
|
7294
7586
|
installMethods: components['schemas']['InstallMethod'][];
|
|
7295
7587
|
};
|
|
7296
7588
|
/** @description Paginated response */
|
|
@@ -7442,6 +7734,11 @@ export interface components {
|
|
|
7442
7734
|
groupBy?: {
|
|
7443
7735
|
[key: string]: string;
|
|
7444
7736
|
};
|
|
7737
|
+
/**
|
|
7738
|
+
* Annotations
|
|
7739
|
+
* @description Set of key-value pairs managed by the system. Cannot be modified by user.
|
|
7740
|
+
*/
|
|
7741
|
+
readonly annotations?: components['schemas']['Annotations'] | null;
|
|
7445
7742
|
};
|
|
7446
7743
|
/**
|
|
7447
7744
|
* @description The aggregation type to use for the meter.
|
|
@@ -7660,11 +7957,15 @@ export interface components {
|
|
|
7660
7957
|
* @example 2023-01-01T01:01:01.001Z
|
|
7661
7958
|
*/
|
|
7662
7959
|
to?: Date;
|
|
7663
|
-
/**
|
|
7664
|
-
*
|
|
7960
|
+
/**
|
|
7961
|
+
* @description The window size that the usage is aggregated.
|
|
7962
|
+
* If not specified, the usage is aggregated over the entire period.
|
|
7963
|
+
*/
|
|
7665
7964
|
windowSize?: components['schemas']['WindowSize'];
|
|
7666
|
-
/**
|
|
7667
|
-
*
|
|
7965
|
+
/**
|
|
7966
|
+
* @description The usage data.
|
|
7967
|
+
* If no data is available, an empty array is returned.
|
|
7968
|
+
*/
|
|
7668
7969
|
data: components['schemas']['MeterQueryRow'][];
|
|
7669
7970
|
};
|
|
7670
7971
|
/**
|
|
@@ -7698,8 +7999,10 @@ export interface components {
|
|
|
7698
7999
|
* @example 2023-01-01T01:01:01.001Z
|
|
7699
8000
|
*/
|
|
7700
8001
|
windowEnd: Date;
|
|
7701
|
-
/**
|
|
7702
|
-
*
|
|
8002
|
+
/**
|
|
8003
|
+
* @description The subject the value is aggregated over.
|
|
8004
|
+
* If not specified, the value is aggregated over all subjects.
|
|
8005
|
+
*/
|
|
7703
8006
|
subject: string | null;
|
|
7704
8007
|
/** @description The customer ID the value is aggregated over. */
|
|
7705
8008
|
customerId?: string;
|
|
@@ -9198,8 +9501,10 @@ export interface components {
|
|
|
9198
9501
|
PlanStatus: 'draft' | 'active' | 'archived' | 'scheduled';
|
|
9199
9502
|
/** @description Change subscription based on plan. */
|
|
9200
9503
|
PlanSubscriptionChange: {
|
|
9201
|
-
/**
|
|
9202
|
-
*
|
|
9504
|
+
/**
|
|
9505
|
+
* @description Timing configuration for the change, when the change should take effect.
|
|
9506
|
+
* For changing a subscription, the accepted values depend on the subscription configuration.
|
|
9507
|
+
*/
|
|
9203
9508
|
timing: components['schemas']['SubscriptionTiming'];
|
|
9204
9509
|
/** @description What alignment settings the subscription should have. */
|
|
9205
9510
|
alignment?: components['schemas']['Alignment'];
|
|
@@ -9207,8 +9512,10 @@ export interface components {
|
|
|
9207
9512
|
metadata?: components['schemas']['Metadata'];
|
|
9208
9513
|
/** @description The plan reference to change to. */
|
|
9209
9514
|
plan: components['schemas']['PlanReferenceInput'];
|
|
9210
|
-
/**
|
|
9211
|
-
*
|
|
9515
|
+
/**
|
|
9516
|
+
* @description The key of the phase to start the subscription in.
|
|
9517
|
+
* If not provided, the subscription will start in the first phase of the plan.
|
|
9518
|
+
*/
|
|
9212
9519
|
startingPhase?: string;
|
|
9213
9520
|
/** @description The name of the Subscription. If not provided the plan name is used. */
|
|
9214
9521
|
name?: string;
|
|
@@ -9232,8 +9539,10 @@ export interface components {
|
|
|
9232
9539
|
metadata?: components['schemas']['Metadata'];
|
|
9233
9540
|
/** @description The plan reference to change to. */
|
|
9234
9541
|
plan: components['schemas']['PlanReferenceInput'];
|
|
9235
|
-
/**
|
|
9236
|
-
*
|
|
9542
|
+
/**
|
|
9543
|
+
* @description The key of the phase to start the subscription in.
|
|
9544
|
+
* If not provided, the subscription will start in the first phase of the plan.
|
|
9545
|
+
*/
|
|
9237
9546
|
startingPhase?: string;
|
|
9238
9547
|
/** @description The name of the Subscription. If not provided the plan name is used. */
|
|
9239
9548
|
name?: string;
|
|
@@ -9259,10 +9568,12 @@ export interface components {
|
|
|
9259
9568
|
*/
|
|
9260
9569
|
billingAnchor?: Date;
|
|
9261
9570
|
};
|
|
9262
|
-
/**
|
|
9571
|
+
/**
|
|
9572
|
+
* @description A consumer portal token.
|
|
9263
9573
|
*
|
|
9264
9574
|
* Validator doesn't obey required for readOnly properties
|
|
9265
|
-
* See: https://github.com/stoplightio/spectral/issues/1274
|
|
9575
|
+
* See: https://github.com/stoplightio/spectral/issues/1274
|
|
9576
|
+
*/
|
|
9266
9577
|
PortalToken: {
|
|
9267
9578
|
/**
|
|
9268
9579
|
* @description ULID (Universally Unique Lexicographically Sortable Identifier).
|
|
@@ -9305,8 +9616,10 @@ export interface components {
|
|
|
9305
9616
|
* @enum {string}
|
|
9306
9617
|
*/
|
|
9307
9618
|
PricePaymentTerm: 'in_advance' | 'in_arrears';
|
|
9308
|
-
/**
|
|
9309
|
-
*
|
|
9619
|
+
/**
|
|
9620
|
+
* @description A price tier.
|
|
9621
|
+
* At least one price component is required in each tier.
|
|
9622
|
+
*/
|
|
9310
9623
|
PriceTier: {
|
|
9311
9624
|
/**
|
|
9312
9625
|
* Up to quantity
|
|
@@ -9381,8 +9694,10 @@ export interface components {
|
|
|
9381
9694
|
*/
|
|
9382
9695
|
type: 'boolean';
|
|
9383
9696
|
};
|
|
9384
|
-
/**
|
|
9385
|
-
*
|
|
9697
|
+
/**
|
|
9698
|
+
* @description Entitlement templates are used to define the entitlements of a plan.
|
|
9699
|
+
* Features are omitted from the entitlement template, as they are defined in the rate card.
|
|
9700
|
+
*/
|
|
9386
9701
|
RateCardEntitlement: components['schemas']['RateCardMeteredEntitlement'] | components['schemas']['RateCardStaticEntitlement'] | components['schemas']['RateCardBooleanEntitlement'];
|
|
9387
9702
|
/** @description A flat fee rate card defines a one-time purchase or a recurring fee. */
|
|
9388
9703
|
RateCardFlatFee: {
|
|
@@ -9416,8 +9731,10 @@ export interface components {
|
|
|
9416
9731
|
* @description The feature the customer is entitled to use.
|
|
9417
9732
|
*/
|
|
9418
9733
|
featureKey?: string;
|
|
9419
|
-
/**
|
|
9420
|
-
*
|
|
9734
|
+
/**
|
|
9735
|
+
* @description The entitlement of the rate card.
|
|
9736
|
+
* Only available when featureKey is set.
|
|
9737
|
+
*/
|
|
9421
9738
|
entitlementTemplate?: components['schemas']['RateCardEntitlement'];
|
|
9422
9739
|
/**
|
|
9423
9740
|
* Tax config
|
|
@@ -9543,8 +9860,10 @@ export interface components {
|
|
|
9543
9860
|
* @description The feature the customer is entitled to use.
|
|
9544
9861
|
*/
|
|
9545
9862
|
featureKey?: string;
|
|
9546
|
-
/**
|
|
9547
|
-
*
|
|
9863
|
+
/**
|
|
9864
|
+
* @description The entitlement of the rate card.
|
|
9865
|
+
* Only available when featureKey is set.
|
|
9866
|
+
*/
|
|
9548
9867
|
entitlementTemplate?: components['schemas']['RateCardEntitlement'];
|
|
9549
9868
|
/**
|
|
9550
9869
|
* Tax config
|
|
@@ -9558,8 +9877,10 @@ export interface components {
|
|
|
9558
9877
|
* @description The billing cadence of the rate card.
|
|
9559
9878
|
*/
|
|
9560
9879
|
billingCadence: string;
|
|
9561
|
-
/**
|
|
9562
|
-
*
|
|
9880
|
+
/**
|
|
9881
|
+
* @description The price of the rate card.
|
|
9882
|
+
* When null, the feature or service is free.
|
|
9883
|
+
*/
|
|
9563
9884
|
price: components['schemas']['RateCardUsageBasedPrice'] | null;
|
|
9564
9885
|
/**
|
|
9565
9886
|
* Discounts
|
|
@@ -9656,19 +9977,25 @@ export interface components {
|
|
|
9656
9977
|
* @example 2023-01-01T01:01:01.001Z
|
|
9657
9978
|
*/
|
|
9658
9979
|
effectiveAt?: Date;
|
|
9659
|
-
/**
|
|
9980
|
+
/**
|
|
9981
|
+
* @description Determines whether the usage period anchor is retained or reset to the effectiveAt time.
|
|
9660
9982
|
* - If true, the usage period anchor is retained.
|
|
9661
|
-
* - If false, the usage period anchor is reset to the effectiveAt time.
|
|
9983
|
+
* - If false, the usage period anchor is reset to the effectiveAt time.
|
|
9984
|
+
*/
|
|
9662
9985
|
retainAnchor?: boolean;
|
|
9663
|
-
/**
|
|
9986
|
+
/**
|
|
9987
|
+
* @description Determines whether the overage is preserved or forgiven, overriding the entitlement's default behavior.
|
|
9664
9988
|
* - If true, the overage is preserved.
|
|
9665
|
-
* - If false, the overage is forgiven.
|
|
9989
|
+
* - If false, the overage is forgiven.
|
|
9990
|
+
*/
|
|
9666
9991
|
preserveOverage?: boolean;
|
|
9667
9992
|
};
|
|
9668
|
-
/**
|
|
9993
|
+
/**
|
|
9994
|
+
* @description Sandbox app can be used for testing OpenMeter features.
|
|
9669
9995
|
*
|
|
9670
9996
|
* The app is not creating anything in external systems, thus it is safe to use for
|
|
9671
|
-
* verifying OpenMeter features.
|
|
9997
|
+
* verifying OpenMeter features.
|
|
9998
|
+
*/
|
|
9672
9999
|
SandboxApp: {
|
|
9673
10000
|
/**
|
|
9674
10001
|
* ID
|
|
@@ -9769,8 +10096,10 @@ export interface components {
|
|
|
9769
10096
|
* @enum {string}
|
|
9770
10097
|
*/
|
|
9771
10098
|
SortOrder: 'ASC' | 'DESC';
|
|
9772
|
-
/**
|
|
9773
|
-
*
|
|
10099
|
+
/**
|
|
10100
|
+
* @description The Stripe API key input.
|
|
10101
|
+
* Used to authenticate with the Stripe API.
|
|
10102
|
+
*/
|
|
9774
10103
|
StripeAPIKeyInput: {
|
|
9775
10104
|
secretAPIKey: string;
|
|
9776
10105
|
};
|
|
@@ -9784,7 +10113,7 @@ export interface components {
|
|
|
9784
10113
|
* "listing": {
|
|
9785
10114
|
* "type": "stripe",
|
|
9786
10115
|
* "name": "Stripe",
|
|
9787
|
-
* "description": "Stripe
|
|
10116
|
+
* "description": "Stripe integration allows you to collect payments with Stripe.",
|
|
9788
10117
|
* "capabilities": [
|
|
9789
10118
|
* {
|
|
9790
10119
|
* "type": "calculateTax",
|
|
@@ -9873,8 +10202,10 @@ export interface components {
|
|
|
9873
10202
|
readonly stripeAccountId: string;
|
|
9874
10203
|
/** @description Livemode, true if the app is in production mode. */
|
|
9875
10204
|
readonly livemode: boolean;
|
|
9876
|
-
/**
|
|
9877
|
-
*
|
|
10205
|
+
/**
|
|
10206
|
+
* @description The masked API key.
|
|
10207
|
+
* Only shows the first 8 and last 3 characters.
|
|
10208
|
+
*/
|
|
9878
10209
|
readonly maskedAPIKey: string;
|
|
9879
10210
|
};
|
|
9880
10211
|
/** @description Resource update operation model. */
|
|
@@ -9969,23 +10300,31 @@ export interface components {
|
|
|
9969
10300
|
/** @description The Stripe default payment method ID. */
|
|
9970
10301
|
stripeDefaultPaymentMethodId?: string;
|
|
9971
10302
|
};
|
|
9972
|
-
/**
|
|
10303
|
+
/**
|
|
10304
|
+
* @description Stripe customer portal session.
|
|
9973
10305
|
*
|
|
9974
|
-
* See: https://docs.stripe.com/api/customer_portal/sessions/object
|
|
10306
|
+
* See: https://docs.stripe.com/api/customer_portal/sessions/object
|
|
10307
|
+
*/
|
|
9975
10308
|
StripeCustomerPortalSession: {
|
|
9976
|
-
/**
|
|
10309
|
+
/**
|
|
10310
|
+
* @description The ID of the customer portal session.
|
|
9977
10311
|
*
|
|
9978
|
-
* See: https://docs.stripe.com/api/customer_portal/sessions/object#portal_session_object-id
|
|
10312
|
+
* See: https://docs.stripe.com/api/customer_portal/sessions/object#portal_session_object-id
|
|
10313
|
+
*/
|
|
9979
10314
|
id: string;
|
|
9980
10315
|
/** @description The ID of the stripe customer. */
|
|
9981
10316
|
stripeCustomerId: string;
|
|
9982
|
-
/**
|
|
10317
|
+
/**
|
|
10318
|
+
* @description Configuration used to customize the customer portal.
|
|
9983
10319
|
*
|
|
9984
|
-
* See: https://docs.stripe.com/api/customer_portal/sessions/object#portal_session_object-configuration
|
|
10320
|
+
* See: https://docs.stripe.com/api/customer_portal/sessions/object#portal_session_object-configuration
|
|
10321
|
+
*/
|
|
9985
10322
|
configurationId: string;
|
|
9986
|
-
/**
|
|
10323
|
+
/**
|
|
10324
|
+
* @description Livemode.
|
|
9987
10325
|
*
|
|
9988
|
-
* See: https://docs.stripe.com/api/customer_portal/sessions/object#portal_session_object-livemode
|
|
10326
|
+
* See: https://docs.stripe.com/api/customer_portal/sessions/object#portal_session_object-livemode
|
|
10327
|
+
*/
|
|
9989
10328
|
livemode: boolean;
|
|
9990
10329
|
/**
|
|
9991
10330
|
* Format: date-time
|
|
@@ -9995,19 +10334,25 @@ export interface components {
|
|
|
9995
10334
|
* @example 2023-01-01T01:01:01.001Z
|
|
9996
10335
|
*/
|
|
9997
10336
|
createdAt: Date;
|
|
9998
|
-
/**
|
|
10337
|
+
/**
|
|
10338
|
+
* @description Return URL.
|
|
9999
10339
|
*
|
|
10000
|
-
* See: https://docs.stripe.com/api/customer_portal/sessions/object#portal_session_object-return_url
|
|
10340
|
+
* See: https://docs.stripe.com/api/customer_portal/sessions/object#portal_session_object-return_url
|
|
10341
|
+
*/
|
|
10001
10342
|
returnUrl: string;
|
|
10002
|
-
/**
|
|
10343
|
+
/**
|
|
10344
|
+
* @description Status.
|
|
10003
10345
|
* /**
|
|
10004
10346
|
* The IETF language tag of the locale customer portal is displayed in.
|
|
10005
10347
|
*
|
|
10006
|
-
* See: https://docs.stripe.com/api/customer_portal/sessions/object#portal_session_object-locale
|
|
10348
|
+
* See: https://docs.stripe.com/api/customer_portal/sessions/object#portal_session_object-locale
|
|
10349
|
+
*/
|
|
10007
10350
|
locale: string;
|
|
10008
|
-
/**
|
|
10351
|
+
/**
|
|
10352
|
+
* @description /**
|
|
10009
10353
|
* The ID of the customer.The URL to redirect the customer to after they have completed
|
|
10010
|
-
* their requested actions.
|
|
10354
|
+
* their requested actions.
|
|
10355
|
+
*/
|
|
10011
10356
|
url: string;
|
|
10012
10357
|
};
|
|
10013
10358
|
/** @description The tax config for Stripe. */
|
|
@@ -10059,11 +10404,14 @@ export interface components {
|
|
|
10059
10404
|
message?: string;
|
|
10060
10405
|
};
|
|
10061
10406
|
/**
|
|
10407
|
+
* @deprecated
|
|
10062
10408
|
* @description A subject is a unique identifier for a usage attribution by its key.
|
|
10063
10409
|
* Subjects only exist in the concept of metering.
|
|
10064
10410
|
* Subjects are optional to create and work as an enrichment for the subject key like displayName, metadata, etc.
|
|
10065
10411
|
* Subjects are useful when you are reporting usage events with your own database ID but want to enrich the subject with a human-readable name or metadata.
|
|
10066
10412
|
* For most use cases, a subject is equivalent to a customer.
|
|
10413
|
+
*
|
|
10414
|
+
* ⚠️ __Deprecated__: Subjects as managable entities are being depracated, use customers with subject key usage attribution instead.
|
|
10067
10415
|
* @example {
|
|
10068
10416
|
* "createdAt": "2025-01-01T01:01:01.001Z",
|
|
10069
10417
|
* "updatedAt": "2025-02-01T01:01:01.001Z",
|
|
@@ -10146,7 +10494,10 @@ export interface components {
|
|
|
10146
10494
|
stripeCustomerId?: string | null;
|
|
10147
10495
|
};
|
|
10148
10496
|
/**
|
|
10497
|
+
* @deprecated
|
|
10149
10498
|
* @description A subject is a unique identifier for a user or entity.
|
|
10499
|
+
*
|
|
10500
|
+
* ⚠️ __Deprecated__: Subjects as managable entities are being depracated, use customers with subject key usage attribution instead.
|
|
10150
10501
|
* @example {
|
|
10151
10502
|
* "key": "customer-id",
|
|
10152
10503
|
* "displayName": "Customer Name",
|
|
@@ -10596,8 +10947,10 @@ export interface components {
|
|
|
10596
10947
|
*/
|
|
10597
10948
|
next: components['schemas']['SubscriptionExpanded'];
|
|
10598
10949
|
};
|
|
10599
|
-
/**
|
|
10600
|
-
*
|
|
10950
|
+
/**
|
|
10951
|
+
* @description The request could not be completed due to a conflict with the current state of the target resource.
|
|
10952
|
+
* Variants with ErrorExtensions specific to subscriptions.
|
|
10953
|
+
*/
|
|
10601
10954
|
SubscriptionConflictErrorResponse: {
|
|
10602
10955
|
/**
|
|
10603
10956
|
* Format: uri
|
|
@@ -10635,8 +10988,10 @@ export interface components {
|
|
|
10635
10988
|
SubscriptionCreate: components['schemas']['PlanSubscriptionCreate'] | components['schemas']['CustomSubscriptionCreate'];
|
|
10636
10989
|
/** @description Subscription edit input. */
|
|
10637
10990
|
SubscriptionEdit: {
|
|
10638
|
-
/**
|
|
10639
|
-
*
|
|
10991
|
+
/**
|
|
10992
|
+
* @description Batch processing commands for manipulating running subscriptions.
|
|
10993
|
+
* The key format is `/phases/{phaseKey}` or `/phases/{phaseKey}/items/{itemKey}`.
|
|
10994
|
+
*/
|
|
10640
10995
|
customizations: components['schemas']['SubscriptionEditOperation'][];
|
|
10641
10996
|
/** @description Whether the billing period should be restarted.Timing configuration to allow for the changes to take effect at different times. */
|
|
10642
10997
|
timing?: components['schemas']['SubscriptionTiming'];
|
|
@@ -10810,7 +11165,8 @@ export interface components {
|
|
|
10810
11165
|
* @example 2023-01-01T01:01:01.001Z
|
|
10811
11166
|
*/
|
|
10812
11167
|
activeTo?: Date;
|
|
10813
|
-
/**
|
|
11168
|
+
/**
|
|
11169
|
+
* @description The identifier of the RateCard.
|
|
10814
11170
|
* SubscriptionItem/RateCard can be identified, it has a reference:
|
|
10815
11171
|
*
|
|
10816
11172
|
* 1. If a Feature is associated with the SubscriptionItem, it is identified by the Feature
|
|
@@ -10819,7 +11175,8 @@ export interface components {
|
|
|
10819
11175
|
*
|
|
10820
11176
|
* 2. If a Feature is not associated with the SubscriptionItem, it is referenced by the Price
|
|
10821
11177
|
*
|
|
10822
|
-
* We say "referenced by the Price" regardless of how a price itself is referenced, it colloquially makes sense to say "paying the same price for the same thing". In practice this should be derived from what's printed on the invoice line-item.
|
|
11178
|
+
* We say "referenced by the Price" regardless of how a price itself is referenced, it colloquially makes sense to say "paying the same price for the same thing". In practice this should be derived from what's printed on the invoice line-item.
|
|
11179
|
+
*/
|
|
10823
11180
|
key: string;
|
|
10824
11181
|
/** @description The feature's key (if present). */
|
|
10825
11182
|
featureKey?: string;
|
|
@@ -10975,11 +11332,13 @@ export interface components {
|
|
|
10975
11332
|
* @example 2023-01-01T01:01:01.001Z
|
|
10976
11333
|
*/
|
|
10977
11334
|
activeTo?: Date;
|
|
10978
|
-
/**
|
|
11335
|
+
/**
|
|
11336
|
+
* @description The items of the phase. The structure is flattened to better conform to the Plan API.
|
|
10979
11337
|
* The timelines are flattened according to the following rules:
|
|
10980
11338
|
* - for the current phase, the `items` contains only the active item for each key
|
|
10981
11339
|
* - for past phases, the `items` contains only the last item for each key
|
|
10982
|
-
* - for future phases, the `items` contains only the first version of the item for each key
|
|
11340
|
+
* - for future phases, the `items` contains only the first version of the item for each key
|
|
11341
|
+
*/
|
|
10983
11342
|
items: components['schemas']['SubscriptionItem'][];
|
|
10984
11343
|
/** @description Includes all versions of the items on each key, including all edits, scheduled changes, etc... */
|
|
10985
11344
|
itemTimelines: {
|
|
@@ -10991,8 +11350,10 @@ export interface components {
|
|
|
10991
11350
|
* @enum {string}
|
|
10992
11351
|
*/
|
|
10993
11352
|
SubscriptionStatus: 'active' | 'inactive' | 'canceled' | 'scheduled';
|
|
10994
|
-
/**
|
|
10995
|
-
*
|
|
11353
|
+
/**
|
|
11354
|
+
* @description Subscription edit timing defined when the changes should take effect.
|
|
11355
|
+
* If the provided configuration is not supported by the subscription, an error will be returned.
|
|
11356
|
+
*/
|
|
10996
11357
|
SubscriptionTiming: components['schemas']['SubscriptionTimingEnum'] | Date;
|
|
10997
11358
|
/**
|
|
10998
11359
|
* @description Subscription edit timing.
|
|
@@ -11071,8 +11432,10 @@ export interface components {
|
|
|
11071
11432
|
ULIDOrExternalKey: string;
|
|
11072
11433
|
/** @description The request has not been applied because it lacks valid authentication credentials for the target resource. */
|
|
11073
11434
|
UnauthorizedProblemResponse: components['schemas']['UnexpectedProblemResponse'];
|
|
11074
|
-
/**
|
|
11075
|
-
*
|
|
11435
|
+
/**
|
|
11436
|
+
* @description A Problem Details object (RFC 7807).
|
|
11437
|
+
* Additional properties specific to the problem type may be present.
|
|
11438
|
+
*/
|
|
11076
11439
|
UnexpectedProblemResponse: {
|
|
11077
11440
|
/**
|
|
11078
11441
|
* Format: uri
|
|
@@ -11171,9 +11534,11 @@ export interface components {
|
|
|
11171
11534
|
/** @description Additional attributes. */
|
|
11172
11535
|
readonly attributes?: components['schemas']['Annotations'];
|
|
11173
11536
|
};
|
|
11174
|
-
/**
|
|
11537
|
+
/**
|
|
11538
|
+
* @description ValidationIssue captures any validation issues related to the invoice.
|
|
11175
11539
|
*
|
|
11176
|
-
* Issues with severity "critical" will prevent the invoice from being issued.
|
|
11540
|
+
* Issues with severity "critical" will prevent the invoice from being issued.
|
|
11541
|
+
*/
|
|
11177
11542
|
ValidationIssue: {
|
|
11178
11543
|
/**
|
|
11179
11544
|
* Creation Time
|
|
@@ -11241,9 +11606,11 @@ export interface components {
|
|
|
11241
11606
|
action: components['schemas']['VoidInvoiceActionCreate'];
|
|
11242
11607
|
/** @description The reason for voiding the invoice. */
|
|
11243
11608
|
reason: string;
|
|
11244
|
-
/**
|
|
11609
|
+
/**
|
|
11610
|
+
* @description Per line item overrides for the action.
|
|
11245
11611
|
*
|
|
11246
|
-
* If not specified, the `action` will be applied to all line items.
|
|
11612
|
+
* If not specified, the `action` will be applied to all line items.
|
|
11613
|
+
*/
|
|
11247
11614
|
overrides?: components['schemas']['VoidInvoiceActionLineOverride'][] | null;
|
|
11248
11615
|
};
|
|
11249
11616
|
/** @description VoidInvoiceLineOverride describes how to handle a specific line item in the invoice when voiding. */
|
|
@@ -11307,10 +11674,12 @@ export interface components {
|
|
|
11307
11674
|
WindowSize: 'MINUTE' | 'HOUR' | 'DAY' | 'MONTH';
|
|
11308
11675
|
/** @description The windowed balance history. */
|
|
11309
11676
|
WindowedBalanceHistory: {
|
|
11310
|
-
/**
|
|
11677
|
+
/**
|
|
11678
|
+
* @description The windowed balance history.
|
|
11311
11679
|
* - It only returns rows for windows where there was usage.
|
|
11312
11680
|
* - The windows are inclusive at their start and exclusive at their end.
|
|
11313
|
-
* - The last window may be smaller than the window size and is inclusive at both ends.
|
|
11681
|
+
* - The last window may be smaller than the window size and is inclusive at both ends.
|
|
11682
|
+
*/
|
|
11314
11683
|
windowedHistory: components['schemas']['BalanceHistoryWindow'][];
|
|
11315
11684
|
/** @description Grant burndown history. */
|
|
11316
11685
|
burndownHistory: components['schemas']['GrantBurnDownHistorySegment'][];
|
|
@@ -11340,11 +11709,13 @@ export interface components {
|
|
|
11340
11709
|
'BillingProfileListCustomerOverridesParams.customersWithoutPinnedProfile': boolean;
|
|
11341
11710
|
/** @description Expand the response with additional details. */
|
|
11342
11711
|
'BillingProfileListCustomerOverridesParams.expand': components['schemas']['BillingProfileCustomerOverrideExpand'][];
|
|
11343
|
-
/**
|
|
11712
|
+
/**
|
|
11713
|
+
* @description Include customers without customer overrides.
|
|
11344
11714
|
*
|
|
11345
11715
|
* If set to false only the customers specifically associated with a billing profile will be returned.
|
|
11346
11716
|
*
|
|
11347
|
-
* If set to true, in case of the default billing profile, all customers will be returned.
|
|
11717
|
+
* If set to true, in case of the default billing profile, all customers will be returned.
|
|
11718
|
+
*/
|
|
11348
11719
|
'BillingProfileListCustomerOverridesParams.includeAllCustomers': boolean;
|
|
11349
11720
|
/** @description The order direction. */
|
|
11350
11721
|
'BillingProfileOrderByOrdering.order': components['schemas']['SortOrder'];
|
|
@@ -11374,11 +11745,15 @@ export interface components {
|
|
|
11374
11745
|
'GrantOrderByOrdering.order': components['schemas']['SortOrder'];
|
|
11375
11746
|
/** @description The order by field. */
|
|
11376
11747
|
'GrantOrderByOrdering.orderBy': components['schemas']['GrantOrderBy'];
|
|
11377
|
-
/**
|
|
11378
|
-
*
|
|
11748
|
+
/**
|
|
11749
|
+
* @description Filter by invoice created time.
|
|
11750
|
+
* Inclusive.
|
|
11751
|
+
*/
|
|
11379
11752
|
'InvoiceListParams.createdAfter': Date | string;
|
|
11380
|
-
/**
|
|
11381
|
-
*
|
|
11753
|
+
/**
|
|
11754
|
+
* @description Filter by invoice created time.
|
|
11755
|
+
* Inclusive.
|
|
11756
|
+
*/
|
|
11382
11757
|
'InvoiceListParams.createdBefore': Date | string;
|
|
11383
11758
|
/** @description Filter by customer ID */
|
|
11384
11759
|
'InvoiceListParams.customers': string[];
|
|
@@ -11388,17 +11763,25 @@ export interface components {
|
|
|
11388
11763
|
'InvoiceListParams.extendedStatuses': string[];
|
|
11389
11764
|
/** @description Include deleted invoices */
|
|
11390
11765
|
'InvoiceListParams.includeDeleted': boolean;
|
|
11391
|
-
/**
|
|
11392
|
-
*
|
|
11766
|
+
/**
|
|
11767
|
+
* @description Filter by invoice issued time.
|
|
11768
|
+
* Inclusive.
|
|
11769
|
+
*/
|
|
11393
11770
|
'InvoiceListParams.issuedAfter': Date | string;
|
|
11394
|
-
/**
|
|
11395
|
-
*
|
|
11771
|
+
/**
|
|
11772
|
+
* @description Filter by invoice issued time.
|
|
11773
|
+
* Inclusive.
|
|
11774
|
+
*/
|
|
11396
11775
|
'InvoiceListParams.issuedBefore': Date | string;
|
|
11397
|
-
/**
|
|
11398
|
-
*
|
|
11776
|
+
/**
|
|
11777
|
+
* @description Filter by period start time.
|
|
11778
|
+
* Inclusive.
|
|
11779
|
+
*/
|
|
11399
11780
|
'InvoiceListParams.periodStartAfter': Date | string;
|
|
11400
|
-
/**
|
|
11401
|
-
*
|
|
11781
|
+
/**
|
|
11782
|
+
* @description Filter by period start time.
|
|
11783
|
+
* Inclusive.
|
|
11784
|
+
*/
|
|
11402
11785
|
'InvoiceListParams.periodStartBefore': Date | string;
|
|
11403
11786
|
/** @description Filter by the invoice status. */
|
|
11404
11787
|
'InvoiceListParams.statuses': components['schemas']['InvoiceStatus'][];
|
|
@@ -11406,13 +11789,17 @@ export interface components {
|
|
|
11406
11789
|
'InvoiceOrderByOrdering.order': components['schemas']['SortOrder'];
|
|
11407
11790
|
/** @description The order by field. */
|
|
11408
11791
|
'InvoiceOrderByOrdering.orderBy': components['schemas']['InvoiceOrderBy'];
|
|
11409
|
-
/**
|
|
11792
|
+
/**
|
|
11793
|
+
* @description Number of items to return.
|
|
11410
11794
|
*
|
|
11411
|
-
* Default is 100.
|
|
11795
|
+
* Default is 100.
|
|
11796
|
+
*/
|
|
11412
11797
|
'LimitOffset.limit': number;
|
|
11413
|
-
/**
|
|
11798
|
+
/**
|
|
11799
|
+
* @description Number of items to skip.
|
|
11414
11800
|
*
|
|
11415
|
-
* Default is 0.
|
|
11801
|
+
* Default is 0.
|
|
11802
|
+
*/
|
|
11416
11803
|
'LimitOffset.offset': number;
|
|
11417
11804
|
/** @description The type of the app to install. */
|
|
11418
11805
|
'MarketplaceApiKeyInstallRequest.type': components['schemas']['AppType'];
|
|
@@ -11424,54 +11811,74 @@ export interface components {
|
|
|
11424
11811
|
'MeterOrderByOrdering.order': components['schemas']['SortOrder'];
|
|
11425
11812
|
/** @description The order by field. */
|
|
11426
11813
|
'MeterOrderByOrdering.orderBy': components['schemas']['MeterOrderBy'];
|
|
11427
|
-
/**
|
|
11428
|
-
*
|
|
11814
|
+
/**
|
|
11815
|
+
* @description Optional advanced meter group by filters.
|
|
11816
|
+
* You can use this to filter for values of the meter groupBy fields.
|
|
11817
|
+
*/
|
|
11429
11818
|
'MeterQuery.advancedMeterGroupByFilters': string;
|
|
11430
|
-
/**
|
|
11431
|
-
*
|
|
11819
|
+
/**
|
|
11820
|
+
* @description Client ID
|
|
11821
|
+
* Useful to track progress of a query.
|
|
11822
|
+
*/
|
|
11432
11823
|
'MeterQuery.clientId': string;
|
|
11433
|
-
/**
|
|
11824
|
+
/**
|
|
11825
|
+
* @description Filtering by multiple customers.
|
|
11434
11826
|
*
|
|
11435
|
-
* For example: ?filterCustomerId=customer-1&filterCustomerId=customer-2
|
|
11827
|
+
* For example: ?filterCustomerId=customer-1&filterCustomerId=customer-2
|
|
11828
|
+
*/
|
|
11436
11829
|
'MeterQuery.filterCustomerId': string[];
|
|
11437
11830
|
/**
|
|
11438
11831
|
* @deprecated
|
|
11439
11832
|
* @description Simple filter for group bys with exact match.
|
|
11440
11833
|
*
|
|
11441
11834
|
* For example: ?filterGroupBy[vendor]=openai&filterGroupBy[model]=gpt-4-turbo
|
|
11835
|
+
*
|
|
11836
|
+
* ⚠️ __Deprecated__: Use `advancedMeterGroupByFilters` instead
|
|
11442
11837
|
*/
|
|
11443
11838
|
'MeterQuery.filterGroupBy': {
|
|
11444
11839
|
[key: string]: string;
|
|
11445
11840
|
};
|
|
11446
|
-
/**
|
|
11841
|
+
/**
|
|
11842
|
+
* @description Start date-time in RFC 3339 format.
|
|
11447
11843
|
*
|
|
11448
11844
|
* Inclusive.
|
|
11449
11845
|
*
|
|
11450
|
-
* For example: ?from=2025-01-01T00%3A00%3A00.000Z
|
|
11846
|
+
* For example: ?from=2025-01-01T00%3A00%3A00.000Z
|
|
11847
|
+
*/
|
|
11451
11848
|
'MeterQuery.from': Date | string;
|
|
11452
|
-
/**
|
|
11849
|
+
/**
|
|
11850
|
+
* @description If not specified a single aggregate will be returned for each subject and time window.
|
|
11453
11851
|
* `subject` is a reserved group by value.
|
|
11454
11852
|
*
|
|
11455
|
-
* For example: ?groupBy=subject&groupBy=model
|
|
11853
|
+
* For example: ?groupBy=subject&groupBy=model
|
|
11854
|
+
*/
|
|
11456
11855
|
'MeterQuery.groupBy': string[];
|
|
11457
|
-
/**
|
|
11856
|
+
/**
|
|
11857
|
+
* @description Filtering by multiple subjects.
|
|
11458
11858
|
*
|
|
11459
|
-
* For example: ?subject=subject-1&subject=subject-2
|
|
11859
|
+
* For example: ?subject=subject-1&subject=subject-2
|
|
11860
|
+
*/
|
|
11460
11861
|
'MeterQuery.subject': string[];
|
|
11461
|
-
/**
|
|
11862
|
+
/**
|
|
11863
|
+
* @description End date-time in RFC 3339 format.
|
|
11462
11864
|
*
|
|
11463
11865
|
* Inclusive.
|
|
11464
11866
|
*
|
|
11465
|
-
* For example: ?to=2025-02-01T00%3A00%3A00.000Z
|
|
11867
|
+
* For example: ?to=2025-02-01T00%3A00%3A00.000Z
|
|
11868
|
+
*/
|
|
11466
11869
|
'MeterQuery.to': Date | string;
|
|
11467
|
-
/**
|
|
11870
|
+
/**
|
|
11871
|
+
* @description If not specified, a single usage aggregate will be returned for the entirety of the specified period for each subject and group.
|
|
11468
11872
|
*
|
|
11469
|
-
* For example: ?windowSize=DAY
|
|
11873
|
+
* For example: ?windowSize=DAY
|
|
11874
|
+
*/
|
|
11470
11875
|
'MeterQuery.windowSize': components['schemas']['WindowSize'];
|
|
11471
|
-
/**
|
|
11876
|
+
/**
|
|
11877
|
+
* @description The value is the name of the time zone as defined in the IANA Time Zone Database (http://www.iana.org/time-zones).
|
|
11472
11878
|
* If not specified, the UTC timezone will be used.
|
|
11473
11879
|
*
|
|
11474
|
-
* For example: ?windowTimeZone=UTC
|
|
11880
|
+
* For example: ?windowTimeZone=UTC
|
|
11881
|
+
*/
|
|
11475
11882
|
'MeterQuery.windowTimeZone': string;
|
|
11476
11883
|
/** @description The order direction. */
|
|
11477
11884
|
'NotificationChannelOrderByOrdering.order': components['schemas']['SortOrder'];
|
|
@@ -11485,32 +11892,46 @@ export interface components {
|
|
|
11485
11892
|
'NotificationRuleOrderByOrdering.order': components['schemas']['SortOrder'];
|
|
11486
11893
|
/** @description The order by field. */
|
|
11487
11894
|
'NotificationRuleOrderByOrdering.orderBy': components['schemas']['NotificationRuleOrderBy'];
|
|
11488
|
-
/**
|
|
11489
|
-
*
|
|
11895
|
+
/**
|
|
11896
|
+
* @description Error code.
|
|
11897
|
+
* Required with the error response.
|
|
11898
|
+
*/
|
|
11490
11899
|
'OAuth2AuthorizationCodeGrantErrorParams.error': components['schemas']['OAuth2AuthorizationCodeGrantErrorType'];
|
|
11491
|
-
/**
|
|
11492
|
-
*
|
|
11900
|
+
/**
|
|
11901
|
+
* @description Optional human-readable text providing additional information,
|
|
11902
|
+
* used to assist the client developer in understanding the error that occurred.
|
|
11903
|
+
*/
|
|
11493
11904
|
'OAuth2AuthorizationCodeGrantErrorParams.error_description': string;
|
|
11494
|
-
/**
|
|
11905
|
+
/**
|
|
11906
|
+
* @description Optional uri identifying a human-readable web page with
|
|
11495
11907
|
* information about the error, used to provide the client
|
|
11496
|
-
* developer with additional information about the error
|
|
11908
|
+
* developer with additional information about the error
|
|
11909
|
+
*/
|
|
11497
11910
|
'OAuth2AuthorizationCodeGrantErrorParams.error_uri': string;
|
|
11498
|
-
/**
|
|
11499
|
-
*
|
|
11911
|
+
/**
|
|
11912
|
+
* @description Authorization code which the client will later exchange for an access token.
|
|
11913
|
+
* Required with the success response.
|
|
11914
|
+
*/
|
|
11500
11915
|
'OAuth2AuthorizationCodeGrantSuccessParams.code': string;
|
|
11501
|
-
/**
|
|
11916
|
+
/**
|
|
11917
|
+
* @description Required if the "state" parameter was present in the client authorization request.
|
|
11502
11918
|
* The exact value received from the client:
|
|
11503
11919
|
*
|
|
11504
11920
|
* Unique, randomly generated, opaque, and non-guessable string that is sent
|
|
11505
|
-
* when starting an authentication request and validated when processing the response.
|
|
11921
|
+
* when starting an authentication request and validated when processing the response.
|
|
11922
|
+
*/
|
|
11506
11923
|
'OAuth2AuthorizationCodeGrantSuccessParams.state': string;
|
|
11507
|
-
/**
|
|
11924
|
+
/**
|
|
11925
|
+
* @description Page index.
|
|
11508
11926
|
*
|
|
11509
|
-
* Default is 1.
|
|
11927
|
+
* Default is 1.
|
|
11928
|
+
*/
|
|
11510
11929
|
'Pagination.page': number;
|
|
11511
|
-
/**
|
|
11930
|
+
/**
|
|
11931
|
+
* @description The maximum number of items per page.
|
|
11512
11932
|
*
|
|
11513
|
-
* Default is 100.
|
|
11933
|
+
* Default is 100.
|
|
11934
|
+
*/
|
|
11514
11935
|
'Pagination.pageSize': number;
|
|
11515
11936
|
/** @description The order direction. */
|
|
11516
11937
|
'PlanAddonOrderByOrdering.order': components['schemas']['SortOrder'];
|
|
@@ -11528,19 +11949,27 @@ export interface components {
|
|
|
11528
11949
|
'queryCustomerList.expand': components['schemas']['CustomerExpand'][];
|
|
11529
11950
|
/** @description Include deleted customers. */
|
|
11530
11951
|
'queryCustomerList.includeDeleted': boolean;
|
|
11531
|
-
/**
|
|
11532
|
-
*
|
|
11952
|
+
/**
|
|
11953
|
+
* @description Filter customers by key.
|
|
11954
|
+
* Case-insensitive partial match.
|
|
11955
|
+
*/
|
|
11533
11956
|
'queryCustomerList.key': string;
|
|
11534
|
-
/**
|
|
11535
|
-
*
|
|
11957
|
+
/**
|
|
11958
|
+
* @description Filter customers by name.
|
|
11959
|
+
* Case-insensitive partial match.
|
|
11960
|
+
*/
|
|
11536
11961
|
'queryCustomerList.name': string;
|
|
11537
11962
|
/** @description Filter customers by the plan key of their susbcription. */
|
|
11538
11963
|
'queryCustomerList.planKey': string;
|
|
11539
|
-
/**
|
|
11540
|
-
*
|
|
11964
|
+
/**
|
|
11965
|
+
* @description Filter customers by primary email.
|
|
11966
|
+
* Case-insensitive partial match.
|
|
11967
|
+
*/
|
|
11541
11968
|
'queryCustomerList.primaryEmail': string;
|
|
11542
|
-
/**
|
|
11543
|
-
*
|
|
11969
|
+
/**
|
|
11970
|
+
* @description Filter customers by usage attribution subject.
|
|
11971
|
+
* Case-insensitive partial match.
|
|
11972
|
+
*/
|
|
11544
11973
|
'queryCustomerList.subject': string;
|
|
11545
11974
|
/** @description Include deleted meters. */
|
|
11546
11975
|
'queryMeterList.includeDeleted': boolean;
|
|
@@ -12025,9 +12454,11 @@ export interface operations {
|
|
|
12025
12454
|
listAddons: {
|
|
12026
12455
|
parameters: {
|
|
12027
12456
|
query?: {
|
|
12028
|
-
/**
|
|
12457
|
+
/**
|
|
12458
|
+
* @description Include deleted add-ons in response.
|
|
12029
12459
|
*
|
|
12030
|
-
* Usage: `?includeDeleted=true`
|
|
12460
|
+
* Usage: `?includeDeleted=true`
|
|
12461
|
+
*/
|
|
12031
12462
|
includeDeleted?: boolean;
|
|
12032
12463
|
/** @description Filter by addon.id attribute */
|
|
12033
12464
|
id?: string[];
|
|
@@ -12037,22 +12468,28 @@ export interface operations {
|
|
|
12037
12468
|
keyVersion?: {
|
|
12038
12469
|
[key: string]: number[];
|
|
12039
12470
|
};
|
|
12040
|
-
/**
|
|
12471
|
+
/**
|
|
12472
|
+
* @description Only return add-ons with the given status.
|
|
12041
12473
|
*
|
|
12042
12474
|
* Usage:
|
|
12043
12475
|
* - `?status=active`: return only the currently active add-ons
|
|
12044
12476
|
* - `?status=draft`: return only the draft add-ons
|
|
12045
|
-
* - `?status=archived`: return only the archived add-ons
|
|
12477
|
+
* - `?status=archived`: return only the archived add-ons
|
|
12478
|
+
*/
|
|
12046
12479
|
status?: components['schemas']['AddonStatus'][];
|
|
12047
12480
|
/** @description Filter by addon.currency attribute */
|
|
12048
12481
|
currency?: components['schemas']['CurrencyCode'][];
|
|
12049
|
-
/**
|
|
12482
|
+
/**
|
|
12483
|
+
* @description Page index.
|
|
12050
12484
|
*
|
|
12051
|
-
* Default is 1.
|
|
12485
|
+
* Default is 1.
|
|
12486
|
+
*/
|
|
12052
12487
|
page?: components['parameters']['Pagination.page'];
|
|
12053
|
-
/**
|
|
12488
|
+
/**
|
|
12489
|
+
* @description The maximum number of items per page.
|
|
12054
12490
|
*
|
|
12055
|
-
* Default is 100.
|
|
12491
|
+
* Default is 100.
|
|
12492
|
+
*/
|
|
12056
12493
|
pageSize?: components['parameters']['Pagination.pageSize'];
|
|
12057
12494
|
/** @description The order direction. */
|
|
12058
12495
|
order?: components['parameters']['AddonOrderByOrdering.order'];
|
|
@@ -12229,9 +12666,11 @@ export interface operations {
|
|
|
12229
12666
|
getAddon: {
|
|
12230
12667
|
parameters: {
|
|
12231
12668
|
query?: {
|
|
12232
|
-
/**
|
|
12669
|
+
/**
|
|
12670
|
+
* @description Include latest version of the add-on instead of the version in active state.
|
|
12233
12671
|
*
|
|
12234
|
-
* Usage: `?includeLatest=true`
|
|
12672
|
+
* Usage: `?includeLatest=true`
|
|
12673
|
+
*/
|
|
12235
12674
|
includeLatest?: boolean;
|
|
12236
12675
|
};
|
|
12237
12676
|
header?: never;
|
|
@@ -12434,7 +12873,7 @@ export interface operations {
|
|
|
12434
12873
|
};
|
|
12435
12874
|
requestBody?: never;
|
|
12436
12875
|
responses: {
|
|
12437
|
-
/** @description There is no content to send for this request, but the headers may be useful.
|
|
12876
|
+
/** @description There is no content to send for this request, but the headers may be useful. */
|
|
12438
12877
|
204: {
|
|
12439
12878
|
headers: {
|
|
12440
12879
|
[name: string]: unknown;
|
|
@@ -12706,13 +13145,17 @@ export interface operations {
|
|
|
12706
13145
|
listApps: {
|
|
12707
13146
|
parameters: {
|
|
12708
13147
|
query?: {
|
|
12709
|
-
/**
|
|
13148
|
+
/**
|
|
13149
|
+
* @description Page index.
|
|
12710
13150
|
*
|
|
12711
|
-
* Default is 1.
|
|
13151
|
+
* Default is 1.
|
|
13152
|
+
*/
|
|
12712
13153
|
page?: components['parameters']['Pagination.page'];
|
|
12713
|
-
/**
|
|
13154
|
+
/**
|
|
13155
|
+
* @description The maximum number of items per page.
|
|
12714
13156
|
*
|
|
12715
|
-
* Default is 100.
|
|
13157
|
+
* Default is 100.
|
|
13158
|
+
*/
|
|
12716
13159
|
pageSize?: components['parameters']['Pagination.pageSize'];
|
|
12717
13160
|
};
|
|
12718
13161
|
header?: never;
|
|
@@ -12810,7 +13253,7 @@ export interface operations {
|
|
|
12810
13253
|
};
|
|
12811
13254
|
};
|
|
12812
13255
|
responses: {
|
|
12813
|
-
/** @description There is no content to send for this request, but the headers may be useful.
|
|
13256
|
+
/** @description There is no content to send for this request, but the headers may be useful. */
|
|
12814
13257
|
204: {
|
|
12815
13258
|
headers: {
|
|
12816
13259
|
[name: string]: unknown;
|
|
@@ -12897,7 +13340,7 @@ export interface operations {
|
|
|
12897
13340
|
};
|
|
12898
13341
|
};
|
|
12899
13342
|
responses: {
|
|
12900
|
-
/** @description There is no content to send for this request, but the headers may be useful.
|
|
13343
|
+
/** @description There is no content to send for this request, but the headers may be useful. */
|
|
12901
13344
|
204: {
|
|
12902
13345
|
headers: {
|
|
12903
13346
|
[name: string]: unknown;
|
|
@@ -12984,7 +13427,7 @@ export interface operations {
|
|
|
12984
13427
|
};
|
|
12985
13428
|
};
|
|
12986
13429
|
responses: {
|
|
12987
|
-
/** @description There is no content to send for this request, but the headers may be useful.
|
|
13430
|
+
/** @description There is no content to send for this request, but the headers may be useful. */
|
|
12988
13431
|
204: {
|
|
12989
13432
|
headers: {
|
|
12990
13433
|
[name: string]: unknown;
|
|
@@ -13259,7 +13702,7 @@ export interface operations {
|
|
|
13259
13702
|
};
|
|
13260
13703
|
requestBody?: never;
|
|
13261
13704
|
responses: {
|
|
13262
|
-
/** @description There is no content to send for this request, but the headers may be useful.
|
|
13705
|
+
/** @description There is no content to send for this request, but the headers may be useful. */
|
|
13263
13706
|
204: {
|
|
13264
13707
|
headers: {
|
|
13265
13708
|
[name: string]: unknown;
|
|
@@ -13355,7 +13798,7 @@ export interface operations {
|
|
|
13355
13798
|
};
|
|
13356
13799
|
};
|
|
13357
13800
|
responses: {
|
|
13358
|
-
/** @description There is no content to send for this request, but the headers may be useful.
|
|
13801
|
+
/** @description There is no content to send for this request, but the headers may be useful. */
|
|
13359
13802
|
204: {
|
|
13360
13803
|
headers: {
|
|
13361
13804
|
[name: string]: unknown;
|
|
@@ -13532,11 +13975,13 @@ export interface operations {
|
|
|
13532
13975
|
billingProfile?: components['parameters']['BillingProfileListCustomerOverridesParams.billingProfile'];
|
|
13533
13976
|
/** @description Only return customers without pinned billing profiles. This implicitly sets includeAllCustomers to true. */
|
|
13534
13977
|
customersWithoutPinnedProfile?: components['parameters']['BillingProfileListCustomerOverridesParams.customersWithoutPinnedProfile'];
|
|
13535
|
-
/**
|
|
13978
|
+
/**
|
|
13979
|
+
* @description Include customers without customer overrides.
|
|
13536
13980
|
*
|
|
13537
13981
|
* If set to false only the customers specifically associated with a billing profile will be returned.
|
|
13538
13982
|
*
|
|
13539
|
-
* If set to true, in case of the default billing profile, all customers will be returned.
|
|
13983
|
+
* If set to true, in case of the default billing profile, all customers will be returned.
|
|
13984
|
+
*/
|
|
13540
13985
|
includeAllCustomers?: components['parameters']['BillingProfileListCustomerOverridesParams.includeAllCustomers'];
|
|
13541
13986
|
/** @description Filter by customer id. */
|
|
13542
13987
|
customerId?: components['parameters']['BillingProfileListCustomerOverridesParams.customerId'];
|
|
@@ -13552,13 +13997,17 @@ export interface operations {
|
|
|
13552
13997
|
order?: components['parameters']['BillingProfileCustomerOverrideOrderByOrdering.order'];
|
|
13553
13998
|
/** @description The order by field. */
|
|
13554
13999
|
orderBy?: components['parameters']['BillingProfileCustomerOverrideOrderByOrdering.orderBy'];
|
|
13555
|
-
/**
|
|
14000
|
+
/**
|
|
14001
|
+
* @description Page index.
|
|
13556
14002
|
*
|
|
13557
|
-
* Default is 1.
|
|
14003
|
+
* Default is 1.
|
|
14004
|
+
*/
|
|
13558
14005
|
page?: components['parameters']['Pagination.page'];
|
|
13559
|
-
/**
|
|
14006
|
+
/**
|
|
14007
|
+
* @description The maximum number of items per page.
|
|
13560
14008
|
*
|
|
13561
|
-
* Default is 100.
|
|
14009
|
+
* Default is 100.
|
|
14010
|
+
*/
|
|
13562
14011
|
pageSize?: components['parameters']['Pagination.pageSize'];
|
|
13563
14012
|
};
|
|
13564
14013
|
header?: never;
|
|
@@ -13846,7 +14295,7 @@ export interface operations {
|
|
|
13846
14295
|
};
|
|
13847
14296
|
requestBody?: never;
|
|
13848
14297
|
responses: {
|
|
13849
|
-
/** @description There is no content to send for this request, but the headers may be useful.
|
|
14298
|
+
/** @description There is no content to send for this request, but the headers may be useful. */
|
|
13850
14299
|
204: {
|
|
13851
14300
|
headers: {
|
|
13852
14301
|
[name: string]: unknown;
|
|
@@ -14112,23 +14561,35 @@ export interface operations {
|
|
|
14112
14561
|
statuses?: components['parameters']['InvoiceListParams.statuses'];
|
|
14113
14562
|
/** @description Filter by invoice extended statuses */
|
|
14114
14563
|
extendedStatuses?: components['parameters']['InvoiceListParams.extendedStatuses'];
|
|
14115
|
-
/**
|
|
14116
|
-
*
|
|
14564
|
+
/**
|
|
14565
|
+
* @description Filter by invoice issued time.
|
|
14566
|
+
* Inclusive.
|
|
14567
|
+
*/
|
|
14117
14568
|
issuedAfter?: components['parameters']['InvoiceListParams.issuedAfter'];
|
|
14118
|
-
/**
|
|
14119
|
-
*
|
|
14569
|
+
/**
|
|
14570
|
+
* @description Filter by invoice issued time.
|
|
14571
|
+
* Inclusive.
|
|
14572
|
+
*/
|
|
14120
14573
|
issuedBefore?: components['parameters']['InvoiceListParams.issuedBefore'];
|
|
14121
|
-
/**
|
|
14122
|
-
*
|
|
14574
|
+
/**
|
|
14575
|
+
* @description Filter by period start time.
|
|
14576
|
+
* Inclusive.
|
|
14577
|
+
*/
|
|
14123
14578
|
periodStartAfter?: components['parameters']['InvoiceListParams.periodStartAfter'];
|
|
14124
|
-
/**
|
|
14125
|
-
*
|
|
14579
|
+
/**
|
|
14580
|
+
* @description Filter by period start time.
|
|
14581
|
+
* Inclusive.
|
|
14582
|
+
*/
|
|
14126
14583
|
periodStartBefore?: components['parameters']['InvoiceListParams.periodStartBefore'];
|
|
14127
|
-
/**
|
|
14128
|
-
*
|
|
14584
|
+
/**
|
|
14585
|
+
* @description Filter by invoice created time.
|
|
14586
|
+
* Inclusive.
|
|
14587
|
+
*/
|
|
14129
14588
|
createdAfter?: components['parameters']['InvoiceListParams.createdAfter'];
|
|
14130
|
-
/**
|
|
14131
|
-
*
|
|
14589
|
+
/**
|
|
14590
|
+
* @description Filter by invoice created time.
|
|
14591
|
+
* Inclusive.
|
|
14592
|
+
*/
|
|
14132
14593
|
createdBefore?: components['parameters']['InvoiceListParams.createdBefore'];
|
|
14133
14594
|
/** @description What parts of the list output to expand in listings */
|
|
14134
14595
|
expand?: components['parameters']['InvoiceListParams.expand'];
|
|
@@ -14136,13 +14597,17 @@ export interface operations {
|
|
|
14136
14597
|
customers?: components['parameters']['InvoiceListParams.customers'];
|
|
14137
14598
|
/** @description Include deleted invoices */
|
|
14138
14599
|
includeDeleted?: components['parameters']['InvoiceListParams.includeDeleted'];
|
|
14139
|
-
/**
|
|
14600
|
+
/**
|
|
14601
|
+
* @description Page index.
|
|
14140
14602
|
*
|
|
14141
|
-
* Default is 1.
|
|
14603
|
+
* Default is 1.
|
|
14604
|
+
*/
|
|
14142
14605
|
page?: components['parameters']['Pagination.page'];
|
|
14143
|
-
/**
|
|
14606
|
+
/**
|
|
14607
|
+
* @description The maximum number of items per page.
|
|
14144
14608
|
*
|
|
14145
|
-
* Default is 100.
|
|
14609
|
+
* Default is 100.
|
|
14610
|
+
*/
|
|
14146
14611
|
pageSize?: components['parameters']['Pagination.pageSize'];
|
|
14147
14612
|
/** @description The order direction. */
|
|
14148
14613
|
order?: components['parameters']['InvoiceOrderByOrdering.order'];
|
|
@@ -14522,7 +14987,7 @@ export interface operations {
|
|
|
14522
14987
|
};
|
|
14523
14988
|
requestBody?: never;
|
|
14524
14989
|
responses: {
|
|
14525
|
-
/** @description There is no content to send for this request, but the headers may be useful.
|
|
14990
|
+
/** @description There is no content to send for this request, but the headers may be useful. */
|
|
14526
14991
|
204: {
|
|
14527
14992
|
headers: {
|
|
14528
14993
|
[name: string]: unknown;
|
|
@@ -15176,13 +15641,17 @@ export interface operations {
|
|
|
15176
15641
|
query?: {
|
|
15177
15642
|
includeArchived?: boolean;
|
|
15178
15643
|
expand?: components['schemas']['BillingProfileExpand'][];
|
|
15179
|
-
/**
|
|
15644
|
+
/**
|
|
15645
|
+
* @description Page index.
|
|
15180
15646
|
*
|
|
15181
|
-
* Default is 1.
|
|
15647
|
+
* Default is 1.
|
|
15648
|
+
*/
|
|
15182
15649
|
page?: components['parameters']['Pagination.page'];
|
|
15183
|
-
/**
|
|
15650
|
+
/**
|
|
15651
|
+
* @description The maximum number of items per page.
|
|
15184
15652
|
*
|
|
15185
|
-
* Default is 100.
|
|
15653
|
+
* Default is 100.
|
|
15654
|
+
*/
|
|
15186
15655
|
pageSize?: components['parameters']['Pagination.pageSize'];
|
|
15187
15656
|
/** @description The order direction. */
|
|
15188
15657
|
order?: components['parameters']['BillingProfileOrderByOrdering.order'];
|
|
@@ -15561,7 +16030,7 @@ export interface operations {
|
|
|
15561
16030
|
};
|
|
15562
16031
|
requestBody?: never;
|
|
15563
16032
|
responses: {
|
|
15564
|
-
/** @description There is no content to send for this request, but the headers may be useful.
|
|
16033
|
+
/** @description There is no content to send for this request, but the headers may be useful. */
|
|
15565
16034
|
204: {
|
|
15566
16035
|
headers: {
|
|
15567
16036
|
[name: string]: unknown;
|
|
@@ -15645,13 +16114,17 @@ export interface operations {
|
|
|
15645
16114
|
listCustomers: {
|
|
15646
16115
|
parameters: {
|
|
15647
16116
|
query?: {
|
|
15648
|
-
/**
|
|
16117
|
+
/**
|
|
16118
|
+
* @description Page index.
|
|
15649
16119
|
*
|
|
15650
|
-
* Default is 1.
|
|
16120
|
+
* Default is 1.
|
|
16121
|
+
*/
|
|
15651
16122
|
page?: components['parameters']['Pagination.page'];
|
|
15652
|
-
/**
|
|
16123
|
+
/**
|
|
16124
|
+
* @description The maximum number of items per page.
|
|
15653
16125
|
*
|
|
15654
|
-
* Default is 100.
|
|
16126
|
+
* Default is 100.
|
|
16127
|
+
*/
|
|
15655
16128
|
pageSize?: components['parameters']['Pagination.pageSize'];
|
|
15656
16129
|
/** @description The order direction. */
|
|
15657
16130
|
order?: components['parameters']['CustomerOrderByOrdering.order'];
|
|
@@ -15659,17 +16132,25 @@ export interface operations {
|
|
|
15659
16132
|
orderBy?: components['parameters']['CustomerOrderByOrdering.orderBy'];
|
|
15660
16133
|
/** @description Include deleted customers. */
|
|
15661
16134
|
includeDeleted?: components['parameters']['queryCustomerList.includeDeleted'];
|
|
15662
|
-
/**
|
|
15663
|
-
*
|
|
16135
|
+
/**
|
|
16136
|
+
* @description Filter customers by key.
|
|
16137
|
+
* Case-insensitive partial match.
|
|
16138
|
+
*/
|
|
15664
16139
|
key?: components['parameters']['queryCustomerList.key'];
|
|
15665
|
-
/**
|
|
15666
|
-
*
|
|
16140
|
+
/**
|
|
16141
|
+
* @description Filter customers by name.
|
|
16142
|
+
* Case-insensitive partial match.
|
|
16143
|
+
*/
|
|
15667
16144
|
name?: components['parameters']['queryCustomerList.name'];
|
|
15668
|
-
/**
|
|
15669
|
-
*
|
|
16145
|
+
/**
|
|
16146
|
+
* @description Filter customers by primary email.
|
|
16147
|
+
* Case-insensitive partial match.
|
|
16148
|
+
*/
|
|
15670
16149
|
primaryEmail?: components['parameters']['queryCustomerList.primaryEmail'];
|
|
15671
|
-
/**
|
|
15672
|
-
*
|
|
16150
|
+
/**
|
|
16151
|
+
* @description Filter customers by usage attribution subject.
|
|
16152
|
+
* Case-insensitive partial match.
|
|
16153
|
+
*/
|
|
15673
16154
|
subject?: components['parameters']['queryCustomerList.subject'];
|
|
15674
16155
|
/** @description Filter customers by the plan key of their susbcription. */
|
|
15675
16156
|
planKey?: components['parameters']['queryCustomerList.planKey'];
|
|
@@ -16049,7 +16530,7 @@ export interface operations {
|
|
|
16049
16530
|
};
|
|
16050
16531
|
requestBody?: never;
|
|
16051
16532
|
responses: {
|
|
16052
|
-
/** @description There is no content to send for this request, but the headers may be useful.
|
|
16533
|
+
/** @description There is no content to send for this request, but the headers may be useful. */
|
|
16053
16534
|
204: {
|
|
16054
16535
|
headers: {
|
|
16055
16536
|
[name: string]: unknown;
|
|
@@ -16227,13 +16708,17 @@ export interface operations {
|
|
|
16227
16708
|
listCustomerAppData: {
|
|
16228
16709
|
parameters: {
|
|
16229
16710
|
query?: {
|
|
16230
|
-
/**
|
|
16711
|
+
/**
|
|
16712
|
+
* @description Page index.
|
|
16231
16713
|
*
|
|
16232
|
-
* Default is 1.
|
|
16714
|
+
* Default is 1.
|
|
16715
|
+
*/
|
|
16233
16716
|
page?: components['parameters']['Pagination.page'];
|
|
16234
|
-
/**
|
|
16717
|
+
/**
|
|
16718
|
+
* @description The maximum number of items per page.
|
|
16235
16719
|
*
|
|
16236
|
-
* Default is 100.
|
|
16720
|
+
* Default is 100.
|
|
16721
|
+
*/
|
|
16237
16722
|
pageSize?: components['parameters']['Pagination.pageSize'];
|
|
16238
16723
|
/** @description Filter customer data by app type. */
|
|
16239
16724
|
type?: components['parameters']['listCustomerAppDataParams.type'];
|
|
@@ -16439,7 +16924,7 @@ export interface operations {
|
|
|
16439
16924
|
};
|
|
16440
16925
|
requestBody?: never;
|
|
16441
16926
|
responses: {
|
|
16442
|
-
/** @description There is no content to send for this request, but the headers may be useful.
|
|
16927
|
+
/** @description There is no content to send for this request, but the headers may be useful. */
|
|
16443
16928
|
204: {
|
|
16444
16929
|
headers: {
|
|
16445
16930
|
[name: string]: unknown;
|
|
@@ -16915,13 +17400,17 @@ export interface operations {
|
|
|
16915
17400
|
order?: components['parameters']['CustomerSubscriptionOrderByOrdering.order'];
|
|
16916
17401
|
/** @description The order by field. */
|
|
16917
17402
|
orderBy?: components['parameters']['CustomerSubscriptionOrderByOrdering.orderBy'];
|
|
16918
|
-
/**
|
|
17403
|
+
/**
|
|
17404
|
+
* @description Page index.
|
|
16919
17405
|
*
|
|
16920
|
-
* Default is 1.
|
|
17406
|
+
* Default is 1.
|
|
17407
|
+
*/
|
|
16921
17408
|
page?: components['parameters']['Pagination.page'];
|
|
16922
|
-
/**
|
|
17409
|
+
/**
|
|
17410
|
+
* @description The maximum number of items per page.
|
|
16923
17411
|
*
|
|
16924
|
-
* Default is 100.
|
|
17412
|
+
* Default is 100.
|
|
17413
|
+
*/
|
|
16925
17414
|
pageSize?: components['parameters']['Pagination.pageSize'];
|
|
16926
17415
|
};
|
|
16927
17416
|
header?: never;
|
|
@@ -17101,35 +17590,49 @@ export interface operations {
|
|
|
17101
17590
|
listEntitlements: {
|
|
17102
17591
|
parameters: {
|
|
17103
17592
|
query?: {
|
|
17104
|
-
/**
|
|
17593
|
+
/**
|
|
17594
|
+
* @description Filtering by multiple features.
|
|
17105
17595
|
*
|
|
17106
|
-
* Usage: `?feature=feature-1&feature=feature-2`
|
|
17596
|
+
* Usage: `?feature=feature-1&feature=feature-2`
|
|
17597
|
+
*/
|
|
17107
17598
|
feature?: string[];
|
|
17108
|
-
/**
|
|
17599
|
+
/**
|
|
17600
|
+
* @description Filtering by multiple subjects.
|
|
17109
17601
|
*
|
|
17110
|
-
* Usage: `?subject=customer-1&subject=customer-2`
|
|
17602
|
+
* Usage: `?subject=customer-1&subject=customer-2`
|
|
17603
|
+
*/
|
|
17111
17604
|
subject?: string[];
|
|
17112
|
-
/**
|
|
17605
|
+
/**
|
|
17606
|
+
* @description Filtering by multiple entitlement types.
|
|
17113
17607
|
*
|
|
17114
|
-
* Usage: `?entitlementType=metered&entitlementType=boolean`
|
|
17608
|
+
* Usage: `?entitlementType=metered&entitlementType=boolean`
|
|
17609
|
+
*/
|
|
17115
17610
|
entitlementType?: components['schemas']['EntitlementType'][];
|
|
17116
17611
|
/** @description Exclude inactive entitlements in the response (those scheduled for later or earlier) */
|
|
17117
17612
|
excludeInactive?: boolean;
|
|
17118
|
-
/**
|
|
17613
|
+
/**
|
|
17614
|
+
* @description Page index.
|
|
17119
17615
|
*
|
|
17120
|
-
* Default is 1.
|
|
17616
|
+
* Default is 1.
|
|
17617
|
+
*/
|
|
17121
17618
|
page?: components['parameters']['Pagination.page'];
|
|
17122
|
-
/**
|
|
17619
|
+
/**
|
|
17620
|
+
* @description The maximum number of items per page.
|
|
17123
17621
|
*
|
|
17124
|
-
* Default is 100.
|
|
17622
|
+
* Default is 100.
|
|
17623
|
+
*/
|
|
17125
17624
|
pageSize?: components['parameters']['Pagination.pageSize'];
|
|
17126
|
-
/**
|
|
17625
|
+
/**
|
|
17626
|
+
* @description Number of items to skip.
|
|
17127
17627
|
*
|
|
17128
|
-
* Default is 0.
|
|
17628
|
+
* Default is 0.
|
|
17629
|
+
*/
|
|
17129
17630
|
offset?: components['parameters']['LimitOffset.offset'];
|
|
17130
|
-
/**
|
|
17631
|
+
/**
|
|
17632
|
+
* @description Number of items to return.
|
|
17131
17633
|
*
|
|
17132
|
-
* Default is 100.
|
|
17634
|
+
* Default is 100.
|
|
17635
|
+
*/
|
|
17133
17636
|
limit?: components['parameters']['LimitOffset.limit'];
|
|
17134
17637
|
/** @description The order direction. */
|
|
17135
17638
|
order?: components['parameters']['EntitlementOrderByOrdering.order'];
|
|
@@ -17313,34 +17816,48 @@ export interface operations {
|
|
|
17313
17816
|
listEvents: {
|
|
17314
17817
|
parameters: {
|
|
17315
17818
|
query?: {
|
|
17316
|
-
/**
|
|
17317
|
-
*
|
|
17819
|
+
/**
|
|
17820
|
+
* @description Client ID
|
|
17821
|
+
* Useful to track progress of a query.
|
|
17822
|
+
*/
|
|
17318
17823
|
clientId?: string;
|
|
17319
|
-
/**
|
|
17824
|
+
/**
|
|
17825
|
+
* @description Start date-time in RFC 3339 format.
|
|
17320
17826
|
*
|
|
17321
|
-
* Inclusive.
|
|
17827
|
+
* Inclusive.
|
|
17828
|
+
*/
|
|
17322
17829
|
ingestedAtFrom?: Date | string;
|
|
17323
|
-
/**
|
|
17830
|
+
/**
|
|
17831
|
+
* @description End date-time in RFC 3339 format.
|
|
17324
17832
|
*
|
|
17325
|
-
* Inclusive.
|
|
17833
|
+
* Inclusive.
|
|
17834
|
+
*/
|
|
17326
17835
|
ingestedAtTo?: Date | string;
|
|
17327
|
-
/**
|
|
17836
|
+
/**
|
|
17837
|
+
* @description The event ID.
|
|
17328
17838
|
*
|
|
17329
|
-
* Accepts partial ID.
|
|
17839
|
+
* Accepts partial ID.
|
|
17840
|
+
*/
|
|
17330
17841
|
id?: string;
|
|
17331
|
-
/**
|
|
17842
|
+
/**
|
|
17843
|
+
* @description The event subject.
|
|
17332
17844
|
*
|
|
17333
|
-
* Accepts partial subject.
|
|
17845
|
+
* Accepts partial subject.
|
|
17846
|
+
*/
|
|
17334
17847
|
subject?: string;
|
|
17335
17848
|
/** @description The event customer ID. */
|
|
17336
17849
|
customerId?: string[];
|
|
17337
|
-
/**
|
|
17850
|
+
/**
|
|
17851
|
+
* @description Start date-time in RFC 3339 format.
|
|
17338
17852
|
*
|
|
17339
|
-
* Inclusive.
|
|
17853
|
+
* Inclusive.
|
|
17854
|
+
*/
|
|
17340
17855
|
from?: Date | string;
|
|
17341
|
-
/**
|
|
17856
|
+
/**
|
|
17857
|
+
* @description End date-time in RFC 3339 format.
|
|
17342
17858
|
*
|
|
17343
|
-
* Inclusive.
|
|
17859
|
+
* Inclusive.
|
|
17860
|
+
*/
|
|
17344
17861
|
to?: Date | string;
|
|
17345
17862
|
/** @description Number of events to return. */
|
|
17346
17863
|
limit?: number;
|
|
@@ -17440,7 +17957,7 @@ export interface operations {
|
|
|
17440
17957
|
};
|
|
17441
17958
|
};
|
|
17442
17959
|
responses: {
|
|
17443
|
-
/** @description There is no content to send for this request, but the headers may be useful.
|
|
17960
|
+
/** @description There is no content to send for this request, but the headers may be useful. */
|
|
17444
17961
|
204: {
|
|
17445
17962
|
headers: {
|
|
17446
17963
|
[name: string]: unknown;
|
|
@@ -17519,21 +18036,29 @@ export interface operations {
|
|
|
17519
18036
|
meterSlug?: string[];
|
|
17520
18037
|
/** @description Include archived features in response. */
|
|
17521
18038
|
includeArchived?: boolean;
|
|
17522
|
-
/**
|
|
18039
|
+
/**
|
|
18040
|
+
* @description Page index.
|
|
17523
18041
|
*
|
|
17524
|
-
* Default is 1.
|
|
18042
|
+
* Default is 1.
|
|
18043
|
+
*/
|
|
17525
18044
|
page?: components['parameters']['Pagination.page'];
|
|
17526
|
-
/**
|
|
18045
|
+
/**
|
|
18046
|
+
* @description The maximum number of items per page.
|
|
17527
18047
|
*
|
|
17528
|
-
* Default is 100.
|
|
18048
|
+
* Default is 100.
|
|
18049
|
+
*/
|
|
17529
18050
|
pageSize?: components['parameters']['Pagination.pageSize'];
|
|
17530
|
-
/**
|
|
18051
|
+
/**
|
|
18052
|
+
* @description Number of items to skip.
|
|
17531
18053
|
*
|
|
17532
|
-
* Default is 0.
|
|
18054
|
+
* Default is 0.
|
|
18055
|
+
*/
|
|
17533
18056
|
offset?: components['parameters']['LimitOffset.offset'];
|
|
17534
|
-
/**
|
|
18057
|
+
/**
|
|
18058
|
+
* @description Number of items to return.
|
|
17535
18059
|
*
|
|
17536
|
-
* Default is 100.
|
|
18060
|
+
* Default is 100.
|
|
18061
|
+
*/
|
|
17537
18062
|
limit?: components['parameters']['LimitOffset.limit'];
|
|
17538
18063
|
/** @description The order direction. */
|
|
17539
18064
|
order?: components['parameters']['FeatureOrderByOrdering.order'];
|
|
@@ -17812,7 +18337,7 @@ export interface operations {
|
|
|
17812
18337
|
};
|
|
17813
18338
|
requestBody?: never;
|
|
17814
18339
|
responses: {
|
|
17815
|
-
/** @description There is no content to send for this request, but the headers may be useful.
|
|
18340
|
+
/** @description There is no content to send for this request, but the headers may be useful. */
|
|
17816
18341
|
204: {
|
|
17817
18342
|
headers: {
|
|
17818
18343
|
[name: string]: unknown;
|
|
@@ -17896,31 +18421,43 @@ export interface operations {
|
|
|
17896
18421
|
listGrants: {
|
|
17897
18422
|
parameters: {
|
|
17898
18423
|
query?: {
|
|
17899
|
-
/**
|
|
18424
|
+
/**
|
|
18425
|
+
* @description Filtering by multiple features.
|
|
17900
18426
|
*
|
|
17901
|
-
* Usage: `?feature=feature-1&feature=feature-2`
|
|
18427
|
+
* Usage: `?feature=feature-1&feature=feature-2`
|
|
18428
|
+
*/
|
|
17902
18429
|
feature?: string[];
|
|
17903
|
-
/**
|
|
18430
|
+
/**
|
|
18431
|
+
* @description Filtering by multiple subjects.
|
|
17904
18432
|
*
|
|
17905
|
-
* Usage: `?subject=customer-1&subject=customer-2`
|
|
18433
|
+
* Usage: `?subject=customer-1&subject=customer-2`
|
|
18434
|
+
*/
|
|
17906
18435
|
subject?: string[];
|
|
17907
18436
|
/** @description Include deleted */
|
|
17908
18437
|
includeDeleted?: boolean;
|
|
17909
|
-
/**
|
|
18438
|
+
/**
|
|
18439
|
+
* @description Page index.
|
|
17910
18440
|
*
|
|
17911
|
-
* Default is 1.
|
|
18441
|
+
* Default is 1.
|
|
18442
|
+
*/
|
|
17912
18443
|
page?: components['parameters']['Pagination.page'];
|
|
17913
|
-
/**
|
|
18444
|
+
/**
|
|
18445
|
+
* @description The maximum number of items per page.
|
|
17914
18446
|
*
|
|
17915
|
-
* Default is 100.
|
|
18447
|
+
* Default is 100.
|
|
18448
|
+
*/
|
|
17916
18449
|
pageSize?: components['parameters']['Pagination.pageSize'];
|
|
17917
|
-
/**
|
|
18450
|
+
/**
|
|
18451
|
+
* @description Number of items to skip.
|
|
17918
18452
|
*
|
|
17919
|
-
* Default is 0.
|
|
18453
|
+
* Default is 0.
|
|
18454
|
+
*/
|
|
17920
18455
|
offset?: components['parameters']['LimitOffset.offset'];
|
|
17921
|
-
/**
|
|
18456
|
+
/**
|
|
18457
|
+
* @description Number of items to return.
|
|
17922
18458
|
*
|
|
17923
|
-
* Default is 100.
|
|
18459
|
+
* Default is 100.
|
|
18460
|
+
*/
|
|
17924
18461
|
limit?: components['parameters']['LimitOffset.limit'];
|
|
17925
18462
|
/** @description The order direction. */
|
|
17926
18463
|
order?: components['parameters']['GrantOrderByOrdering.order'];
|
|
@@ -18018,7 +18555,7 @@ export interface operations {
|
|
|
18018
18555
|
};
|
|
18019
18556
|
requestBody?: never;
|
|
18020
18557
|
responses: {
|
|
18021
|
-
/** @description There is no content to send for this request, but the headers may be useful.
|
|
18558
|
+
/** @description There is no content to send for this request, but the headers may be useful. */
|
|
18022
18559
|
204: {
|
|
18023
18560
|
headers: {
|
|
18024
18561
|
[name: string]: unknown;
|
|
@@ -18288,13 +18825,17 @@ export interface operations {
|
|
|
18288
18825
|
listMarketplaceListings: {
|
|
18289
18826
|
parameters: {
|
|
18290
18827
|
query?: {
|
|
18291
|
-
/**
|
|
18828
|
+
/**
|
|
18829
|
+
* @description Page index.
|
|
18292
18830
|
*
|
|
18293
|
-
* Default is 1.
|
|
18831
|
+
* Default is 1.
|
|
18832
|
+
*/
|
|
18294
18833
|
page?: components['parameters']['Pagination.page'];
|
|
18295
|
-
/**
|
|
18834
|
+
/**
|
|
18835
|
+
* @description The maximum number of items per page.
|
|
18296
18836
|
*
|
|
18297
|
-
* Default is 100.
|
|
18837
|
+
* Default is 100.
|
|
18838
|
+
*/
|
|
18298
18839
|
pageSize?: components['parameters']['Pagination.pageSize'];
|
|
18299
18840
|
};
|
|
18300
18841
|
header?: never;
|
|
@@ -18565,9 +19106,11 @@ export interface operations {
|
|
|
18565
19106
|
requestBody: {
|
|
18566
19107
|
content: {
|
|
18567
19108
|
'application/json': {
|
|
18568
|
-
/**
|
|
19109
|
+
/**
|
|
19110
|
+
* @description Name of the application to install.
|
|
18569
19111
|
*
|
|
18570
|
-
* If name is not provided defaults to the marketplace listing's name.
|
|
19112
|
+
* If name is not provided defaults to the marketplace listing's name.
|
|
19113
|
+
*/
|
|
18571
19114
|
name?: string;
|
|
18572
19115
|
/**
|
|
18573
19116
|
* @description If true, a billing profile will be created for the app.
|
|
@@ -18575,8 +19118,10 @@ export interface operations {
|
|
|
18575
19118
|
* @default true
|
|
18576
19119
|
*/
|
|
18577
19120
|
createBillingProfile?: boolean;
|
|
18578
|
-
/**
|
|
18579
|
-
*
|
|
19121
|
+
/**
|
|
19122
|
+
* @description The API key for the provider.
|
|
19123
|
+
* For example, the Stripe API key.
|
|
19124
|
+
*/
|
|
18580
19125
|
apiKey: string;
|
|
18581
19126
|
};
|
|
18582
19127
|
};
|
|
@@ -18744,24 +19289,34 @@ export interface operations {
|
|
|
18744
19289
|
marketplaceOAuth2InstallAuthorize: {
|
|
18745
19290
|
parameters: {
|
|
18746
19291
|
query?: {
|
|
18747
|
-
/**
|
|
19292
|
+
/**
|
|
19293
|
+
* @description Required if the "state" parameter was present in the client authorization request.
|
|
18748
19294
|
* The exact value received from the client:
|
|
18749
19295
|
*
|
|
18750
19296
|
* Unique, randomly generated, opaque, and non-guessable string that is sent
|
|
18751
|
-
* when starting an authentication request and validated when processing the response.
|
|
19297
|
+
* when starting an authentication request and validated when processing the response.
|
|
19298
|
+
*/
|
|
18752
19299
|
state?: components['parameters']['OAuth2AuthorizationCodeGrantSuccessParams.state'];
|
|
18753
|
-
/**
|
|
18754
|
-
*
|
|
19300
|
+
/**
|
|
19301
|
+
* @description Authorization code which the client will later exchange for an access token.
|
|
19302
|
+
* Required with the success response.
|
|
19303
|
+
*/
|
|
18755
19304
|
code?: components['parameters']['OAuth2AuthorizationCodeGrantSuccessParams.code'];
|
|
18756
|
-
/**
|
|
18757
|
-
*
|
|
19305
|
+
/**
|
|
19306
|
+
* @description Error code.
|
|
19307
|
+
* Required with the error response.
|
|
19308
|
+
*/
|
|
18758
19309
|
error?: components['parameters']['OAuth2AuthorizationCodeGrantErrorParams.error'];
|
|
18759
|
-
/**
|
|
18760
|
-
*
|
|
19310
|
+
/**
|
|
19311
|
+
* @description Optional human-readable text providing additional information,
|
|
19312
|
+
* used to assist the client developer in understanding the error that occurred.
|
|
19313
|
+
*/
|
|
18761
19314
|
error_description?: components['parameters']['OAuth2AuthorizationCodeGrantErrorParams.error_description'];
|
|
18762
|
-
/**
|
|
19315
|
+
/**
|
|
19316
|
+
* @description Optional uri identifying a human-readable web page with
|
|
18763
19317
|
* information about the error, used to provide the client
|
|
18764
|
-
* developer with additional information about the error
|
|
19318
|
+
* developer with additional information about the error
|
|
19319
|
+
*/
|
|
18765
19320
|
error_uri?: components['parameters']['OAuth2AuthorizationCodeGrantErrorParams.error_uri'];
|
|
18766
19321
|
};
|
|
18767
19322
|
header?: never;
|
|
@@ -18848,13 +19403,17 @@ export interface operations {
|
|
|
18848
19403
|
listMeters: {
|
|
18849
19404
|
parameters: {
|
|
18850
19405
|
query?: {
|
|
18851
|
-
/**
|
|
19406
|
+
/**
|
|
19407
|
+
* @description Page index.
|
|
18852
19408
|
*
|
|
18853
|
-
* Default is 1.
|
|
19409
|
+
* Default is 1.
|
|
19410
|
+
*/
|
|
18854
19411
|
page?: components['parameters']['Pagination.page'];
|
|
18855
|
-
/**
|
|
19412
|
+
/**
|
|
19413
|
+
* @description The maximum number of items per page.
|
|
18856
19414
|
*
|
|
18857
|
-
* Default is 100.
|
|
19415
|
+
* Default is 100.
|
|
19416
|
+
*/
|
|
18858
19417
|
pageSize?: components['parameters']['Pagination.pageSize'];
|
|
18859
19418
|
/** @description The order direction. */
|
|
18860
19419
|
order?: components['parameters']['MeterOrderByOrdering.order'];
|
|
@@ -19224,7 +19783,7 @@ export interface operations {
|
|
|
19224
19783
|
};
|
|
19225
19784
|
requestBody?: never;
|
|
19226
19785
|
responses: {
|
|
19227
|
-
/** @description There is no content to send for this request, but the headers may be useful.
|
|
19786
|
+
/** @description There is no content to send for this request, but the headers may be useful. */
|
|
19228
19787
|
204: {
|
|
19229
19788
|
headers: {
|
|
19230
19789
|
[name: string]: unknown;
|
|
@@ -19299,17 +19858,21 @@ export interface operations {
|
|
|
19299
19858
|
listMeterGroupByValues: {
|
|
19300
19859
|
parameters: {
|
|
19301
19860
|
query?: {
|
|
19302
|
-
/**
|
|
19861
|
+
/**
|
|
19862
|
+
* @description Start date-time in RFC 3339 format.
|
|
19303
19863
|
*
|
|
19304
19864
|
* Inclusive. Defaults to 24 hours ago.
|
|
19305
19865
|
*
|
|
19306
|
-
* For example: ?from=2025-01-01T00%3A00%3A00.000Z
|
|
19866
|
+
* For example: ?from=2025-01-01T00%3A00%3A00.000Z
|
|
19867
|
+
*/
|
|
19307
19868
|
from?: Date | string;
|
|
19308
|
-
/**
|
|
19869
|
+
/**
|
|
19870
|
+
* @description End date-time in RFC 3339 format.
|
|
19309
19871
|
*
|
|
19310
19872
|
* Inclusive.
|
|
19311
19873
|
*
|
|
19312
|
-
* For example: ?to=2025-02-01T00%3A00%3A00.000Z
|
|
19874
|
+
* For example: ?to=2025-02-01T00%3A00%3A00.000Z
|
|
19875
|
+
*/
|
|
19313
19876
|
to?: Date | string;
|
|
19314
19877
|
};
|
|
19315
19878
|
header?: never;
|
|
@@ -19398,52 +19961,72 @@ export interface operations {
|
|
|
19398
19961
|
queryMeter: {
|
|
19399
19962
|
parameters: {
|
|
19400
19963
|
query?: {
|
|
19401
|
-
/**
|
|
19402
|
-
*
|
|
19964
|
+
/**
|
|
19965
|
+
* @description Client ID
|
|
19966
|
+
* Useful to track progress of a query.
|
|
19967
|
+
*/
|
|
19403
19968
|
clientId?: components['parameters']['MeterQuery.clientId'];
|
|
19404
|
-
/**
|
|
19969
|
+
/**
|
|
19970
|
+
* @description Start date-time in RFC 3339 format.
|
|
19405
19971
|
*
|
|
19406
19972
|
* Inclusive.
|
|
19407
19973
|
*
|
|
19408
|
-
* For example: ?from=2025-01-01T00%3A00%3A00.000Z
|
|
19974
|
+
* For example: ?from=2025-01-01T00%3A00%3A00.000Z
|
|
19975
|
+
*/
|
|
19409
19976
|
from?: components['parameters']['MeterQuery.from'];
|
|
19410
|
-
/**
|
|
19977
|
+
/**
|
|
19978
|
+
* @description End date-time in RFC 3339 format.
|
|
19411
19979
|
*
|
|
19412
19980
|
* Inclusive.
|
|
19413
19981
|
*
|
|
19414
|
-
* For example: ?to=2025-02-01T00%3A00%3A00.000Z
|
|
19982
|
+
* For example: ?to=2025-02-01T00%3A00%3A00.000Z
|
|
19983
|
+
*/
|
|
19415
19984
|
to?: components['parameters']['MeterQuery.to'];
|
|
19416
|
-
/**
|
|
19985
|
+
/**
|
|
19986
|
+
* @description If not specified, a single usage aggregate will be returned for the entirety of the specified period for each subject and group.
|
|
19417
19987
|
*
|
|
19418
|
-
* For example: ?windowSize=DAY
|
|
19988
|
+
* For example: ?windowSize=DAY
|
|
19989
|
+
*/
|
|
19419
19990
|
windowSize?: components['parameters']['MeterQuery.windowSize'];
|
|
19420
|
-
/**
|
|
19991
|
+
/**
|
|
19992
|
+
* @description The value is the name of the time zone as defined in the IANA Time Zone Database (http://www.iana.org/time-zones).
|
|
19421
19993
|
* If not specified, the UTC timezone will be used.
|
|
19422
19994
|
*
|
|
19423
|
-
* For example: ?windowTimeZone=UTC
|
|
19995
|
+
* For example: ?windowTimeZone=UTC
|
|
19996
|
+
*/
|
|
19424
19997
|
windowTimeZone?: components['parameters']['MeterQuery.windowTimeZone'];
|
|
19425
|
-
/**
|
|
19998
|
+
/**
|
|
19999
|
+
* @description Filtering by multiple subjects.
|
|
19426
20000
|
*
|
|
19427
|
-
* For example: ?subject=subject-1&subject=subject-2
|
|
20001
|
+
* For example: ?subject=subject-1&subject=subject-2
|
|
20002
|
+
*/
|
|
19428
20003
|
subject?: components['parameters']['MeterQuery.subject'];
|
|
19429
|
-
/**
|
|
20004
|
+
/**
|
|
20005
|
+
* @description Filtering by multiple customers.
|
|
19430
20006
|
*
|
|
19431
|
-
* For example: ?filterCustomerId=customer-1&filterCustomerId=customer-2
|
|
20007
|
+
* For example: ?filterCustomerId=customer-1&filterCustomerId=customer-2
|
|
20008
|
+
*/
|
|
19432
20009
|
filterCustomerId?: components['parameters']['MeterQuery.filterCustomerId'];
|
|
19433
20010
|
/**
|
|
19434
20011
|
* @deprecated
|
|
19435
20012
|
* @description Simple filter for group bys with exact match.
|
|
19436
20013
|
*
|
|
19437
20014
|
* For example: ?filterGroupBy[vendor]=openai&filterGroupBy[model]=gpt-4-turbo
|
|
20015
|
+
*
|
|
20016
|
+
* ⚠️ __Deprecated__: Use `advancedMeterGroupByFilters` instead
|
|
19438
20017
|
*/
|
|
19439
20018
|
filterGroupBy?: components['parameters']['MeterQuery.filterGroupBy'];
|
|
19440
|
-
/**
|
|
19441
|
-
*
|
|
20019
|
+
/**
|
|
20020
|
+
* @description Optional advanced meter group by filters.
|
|
20021
|
+
* You can use this to filter for values of the meter groupBy fields.
|
|
20022
|
+
*/
|
|
19442
20023
|
advancedMeterGroupByFilters?: components['parameters']['MeterQuery.advancedMeterGroupByFilters'];
|
|
19443
|
-
/**
|
|
20024
|
+
/**
|
|
20025
|
+
* @description If not specified a single aggregate will be returned for each subject and time window.
|
|
19444
20026
|
* `subject` is a reserved group by value.
|
|
19445
20027
|
*
|
|
19446
|
-
* For example: ?groupBy=subject&groupBy=model
|
|
20028
|
+
* For example: ?groupBy=subject&groupBy=model
|
|
20029
|
+
*/
|
|
19447
20030
|
groupBy?: components['parameters']['MeterQuery.groupBy'];
|
|
19448
20031
|
};
|
|
19449
20032
|
header?: never;
|
|
@@ -19639,17 +20222,21 @@ export interface operations {
|
|
|
19639
20222
|
listMeterSubjects: {
|
|
19640
20223
|
parameters: {
|
|
19641
20224
|
query?: {
|
|
19642
|
-
/**
|
|
20225
|
+
/**
|
|
20226
|
+
* @description Start date-time in RFC 3339 format.
|
|
19643
20227
|
*
|
|
19644
20228
|
* Inclusive. Defaults to the beginning of time.
|
|
19645
20229
|
*
|
|
19646
|
-
* For example: ?from=2025-01-01T00%3A00%3A00.000Z
|
|
20230
|
+
* For example: ?from=2025-01-01T00%3A00%3A00.000Z
|
|
20231
|
+
*/
|
|
19647
20232
|
from?: Date | string;
|
|
19648
|
-
/**
|
|
20233
|
+
/**
|
|
20234
|
+
* @description End date-time in RFC 3339 format.
|
|
19649
20235
|
*
|
|
19650
20236
|
* Inclusive.
|
|
19651
20237
|
*
|
|
19652
|
-
* For example: ?to=2025-02-01T00%3A00%3A00.000Z
|
|
20238
|
+
* For example: ?to=2025-02-01T00%3A00%3A00.000Z
|
|
20239
|
+
*/
|
|
19653
20240
|
to?: Date | string;
|
|
19654
20241
|
};
|
|
19655
20242
|
header?: never;
|
|
@@ -19737,21 +20324,29 @@ export interface operations {
|
|
|
19737
20324
|
listNotificationChannels: {
|
|
19738
20325
|
parameters: {
|
|
19739
20326
|
query?: {
|
|
19740
|
-
/**
|
|
20327
|
+
/**
|
|
20328
|
+
* @description Include deleted notification channels in response.
|
|
19741
20329
|
*
|
|
19742
|
-
* Usage: `?includeDeleted=true`
|
|
20330
|
+
* Usage: `?includeDeleted=true`
|
|
20331
|
+
*/
|
|
19743
20332
|
includeDeleted?: boolean;
|
|
19744
|
-
/**
|
|
20333
|
+
/**
|
|
20334
|
+
* @description Include disabled notification channels in response.
|
|
19745
20335
|
*
|
|
19746
|
-
* Usage: `?includeDisabled=false`
|
|
20336
|
+
* Usage: `?includeDisabled=false`
|
|
20337
|
+
*/
|
|
19747
20338
|
includeDisabled?: boolean;
|
|
19748
|
-
/**
|
|
20339
|
+
/**
|
|
20340
|
+
* @description Page index.
|
|
19749
20341
|
*
|
|
19750
|
-
* Default is 1.
|
|
20342
|
+
* Default is 1.
|
|
20343
|
+
*/
|
|
19751
20344
|
page?: components['parameters']['Pagination.page'];
|
|
19752
|
-
/**
|
|
20345
|
+
/**
|
|
20346
|
+
* @description The maximum number of items per page.
|
|
19753
20347
|
*
|
|
19754
|
-
* Default is 100.
|
|
20348
|
+
* Default is 100.
|
|
20349
|
+
*/
|
|
19755
20350
|
pageSize?: components['parameters']['Pagination.pageSize'];
|
|
19756
20351
|
/** @description The order direction. */
|
|
19757
20352
|
order?: components['parameters']['NotificationChannelOrderByOrdering.order'];
|
|
@@ -20128,7 +20723,7 @@ export interface operations {
|
|
|
20128
20723
|
};
|
|
20129
20724
|
requestBody?: never;
|
|
20130
20725
|
responses: {
|
|
20131
|
-
/** @description There is no content to send for this request, but the headers may be useful.
|
|
20726
|
+
/** @description There is no content to send for this request, but the headers may be useful. */
|
|
20132
20727
|
204: {
|
|
20133
20728
|
headers: {
|
|
20134
20729
|
[name: string]: unknown;
|
|
@@ -20212,35 +20807,51 @@ export interface operations {
|
|
|
20212
20807
|
listNotificationEvents: {
|
|
20213
20808
|
parameters: {
|
|
20214
20809
|
query?: {
|
|
20215
|
-
/**
|
|
20216
|
-
*
|
|
20810
|
+
/**
|
|
20811
|
+
* @description Start date-time in RFC 3339 format.
|
|
20812
|
+
* Inclusive.
|
|
20813
|
+
*/
|
|
20217
20814
|
from?: Date | string;
|
|
20218
|
-
/**
|
|
20219
|
-
*
|
|
20815
|
+
/**
|
|
20816
|
+
* @description End date-time in RFC 3339 format.
|
|
20817
|
+
* Inclusive.
|
|
20818
|
+
*/
|
|
20220
20819
|
to?: Date | string;
|
|
20221
|
-
/**
|
|
20820
|
+
/**
|
|
20821
|
+
* @description Filtering by multiple feature ids or keys.
|
|
20222
20822
|
*
|
|
20223
|
-
* Usage: `?feature=feature-1&feature=feature-2`
|
|
20823
|
+
* Usage: `?feature=feature-1&feature=feature-2`
|
|
20824
|
+
*/
|
|
20224
20825
|
feature?: string[];
|
|
20225
|
-
/**
|
|
20826
|
+
/**
|
|
20827
|
+
* @description Filtering by multiple subject ids or keys.
|
|
20226
20828
|
*
|
|
20227
|
-
* Usage: `?subject=subject-1&subject=subject-2`
|
|
20829
|
+
* Usage: `?subject=subject-1&subject=subject-2`
|
|
20830
|
+
*/
|
|
20228
20831
|
subject?: string[];
|
|
20229
|
-
/**
|
|
20832
|
+
/**
|
|
20833
|
+
* @description Filtering by multiple rule ids.
|
|
20230
20834
|
*
|
|
20231
|
-
* Usage: `?rule=01J8J2XYZ2N5WBYK09EDZFBSZM&rule=01J8J4R4VZH180KRKQ63NB2VA5`
|
|
20835
|
+
* Usage: `?rule=01J8J2XYZ2N5WBYK09EDZFBSZM&rule=01J8J4R4VZH180KRKQ63NB2VA5`
|
|
20836
|
+
*/
|
|
20232
20837
|
rule?: string[];
|
|
20233
|
-
/**
|
|
20838
|
+
/**
|
|
20839
|
+
* @description Filtering by multiple channel ids.
|
|
20234
20840
|
*
|
|
20235
|
-
* Usage: `?channel=01J8J4RXH778XB056JS088PCYT&channel=01J8J4S1R1G9EVN62RG23A9M6J`
|
|
20841
|
+
* Usage: `?channel=01J8J4RXH778XB056JS088PCYT&channel=01J8J4S1R1G9EVN62RG23A9M6J`
|
|
20842
|
+
*/
|
|
20236
20843
|
channel?: string[];
|
|
20237
|
-
/**
|
|
20844
|
+
/**
|
|
20845
|
+
* @description Page index.
|
|
20238
20846
|
*
|
|
20239
|
-
* Default is 1.
|
|
20847
|
+
* Default is 1.
|
|
20848
|
+
*/
|
|
20240
20849
|
page?: components['parameters']['Pagination.page'];
|
|
20241
|
-
/**
|
|
20850
|
+
/**
|
|
20851
|
+
* @description The maximum number of items per page.
|
|
20242
20852
|
*
|
|
20243
|
-
* Default is 100.
|
|
20853
|
+
* Default is 100.
|
|
20854
|
+
*/
|
|
20244
20855
|
pageSize?: components['parameters']['Pagination.pageSize'];
|
|
20245
20856
|
/** @description The order direction. */
|
|
20246
20857
|
order?: components['parameters']['NotificationEventOrderByOrdering.order'];
|
|
@@ -20520,29 +21131,41 @@ export interface operations {
|
|
|
20520
21131
|
listNotificationRules: {
|
|
20521
21132
|
parameters: {
|
|
20522
21133
|
query?: {
|
|
20523
|
-
/**
|
|
21134
|
+
/**
|
|
21135
|
+
* @description Include deleted notification rules in response.
|
|
20524
21136
|
*
|
|
20525
|
-
* Usage: `?includeDeleted=true`
|
|
21137
|
+
* Usage: `?includeDeleted=true`
|
|
21138
|
+
*/
|
|
20526
21139
|
includeDeleted?: boolean;
|
|
20527
|
-
/**
|
|
21140
|
+
/**
|
|
21141
|
+
* @description Include disabled notification rules in response.
|
|
20528
21142
|
*
|
|
20529
|
-
* Usage: `?includeDisabled=false`
|
|
21143
|
+
* Usage: `?includeDisabled=false`
|
|
21144
|
+
*/
|
|
20530
21145
|
includeDisabled?: boolean;
|
|
20531
|
-
/**
|
|
21146
|
+
/**
|
|
21147
|
+
* @description Filtering by multiple feature ids/keys.
|
|
20532
21148
|
*
|
|
20533
|
-
* Usage: `?feature=feature-1&feature=feature-2`
|
|
21149
|
+
* Usage: `?feature=feature-1&feature=feature-2`
|
|
21150
|
+
*/
|
|
20534
21151
|
feature?: string[];
|
|
20535
|
-
/**
|
|
21152
|
+
/**
|
|
21153
|
+
* @description Filtering by multiple notifiaction channel ids.
|
|
20536
21154
|
*
|
|
20537
|
-
* Usage: `?channel=01ARZ3NDEKTSV4RRFFQ69G5FAV&channel=01J8J2Y5X4NNGQS32CF81W95E3`
|
|
21155
|
+
* Usage: `?channel=01ARZ3NDEKTSV4RRFFQ69G5FAV&channel=01J8J2Y5X4NNGQS32CF81W95E3`
|
|
21156
|
+
*/
|
|
20538
21157
|
channel?: string[];
|
|
20539
|
-
/**
|
|
21158
|
+
/**
|
|
21159
|
+
* @description Page index.
|
|
20540
21160
|
*
|
|
20541
|
-
* Default is 1.
|
|
21161
|
+
* Default is 1.
|
|
21162
|
+
*/
|
|
20542
21163
|
page?: components['parameters']['Pagination.page'];
|
|
20543
|
-
/**
|
|
21164
|
+
/**
|
|
21165
|
+
* @description The maximum number of items per page.
|
|
20544
21166
|
*
|
|
20545
|
-
* Default is 100.
|
|
21167
|
+
* Default is 100.
|
|
21168
|
+
*/
|
|
20546
21169
|
pageSize?: components['parameters']['Pagination.pageSize'];
|
|
20547
21170
|
/** @description The order direction. */
|
|
20548
21171
|
order?: components['parameters']['NotificationRuleOrderByOrdering.order'];
|
|
@@ -20919,7 +21542,7 @@ export interface operations {
|
|
|
20919
21542
|
};
|
|
20920
21543
|
requestBody?: never;
|
|
20921
21544
|
responses: {
|
|
20922
|
-
/** @description There is no content to send for this request, but the headers may be useful.
|
|
21545
|
+
/** @description There is no content to send for this request, but the headers may be useful. */
|
|
20923
21546
|
204: {
|
|
20924
21547
|
headers: {
|
|
20925
21548
|
[name: string]: unknown;
|
|
@@ -21097,9 +21720,11 @@ export interface operations {
|
|
|
21097
21720
|
listPlans: {
|
|
21098
21721
|
parameters: {
|
|
21099
21722
|
query?: {
|
|
21100
|
-
/**
|
|
21723
|
+
/**
|
|
21724
|
+
* @description Include deleted plans in response.
|
|
21101
21725
|
*
|
|
21102
|
-
* Usage: `?includeDeleted=true`
|
|
21726
|
+
* Usage: `?includeDeleted=true`
|
|
21727
|
+
*/
|
|
21103
21728
|
includeDeleted?: boolean;
|
|
21104
21729
|
/** @description Filter by plan.id attribute */
|
|
21105
21730
|
id?: string[];
|
|
@@ -21109,22 +21734,28 @@ export interface operations {
|
|
|
21109
21734
|
keyVersion?: {
|
|
21110
21735
|
[key: string]: number[];
|
|
21111
21736
|
};
|
|
21112
|
-
/**
|
|
21737
|
+
/**
|
|
21738
|
+
* @description Only return plans with the given status.
|
|
21113
21739
|
*
|
|
21114
21740
|
* Usage:
|
|
21115
21741
|
* - `?status=active`: return only the currently active plan
|
|
21116
21742
|
* - `?status=draft`: return only the draft plan
|
|
21117
|
-
* - `?status=archived`: return only the archived plans
|
|
21743
|
+
* - `?status=archived`: return only the archived plans
|
|
21744
|
+
*/
|
|
21118
21745
|
status?: components['schemas']['PlanStatus'][];
|
|
21119
21746
|
/** @description Filter by plan.currency attribute */
|
|
21120
21747
|
currency?: components['schemas']['CurrencyCode'][];
|
|
21121
|
-
/**
|
|
21748
|
+
/**
|
|
21749
|
+
* @description Page index.
|
|
21122
21750
|
*
|
|
21123
|
-
* Default is 1.
|
|
21751
|
+
* Default is 1.
|
|
21752
|
+
*/
|
|
21124
21753
|
page?: components['parameters']['Pagination.page'];
|
|
21125
|
-
/**
|
|
21754
|
+
/**
|
|
21755
|
+
* @description The maximum number of items per page.
|
|
21126
21756
|
*
|
|
21127
|
-
* Default is 100.
|
|
21757
|
+
* Default is 100.
|
|
21758
|
+
*/
|
|
21128
21759
|
pageSize?: components['parameters']['Pagination.pageSize'];
|
|
21129
21760
|
/** @description The order direction. */
|
|
21130
21761
|
order?: components['parameters']['PlanOrderByOrdering.order'];
|
|
@@ -21395,9 +22026,11 @@ export interface operations {
|
|
|
21395
22026
|
getPlan: {
|
|
21396
22027
|
parameters: {
|
|
21397
22028
|
query?: {
|
|
21398
|
-
/**
|
|
22029
|
+
/**
|
|
22030
|
+
* @description Include latest version of the Plan instead of the version in active state.
|
|
21399
22031
|
*
|
|
21400
|
-
* Usage: `?includeLatest=true`
|
|
22032
|
+
* Usage: `?includeLatest=true`
|
|
22033
|
+
*/
|
|
21401
22034
|
includeLatest?: boolean;
|
|
21402
22035
|
};
|
|
21403
22036
|
header?: never;
|
|
@@ -21600,7 +22233,7 @@ export interface operations {
|
|
|
21600
22233
|
};
|
|
21601
22234
|
requestBody?: never;
|
|
21602
22235
|
responses: {
|
|
21603
|
-
/** @description There is no content to send for this request, but the headers may be useful.
|
|
22236
|
+
/** @description There is no content to send for this request, but the headers may be useful. */
|
|
21604
22237
|
204: {
|
|
21605
22238
|
headers: {
|
|
21606
22239
|
[name: string]: unknown;
|
|
@@ -21684,9 +22317,11 @@ export interface operations {
|
|
|
21684
22317
|
listPlanAddons: {
|
|
21685
22318
|
parameters: {
|
|
21686
22319
|
query?: {
|
|
21687
|
-
/**
|
|
22320
|
+
/**
|
|
22321
|
+
* @description Include deleted plan add-on assignments.
|
|
21688
22322
|
*
|
|
21689
|
-
* Usage: `?includeDeleted=true`
|
|
22323
|
+
* Usage: `?includeDeleted=true`
|
|
22324
|
+
*/
|
|
21690
22325
|
includeDeleted?: boolean;
|
|
21691
22326
|
/** @description Filter by addon.id attribute. */
|
|
21692
22327
|
id?: string[];
|
|
@@ -21696,13 +22331,17 @@ export interface operations {
|
|
|
21696
22331
|
keyVersion?: {
|
|
21697
22332
|
[key: string]: number[];
|
|
21698
22333
|
};
|
|
21699
|
-
/**
|
|
22334
|
+
/**
|
|
22335
|
+
* @description Page index.
|
|
21700
22336
|
*
|
|
21701
|
-
* Default is 1.
|
|
22337
|
+
* Default is 1.
|
|
22338
|
+
*/
|
|
21702
22339
|
page?: components['parameters']['Pagination.page'];
|
|
21703
|
-
/**
|
|
22340
|
+
/**
|
|
22341
|
+
* @description The maximum number of items per page.
|
|
21704
22342
|
*
|
|
21705
|
-
* Default is 100.
|
|
22343
|
+
* Default is 100.
|
|
22344
|
+
*/
|
|
21706
22345
|
pageSize?: components['parameters']['Pagination.pageSize'];
|
|
21707
22346
|
/** @description The order direction. */
|
|
21708
22347
|
order?: components['parameters']['PlanAddonOrderByOrdering.order'];
|
|
@@ -22113,7 +22752,7 @@ export interface operations {
|
|
|
22113
22752
|
};
|
|
22114
22753
|
requestBody?: never;
|
|
22115
22754
|
responses: {
|
|
22116
|
-
/** @description There is no content to send for this request, but the headers may be useful.
|
|
22755
|
+
/** @description There is no content to send for this request, but the headers may be useful. */
|
|
22117
22756
|
204: {
|
|
22118
22757
|
headers: {
|
|
22119
22758
|
[name: string]: unknown;
|
|
@@ -22385,48 +23024,66 @@ export interface operations {
|
|
|
22385
23024
|
queryPortalMeter: {
|
|
22386
23025
|
parameters: {
|
|
22387
23026
|
query?: {
|
|
22388
|
-
/**
|
|
22389
|
-
*
|
|
23027
|
+
/**
|
|
23028
|
+
* @description Client ID
|
|
23029
|
+
* Useful to track progress of a query.
|
|
23030
|
+
*/
|
|
22390
23031
|
clientId?: components['parameters']['MeterQuery.clientId'];
|
|
22391
|
-
/**
|
|
23032
|
+
/**
|
|
23033
|
+
* @description Start date-time in RFC 3339 format.
|
|
22392
23034
|
*
|
|
22393
23035
|
* Inclusive.
|
|
22394
23036
|
*
|
|
22395
|
-
* For example: ?from=2025-01-01T00%3A00%3A00.000Z
|
|
23037
|
+
* For example: ?from=2025-01-01T00%3A00%3A00.000Z
|
|
23038
|
+
*/
|
|
22396
23039
|
from?: components['parameters']['MeterQuery.from'];
|
|
22397
|
-
/**
|
|
23040
|
+
/**
|
|
23041
|
+
* @description End date-time in RFC 3339 format.
|
|
22398
23042
|
*
|
|
22399
23043
|
* Inclusive.
|
|
22400
23044
|
*
|
|
22401
|
-
* For example: ?to=2025-02-01T00%3A00%3A00.000Z
|
|
23045
|
+
* For example: ?to=2025-02-01T00%3A00%3A00.000Z
|
|
23046
|
+
*/
|
|
22402
23047
|
to?: components['parameters']['MeterQuery.to'];
|
|
22403
|
-
/**
|
|
23048
|
+
/**
|
|
23049
|
+
* @description If not specified, a single usage aggregate will be returned for the entirety of the specified period for each subject and group.
|
|
22404
23050
|
*
|
|
22405
|
-
* For example: ?windowSize=DAY
|
|
23051
|
+
* For example: ?windowSize=DAY
|
|
23052
|
+
*/
|
|
22406
23053
|
windowSize?: components['parameters']['MeterQuery.windowSize'];
|
|
22407
|
-
/**
|
|
23054
|
+
/**
|
|
23055
|
+
* @description The value is the name of the time zone as defined in the IANA Time Zone Database (http://www.iana.org/time-zones).
|
|
22408
23056
|
* If not specified, the UTC timezone will be used.
|
|
22409
23057
|
*
|
|
22410
|
-
* For example: ?windowTimeZone=UTC
|
|
23058
|
+
* For example: ?windowTimeZone=UTC
|
|
23059
|
+
*/
|
|
22411
23060
|
windowTimeZone?: components['parameters']['MeterQuery.windowTimeZone'];
|
|
22412
|
-
/**
|
|
23061
|
+
/**
|
|
23062
|
+
* @description Filtering by multiple customers.
|
|
22413
23063
|
*
|
|
22414
|
-
* For example: ?filterCustomerId=customer-1&filterCustomerId=customer-2
|
|
23064
|
+
* For example: ?filterCustomerId=customer-1&filterCustomerId=customer-2
|
|
23065
|
+
*/
|
|
22415
23066
|
filterCustomerId?: components['parameters']['MeterQuery.filterCustomerId'];
|
|
22416
23067
|
/**
|
|
22417
23068
|
* @deprecated
|
|
22418
23069
|
* @description Simple filter for group bys with exact match.
|
|
22419
23070
|
*
|
|
22420
23071
|
* For example: ?filterGroupBy[vendor]=openai&filterGroupBy[model]=gpt-4-turbo
|
|
23072
|
+
*
|
|
23073
|
+
* ⚠️ __Deprecated__: Use `advancedMeterGroupByFilters` instead
|
|
22421
23074
|
*/
|
|
22422
23075
|
filterGroupBy?: components['parameters']['MeterQuery.filterGroupBy'];
|
|
22423
|
-
/**
|
|
22424
|
-
*
|
|
23076
|
+
/**
|
|
23077
|
+
* @description Optional advanced meter group by filters.
|
|
23078
|
+
* You can use this to filter for values of the meter groupBy fields.
|
|
23079
|
+
*/
|
|
22425
23080
|
advancedMeterGroupByFilters?: components['parameters']['MeterQuery.advancedMeterGroupByFilters'];
|
|
22426
|
-
/**
|
|
23081
|
+
/**
|
|
23082
|
+
* @description If not specified a single aggregate will be returned for each subject and time window.
|
|
22427
23083
|
* `subject` is a reserved group by value.
|
|
22428
23084
|
*
|
|
22429
|
-
* For example: ?groupBy=subject&groupBy=model
|
|
23085
|
+
* For example: ?groupBy=subject&groupBy=model
|
|
23086
|
+
*/
|
|
22430
23087
|
groupBy?: components['parameters']['MeterQuery.groupBy'];
|
|
22431
23088
|
};
|
|
22432
23089
|
header?: never;
|
|
@@ -22711,7 +23368,7 @@ export interface operations {
|
|
|
22711
23368
|
};
|
|
22712
23369
|
};
|
|
22713
23370
|
responses: {
|
|
22714
|
-
/** @description There is no content to send for this request, but the headers may be useful.
|
|
23371
|
+
/** @description There is no content to send for this request, but the headers may be useful. */
|
|
22715
23372
|
204: {
|
|
22716
23373
|
headers: {
|
|
22717
23374
|
[name: string]: unknown;
|
|
@@ -23154,7 +23811,7 @@ export interface operations {
|
|
|
23154
23811
|
};
|
|
23155
23812
|
requestBody?: never;
|
|
23156
23813
|
responses: {
|
|
23157
|
-
/** @description There is no content to send for this request, but the headers may be useful.
|
|
23814
|
+
/** @description There is no content to send for this request, but the headers may be useful. */
|
|
23158
23815
|
204: {
|
|
23159
23816
|
headers: {
|
|
23160
23817
|
[name: string]: unknown;
|
|
@@ -23911,7 +24568,7 @@ export interface operations {
|
|
|
23911
24568
|
};
|
|
23912
24569
|
requestBody?: never;
|
|
23913
24570
|
responses: {
|
|
23914
|
-
/** @description There is no content to send for this request, but the headers may be useful.
|
|
24571
|
+
/** @description There is no content to send for this request, but the headers may be useful. */
|
|
23915
24572
|
204: {
|
|
23916
24573
|
headers: {
|
|
23917
24574
|
[name: string]: unknown;
|
|
@@ -23997,8 +24654,10 @@ export interface operations {
|
|
|
23997
24654
|
query: {
|
|
23998
24655
|
/** @description Start of time range to query entitlement: date-time in RFC 3339 format. Defaults to the last reset. Gets truncated to the granularity of the underlying meter. */
|
|
23999
24656
|
from?: Date | string;
|
|
24000
|
-
/**
|
|
24001
|
-
*
|
|
24657
|
+
/**
|
|
24658
|
+
* @description End of time range to query entitlement: date-time in RFC 3339 format. Defaults to now.
|
|
24659
|
+
* If not now then gets truncated to the granularity of the underlying meter.
|
|
24660
|
+
*/
|
|
24002
24661
|
to?: Date | string;
|
|
24003
24662
|
/** @description Windowsize */
|
|
24004
24663
|
windowSize: components['schemas']['WindowSize'];
|
|
@@ -24113,7 +24772,7 @@ export interface operations {
|
|
|
24113
24772
|
};
|
|
24114
24773
|
};
|
|
24115
24774
|
responses: {
|
|
24116
|
-
/** @description There is no content to send for this request, but the headers may be useful.
|
|
24775
|
+
/** @description There is no content to send for this request, but the headers may be useful. */
|
|
24117
24776
|
204: {
|
|
24118
24777
|
headers: {
|
|
24119
24778
|
[name: string]: unknown;
|
|
@@ -24243,8 +24902,10 @@ export interface operations {
|
|
|
24243
24902
|
'application/problem+json': components['schemas']['ForbiddenProblemResponse'];
|
|
24244
24903
|
};
|
|
24245
24904
|
};
|
|
24246
|
-
/**
|
|
24247
|
-
*
|
|
24905
|
+
/**
|
|
24906
|
+
* @description The request could not be completed due to a conflict with the current state of the target resource.
|
|
24907
|
+
* Variants with ErrorExtensions specific to subscriptions.
|
|
24908
|
+
*/
|
|
24248
24909
|
409: {
|
|
24249
24910
|
headers: {
|
|
24250
24911
|
[name: string]: unknown;
|
|
@@ -24399,7 +25060,7 @@ export interface operations {
|
|
|
24399
25060
|
};
|
|
24400
25061
|
requestBody?: never;
|
|
24401
25062
|
responses: {
|
|
24402
|
-
/** @description There is no content to send for this request, but the headers may be useful.
|
|
25063
|
+
/** @description There is no content to send for this request, but the headers may be useful. */
|
|
24403
25064
|
204: {
|
|
24404
25065
|
headers: {
|
|
24405
25066
|
[name: string]: unknown;
|
|
@@ -24442,8 +25103,10 @@ export interface operations {
|
|
|
24442
25103
|
'application/problem+json': components['schemas']['NotFoundProblemResponse'];
|
|
24443
25104
|
};
|
|
24444
25105
|
};
|
|
24445
|
-
/**
|
|
24446
|
-
*
|
|
25106
|
+
/**
|
|
25107
|
+
* @description The request could not be completed due to a conflict with the current state of the target resource.
|
|
25108
|
+
* Variants with ErrorExtensions specific to subscriptions.
|
|
25109
|
+
*/
|
|
24447
25110
|
409: {
|
|
24448
25111
|
headers: {
|
|
24449
25112
|
[name: string]: unknown;
|
|
@@ -24550,8 +25213,10 @@ export interface operations {
|
|
|
24550
25213
|
'application/problem+json': components['schemas']['NotFoundProblemResponse'];
|
|
24551
25214
|
};
|
|
24552
25215
|
};
|
|
24553
|
-
/**
|
|
24554
|
-
*
|
|
25216
|
+
/**
|
|
25217
|
+
* @description The request could not be completed due to a conflict with the current state of the target resource.
|
|
25218
|
+
* Variants with ErrorExtensions specific to subscriptions.
|
|
25219
|
+
*/
|
|
24555
25220
|
409: {
|
|
24556
25221
|
headers: {
|
|
24557
25222
|
[name: string]: unknown;
|
|
@@ -25056,8 +25721,10 @@ export interface operations {
|
|
|
25056
25721
|
'application/problem+json': components['schemas']['NotFoundProblemResponse'];
|
|
25057
25722
|
};
|
|
25058
25723
|
};
|
|
25059
|
-
/**
|
|
25060
|
-
*
|
|
25724
|
+
/**
|
|
25725
|
+
* @description The request could not be completed due to a conflict with the current state of the target resource.
|
|
25726
|
+
* Variants with ErrorExtensions specific to subscriptions.
|
|
25727
|
+
*/
|
|
25061
25728
|
409: {
|
|
25062
25729
|
headers: {
|
|
25063
25730
|
[name: string]: unknown;
|
|
@@ -25164,8 +25831,10 @@ export interface operations {
|
|
|
25164
25831
|
'application/problem+json': components['schemas']['NotFoundProblemResponse'];
|
|
25165
25832
|
};
|
|
25166
25833
|
};
|
|
25167
|
-
/**
|
|
25168
|
-
*
|
|
25834
|
+
/**
|
|
25835
|
+
* @description The request could not be completed due to a conflict with the current state of the target resource.
|
|
25836
|
+
* Variants with ErrorExtensions specific to subscriptions.
|
|
25837
|
+
*/
|
|
25169
25838
|
409: {
|
|
25170
25839
|
headers: {
|
|
25171
25840
|
[name: string]: unknown;
|
|
@@ -25230,11 +25899,15 @@ export interface operations {
|
|
|
25230
25899
|
* @default immediate
|
|
25231
25900
|
*/
|
|
25232
25901
|
timing?: components['schemas']['SubscriptionTiming'];
|
|
25233
|
-
/**
|
|
25234
|
-
*
|
|
25902
|
+
/**
|
|
25903
|
+
* @description The version of the plan to migrate to.
|
|
25904
|
+
* If not provided, the subscription will migrate to the latest version of the current plan.
|
|
25905
|
+
*/
|
|
25235
25906
|
targetVersion?: number;
|
|
25236
|
-
/**
|
|
25237
|
-
*
|
|
25907
|
+
/**
|
|
25908
|
+
* @description The key of the phase to start the subscription in.
|
|
25909
|
+
* If not provided, the subscription will start in the first phase of the plan.
|
|
25910
|
+
*/
|
|
25238
25911
|
startingPhase?: string;
|
|
25239
25912
|
/**
|
|
25240
25913
|
* Format: date-time
|
|
@@ -25291,8 +25964,10 @@ export interface operations {
|
|
|
25291
25964
|
'application/problem+json': components['schemas']['NotFoundProblemResponse'];
|
|
25292
25965
|
};
|
|
25293
25966
|
};
|
|
25294
|
-
/**
|
|
25295
|
-
*
|
|
25967
|
+
/**
|
|
25968
|
+
* @description The request could not be completed due to a conflict with the current state of the target resource.
|
|
25969
|
+
* Variants with ErrorExtensions specific to subscriptions.
|
|
25970
|
+
*/
|
|
25296
25971
|
409: {
|
|
25297
25972
|
headers: {
|
|
25298
25973
|
[name: string]: unknown;
|
|
@@ -25489,8 +26164,10 @@ export interface operations {
|
|
|
25489
26164
|
'application/problem+json': components['schemas']['NotFoundProblemResponse'];
|
|
25490
26165
|
};
|
|
25491
26166
|
};
|
|
25492
|
-
/**
|
|
25493
|
-
*
|
|
26167
|
+
/**
|
|
26168
|
+
* @description The request could not be completed due to a conflict with the current state of the target resource.
|
|
26169
|
+
* Variants with ErrorExtensions specific to subscriptions.
|
|
26170
|
+
*/
|
|
25494
26171
|
409: {
|
|
25495
26172
|
headers: {
|
|
25496
26173
|
[name: string]: unknown;
|
|
@@ -25541,13 +26218,17 @@ export interface operations {
|
|
|
25541
26218
|
parameters: {
|
|
25542
26219
|
query?: {
|
|
25543
26220
|
includeDeleted?: boolean;
|
|
25544
|
-
/**
|
|
26221
|
+
/**
|
|
26222
|
+
* @description Page index.
|
|
25545
26223
|
*
|
|
25546
|
-
* Default is 1.
|
|
26224
|
+
* Default is 1.
|
|
26225
|
+
*/
|
|
25547
26226
|
page?: components['parameters']['Pagination.page'];
|
|
25548
|
-
/**
|
|
26227
|
+
/**
|
|
26228
|
+
* @description The maximum number of items per page.
|
|
25549
26229
|
*
|
|
25550
|
-
* Default is 100.
|
|
26230
|
+
* Default is 100.
|
|
26231
|
+
*/
|
|
25551
26232
|
pageSize?: components['parameters']['Pagination.pageSize'];
|
|
25552
26233
|
/** @description The order direction. */
|
|
25553
26234
|
order?: components['parameters']['EntitlementOrderByOrdering.order'];
|
|
@@ -25841,7 +26522,7 @@ export interface operations {
|
|
|
25841
26522
|
};
|
|
25842
26523
|
requestBody?: never;
|
|
25843
26524
|
responses: {
|
|
25844
|
-
/** @description There is no content to send for this request, but the headers may be useful.
|
|
26525
|
+
/** @description There is no content to send for this request, but the headers may be useful. */
|
|
25845
26526
|
204: {
|
|
25846
26527
|
headers: {
|
|
25847
26528
|
[name: string]: unknown;
|
|
@@ -25926,21 +26607,29 @@ export interface operations {
|
|
|
25926
26607
|
parameters: {
|
|
25927
26608
|
query?: {
|
|
25928
26609
|
includeDeleted?: boolean;
|
|
25929
|
-
/**
|
|
26610
|
+
/**
|
|
26611
|
+
* @description Page index.
|
|
25930
26612
|
*
|
|
25931
|
-
* Default is 1.
|
|
26613
|
+
* Default is 1.
|
|
26614
|
+
*/
|
|
25932
26615
|
page?: components['parameters']['Pagination.page'];
|
|
25933
|
-
/**
|
|
26616
|
+
/**
|
|
26617
|
+
* @description The maximum number of items per page.
|
|
25934
26618
|
*
|
|
25935
|
-
* Default is 100.
|
|
26619
|
+
* Default is 100.
|
|
26620
|
+
*/
|
|
25936
26621
|
pageSize?: components['parameters']['Pagination.pageSize'];
|
|
25937
|
-
/**
|
|
26622
|
+
/**
|
|
26623
|
+
* @description Number of items to skip.
|
|
25938
26624
|
*
|
|
25939
|
-
* Default is 0.
|
|
26625
|
+
* Default is 0.
|
|
26626
|
+
*/
|
|
25940
26627
|
offset?: components['parameters']['LimitOffset.offset'];
|
|
25941
|
-
/**
|
|
26628
|
+
/**
|
|
26629
|
+
* @description Number of items to return.
|
|
25942
26630
|
*
|
|
25943
|
-
* Default is 100.
|
|
26631
|
+
* Default is 100.
|
|
26632
|
+
*/
|
|
25944
26633
|
limit?: components['parameters']['LimitOffset.limit'];
|
|
25945
26634
|
/** @description The order direction. */
|
|
25946
26635
|
order?: components['parameters']['GrantOrderByOrdering.order'];
|
|
@@ -26134,8 +26823,10 @@ export interface operations {
|
|
|
26134
26823
|
query: {
|
|
26135
26824
|
/** @description Start of time range to query entitlement: date-time in RFC 3339 format. Defaults to the last reset. Gets truncated to the granularity of the underlying meter. */
|
|
26136
26825
|
from?: Date | string;
|
|
26137
|
-
/**
|
|
26138
|
-
*
|
|
26826
|
+
/**
|
|
26827
|
+
* @description End of time range to query entitlement: date-time in RFC 3339 format. Defaults to now.
|
|
26828
|
+
* If not now then gets truncated to the granularity of the underlying meter.
|
|
26829
|
+
*/
|
|
26139
26830
|
to?: Date | string;
|
|
26140
26831
|
/** @description Windowsize */
|
|
26141
26832
|
windowSize: components['schemas']['WindowSize'];
|
|
@@ -26358,7 +27049,7 @@ export interface operations {
|
|
|
26358
27049
|
};
|
|
26359
27050
|
};
|
|
26360
27051
|
responses: {
|
|
26361
|
-
/** @description There is no content to send for this request, but the headers may be useful.
|
|
27052
|
+
/** @description There is no content to send for this request, but the headers may be useful. */
|
|
26362
27053
|
204: {
|
|
26363
27054
|
headers: {
|
|
26364
27055
|
[name: string]: unknown;
|
|
@@ -26539,39 +27230,55 @@ export interface operations {
|
|
|
26539
27230
|
listEntitlementsV2: {
|
|
26540
27231
|
parameters: {
|
|
26541
27232
|
query?: {
|
|
26542
|
-
/**
|
|
27233
|
+
/**
|
|
27234
|
+
* @description Filtering by multiple features.
|
|
26543
27235
|
*
|
|
26544
|
-
* Usage: `?feature=feature-1&feature=feature-2`
|
|
27236
|
+
* Usage: `?feature=feature-1&feature=feature-2`
|
|
27237
|
+
*/
|
|
26545
27238
|
feature?: string[];
|
|
26546
|
-
/**
|
|
27239
|
+
/**
|
|
27240
|
+
* @description Filtering by multiple customers.
|
|
26547
27241
|
*
|
|
26548
|
-
* Usage: `?customerKeys=customer-1&customerKeys=customer-3`
|
|
27242
|
+
* Usage: `?customerKeys=customer-1&customerKeys=customer-3`
|
|
27243
|
+
*/
|
|
26549
27244
|
customerKeys?: string[];
|
|
26550
|
-
/**
|
|
27245
|
+
/**
|
|
27246
|
+
* @description Filtering by multiple customers.
|
|
26551
27247
|
*
|
|
26552
|
-
* Usage: `?customerIds=01K4WAQ0J99ZZ0MD75HXR112H8&customerIds=01K4WAQ0J99ZZ0MD75HXR112H9`
|
|
27248
|
+
* Usage: `?customerIds=01K4WAQ0J99ZZ0MD75HXR112H8&customerIds=01K4WAQ0J99ZZ0MD75HXR112H9`
|
|
27249
|
+
*/
|
|
26553
27250
|
customerIds?: string[];
|
|
26554
|
-
/**
|
|
27251
|
+
/**
|
|
27252
|
+
* @description Filtering by multiple entitlement types.
|
|
26555
27253
|
*
|
|
26556
|
-
* Usage: `?entitlementType=metered&entitlementType=boolean`
|
|
27254
|
+
* Usage: `?entitlementType=metered&entitlementType=boolean`
|
|
27255
|
+
*/
|
|
26557
27256
|
entitlementType?: components['schemas']['EntitlementType'][];
|
|
26558
27257
|
/** @description Exclude inactive entitlements in the response (those scheduled for later or earlier) */
|
|
26559
27258
|
excludeInactive?: boolean;
|
|
26560
|
-
/**
|
|
27259
|
+
/**
|
|
27260
|
+
* @description Page index.
|
|
26561
27261
|
*
|
|
26562
|
-
* Default is 1.
|
|
27262
|
+
* Default is 1.
|
|
27263
|
+
*/
|
|
26563
27264
|
page?: components['parameters']['Pagination.page'];
|
|
26564
|
-
/**
|
|
27265
|
+
/**
|
|
27266
|
+
* @description The maximum number of items per page.
|
|
26565
27267
|
*
|
|
26566
|
-
* Default is 100.
|
|
27268
|
+
* Default is 100.
|
|
27269
|
+
*/
|
|
26567
27270
|
pageSize?: components['parameters']['Pagination.pageSize'];
|
|
26568
|
-
/**
|
|
27271
|
+
/**
|
|
27272
|
+
* @description Number of items to skip.
|
|
26569
27273
|
*
|
|
26570
|
-
* Default is 0.
|
|
27274
|
+
* Default is 0.
|
|
27275
|
+
*/
|
|
26571
27276
|
offset?: components['parameters']['LimitOffset.offset'];
|
|
26572
|
-
/**
|
|
27277
|
+
/**
|
|
27278
|
+
* @description Number of items to return.
|
|
26573
27279
|
*
|
|
26574
|
-
* Default is 100.
|
|
27280
|
+
* Default is 100.
|
|
27281
|
+
*/
|
|
26575
27282
|
limit?: components['parameters']['LimitOffset.limit'];
|
|
26576
27283
|
/** @description The order direction. */
|
|
26577
27284
|
order?: components['parameters']['EntitlementOrderByOrdering.order'];
|
|
@@ -26759,8 +27466,10 @@ export interface operations {
|
|
|
26759
27466
|
cursor?: components['parameters']['CursorPagination.cursor'];
|
|
26760
27467
|
/** @description The limit of the pagination. */
|
|
26761
27468
|
limit?: components['parameters']['CursorPagination.limit'];
|
|
26762
|
-
/**
|
|
26763
|
-
*
|
|
27469
|
+
/**
|
|
27470
|
+
* @description Client ID
|
|
27471
|
+
* Useful to track progress of a query.
|
|
27472
|
+
*/
|
|
26764
27473
|
clientId?: string;
|
|
26765
27474
|
/** @description The filter for the events encoded as JSON string. */
|
|
26766
27475
|
filter?: string;
|
|
@@ -26848,31 +27557,43 @@ export interface operations {
|
|
|
26848
27557
|
listGrantsV2: {
|
|
26849
27558
|
parameters: {
|
|
26850
27559
|
query?: {
|
|
26851
|
-
/**
|
|
27560
|
+
/**
|
|
27561
|
+
* @description Filtering by multiple features.
|
|
26852
27562
|
*
|
|
26853
|
-
* Usage: `?feature=feature-1&feature=feature-2`
|
|
27563
|
+
* Usage: `?feature=feature-1&feature=feature-2`
|
|
27564
|
+
*/
|
|
26854
27565
|
feature?: string[];
|
|
26855
|
-
/**
|
|
27566
|
+
/**
|
|
27567
|
+
* @description Filtering by multiple customers (either by ID or key).
|
|
26856
27568
|
*
|
|
26857
|
-
* Usage: `?customer=customer-1&customer=customer-2`
|
|
27569
|
+
* Usage: `?customer=customer-1&customer=customer-2`
|
|
27570
|
+
*/
|
|
26858
27571
|
customer?: components['schemas']['ULIDOrExternalKey'][];
|
|
26859
27572
|
/** @description Include deleted */
|
|
26860
27573
|
includeDeleted?: boolean;
|
|
26861
|
-
/**
|
|
27574
|
+
/**
|
|
27575
|
+
* @description Page index.
|
|
26862
27576
|
*
|
|
26863
|
-
* Default is 1.
|
|
27577
|
+
* Default is 1.
|
|
27578
|
+
*/
|
|
26864
27579
|
page?: components['parameters']['Pagination.page'];
|
|
26865
|
-
/**
|
|
27580
|
+
/**
|
|
27581
|
+
* @description The maximum number of items per page.
|
|
26866
27582
|
*
|
|
26867
|
-
* Default is 100.
|
|
27583
|
+
* Default is 100.
|
|
27584
|
+
*/
|
|
26868
27585
|
pageSize?: components['parameters']['Pagination.pageSize'];
|
|
26869
|
-
/**
|
|
27586
|
+
/**
|
|
27587
|
+
* @description Number of items to skip.
|
|
26870
27588
|
*
|
|
26871
|
-
* Default is 0.
|
|
27589
|
+
* Default is 0.
|
|
27590
|
+
*/
|
|
26872
27591
|
offset?: components['parameters']['LimitOffset.offset'];
|
|
26873
|
-
/**
|
|
27592
|
+
/**
|
|
27593
|
+
* @description Number of items to return.
|
|
26874
27594
|
*
|
|
26875
|
-
* Default is 100.
|
|
27595
|
+
* Default is 100.
|
|
27596
|
+
*/
|
|
26876
27597
|
limit?: components['parameters']['LimitOffset.limit'];
|
|
26877
27598
|
/** @description The order direction. */
|
|
26878
27599
|
order?: components['parameters']['GrantOrderByOrdering.order'];
|