@openmeter/sdk 1.0.0-beta.206 → 1.0.0-beta.208
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/src/client/billing.d.cts +1 -0
- package/dist/cjs/src/client/schemas.d.cts +747 -26
- package/dist/cjs/{tsconfig.0b6649c3.tsbuildinfo → tsconfig.51a5d764.tsbuildinfo} +1 -1
- package/dist/cjs/{tsconfig.57049e40.tsbuildinfo → tsconfig.97034641.tsbuildinfo} +1 -1
- package/dist/src/client/billing.d.ts +1 -0
- package/dist/src/client/schemas.d.ts +747 -26
- package/dist/tsconfig.tsbuildinfo +1 -1
- package/package.json +1 -1
|
@@ -23,7 +23,7 @@ export interface paths {
|
|
|
23
23
|
patch?: never;
|
|
24
24
|
trace?: never;
|
|
25
25
|
};
|
|
26
|
-
'/api/v1/addons/{
|
|
26
|
+
'/api/v1/addons/{addonId}': {
|
|
27
27
|
parameters: {
|
|
28
28
|
query?: never;
|
|
29
29
|
header?: never;
|
|
@@ -35,22 +35,6 @@ export interface paths {
|
|
|
35
35
|
* @description Get add-on by id or key. The latest published version is returned if latter is used.
|
|
36
36
|
*/
|
|
37
37
|
get: operations['getAddon'];
|
|
38
|
-
put?: never;
|
|
39
|
-
post?: never;
|
|
40
|
-
delete?: never;
|
|
41
|
-
options?: never;
|
|
42
|
-
head?: never;
|
|
43
|
-
patch?: never;
|
|
44
|
-
trace?: never;
|
|
45
|
-
};
|
|
46
|
-
'/api/v1/addons/{addonId}': {
|
|
47
|
-
parameters: {
|
|
48
|
-
query?: never;
|
|
49
|
-
header?: never;
|
|
50
|
-
path?: never;
|
|
51
|
-
cookie?: never;
|
|
52
|
-
};
|
|
53
|
-
get?: never;
|
|
54
38
|
/**
|
|
55
39
|
* Update add-on
|
|
56
40
|
* @description Update add-on by id.
|
|
@@ -1789,6 +1773,54 @@ export interface paths {
|
|
|
1789
1773
|
patch: operations['editSubscription'];
|
|
1790
1774
|
trace?: never;
|
|
1791
1775
|
};
|
|
1776
|
+
'/api/v1/subscriptions/{subscriptionId}/addons': {
|
|
1777
|
+
parameters: {
|
|
1778
|
+
query?: never;
|
|
1779
|
+
header?: never;
|
|
1780
|
+
path?: never;
|
|
1781
|
+
cookie?: never;
|
|
1782
|
+
};
|
|
1783
|
+
/**
|
|
1784
|
+
* List subscription addons
|
|
1785
|
+
* @description List all addons of a subscription. In the returned list will match to a set unique by addonId.
|
|
1786
|
+
*/
|
|
1787
|
+
get: operations['listSubscriptionAddons'];
|
|
1788
|
+
put?: never;
|
|
1789
|
+
/**
|
|
1790
|
+
* Create subscription addon
|
|
1791
|
+
* @description Create a new subscription addon, either providing the key or the id of the addon.
|
|
1792
|
+
*/
|
|
1793
|
+
post: operations['createSubscriptionAddon'];
|
|
1794
|
+
delete?: never;
|
|
1795
|
+
options?: never;
|
|
1796
|
+
head?: never;
|
|
1797
|
+
patch?: never;
|
|
1798
|
+
trace?: never;
|
|
1799
|
+
};
|
|
1800
|
+
'/api/v1/subscriptions/{subscriptionId}/addons/{subscriptionAddonId}': {
|
|
1801
|
+
parameters: {
|
|
1802
|
+
query?: never;
|
|
1803
|
+
header?: never;
|
|
1804
|
+
path?: never;
|
|
1805
|
+
cookie?: never;
|
|
1806
|
+
};
|
|
1807
|
+
/**
|
|
1808
|
+
* Get subscription addon
|
|
1809
|
+
* @description Get a subscription addon by id.
|
|
1810
|
+
*/
|
|
1811
|
+
get: operations['getSubscriptionAddon'];
|
|
1812
|
+
put?: never;
|
|
1813
|
+
post?: never;
|
|
1814
|
+
delete?: never;
|
|
1815
|
+
options?: never;
|
|
1816
|
+
head?: never;
|
|
1817
|
+
/**
|
|
1818
|
+
* Update subscription addon
|
|
1819
|
+
* @description Updates a subscription addon (allows changing the quantity: purchasing more instances or cancelling the current instances)
|
|
1820
|
+
*/
|
|
1821
|
+
patch: operations['updateSubscriptionAddon'];
|
|
1822
|
+
trace?: never;
|
|
1823
|
+
};
|
|
1792
1824
|
'/api/v1/subscriptions/{subscriptionId}/cancel': {
|
|
1793
1825
|
parameters: {
|
|
1794
1826
|
query?: never;
|
|
@@ -4722,6 +4754,11 @@ export interface components {
|
|
|
4722
4754
|
/** @description Invoice a gathering invoice */
|
|
4723
4755
|
readonly invoice?: components['schemas']['InvoiceAvailableActionInvoiceDetails'];
|
|
4724
4756
|
};
|
|
4757
|
+
/**
|
|
4758
|
+
* @description Reason code.
|
|
4759
|
+
* @enum {string}
|
|
4760
|
+
*/
|
|
4761
|
+
InvoiceDiscountReason: 'maximum_spend' | 'ratecard_discount';
|
|
4725
4762
|
/** @description InvoiceDocumentRef is used to describe a reference to an existing document (invoice). */
|
|
4726
4763
|
InvoiceDocumentRef: components['schemas']['CreditNoteOriginalInvoiceRef'];
|
|
4727
4764
|
/**
|
|
@@ -5074,9 +5111,13 @@ export interface components {
|
|
|
5074
5111
|
*/
|
|
5075
5112
|
readonly id: string;
|
|
5076
5113
|
/** @description Reason code. */
|
|
5077
|
-
readonly
|
|
5114
|
+
readonly reason: components['schemas']['InvoiceDiscountReason'];
|
|
5078
5115
|
/** @description Text description as to why the discount was applied. */
|
|
5079
5116
|
readonly description?: string;
|
|
5117
|
+
/** @description External IDs of the invoice in other apps such as Stripe. */
|
|
5118
|
+
readonly externalIds?: components['schemas']['InvoiceLineAppExternalIds'];
|
|
5119
|
+
/** @description The discount from the rate card this discount is based on. */
|
|
5120
|
+
readonly rateCardDiscount?: components['schemas']['Discount'];
|
|
5080
5121
|
/**
|
|
5081
5122
|
* Amount in the currency of the invoice
|
|
5082
5123
|
* @description Fixed discount amount to apply (calculated if percent present).
|
|
@@ -5087,10 +5128,6 @@ export interface components {
|
|
|
5087
5128
|
* @enum {string}
|
|
5088
5129
|
*/
|
|
5089
5130
|
type: 'amount';
|
|
5090
|
-
/** @description The discount from the rate card this discount is based on. */
|
|
5091
|
-
readonly rateCardDiscount?: components['schemas']['Discount'];
|
|
5092
|
-
/** @description External IDs of the invoice in other apps such as Stripe. */
|
|
5093
|
-
readonly externalIds?: components['schemas']['InvoiceLineAppExternalIds'];
|
|
5094
5131
|
};
|
|
5095
5132
|
/** @description InvoiceLineDiscountUsage represents an usage-based discount applied to the line.
|
|
5096
5133
|
*
|
|
@@ -5123,9 +5160,13 @@ export interface components {
|
|
|
5123
5160
|
*/
|
|
5124
5161
|
readonly id: string;
|
|
5125
5162
|
/** @description Reason code. */
|
|
5126
|
-
readonly
|
|
5163
|
+
readonly reason: components['schemas']['InvoiceDiscountReason'];
|
|
5127
5164
|
/** @description Text description as to why the discount was applied. */
|
|
5128
5165
|
readonly description?: string;
|
|
5166
|
+
/** @description External IDs of the invoice in other apps such as Stripe. */
|
|
5167
|
+
readonly externalIds?: components['schemas']['InvoiceLineAppExternalIds'];
|
|
5168
|
+
/** @description The discount from the rate card this discount is based on. */
|
|
5169
|
+
readonly rateCardDiscount?: components['schemas']['Discount'];
|
|
5129
5170
|
/**
|
|
5130
5171
|
* Usage quantity in the unit of the underlying meter
|
|
5131
5172
|
* @description The usage to apply.
|
|
@@ -5143,8 +5184,6 @@ export interface components {
|
|
|
5143
5184
|
* @enum {string}
|
|
5144
5185
|
*/
|
|
5145
5186
|
type: 'usage';
|
|
5146
|
-
/** @description The discount from the rate card this discount is based on. */
|
|
5147
|
-
readonly rateCardDiscount?: components['schemas']['Discount'];
|
|
5148
5187
|
};
|
|
5149
5188
|
/**
|
|
5150
5189
|
* @description InvoiceLineManagedBy specifies who manages the line.
|
|
@@ -5594,6 +5633,8 @@ export interface components {
|
|
|
5594
5633
|
rateCard?: components['schemas']['InvoiceUsageBasedRateCard'];
|
|
5595
5634
|
/** @description The quantity of the item being sold. */
|
|
5596
5635
|
readonly quantity?: components['schemas']['Numeric'];
|
|
5636
|
+
/** @description The quantity of the item that has been metered for the period before any discounts were applied. */
|
|
5637
|
+
readonly meteredQuantity?: components['schemas']['Numeric'];
|
|
5597
5638
|
/** @description The quantity of the item used in before this line's period.
|
|
5598
5639
|
*
|
|
5599
5640
|
* It is non-zero in case of progressive billing, when this shows how much of the usage was already billed. */
|
|
@@ -7872,6 +7913,285 @@ export interface components {
|
|
|
7872
7913
|
*/
|
|
7873
7914
|
currency: components['schemas']['CurrencyCode'];
|
|
7874
7915
|
};
|
|
7916
|
+
/** @description A subscription add-on, represents concrete instances of an add-on for a given subscription. */
|
|
7917
|
+
SubscriptionAddon: {
|
|
7918
|
+
/**
|
|
7919
|
+
* ID
|
|
7920
|
+
* @description A unique identifier for the resource.
|
|
7921
|
+
* @example 01G65Z755AFWAKHE12NY0CQ9FH
|
|
7922
|
+
*/
|
|
7923
|
+
readonly id: string;
|
|
7924
|
+
/**
|
|
7925
|
+
* Display name
|
|
7926
|
+
* @description Human-readable name for the resource. Between 1 and 256 characters.
|
|
7927
|
+
*/
|
|
7928
|
+
name: string;
|
|
7929
|
+
/**
|
|
7930
|
+
* Description
|
|
7931
|
+
* @description Optional description of the resource. Maximum 1024 characters.
|
|
7932
|
+
*/
|
|
7933
|
+
description?: string;
|
|
7934
|
+
/**
|
|
7935
|
+
* Metadata
|
|
7936
|
+
* @description Additional metadata for the resource.
|
|
7937
|
+
*/
|
|
7938
|
+
metadata?: components['schemas']['Metadata'] | null;
|
|
7939
|
+
/**
|
|
7940
|
+
* Creation Time
|
|
7941
|
+
* Format: date-time
|
|
7942
|
+
* @description Timestamp of when the resource was created.
|
|
7943
|
+
* @example 2024-01-01T01:01:01.001Z
|
|
7944
|
+
*/
|
|
7945
|
+
readonly createdAt: Date;
|
|
7946
|
+
/**
|
|
7947
|
+
* Last Update Time
|
|
7948
|
+
* Format: date-time
|
|
7949
|
+
* @description Timestamp of when the resource was last updated.
|
|
7950
|
+
* @example 2024-01-01T01:01:01.001Z
|
|
7951
|
+
*/
|
|
7952
|
+
readonly updatedAt: Date;
|
|
7953
|
+
/**
|
|
7954
|
+
* Deletion Time
|
|
7955
|
+
* Format: date-time
|
|
7956
|
+
* @description Timestamp of when the resource was permanently deleted.
|
|
7957
|
+
* @example 2024-01-01T01:01:01.001Z
|
|
7958
|
+
*/
|
|
7959
|
+
readonly deletedAt?: Date;
|
|
7960
|
+
/**
|
|
7961
|
+
* Format: date-time
|
|
7962
|
+
* @description The cadence start of the resource.
|
|
7963
|
+
* @example 2023-01-01T01:01:01.001Z
|
|
7964
|
+
*/
|
|
7965
|
+
activeFrom: Date;
|
|
7966
|
+
/**
|
|
7967
|
+
* Format: date-time
|
|
7968
|
+
* @description The cadence end of the resource.
|
|
7969
|
+
* @example 2023-01-01T01:01:01.001Z
|
|
7970
|
+
*/
|
|
7971
|
+
activeTo?: Date;
|
|
7972
|
+
/**
|
|
7973
|
+
* Addon
|
|
7974
|
+
* @description Partially populated add-on properties.
|
|
7975
|
+
*/
|
|
7976
|
+
addon: {
|
|
7977
|
+
/**
|
|
7978
|
+
* ID
|
|
7979
|
+
* @description The ID of the add-on.
|
|
7980
|
+
* @example 01G65Z755AFWAKHE12NY0CQ9FH
|
|
7981
|
+
*/
|
|
7982
|
+
id: string;
|
|
7983
|
+
/**
|
|
7984
|
+
* Key
|
|
7985
|
+
* @description A semi-unique identifier for the resource.
|
|
7986
|
+
*/
|
|
7987
|
+
readonly key: string;
|
|
7988
|
+
/**
|
|
7989
|
+
* Version
|
|
7990
|
+
* @description The version of the Add-on which templates this instance.
|
|
7991
|
+
* @default 1
|
|
7992
|
+
*/
|
|
7993
|
+
readonly version: number;
|
|
7994
|
+
/**
|
|
7995
|
+
* InstanceType
|
|
7996
|
+
* @description The instance type of the add-on.
|
|
7997
|
+
*/
|
|
7998
|
+
readonly instanceType: components['schemas']['AddonInstanceType'];
|
|
7999
|
+
};
|
|
8000
|
+
/**
|
|
8001
|
+
* QuantityAt
|
|
8002
|
+
* Format: date-time
|
|
8003
|
+
* @description For which point in time the quantity was resolved to.
|
|
8004
|
+
* @example 2025-01-05T00:00:00Z
|
|
8005
|
+
*/
|
|
8006
|
+
readonly quantityAt: Date;
|
|
8007
|
+
/**
|
|
8008
|
+
* Quantity
|
|
8009
|
+
* @description The quantity of the add-on. Always 1 for single instance add-ons.
|
|
8010
|
+
* @example 1
|
|
8011
|
+
*/
|
|
8012
|
+
quantity: number;
|
|
8013
|
+
/**
|
|
8014
|
+
* Timeline
|
|
8015
|
+
* @description The timeline of the add-on. The returned periods are sorted and continuous.
|
|
8016
|
+
* @example [
|
|
8017
|
+
* {
|
|
8018
|
+
* "quantity": 1,
|
|
8019
|
+
* "activeFrom": "2025-01-01T00:00:00Z",
|
|
8020
|
+
* "activeTo": "2025-01-02T00:00:00Z"
|
|
8021
|
+
* },
|
|
8022
|
+
* {
|
|
8023
|
+
* "quantity": 0,
|
|
8024
|
+
* "activeFrom": "2025-01-02T00:00:00Z",
|
|
8025
|
+
* "activeTo": "2025-01-03T00:00:00Z"
|
|
8026
|
+
* },
|
|
8027
|
+
* {
|
|
8028
|
+
* "quantity": 1,
|
|
8029
|
+
* "activeFrom": "2025-01-03T00:00:00Z"
|
|
8030
|
+
* }
|
|
8031
|
+
* ]
|
|
8032
|
+
*/
|
|
8033
|
+
readonly timeline: components['schemas']['SubscriptionAddonTimelineSegment'][];
|
|
8034
|
+
/**
|
|
8035
|
+
* SubscriptionID
|
|
8036
|
+
* @description The ID of the subscription.
|
|
8037
|
+
* @example 01G65Z755AFWAKHE12NY0CQ9FH
|
|
8038
|
+
*/
|
|
8039
|
+
readonly subscriptionId: string;
|
|
8040
|
+
/**
|
|
8041
|
+
* Rate cards
|
|
8042
|
+
* @description The rate cards of the add-on.
|
|
8043
|
+
*/
|
|
8044
|
+
readonly rateCards: components['schemas']['SubscriptionAddonRateCard'][];
|
|
8045
|
+
};
|
|
8046
|
+
/** @description Resource create operation model. */
|
|
8047
|
+
SubscriptionAddonCreate: {
|
|
8048
|
+
/**
|
|
8049
|
+
* Display name
|
|
8050
|
+
* @description Human-readable name for the resource. Between 1 and 256 characters.
|
|
8051
|
+
*/
|
|
8052
|
+
name: string;
|
|
8053
|
+
/**
|
|
8054
|
+
* Description
|
|
8055
|
+
* @description Optional description of the resource. Maximum 1024 characters.
|
|
8056
|
+
*/
|
|
8057
|
+
description?: string;
|
|
8058
|
+
/**
|
|
8059
|
+
* Metadata
|
|
8060
|
+
* @description Additional metadata for the resource.
|
|
8061
|
+
*/
|
|
8062
|
+
metadata?: components['schemas']['Metadata'] | null;
|
|
8063
|
+
/**
|
|
8064
|
+
* Format: date-time
|
|
8065
|
+
* @description The cadence start of the resource.
|
|
8066
|
+
* @example 2023-01-01T01:01:01.001Z
|
|
8067
|
+
*/
|
|
8068
|
+
activeFrom: Date;
|
|
8069
|
+
/**
|
|
8070
|
+
* Format: date-time
|
|
8071
|
+
* @description The cadence end of the resource.
|
|
8072
|
+
* @example 2023-01-01T01:01:01.001Z
|
|
8073
|
+
*/
|
|
8074
|
+
activeTo?: Date;
|
|
8075
|
+
/**
|
|
8076
|
+
* Addon
|
|
8077
|
+
* @description Partially populated add-on properties.
|
|
8078
|
+
*/
|
|
8079
|
+
addon: {
|
|
8080
|
+
/**
|
|
8081
|
+
* ID
|
|
8082
|
+
* @description The ID of the add-on.
|
|
8083
|
+
* @example 01G65Z755AFWAKHE12NY0CQ9FH
|
|
8084
|
+
*/
|
|
8085
|
+
id: string;
|
|
8086
|
+
/**
|
|
8087
|
+
* Key
|
|
8088
|
+
* @description A semi-unique identifier for the resource.
|
|
8089
|
+
*/
|
|
8090
|
+
readonly key: string;
|
|
8091
|
+
/**
|
|
8092
|
+
* Version
|
|
8093
|
+
* @description The version of the Add-on which templates this instance.
|
|
8094
|
+
* @default 1
|
|
8095
|
+
*/
|
|
8096
|
+
readonly version: number;
|
|
8097
|
+
/**
|
|
8098
|
+
* InstanceType
|
|
8099
|
+
* @description The instance type of the add-on.
|
|
8100
|
+
*/
|
|
8101
|
+
readonly instanceType: components['schemas']['AddonInstanceType'];
|
|
8102
|
+
};
|
|
8103
|
+
/**
|
|
8104
|
+
* Quantity
|
|
8105
|
+
* @description The quantity of the add-on. Always 1 for single instance add-ons.
|
|
8106
|
+
* @example 1
|
|
8107
|
+
*/
|
|
8108
|
+
quantity: number;
|
|
8109
|
+
/**
|
|
8110
|
+
* Timing
|
|
8111
|
+
* @description The timing of the operation. After the create or update, a new entry will be created in the timeline.
|
|
8112
|
+
*/
|
|
8113
|
+
timing: components['schemas']['SubscriptionTiming'];
|
|
8114
|
+
};
|
|
8115
|
+
/** @description A rate card for a subscription add-on. */
|
|
8116
|
+
SubscriptionAddonRateCard: {
|
|
8117
|
+
/**
|
|
8118
|
+
* Rate card
|
|
8119
|
+
* @description The rate card.
|
|
8120
|
+
*/
|
|
8121
|
+
rateCard: components['schemas']['RateCard'];
|
|
8122
|
+
/**
|
|
8123
|
+
* Affected subscription item IDs
|
|
8124
|
+
* @description The IDs of the subscription items that this rate card belongs to.
|
|
8125
|
+
*/
|
|
8126
|
+
readonly affectedSubscriptionItemIds: string[];
|
|
8127
|
+
};
|
|
8128
|
+
/** @description A subscription add-on event. */
|
|
8129
|
+
SubscriptionAddonTimelineSegment: {
|
|
8130
|
+
/**
|
|
8131
|
+
* Format: date-time
|
|
8132
|
+
* @description The cadence start of the resource.
|
|
8133
|
+
* @example 2023-01-01T01:01:01.001Z
|
|
8134
|
+
*/
|
|
8135
|
+
activeFrom: Date;
|
|
8136
|
+
/**
|
|
8137
|
+
* Format: date-time
|
|
8138
|
+
* @description The cadence end of the resource.
|
|
8139
|
+
* @example 2023-01-01T01:01:01.001Z
|
|
8140
|
+
*/
|
|
8141
|
+
activeTo?: Date;
|
|
8142
|
+
/**
|
|
8143
|
+
* Quantity
|
|
8144
|
+
* @description The quantity of the add-on for the given period.
|
|
8145
|
+
* @example 1
|
|
8146
|
+
*/
|
|
8147
|
+
readonly quantity: number;
|
|
8148
|
+
};
|
|
8149
|
+
/** @description Resource create or update operation model. */
|
|
8150
|
+
SubscriptionAddonUpdate: {
|
|
8151
|
+
/**
|
|
8152
|
+
* Display name
|
|
8153
|
+
* @description Human-readable name for the resource. Between 1 and 256 characters.
|
|
8154
|
+
*/
|
|
8155
|
+
name?: string;
|
|
8156
|
+
/**
|
|
8157
|
+
* Description
|
|
8158
|
+
* @description Optional description of the resource. Maximum 1024 characters.
|
|
8159
|
+
*/
|
|
8160
|
+
description?: string;
|
|
8161
|
+
/**
|
|
8162
|
+
* Metadata
|
|
8163
|
+
* @description Additional metadata for the resource.
|
|
8164
|
+
*/
|
|
8165
|
+
metadata?: components['schemas']['Metadata'] | null;
|
|
8166
|
+
/**
|
|
8167
|
+
* Format: date-time
|
|
8168
|
+
* @description The cadence start of the resource.
|
|
8169
|
+
* @example 2023-01-01T01:01:01.001Z
|
|
8170
|
+
*/
|
|
8171
|
+
activeFrom?: Date;
|
|
8172
|
+
/**
|
|
8173
|
+
* Format: date-time
|
|
8174
|
+
* @description The cadence end of the resource.
|
|
8175
|
+
* @example 2023-01-01T01:01:01.001Z
|
|
8176
|
+
*/
|
|
8177
|
+
activeTo?: Date;
|
|
8178
|
+
/**
|
|
8179
|
+
* Addon
|
|
8180
|
+
* @description Partially populated add-on properties.
|
|
8181
|
+
*/
|
|
8182
|
+
addon?: Record<string, never>;
|
|
8183
|
+
/**
|
|
8184
|
+
* Quantity
|
|
8185
|
+
* @description The quantity of the add-on. Always 1 for single instance add-ons.
|
|
8186
|
+
* @example 1
|
|
8187
|
+
*/
|
|
8188
|
+
quantity?: number;
|
|
8189
|
+
/**
|
|
8190
|
+
* Timing
|
|
8191
|
+
* @description The timing of the operation. After the create or update, a new entry will be created in the timeline.
|
|
8192
|
+
*/
|
|
8193
|
+
timing?: components['schemas']['SubscriptionTiming'];
|
|
8194
|
+
};
|
|
7875
8195
|
/** @description Alignment details enriched with the current billing period. */
|
|
7876
8196
|
SubscriptionAlignment: {
|
|
7877
8197
|
/** @description Whether all Billable items and RateCards must align.
|
|
@@ -8847,6 +9167,7 @@ export type InvoiceAppExternalIds = components['schemas']['InvoiceAppExternalIds
|
|
|
8847
9167
|
export type InvoiceAvailableActionDetails = components['schemas']['InvoiceAvailableActionDetails'];
|
|
8848
9168
|
export type InvoiceAvailableActionInvoiceDetails = components['schemas']['InvoiceAvailableActionInvoiceDetails'];
|
|
8849
9169
|
export type InvoiceAvailableActions = components['schemas']['InvoiceAvailableActions'];
|
|
9170
|
+
export type InvoiceDiscountReason = components['schemas']['InvoiceDiscountReason'];
|
|
8850
9171
|
export type InvoiceDocumentRef = components['schemas']['InvoiceDocumentRef'];
|
|
8851
9172
|
export type InvoiceDocumentRefType = components['schemas']['InvoiceDocumentRefType'];
|
|
8852
9173
|
export type InvoiceExpand = components['schemas']['InvoiceExpand'];
|
|
@@ -8988,6 +9309,11 @@ export type StripeWebhookResponse = components['schemas']['StripeWebhookResponse
|
|
|
8988
9309
|
export type Subject = components['schemas']['Subject'];
|
|
8989
9310
|
export type SubjectUpsert = components['schemas']['SubjectUpsert'];
|
|
8990
9311
|
export type Subscription = components['schemas']['Subscription'];
|
|
9312
|
+
export type SubscriptionAddon = components['schemas']['SubscriptionAddon'];
|
|
9313
|
+
export type SubscriptionAddonCreate = components['schemas']['SubscriptionAddonCreate'];
|
|
9314
|
+
export type SubscriptionAddonRateCard = components['schemas']['SubscriptionAddonRateCard'];
|
|
9315
|
+
export type SubscriptionAddonTimelineSegment = components['schemas']['SubscriptionAddonTimelineSegment'];
|
|
9316
|
+
export type SubscriptionAddonUpdate = components['schemas']['SubscriptionAddonUpdate'];
|
|
8991
9317
|
export type SubscriptionAlignment = components['schemas']['SubscriptionAlignment'];
|
|
8992
9318
|
export type SubscriptionChange = components['schemas']['SubscriptionChange'];
|
|
8993
9319
|
export type SubscriptionChangeResponseBody = components['schemas']['SubscriptionChangeResponseBody'];
|
|
@@ -9310,7 +9636,7 @@ export interface operations {
|
|
|
9310
9636
|
};
|
|
9311
9637
|
header?: never;
|
|
9312
9638
|
path: {
|
|
9313
|
-
|
|
9639
|
+
addonId: string;
|
|
9314
9640
|
};
|
|
9315
9641
|
cookie?: never;
|
|
9316
9642
|
};
|
|
@@ -20135,6 +20461,401 @@ export interface operations {
|
|
|
20135
20461
|
};
|
|
20136
20462
|
};
|
|
20137
20463
|
};
|
|
20464
|
+
listSubscriptionAddons: {
|
|
20465
|
+
parameters: {
|
|
20466
|
+
query?: never;
|
|
20467
|
+
header?: never;
|
|
20468
|
+
path: {
|
|
20469
|
+
subscriptionId: string;
|
|
20470
|
+
};
|
|
20471
|
+
cookie?: never;
|
|
20472
|
+
};
|
|
20473
|
+
requestBody?: never;
|
|
20474
|
+
responses: {
|
|
20475
|
+
/** @description The request has succeeded. */
|
|
20476
|
+
200: {
|
|
20477
|
+
headers: {
|
|
20478
|
+
[name: string]: unknown;
|
|
20479
|
+
};
|
|
20480
|
+
content: {
|
|
20481
|
+
'application/json': components['schemas']['SubscriptionAddon'][];
|
|
20482
|
+
};
|
|
20483
|
+
};
|
|
20484
|
+
/** @description The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing). */
|
|
20485
|
+
400: {
|
|
20486
|
+
headers: {
|
|
20487
|
+
[name: string]: unknown;
|
|
20488
|
+
};
|
|
20489
|
+
content: {
|
|
20490
|
+
'application/problem+json': components['schemas']['BadRequestProblemResponse'];
|
|
20491
|
+
};
|
|
20492
|
+
};
|
|
20493
|
+
/** @description The request has not been applied because it lacks valid authentication credentials for the target resource. */
|
|
20494
|
+
401: {
|
|
20495
|
+
headers: {
|
|
20496
|
+
[name: string]: unknown;
|
|
20497
|
+
};
|
|
20498
|
+
content: {
|
|
20499
|
+
'application/problem+json': components['schemas']['UnauthorizedProblemResponse'];
|
|
20500
|
+
};
|
|
20501
|
+
};
|
|
20502
|
+
/** @description The server understood the request but refuses to authorize it. */
|
|
20503
|
+
403: {
|
|
20504
|
+
headers: {
|
|
20505
|
+
[name: string]: unknown;
|
|
20506
|
+
};
|
|
20507
|
+
content: {
|
|
20508
|
+
'application/problem+json': components['schemas']['ForbiddenProblemResponse'];
|
|
20509
|
+
};
|
|
20510
|
+
};
|
|
20511
|
+
/** @description The origin server did not find a current representation for the target resource or is not willing to disclose that one exists. */
|
|
20512
|
+
404: {
|
|
20513
|
+
headers: {
|
|
20514
|
+
[name: string]: unknown;
|
|
20515
|
+
};
|
|
20516
|
+
content: {
|
|
20517
|
+
'application/problem+json': components['schemas']['NotFoundProblemResponse'];
|
|
20518
|
+
};
|
|
20519
|
+
};
|
|
20520
|
+
/** @description One or more conditions given in the request header fields evaluated to false when tested on the server. */
|
|
20521
|
+
412: {
|
|
20522
|
+
headers: {
|
|
20523
|
+
[name: string]: unknown;
|
|
20524
|
+
};
|
|
20525
|
+
content: {
|
|
20526
|
+
'application/problem+json': components['schemas']['PreconditionFailedProblemResponse'];
|
|
20527
|
+
};
|
|
20528
|
+
};
|
|
20529
|
+
/** @description The server encountered an unexpected condition that prevented it from fulfilling the request. */
|
|
20530
|
+
500: {
|
|
20531
|
+
headers: {
|
|
20532
|
+
[name: string]: unknown;
|
|
20533
|
+
};
|
|
20534
|
+
content: {
|
|
20535
|
+
'application/problem+json': components['schemas']['InternalServerErrorProblemResponse'];
|
|
20536
|
+
};
|
|
20537
|
+
};
|
|
20538
|
+
/** @description The server is currently unable to handle the request due to a temporary overload or scheduled maintenance, which will likely be alleviated after some delay. */
|
|
20539
|
+
503: {
|
|
20540
|
+
headers: {
|
|
20541
|
+
[name: string]: unknown;
|
|
20542
|
+
};
|
|
20543
|
+
content: {
|
|
20544
|
+
'application/problem+json': components['schemas']['ServiceUnavailableProblemResponse'];
|
|
20545
|
+
};
|
|
20546
|
+
};
|
|
20547
|
+
/** @description An unexpected error response. */
|
|
20548
|
+
default: {
|
|
20549
|
+
headers: {
|
|
20550
|
+
[name: string]: unknown;
|
|
20551
|
+
};
|
|
20552
|
+
content: {
|
|
20553
|
+
'application/problem+json': components['schemas']['UnexpectedProblemResponse'];
|
|
20554
|
+
};
|
|
20555
|
+
};
|
|
20556
|
+
};
|
|
20557
|
+
};
|
|
20558
|
+
createSubscriptionAddon: {
|
|
20559
|
+
parameters: {
|
|
20560
|
+
query?: never;
|
|
20561
|
+
header?: never;
|
|
20562
|
+
path: {
|
|
20563
|
+
subscriptionId: string;
|
|
20564
|
+
};
|
|
20565
|
+
cookie?: never;
|
|
20566
|
+
};
|
|
20567
|
+
requestBody: {
|
|
20568
|
+
content: {
|
|
20569
|
+
'application/json': components['schemas']['SubscriptionAddonCreate'];
|
|
20570
|
+
};
|
|
20571
|
+
};
|
|
20572
|
+
responses: {
|
|
20573
|
+
/** @description The request has succeeded and a new resource has been created as a result. */
|
|
20574
|
+
201: {
|
|
20575
|
+
headers: {
|
|
20576
|
+
[name: string]: unknown;
|
|
20577
|
+
};
|
|
20578
|
+
content: {
|
|
20579
|
+
'application/json': components['schemas']['SubscriptionAddon'];
|
|
20580
|
+
};
|
|
20581
|
+
};
|
|
20582
|
+
/** @description The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing). */
|
|
20583
|
+
400: {
|
|
20584
|
+
headers: {
|
|
20585
|
+
[name: string]: unknown;
|
|
20586
|
+
};
|
|
20587
|
+
content: {
|
|
20588
|
+
'application/problem+json': components['schemas']['BadRequestProblemResponse'];
|
|
20589
|
+
};
|
|
20590
|
+
};
|
|
20591
|
+
/** @description The request has not been applied because it lacks valid authentication credentials for the target resource. */
|
|
20592
|
+
401: {
|
|
20593
|
+
headers: {
|
|
20594
|
+
[name: string]: unknown;
|
|
20595
|
+
};
|
|
20596
|
+
content: {
|
|
20597
|
+
'application/problem+json': components['schemas']['UnauthorizedProblemResponse'];
|
|
20598
|
+
};
|
|
20599
|
+
};
|
|
20600
|
+
/** @description The server understood the request but refuses to authorize it. */
|
|
20601
|
+
403: {
|
|
20602
|
+
headers: {
|
|
20603
|
+
[name: string]: unknown;
|
|
20604
|
+
};
|
|
20605
|
+
content: {
|
|
20606
|
+
'application/problem+json': components['schemas']['ForbiddenProblemResponse'];
|
|
20607
|
+
};
|
|
20608
|
+
};
|
|
20609
|
+
/** @description The origin server did not find a current representation for the target resource or is not willing to disclose that one exists. */
|
|
20610
|
+
404: {
|
|
20611
|
+
headers: {
|
|
20612
|
+
[name: string]: unknown;
|
|
20613
|
+
};
|
|
20614
|
+
content: {
|
|
20615
|
+
'application/problem+json': components['schemas']['NotFoundProblemResponse'];
|
|
20616
|
+
};
|
|
20617
|
+
};
|
|
20618
|
+
/** @description The request could not be completed due to a conflict with the current state of the target resource. */
|
|
20619
|
+
409: {
|
|
20620
|
+
headers: {
|
|
20621
|
+
[name: string]: unknown;
|
|
20622
|
+
};
|
|
20623
|
+
content: {
|
|
20624
|
+
'application/problem+json': components['schemas']['ConflictProblemResponse'];
|
|
20625
|
+
};
|
|
20626
|
+
};
|
|
20627
|
+
/** @description One or more conditions given in the request header fields evaluated to false when tested on the server. */
|
|
20628
|
+
412: {
|
|
20629
|
+
headers: {
|
|
20630
|
+
[name: string]: unknown;
|
|
20631
|
+
};
|
|
20632
|
+
content: {
|
|
20633
|
+
'application/problem+json': components['schemas']['PreconditionFailedProblemResponse'];
|
|
20634
|
+
};
|
|
20635
|
+
};
|
|
20636
|
+
/** @description The server encountered an unexpected condition that prevented it from fulfilling the request. */
|
|
20637
|
+
500: {
|
|
20638
|
+
headers: {
|
|
20639
|
+
[name: string]: unknown;
|
|
20640
|
+
};
|
|
20641
|
+
content: {
|
|
20642
|
+
'application/problem+json': components['schemas']['InternalServerErrorProblemResponse'];
|
|
20643
|
+
};
|
|
20644
|
+
};
|
|
20645
|
+
/** @description The server is currently unable to handle the request due to a temporary overload or scheduled maintenance, which will likely be alleviated after some delay. */
|
|
20646
|
+
503: {
|
|
20647
|
+
headers: {
|
|
20648
|
+
[name: string]: unknown;
|
|
20649
|
+
};
|
|
20650
|
+
content: {
|
|
20651
|
+
'application/problem+json': components['schemas']['ServiceUnavailableProblemResponse'];
|
|
20652
|
+
};
|
|
20653
|
+
};
|
|
20654
|
+
/** @description An unexpected error response. */
|
|
20655
|
+
default: {
|
|
20656
|
+
headers: {
|
|
20657
|
+
[name: string]: unknown;
|
|
20658
|
+
};
|
|
20659
|
+
content: {
|
|
20660
|
+
'application/problem+json': components['schemas']['UnexpectedProblemResponse'];
|
|
20661
|
+
};
|
|
20662
|
+
};
|
|
20663
|
+
};
|
|
20664
|
+
};
|
|
20665
|
+
getSubscriptionAddon: {
|
|
20666
|
+
parameters: {
|
|
20667
|
+
query?: never;
|
|
20668
|
+
header?: never;
|
|
20669
|
+
path: {
|
|
20670
|
+
subscriptionId: string;
|
|
20671
|
+
subscriptionAddonId: string;
|
|
20672
|
+
};
|
|
20673
|
+
cookie?: never;
|
|
20674
|
+
};
|
|
20675
|
+
requestBody?: never;
|
|
20676
|
+
responses: {
|
|
20677
|
+
/** @description The request has succeeded. */
|
|
20678
|
+
200: {
|
|
20679
|
+
headers: {
|
|
20680
|
+
[name: string]: unknown;
|
|
20681
|
+
};
|
|
20682
|
+
content: {
|
|
20683
|
+
'application/json': components['schemas']['SubscriptionAddon'];
|
|
20684
|
+
};
|
|
20685
|
+
};
|
|
20686
|
+
/** @description The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing). */
|
|
20687
|
+
400: {
|
|
20688
|
+
headers: {
|
|
20689
|
+
[name: string]: unknown;
|
|
20690
|
+
};
|
|
20691
|
+
content: {
|
|
20692
|
+
'application/problem+json': components['schemas']['BadRequestProblemResponse'];
|
|
20693
|
+
};
|
|
20694
|
+
};
|
|
20695
|
+
/** @description The request has not been applied because it lacks valid authentication credentials for the target resource. */
|
|
20696
|
+
401: {
|
|
20697
|
+
headers: {
|
|
20698
|
+
[name: string]: unknown;
|
|
20699
|
+
};
|
|
20700
|
+
content: {
|
|
20701
|
+
'application/problem+json': components['schemas']['UnauthorizedProblemResponse'];
|
|
20702
|
+
};
|
|
20703
|
+
};
|
|
20704
|
+
/** @description The server understood the request but refuses to authorize it. */
|
|
20705
|
+
403: {
|
|
20706
|
+
headers: {
|
|
20707
|
+
[name: string]: unknown;
|
|
20708
|
+
};
|
|
20709
|
+
content: {
|
|
20710
|
+
'application/problem+json': components['schemas']['ForbiddenProblemResponse'];
|
|
20711
|
+
};
|
|
20712
|
+
};
|
|
20713
|
+
/** @description The origin server did not find a current representation for the target resource or is not willing to disclose that one exists. */
|
|
20714
|
+
404: {
|
|
20715
|
+
headers: {
|
|
20716
|
+
[name: string]: unknown;
|
|
20717
|
+
};
|
|
20718
|
+
content: {
|
|
20719
|
+
'application/problem+json': components['schemas']['NotFoundProblemResponse'];
|
|
20720
|
+
};
|
|
20721
|
+
};
|
|
20722
|
+
/** @description One or more conditions given in the request header fields evaluated to false when tested on the server. */
|
|
20723
|
+
412: {
|
|
20724
|
+
headers: {
|
|
20725
|
+
[name: string]: unknown;
|
|
20726
|
+
};
|
|
20727
|
+
content: {
|
|
20728
|
+
'application/problem+json': components['schemas']['PreconditionFailedProblemResponse'];
|
|
20729
|
+
};
|
|
20730
|
+
};
|
|
20731
|
+
/** @description The server encountered an unexpected condition that prevented it from fulfilling the request. */
|
|
20732
|
+
500: {
|
|
20733
|
+
headers: {
|
|
20734
|
+
[name: string]: unknown;
|
|
20735
|
+
};
|
|
20736
|
+
content: {
|
|
20737
|
+
'application/problem+json': components['schemas']['InternalServerErrorProblemResponse'];
|
|
20738
|
+
};
|
|
20739
|
+
};
|
|
20740
|
+
/** @description The server is currently unable to handle the request due to a temporary overload or scheduled maintenance, which will likely be alleviated after some delay. */
|
|
20741
|
+
503: {
|
|
20742
|
+
headers: {
|
|
20743
|
+
[name: string]: unknown;
|
|
20744
|
+
};
|
|
20745
|
+
content: {
|
|
20746
|
+
'application/problem+json': components['schemas']['ServiceUnavailableProblemResponse'];
|
|
20747
|
+
};
|
|
20748
|
+
};
|
|
20749
|
+
/** @description An unexpected error response. */
|
|
20750
|
+
default: {
|
|
20751
|
+
headers: {
|
|
20752
|
+
[name: string]: unknown;
|
|
20753
|
+
};
|
|
20754
|
+
content: {
|
|
20755
|
+
'application/problem+json': components['schemas']['UnexpectedProblemResponse'];
|
|
20756
|
+
};
|
|
20757
|
+
};
|
|
20758
|
+
};
|
|
20759
|
+
};
|
|
20760
|
+
updateSubscriptionAddon: {
|
|
20761
|
+
parameters: {
|
|
20762
|
+
query?: never;
|
|
20763
|
+
header?: never;
|
|
20764
|
+
path: {
|
|
20765
|
+
subscriptionId: string;
|
|
20766
|
+
subscriptionAddonId: string;
|
|
20767
|
+
};
|
|
20768
|
+
cookie?: never;
|
|
20769
|
+
};
|
|
20770
|
+
requestBody: {
|
|
20771
|
+
content: {
|
|
20772
|
+
'application/json': components['schemas']['SubscriptionAddonUpdate'];
|
|
20773
|
+
};
|
|
20774
|
+
};
|
|
20775
|
+
responses: {
|
|
20776
|
+
/** @description The request has succeeded. */
|
|
20777
|
+
200: {
|
|
20778
|
+
headers: {
|
|
20779
|
+
[name: string]: unknown;
|
|
20780
|
+
};
|
|
20781
|
+
content: {
|
|
20782
|
+
'application/json': components['schemas']['SubscriptionAddon'];
|
|
20783
|
+
};
|
|
20784
|
+
};
|
|
20785
|
+
/** @description The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing). */
|
|
20786
|
+
400: {
|
|
20787
|
+
headers: {
|
|
20788
|
+
[name: string]: unknown;
|
|
20789
|
+
};
|
|
20790
|
+
content: {
|
|
20791
|
+
'application/problem+json': components['schemas']['BadRequestProblemResponse'];
|
|
20792
|
+
};
|
|
20793
|
+
};
|
|
20794
|
+
/** @description The request has not been applied because it lacks valid authentication credentials for the target resource. */
|
|
20795
|
+
401: {
|
|
20796
|
+
headers: {
|
|
20797
|
+
[name: string]: unknown;
|
|
20798
|
+
};
|
|
20799
|
+
content: {
|
|
20800
|
+
'application/problem+json': components['schemas']['UnauthorizedProblemResponse'];
|
|
20801
|
+
};
|
|
20802
|
+
};
|
|
20803
|
+
/** @description The server understood the request but refuses to authorize it. */
|
|
20804
|
+
403: {
|
|
20805
|
+
headers: {
|
|
20806
|
+
[name: string]: unknown;
|
|
20807
|
+
};
|
|
20808
|
+
content: {
|
|
20809
|
+
'application/problem+json': components['schemas']['ForbiddenProblemResponse'];
|
|
20810
|
+
};
|
|
20811
|
+
};
|
|
20812
|
+
/** @description The origin server did not find a current representation for the target resource or is not willing to disclose that one exists. */
|
|
20813
|
+
404: {
|
|
20814
|
+
headers: {
|
|
20815
|
+
[name: string]: unknown;
|
|
20816
|
+
};
|
|
20817
|
+
content: {
|
|
20818
|
+
'application/problem+json': components['schemas']['NotFoundProblemResponse'];
|
|
20819
|
+
};
|
|
20820
|
+
};
|
|
20821
|
+
/** @description One or more conditions given in the request header fields evaluated to false when tested on the server. */
|
|
20822
|
+
412: {
|
|
20823
|
+
headers: {
|
|
20824
|
+
[name: string]: unknown;
|
|
20825
|
+
};
|
|
20826
|
+
content: {
|
|
20827
|
+
'application/problem+json': components['schemas']['PreconditionFailedProblemResponse'];
|
|
20828
|
+
};
|
|
20829
|
+
};
|
|
20830
|
+
/** @description The server encountered an unexpected condition that prevented it from fulfilling the request. */
|
|
20831
|
+
500: {
|
|
20832
|
+
headers: {
|
|
20833
|
+
[name: string]: unknown;
|
|
20834
|
+
};
|
|
20835
|
+
content: {
|
|
20836
|
+
'application/problem+json': components['schemas']['InternalServerErrorProblemResponse'];
|
|
20837
|
+
};
|
|
20838
|
+
};
|
|
20839
|
+
/** @description The server is currently unable to handle the request due to a temporary overload or scheduled maintenance, which will likely be alleviated after some delay. */
|
|
20840
|
+
503: {
|
|
20841
|
+
headers: {
|
|
20842
|
+
[name: string]: unknown;
|
|
20843
|
+
};
|
|
20844
|
+
content: {
|
|
20845
|
+
'application/problem+json': components['schemas']['ServiceUnavailableProblemResponse'];
|
|
20846
|
+
};
|
|
20847
|
+
};
|
|
20848
|
+
/** @description An unexpected error response. */
|
|
20849
|
+
default: {
|
|
20850
|
+
headers: {
|
|
20851
|
+
[name: string]: unknown;
|
|
20852
|
+
};
|
|
20853
|
+
content: {
|
|
20854
|
+
'application/problem+json': components['schemas']['UnexpectedProblemResponse'];
|
|
20855
|
+
};
|
|
20856
|
+
};
|
|
20857
|
+
};
|
|
20858
|
+
};
|
|
20138
20859
|
cancelSubscription: {
|
|
20139
20860
|
parameters: {
|
|
20140
20861
|
query?: never;
|