@openmeter/sdk 1.0.0-beta.207 → 1.0.0-beta.209
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 +785 -13
- package/dist/cjs/{tsconfig.2e070361.tsbuildinfo → tsconfig.1abe68fc.tsbuildinfo} +1 -1
- package/dist/cjs/{tsconfig.986e9f83.tsbuildinfo → tsconfig.1c637a57.tsbuildinfo} +1 -1
- package/dist/src/client/billing.d.ts +1 -0
- package/dist/src/client/schemas.d.ts +785 -13
- package/dist/tsconfig.tsbuildinfo +1 -1
- package/package.json +1 -1
|
@@ -1773,6 +1773,54 @@ export interface paths {
|
|
|
1773
1773
|
patch: operations['editSubscription'];
|
|
1774
1774
|
trace?: never;
|
|
1775
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
|
+
};
|
|
1776
1824
|
'/api/v1/subscriptions/{subscriptionId}/cancel': {
|
|
1777
1825
|
parameters: {
|
|
1778
1826
|
query?: never;
|
|
@@ -2260,6 +2308,55 @@ export interface components {
|
|
|
2260
2308
|
* Expand settings govern if this includes the whole app object or just the ID references. */
|
|
2261
2309
|
readonly apps: components['schemas']['BillingProfileAppsOrReference'];
|
|
2262
2310
|
};
|
|
2311
|
+
/** @description A discount on a price. This extends the productcatalog.Discount union to include the
|
|
2312
|
+
* billing specific extra fields required. */
|
|
2313
|
+
BillingDiscount: components['schemas']['BillingDiscountPercentage'] | components['schemas']['BillingDiscountUsage'];
|
|
2314
|
+
/** @description A percentage discount. */
|
|
2315
|
+
BillingDiscountPercentage: {
|
|
2316
|
+
/**
|
|
2317
|
+
* @description The type of the discount. (enum property replaced by openapi-typescript)
|
|
2318
|
+
* @enum {string}
|
|
2319
|
+
*/
|
|
2320
|
+
type: 'percentage';
|
|
2321
|
+
/**
|
|
2322
|
+
* Percentage
|
|
2323
|
+
* @description The percentage of the discount.
|
|
2324
|
+
*/
|
|
2325
|
+
percentage: components['schemas']['Percentage'];
|
|
2326
|
+
/**
|
|
2327
|
+
* @description Correlation ID for the discount.
|
|
2328
|
+
*
|
|
2329
|
+
* This is used to link discounts across different invoices (progressive billing use case).
|
|
2330
|
+
*
|
|
2331
|
+
* If not provided, the invoicing engine will auto-generate one.
|
|
2332
|
+
* @example 01G65Z755AFWAKHE12NY0CQ9FH
|
|
2333
|
+
*/
|
|
2334
|
+
correlationId?: string;
|
|
2335
|
+
};
|
|
2336
|
+
/** @description A usage discount. */
|
|
2337
|
+
BillingDiscountUsage: {
|
|
2338
|
+
/**
|
|
2339
|
+
* @description The type of the discount. (enum property replaced by openapi-typescript)
|
|
2340
|
+
* @enum {string}
|
|
2341
|
+
*/
|
|
2342
|
+
type: 'usage';
|
|
2343
|
+
/**
|
|
2344
|
+
* Usage
|
|
2345
|
+
* @description The quantity of the usage discount.
|
|
2346
|
+
*
|
|
2347
|
+
* Must be positive.
|
|
2348
|
+
*/
|
|
2349
|
+
quantity: components['schemas']['Numeric'];
|
|
2350
|
+
/**
|
|
2351
|
+
* @description Correlation ID for the discount.
|
|
2352
|
+
*
|
|
2353
|
+
* This is used to link discounts across different invoices (progressive billing use case).
|
|
2354
|
+
*
|
|
2355
|
+
* If not provided, the invoicing engine will auto-generate one.
|
|
2356
|
+
* @example 01G65Z755AFWAKHE12NY0CQ9FH
|
|
2357
|
+
*/
|
|
2358
|
+
correlationId?: string;
|
|
2359
|
+
};
|
|
2263
2360
|
/** @description Party represents a person or business entity. */
|
|
2264
2361
|
BillingParty: {
|
|
2265
2362
|
/** @description Unique identifier for the party (if available) */
|
|
@@ -4997,16 +5094,12 @@ export interface components {
|
|
|
4997
5094
|
* }
|
|
4998
5095
|
*/
|
|
4999
5096
|
price: components['schemas']['FlatPriceWithPaymentTerm'] | null;
|
|
5000
|
-
/**
|
|
5001
|
-
* Discounts
|
|
5002
|
-
* @description The discount of the rate card. For flat fee rate cards only percentage discounts are supported.
|
|
5003
|
-
* Only available when price is set.
|
|
5004
|
-
*/
|
|
5005
|
-
discounts?: components['schemas']['DiscountPercentage'][];
|
|
5006
5097
|
/** @description Quantity of the item being sold.
|
|
5007
5098
|
*
|
|
5008
5099
|
* Default: 1 */
|
|
5009
5100
|
quantity?: components['schemas']['Numeric'];
|
|
5101
|
+
/** @description The discounts that are applied to the line. */
|
|
5102
|
+
discounts?: components['schemas']['BillingDiscountPercentage'][];
|
|
5010
5103
|
};
|
|
5011
5104
|
/**
|
|
5012
5105
|
* InvoiceGenericDocumentRef is used to describe an existing document or a specific part of it's contents.
|
|
@@ -5585,6 +5678,8 @@ export interface components {
|
|
|
5585
5678
|
rateCard?: components['schemas']['InvoiceUsageBasedRateCard'];
|
|
5586
5679
|
/** @description The quantity of the item being sold. */
|
|
5587
5680
|
readonly quantity?: components['schemas']['Numeric'];
|
|
5681
|
+
/** @description The quantity of the item that has been metered for the period before any discounts were applied. */
|
|
5682
|
+
readonly meteredQuantity?: components['schemas']['Numeric'];
|
|
5588
5683
|
/** @description The quantity of the item used in before this line's period.
|
|
5589
5684
|
*
|
|
5590
5685
|
* It is non-zero in case of progressive billing, when this shows how much of the usage was already billed. */
|
|
@@ -5724,13 +5819,8 @@ export interface components {
|
|
|
5724
5819
|
/** @description The price of the rate card.
|
|
5725
5820
|
* When null, the feature or service is free. */
|
|
5726
5821
|
price: components['schemas']['RateCardUsageBasedPrice'] | null;
|
|
5727
|
-
/**
|
|
5728
|
-
|
|
5729
|
-
* @description The discounts of the rate card.
|
|
5730
|
-
*
|
|
5731
|
-
* Flat fee rate cards only support percentage discounts.
|
|
5732
|
-
*/
|
|
5733
|
-
discounts?: components['schemas']['Discount'][];
|
|
5822
|
+
/** @description The discounts that are applied to the line. */
|
|
5823
|
+
discounts?: components['schemas']['BillingDiscount'][];
|
|
5734
5824
|
};
|
|
5735
5825
|
/** @description InvoiceWorkflowInvoicingSettingsReplaceUpdate represents the update model for the invoicing settings of an invoice workflow. */
|
|
5736
5826
|
InvoiceWorkflowInvoicingSettingsReplaceUpdate: {
|
|
@@ -7863,6 +7953,285 @@ export interface components {
|
|
|
7863
7953
|
*/
|
|
7864
7954
|
currency: components['schemas']['CurrencyCode'];
|
|
7865
7955
|
};
|
|
7956
|
+
/** @description A subscription add-on, represents concrete instances of an add-on for a given subscription. */
|
|
7957
|
+
SubscriptionAddon: {
|
|
7958
|
+
/**
|
|
7959
|
+
* ID
|
|
7960
|
+
* @description A unique identifier for the resource.
|
|
7961
|
+
* @example 01G65Z755AFWAKHE12NY0CQ9FH
|
|
7962
|
+
*/
|
|
7963
|
+
readonly id: string;
|
|
7964
|
+
/**
|
|
7965
|
+
* Display name
|
|
7966
|
+
* @description Human-readable name for the resource. Between 1 and 256 characters.
|
|
7967
|
+
*/
|
|
7968
|
+
name: string;
|
|
7969
|
+
/**
|
|
7970
|
+
* Description
|
|
7971
|
+
* @description Optional description of the resource. Maximum 1024 characters.
|
|
7972
|
+
*/
|
|
7973
|
+
description?: string;
|
|
7974
|
+
/**
|
|
7975
|
+
* Metadata
|
|
7976
|
+
* @description Additional metadata for the resource.
|
|
7977
|
+
*/
|
|
7978
|
+
metadata?: components['schemas']['Metadata'] | null;
|
|
7979
|
+
/**
|
|
7980
|
+
* Creation Time
|
|
7981
|
+
* Format: date-time
|
|
7982
|
+
* @description Timestamp of when the resource was created.
|
|
7983
|
+
* @example 2024-01-01T01:01:01.001Z
|
|
7984
|
+
*/
|
|
7985
|
+
readonly createdAt: Date;
|
|
7986
|
+
/**
|
|
7987
|
+
* Last Update Time
|
|
7988
|
+
* Format: date-time
|
|
7989
|
+
* @description Timestamp of when the resource was last updated.
|
|
7990
|
+
* @example 2024-01-01T01:01:01.001Z
|
|
7991
|
+
*/
|
|
7992
|
+
readonly updatedAt: Date;
|
|
7993
|
+
/**
|
|
7994
|
+
* Deletion Time
|
|
7995
|
+
* Format: date-time
|
|
7996
|
+
* @description Timestamp of when the resource was permanently deleted.
|
|
7997
|
+
* @example 2024-01-01T01:01:01.001Z
|
|
7998
|
+
*/
|
|
7999
|
+
readonly deletedAt?: Date;
|
|
8000
|
+
/**
|
|
8001
|
+
* Format: date-time
|
|
8002
|
+
* @description The cadence start of the resource.
|
|
8003
|
+
* @example 2023-01-01T01:01:01.001Z
|
|
8004
|
+
*/
|
|
8005
|
+
activeFrom: Date;
|
|
8006
|
+
/**
|
|
8007
|
+
* Format: date-time
|
|
8008
|
+
* @description The cadence end of the resource.
|
|
8009
|
+
* @example 2023-01-01T01:01:01.001Z
|
|
8010
|
+
*/
|
|
8011
|
+
activeTo?: Date;
|
|
8012
|
+
/**
|
|
8013
|
+
* Addon
|
|
8014
|
+
* @description Partially populated add-on properties.
|
|
8015
|
+
*/
|
|
8016
|
+
addon: {
|
|
8017
|
+
/**
|
|
8018
|
+
* ID
|
|
8019
|
+
* @description The ID of the add-on.
|
|
8020
|
+
* @example 01G65Z755AFWAKHE12NY0CQ9FH
|
|
8021
|
+
*/
|
|
8022
|
+
id: string;
|
|
8023
|
+
/**
|
|
8024
|
+
* Key
|
|
8025
|
+
* @description A semi-unique identifier for the resource.
|
|
8026
|
+
*/
|
|
8027
|
+
readonly key: string;
|
|
8028
|
+
/**
|
|
8029
|
+
* Version
|
|
8030
|
+
* @description The version of the Add-on which templates this instance.
|
|
8031
|
+
* @default 1
|
|
8032
|
+
*/
|
|
8033
|
+
readonly version: number;
|
|
8034
|
+
/**
|
|
8035
|
+
* InstanceType
|
|
8036
|
+
* @description The instance type of the add-on.
|
|
8037
|
+
*/
|
|
8038
|
+
readonly instanceType: components['schemas']['AddonInstanceType'];
|
|
8039
|
+
};
|
|
8040
|
+
/**
|
|
8041
|
+
* QuantityAt
|
|
8042
|
+
* Format: date-time
|
|
8043
|
+
* @description For which point in time the quantity was resolved to.
|
|
8044
|
+
* @example 2025-01-05T00:00:00Z
|
|
8045
|
+
*/
|
|
8046
|
+
readonly quantityAt: Date;
|
|
8047
|
+
/**
|
|
8048
|
+
* Quantity
|
|
8049
|
+
* @description The quantity of the add-on. Always 1 for single instance add-ons.
|
|
8050
|
+
* @example 1
|
|
8051
|
+
*/
|
|
8052
|
+
quantity: number;
|
|
8053
|
+
/**
|
|
8054
|
+
* Timeline
|
|
8055
|
+
* @description The timeline of the add-on. The returned periods are sorted and continuous.
|
|
8056
|
+
* @example [
|
|
8057
|
+
* {
|
|
8058
|
+
* "quantity": 1,
|
|
8059
|
+
* "activeFrom": "2025-01-01T00:00:00Z",
|
|
8060
|
+
* "activeTo": "2025-01-02T00:00:00Z"
|
|
8061
|
+
* },
|
|
8062
|
+
* {
|
|
8063
|
+
* "quantity": 0,
|
|
8064
|
+
* "activeFrom": "2025-01-02T00:00:00Z",
|
|
8065
|
+
* "activeTo": "2025-01-03T00:00:00Z"
|
|
8066
|
+
* },
|
|
8067
|
+
* {
|
|
8068
|
+
* "quantity": 1,
|
|
8069
|
+
* "activeFrom": "2025-01-03T00:00:00Z"
|
|
8070
|
+
* }
|
|
8071
|
+
* ]
|
|
8072
|
+
*/
|
|
8073
|
+
readonly timeline: components['schemas']['SubscriptionAddonTimelineSegment'][];
|
|
8074
|
+
/**
|
|
8075
|
+
* SubscriptionID
|
|
8076
|
+
* @description The ID of the subscription.
|
|
8077
|
+
* @example 01G65Z755AFWAKHE12NY0CQ9FH
|
|
8078
|
+
*/
|
|
8079
|
+
readonly subscriptionId: string;
|
|
8080
|
+
/**
|
|
8081
|
+
* Rate cards
|
|
8082
|
+
* @description The rate cards of the add-on.
|
|
8083
|
+
*/
|
|
8084
|
+
readonly rateCards: components['schemas']['SubscriptionAddonRateCard'][];
|
|
8085
|
+
};
|
|
8086
|
+
/** @description Resource create operation model. */
|
|
8087
|
+
SubscriptionAddonCreate: {
|
|
8088
|
+
/**
|
|
8089
|
+
* Display name
|
|
8090
|
+
* @description Human-readable name for the resource. Between 1 and 256 characters.
|
|
8091
|
+
*/
|
|
8092
|
+
name: string;
|
|
8093
|
+
/**
|
|
8094
|
+
* Description
|
|
8095
|
+
* @description Optional description of the resource. Maximum 1024 characters.
|
|
8096
|
+
*/
|
|
8097
|
+
description?: string;
|
|
8098
|
+
/**
|
|
8099
|
+
* Metadata
|
|
8100
|
+
* @description Additional metadata for the resource.
|
|
8101
|
+
*/
|
|
8102
|
+
metadata?: components['schemas']['Metadata'] | null;
|
|
8103
|
+
/**
|
|
8104
|
+
* Format: date-time
|
|
8105
|
+
* @description The cadence start of the resource.
|
|
8106
|
+
* @example 2023-01-01T01:01:01.001Z
|
|
8107
|
+
*/
|
|
8108
|
+
activeFrom: Date;
|
|
8109
|
+
/**
|
|
8110
|
+
* Format: date-time
|
|
8111
|
+
* @description The cadence end of the resource.
|
|
8112
|
+
* @example 2023-01-01T01:01:01.001Z
|
|
8113
|
+
*/
|
|
8114
|
+
activeTo?: Date;
|
|
8115
|
+
/**
|
|
8116
|
+
* Addon
|
|
8117
|
+
* @description Partially populated add-on properties.
|
|
8118
|
+
*/
|
|
8119
|
+
addon: {
|
|
8120
|
+
/**
|
|
8121
|
+
* ID
|
|
8122
|
+
* @description The ID of the add-on.
|
|
8123
|
+
* @example 01G65Z755AFWAKHE12NY0CQ9FH
|
|
8124
|
+
*/
|
|
8125
|
+
id: string;
|
|
8126
|
+
/**
|
|
8127
|
+
* Key
|
|
8128
|
+
* @description A semi-unique identifier for the resource.
|
|
8129
|
+
*/
|
|
8130
|
+
readonly key: string;
|
|
8131
|
+
/**
|
|
8132
|
+
* Version
|
|
8133
|
+
* @description The version of the Add-on which templates this instance.
|
|
8134
|
+
* @default 1
|
|
8135
|
+
*/
|
|
8136
|
+
readonly version: number;
|
|
8137
|
+
/**
|
|
8138
|
+
* InstanceType
|
|
8139
|
+
* @description The instance type of the add-on.
|
|
8140
|
+
*/
|
|
8141
|
+
readonly instanceType: components['schemas']['AddonInstanceType'];
|
|
8142
|
+
};
|
|
8143
|
+
/**
|
|
8144
|
+
* Quantity
|
|
8145
|
+
* @description The quantity of the add-on. Always 1 for single instance add-ons.
|
|
8146
|
+
* @example 1
|
|
8147
|
+
*/
|
|
8148
|
+
quantity: number;
|
|
8149
|
+
/**
|
|
8150
|
+
* Timing
|
|
8151
|
+
* @description The timing of the operation. After the create or update, a new entry will be created in the timeline.
|
|
8152
|
+
*/
|
|
8153
|
+
timing: components['schemas']['SubscriptionTiming'];
|
|
8154
|
+
};
|
|
8155
|
+
/** @description A rate card for a subscription add-on. */
|
|
8156
|
+
SubscriptionAddonRateCard: {
|
|
8157
|
+
/**
|
|
8158
|
+
* Rate card
|
|
8159
|
+
* @description The rate card.
|
|
8160
|
+
*/
|
|
8161
|
+
rateCard: components['schemas']['RateCard'];
|
|
8162
|
+
/**
|
|
8163
|
+
* Affected subscription item IDs
|
|
8164
|
+
* @description The IDs of the subscription items that this rate card belongs to.
|
|
8165
|
+
*/
|
|
8166
|
+
readonly affectedSubscriptionItemIds: string[];
|
|
8167
|
+
};
|
|
8168
|
+
/** @description A subscription add-on event. */
|
|
8169
|
+
SubscriptionAddonTimelineSegment: {
|
|
8170
|
+
/**
|
|
8171
|
+
* Format: date-time
|
|
8172
|
+
* @description The cadence start of the resource.
|
|
8173
|
+
* @example 2023-01-01T01:01:01.001Z
|
|
8174
|
+
*/
|
|
8175
|
+
activeFrom: Date;
|
|
8176
|
+
/**
|
|
8177
|
+
* Format: date-time
|
|
8178
|
+
* @description The cadence end of the resource.
|
|
8179
|
+
* @example 2023-01-01T01:01:01.001Z
|
|
8180
|
+
*/
|
|
8181
|
+
activeTo?: Date;
|
|
8182
|
+
/**
|
|
8183
|
+
* Quantity
|
|
8184
|
+
* @description The quantity of the add-on for the given period.
|
|
8185
|
+
* @example 1
|
|
8186
|
+
*/
|
|
8187
|
+
readonly quantity: number;
|
|
8188
|
+
};
|
|
8189
|
+
/** @description Resource create or update operation model. */
|
|
8190
|
+
SubscriptionAddonUpdate: {
|
|
8191
|
+
/**
|
|
8192
|
+
* Display name
|
|
8193
|
+
* @description Human-readable name for the resource. Between 1 and 256 characters.
|
|
8194
|
+
*/
|
|
8195
|
+
name?: string;
|
|
8196
|
+
/**
|
|
8197
|
+
* Description
|
|
8198
|
+
* @description Optional description of the resource. Maximum 1024 characters.
|
|
8199
|
+
*/
|
|
8200
|
+
description?: string;
|
|
8201
|
+
/**
|
|
8202
|
+
* Metadata
|
|
8203
|
+
* @description Additional metadata for the resource.
|
|
8204
|
+
*/
|
|
8205
|
+
metadata?: components['schemas']['Metadata'] | null;
|
|
8206
|
+
/**
|
|
8207
|
+
* Format: date-time
|
|
8208
|
+
* @description The cadence start of the resource.
|
|
8209
|
+
* @example 2023-01-01T01:01:01.001Z
|
|
8210
|
+
*/
|
|
8211
|
+
activeFrom?: Date;
|
|
8212
|
+
/**
|
|
8213
|
+
* Format: date-time
|
|
8214
|
+
* @description The cadence end of the resource.
|
|
8215
|
+
* @example 2023-01-01T01:01:01.001Z
|
|
8216
|
+
*/
|
|
8217
|
+
activeTo?: Date;
|
|
8218
|
+
/**
|
|
8219
|
+
* Addon
|
|
8220
|
+
* @description Partially populated add-on properties.
|
|
8221
|
+
*/
|
|
8222
|
+
addon?: Record<string, never>;
|
|
8223
|
+
/**
|
|
8224
|
+
* Quantity
|
|
8225
|
+
* @description The quantity of the add-on. Always 1 for single instance add-ons.
|
|
8226
|
+
* @example 1
|
|
8227
|
+
*/
|
|
8228
|
+
quantity?: number;
|
|
8229
|
+
/**
|
|
8230
|
+
* Timing
|
|
8231
|
+
* @description The timing of the operation. After the create or update, a new entry will be created in the timeline.
|
|
8232
|
+
*/
|
|
8233
|
+
timing?: components['schemas']['SubscriptionTiming'];
|
|
8234
|
+
};
|
|
7866
8235
|
/** @description Alignment details enriched with the current billing period. */
|
|
7867
8236
|
SubscriptionAlignment: {
|
|
7868
8237
|
/** @description Whether all Billable items and RateCards must align.
|
|
@@ -8721,6 +9090,9 @@ export type AppType = components['schemas']['AppType'];
|
|
|
8721
9090
|
export type BadRequestProblemResponse = components['schemas']['BadRequestProblemResponse'];
|
|
8722
9091
|
export type BalanceHistoryWindow = components['schemas']['BalanceHistoryWindow'];
|
|
8723
9092
|
export type BillingCustomerProfile = components['schemas']['BillingCustomerProfile'];
|
|
9093
|
+
export type BillingDiscount = components['schemas']['BillingDiscount'];
|
|
9094
|
+
export type BillingDiscountPercentage = components['schemas']['BillingDiscountPercentage'];
|
|
9095
|
+
export type BillingDiscountUsage = components['schemas']['BillingDiscountUsage'];
|
|
8724
9096
|
export type BillingParty = components['schemas']['BillingParty'];
|
|
8725
9097
|
export type BillingPartyReplaceUpdate = components['schemas']['BillingPartyReplaceUpdate'];
|
|
8726
9098
|
export type BillingPartyTaxIdentity = components['schemas']['BillingPartyTaxIdentity'];
|
|
@@ -8980,6 +9352,11 @@ export type StripeWebhookResponse = components['schemas']['StripeWebhookResponse
|
|
|
8980
9352
|
export type Subject = components['schemas']['Subject'];
|
|
8981
9353
|
export type SubjectUpsert = components['schemas']['SubjectUpsert'];
|
|
8982
9354
|
export type Subscription = components['schemas']['Subscription'];
|
|
9355
|
+
export type SubscriptionAddon = components['schemas']['SubscriptionAddon'];
|
|
9356
|
+
export type SubscriptionAddonCreate = components['schemas']['SubscriptionAddonCreate'];
|
|
9357
|
+
export type SubscriptionAddonRateCard = components['schemas']['SubscriptionAddonRateCard'];
|
|
9358
|
+
export type SubscriptionAddonTimelineSegment = components['schemas']['SubscriptionAddonTimelineSegment'];
|
|
9359
|
+
export type SubscriptionAddonUpdate = components['schemas']['SubscriptionAddonUpdate'];
|
|
8983
9360
|
export type SubscriptionAlignment = components['schemas']['SubscriptionAlignment'];
|
|
8984
9361
|
export type SubscriptionChange = components['schemas']['SubscriptionChange'];
|
|
8985
9362
|
export type SubscriptionChangeResponseBody = components['schemas']['SubscriptionChangeResponseBody'];
|
|
@@ -20127,6 +20504,401 @@ export interface operations {
|
|
|
20127
20504
|
};
|
|
20128
20505
|
};
|
|
20129
20506
|
};
|
|
20507
|
+
listSubscriptionAddons: {
|
|
20508
|
+
parameters: {
|
|
20509
|
+
query?: never;
|
|
20510
|
+
header?: never;
|
|
20511
|
+
path: {
|
|
20512
|
+
subscriptionId: string;
|
|
20513
|
+
};
|
|
20514
|
+
cookie?: never;
|
|
20515
|
+
};
|
|
20516
|
+
requestBody?: never;
|
|
20517
|
+
responses: {
|
|
20518
|
+
/** @description The request has succeeded. */
|
|
20519
|
+
200: {
|
|
20520
|
+
headers: {
|
|
20521
|
+
[name: string]: unknown;
|
|
20522
|
+
};
|
|
20523
|
+
content: {
|
|
20524
|
+
'application/json': components['schemas']['SubscriptionAddon'][];
|
|
20525
|
+
};
|
|
20526
|
+
};
|
|
20527
|
+
/** @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). */
|
|
20528
|
+
400: {
|
|
20529
|
+
headers: {
|
|
20530
|
+
[name: string]: unknown;
|
|
20531
|
+
};
|
|
20532
|
+
content: {
|
|
20533
|
+
'application/problem+json': components['schemas']['BadRequestProblemResponse'];
|
|
20534
|
+
};
|
|
20535
|
+
};
|
|
20536
|
+
/** @description The request has not been applied because it lacks valid authentication credentials for the target resource. */
|
|
20537
|
+
401: {
|
|
20538
|
+
headers: {
|
|
20539
|
+
[name: string]: unknown;
|
|
20540
|
+
};
|
|
20541
|
+
content: {
|
|
20542
|
+
'application/problem+json': components['schemas']['UnauthorizedProblemResponse'];
|
|
20543
|
+
};
|
|
20544
|
+
};
|
|
20545
|
+
/** @description The server understood the request but refuses to authorize it. */
|
|
20546
|
+
403: {
|
|
20547
|
+
headers: {
|
|
20548
|
+
[name: string]: unknown;
|
|
20549
|
+
};
|
|
20550
|
+
content: {
|
|
20551
|
+
'application/problem+json': components['schemas']['ForbiddenProblemResponse'];
|
|
20552
|
+
};
|
|
20553
|
+
};
|
|
20554
|
+
/** @description The origin server did not find a current representation for the target resource or is not willing to disclose that one exists. */
|
|
20555
|
+
404: {
|
|
20556
|
+
headers: {
|
|
20557
|
+
[name: string]: unknown;
|
|
20558
|
+
};
|
|
20559
|
+
content: {
|
|
20560
|
+
'application/problem+json': components['schemas']['NotFoundProblemResponse'];
|
|
20561
|
+
};
|
|
20562
|
+
};
|
|
20563
|
+
/** @description One or more conditions given in the request header fields evaluated to false when tested on the server. */
|
|
20564
|
+
412: {
|
|
20565
|
+
headers: {
|
|
20566
|
+
[name: string]: unknown;
|
|
20567
|
+
};
|
|
20568
|
+
content: {
|
|
20569
|
+
'application/problem+json': components['schemas']['PreconditionFailedProblemResponse'];
|
|
20570
|
+
};
|
|
20571
|
+
};
|
|
20572
|
+
/** @description The server encountered an unexpected condition that prevented it from fulfilling the request. */
|
|
20573
|
+
500: {
|
|
20574
|
+
headers: {
|
|
20575
|
+
[name: string]: unknown;
|
|
20576
|
+
};
|
|
20577
|
+
content: {
|
|
20578
|
+
'application/problem+json': components['schemas']['InternalServerErrorProblemResponse'];
|
|
20579
|
+
};
|
|
20580
|
+
};
|
|
20581
|
+
/** @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. */
|
|
20582
|
+
503: {
|
|
20583
|
+
headers: {
|
|
20584
|
+
[name: string]: unknown;
|
|
20585
|
+
};
|
|
20586
|
+
content: {
|
|
20587
|
+
'application/problem+json': components['schemas']['ServiceUnavailableProblemResponse'];
|
|
20588
|
+
};
|
|
20589
|
+
};
|
|
20590
|
+
/** @description An unexpected error response. */
|
|
20591
|
+
default: {
|
|
20592
|
+
headers: {
|
|
20593
|
+
[name: string]: unknown;
|
|
20594
|
+
};
|
|
20595
|
+
content: {
|
|
20596
|
+
'application/problem+json': components['schemas']['UnexpectedProblemResponse'];
|
|
20597
|
+
};
|
|
20598
|
+
};
|
|
20599
|
+
};
|
|
20600
|
+
};
|
|
20601
|
+
createSubscriptionAddon: {
|
|
20602
|
+
parameters: {
|
|
20603
|
+
query?: never;
|
|
20604
|
+
header?: never;
|
|
20605
|
+
path: {
|
|
20606
|
+
subscriptionId: string;
|
|
20607
|
+
};
|
|
20608
|
+
cookie?: never;
|
|
20609
|
+
};
|
|
20610
|
+
requestBody: {
|
|
20611
|
+
content: {
|
|
20612
|
+
'application/json': components['schemas']['SubscriptionAddonCreate'];
|
|
20613
|
+
};
|
|
20614
|
+
};
|
|
20615
|
+
responses: {
|
|
20616
|
+
/** @description The request has succeeded and a new resource has been created as a result. */
|
|
20617
|
+
201: {
|
|
20618
|
+
headers: {
|
|
20619
|
+
[name: string]: unknown;
|
|
20620
|
+
};
|
|
20621
|
+
content: {
|
|
20622
|
+
'application/json': components['schemas']['SubscriptionAddon'];
|
|
20623
|
+
};
|
|
20624
|
+
};
|
|
20625
|
+
/** @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). */
|
|
20626
|
+
400: {
|
|
20627
|
+
headers: {
|
|
20628
|
+
[name: string]: unknown;
|
|
20629
|
+
};
|
|
20630
|
+
content: {
|
|
20631
|
+
'application/problem+json': components['schemas']['BadRequestProblemResponse'];
|
|
20632
|
+
};
|
|
20633
|
+
};
|
|
20634
|
+
/** @description The request has not been applied because it lacks valid authentication credentials for the target resource. */
|
|
20635
|
+
401: {
|
|
20636
|
+
headers: {
|
|
20637
|
+
[name: string]: unknown;
|
|
20638
|
+
};
|
|
20639
|
+
content: {
|
|
20640
|
+
'application/problem+json': components['schemas']['UnauthorizedProblemResponse'];
|
|
20641
|
+
};
|
|
20642
|
+
};
|
|
20643
|
+
/** @description The server understood the request but refuses to authorize it. */
|
|
20644
|
+
403: {
|
|
20645
|
+
headers: {
|
|
20646
|
+
[name: string]: unknown;
|
|
20647
|
+
};
|
|
20648
|
+
content: {
|
|
20649
|
+
'application/problem+json': components['schemas']['ForbiddenProblemResponse'];
|
|
20650
|
+
};
|
|
20651
|
+
};
|
|
20652
|
+
/** @description The origin server did not find a current representation for the target resource or is not willing to disclose that one exists. */
|
|
20653
|
+
404: {
|
|
20654
|
+
headers: {
|
|
20655
|
+
[name: string]: unknown;
|
|
20656
|
+
};
|
|
20657
|
+
content: {
|
|
20658
|
+
'application/problem+json': components['schemas']['NotFoundProblemResponse'];
|
|
20659
|
+
};
|
|
20660
|
+
};
|
|
20661
|
+
/** @description The request could not be completed due to a conflict with the current state of the target resource. */
|
|
20662
|
+
409: {
|
|
20663
|
+
headers: {
|
|
20664
|
+
[name: string]: unknown;
|
|
20665
|
+
};
|
|
20666
|
+
content: {
|
|
20667
|
+
'application/problem+json': components['schemas']['ConflictProblemResponse'];
|
|
20668
|
+
};
|
|
20669
|
+
};
|
|
20670
|
+
/** @description One or more conditions given in the request header fields evaluated to false when tested on the server. */
|
|
20671
|
+
412: {
|
|
20672
|
+
headers: {
|
|
20673
|
+
[name: string]: unknown;
|
|
20674
|
+
};
|
|
20675
|
+
content: {
|
|
20676
|
+
'application/problem+json': components['schemas']['PreconditionFailedProblemResponse'];
|
|
20677
|
+
};
|
|
20678
|
+
};
|
|
20679
|
+
/** @description The server encountered an unexpected condition that prevented it from fulfilling the request. */
|
|
20680
|
+
500: {
|
|
20681
|
+
headers: {
|
|
20682
|
+
[name: string]: unknown;
|
|
20683
|
+
};
|
|
20684
|
+
content: {
|
|
20685
|
+
'application/problem+json': components['schemas']['InternalServerErrorProblemResponse'];
|
|
20686
|
+
};
|
|
20687
|
+
};
|
|
20688
|
+
/** @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. */
|
|
20689
|
+
503: {
|
|
20690
|
+
headers: {
|
|
20691
|
+
[name: string]: unknown;
|
|
20692
|
+
};
|
|
20693
|
+
content: {
|
|
20694
|
+
'application/problem+json': components['schemas']['ServiceUnavailableProblemResponse'];
|
|
20695
|
+
};
|
|
20696
|
+
};
|
|
20697
|
+
/** @description An unexpected error response. */
|
|
20698
|
+
default: {
|
|
20699
|
+
headers: {
|
|
20700
|
+
[name: string]: unknown;
|
|
20701
|
+
};
|
|
20702
|
+
content: {
|
|
20703
|
+
'application/problem+json': components['schemas']['UnexpectedProblemResponse'];
|
|
20704
|
+
};
|
|
20705
|
+
};
|
|
20706
|
+
};
|
|
20707
|
+
};
|
|
20708
|
+
getSubscriptionAddon: {
|
|
20709
|
+
parameters: {
|
|
20710
|
+
query?: never;
|
|
20711
|
+
header?: never;
|
|
20712
|
+
path: {
|
|
20713
|
+
subscriptionId: string;
|
|
20714
|
+
subscriptionAddonId: string;
|
|
20715
|
+
};
|
|
20716
|
+
cookie?: never;
|
|
20717
|
+
};
|
|
20718
|
+
requestBody?: never;
|
|
20719
|
+
responses: {
|
|
20720
|
+
/** @description The request has succeeded. */
|
|
20721
|
+
200: {
|
|
20722
|
+
headers: {
|
|
20723
|
+
[name: string]: unknown;
|
|
20724
|
+
};
|
|
20725
|
+
content: {
|
|
20726
|
+
'application/json': components['schemas']['SubscriptionAddon'];
|
|
20727
|
+
};
|
|
20728
|
+
};
|
|
20729
|
+
/** @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). */
|
|
20730
|
+
400: {
|
|
20731
|
+
headers: {
|
|
20732
|
+
[name: string]: unknown;
|
|
20733
|
+
};
|
|
20734
|
+
content: {
|
|
20735
|
+
'application/problem+json': components['schemas']['BadRequestProblemResponse'];
|
|
20736
|
+
};
|
|
20737
|
+
};
|
|
20738
|
+
/** @description The request has not been applied because it lacks valid authentication credentials for the target resource. */
|
|
20739
|
+
401: {
|
|
20740
|
+
headers: {
|
|
20741
|
+
[name: string]: unknown;
|
|
20742
|
+
};
|
|
20743
|
+
content: {
|
|
20744
|
+
'application/problem+json': components['schemas']['UnauthorizedProblemResponse'];
|
|
20745
|
+
};
|
|
20746
|
+
};
|
|
20747
|
+
/** @description The server understood the request but refuses to authorize it. */
|
|
20748
|
+
403: {
|
|
20749
|
+
headers: {
|
|
20750
|
+
[name: string]: unknown;
|
|
20751
|
+
};
|
|
20752
|
+
content: {
|
|
20753
|
+
'application/problem+json': components['schemas']['ForbiddenProblemResponse'];
|
|
20754
|
+
};
|
|
20755
|
+
};
|
|
20756
|
+
/** @description The origin server did not find a current representation for the target resource or is not willing to disclose that one exists. */
|
|
20757
|
+
404: {
|
|
20758
|
+
headers: {
|
|
20759
|
+
[name: string]: unknown;
|
|
20760
|
+
};
|
|
20761
|
+
content: {
|
|
20762
|
+
'application/problem+json': components['schemas']['NotFoundProblemResponse'];
|
|
20763
|
+
};
|
|
20764
|
+
};
|
|
20765
|
+
/** @description One or more conditions given in the request header fields evaluated to false when tested on the server. */
|
|
20766
|
+
412: {
|
|
20767
|
+
headers: {
|
|
20768
|
+
[name: string]: unknown;
|
|
20769
|
+
};
|
|
20770
|
+
content: {
|
|
20771
|
+
'application/problem+json': components['schemas']['PreconditionFailedProblemResponse'];
|
|
20772
|
+
};
|
|
20773
|
+
};
|
|
20774
|
+
/** @description The server encountered an unexpected condition that prevented it from fulfilling the request. */
|
|
20775
|
+
500: {
|
|
20776
|
+
headers: {
|
|
20777
|
+
[name: string]: unknown;
|
|
20778
|
+
};
|
|
20779
|
+
content: {
|
|
20780
|
+
'application/problem+json': components['schemas']['InternalServerErrorProblemResponse'];
|
|
20781
|
+
};
|
|
20782
|
+
};
|
|
20783
|
+
/** @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. */
|
|
20784
|
+
503: {
|
|
20785
|
+
headers: {
|
|
20786
|
+
[name: string]: unknown;
|
|
20787
|
+
};
|
|
20788
|
+
content: {
|
|
20789
|
+
'application/problem+json': components['schemas']['ServiceUnavailableProblemResponse'];
|
|
20790
|
+
};
|
|
20791
|
+
};
|
|
20792
|
+
/** @description An unexpected error response. */
|
|
20793
|
+
default: {
|
|
20794
|
+
headers: {
|
|
20795
|
+
[name: string]: unknown;
|
|
20796
|
+
};
|
|
20797
|
+
content: {
|
|
20798
|
+
'application/problem+json': components['schemas']['UnexpectedProblemResponse'];
|
|
20799
|
+
};
|
|
20800
|
+
};
|
|
20801
|
+
};
|
|
20802
|
+
};
|
|
20803
|
+
updateSubscriptionAddon: {
|
|
20804
|
+
parameters: {
|
|
20805
|
+
query?: never;
|
|
20806
|
+
header?: never;
|
|
20807
|
+
path: {
|
|
20808
|
+
subscriptionId: string;
|
|
20809
|
+
subscriptionAddonId: string;
|
|
20810
|
+
};
|
|
20811
|
+
cookie?: never;
|
|
20812
|
+
};
|
|
20813
|
+
requestBody: {
|
|
20814
|
+
content: {
|
|
20815
|
+
'application/json': components['schemas']['SubscriptionAddonUpdate'];
|
|
20816
|
+
};
|
|
20817
|
+
};
|
|
20818
|
+
responses: {
|
|
20819
|
+
/** @description The request has succeeded. */
|
|
20820
|
+
200: {
|
|
20821
|
+
headers: {
|
|
20822
|
+
[name: string]: unknown;
|
|
20823
|
+
};
|
|
20824
|
+
content: {
|
|
20825
|
+
'application/json': components['schemas']['SubscriptionAddon'];
|
|
20826
|
+
};
|
|
20827
|
+
};
|
|
20828
|
+
/** @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). */
|
|
20829
|
+
400: {
|
|
20830
|
+
headers: {
|
|
20831
|
+
[name: string]: unknown;
|
|
20832
|
+
};
|
|
20833
|
+
content: {
|
|
20834
|
+
'application/problem+json': components['schemas']['BadRequestProblemResponse'];
|
|
20835
|
+
};
|
|
20836
|
+
};
|
|
20837
|
+
/** @description The request has not been applied because it lacks valid authentication credentials for the target resource. */
|
|
20838
|
+
401: {
|
|
20839
|
+
headers: {
|
|
20840
|
+
[name: string]: unknown;
|
|
20841
|
+
};
|
|
20842
|
+
content: {
|
|
20843
|
+
'application/problem+json': components['schemas']['UnauthorizedProblemResponse'];
|
|
20844
|
+
};
|
|
20845
|
+
};
|
|
20846
|
+
/** @description The server understood the request but refuses to authorize it. */
|
|
20847
|
+
403: {
|
|
20848
|
+
headers: {
|
|
20849
|
+
[name: string]: unknown;
|
|
20850
|
+
};
|
|
20851
|
+
content: {
|
|
20852
|
+
'application/problem+json': components['schemas']['ForbiddenProblemResponse'];
|
|
20853
|
+
};
|
|
20854
|
+
};
|
|
20855
|
+
/** @description The origin server did not find a current representation for the target resource or is not willing to disclose that one exists. */
|
|
20856
|
+
404: {
|
|
20857
|
+
headers: {
|
|
20858
|
+
[name: string]: unknown;
|
|
20859
|
+
};
|
|
20860
|
+
content: {
|
|
20861
|
+
'application/problem+json': components['schemas']['NotFoundProblemResponse'];
|
|
20862
|
+
};
|
|
20863
|
+
};
|
|
20864
|
+
/** @description One or more conditions given in the request header fields evaluated to false when tested on the server. */
|
|
20865
|
+
412: {
|
|
20866
|
+
headers: {
|
|
20867
|
+
[name: string]: unknown;
|
|
20868
|
+
};
|
|
20869
|
+
content: {
|
|
20870
|
+
'application/problem+json': components['schemas']['PreconditionFailedProblemResponse'];
|
|
20871
|
+
};
|
|
20872
|
+
};
|
|
20873
|
+
/** @description The server encountered an unexpected condition that prevented it from fulfilling the request. */
|
|
20874
|
+
500: {
|
|
20875
|
+
headers: {
|
|
20876
|
+
[name: string]: unknown;
|
|
20877
|
+
};
|
|
20878
|
+
content: {
|
|
20879
|
+
'application/problem+json': components['schemas']['InternalServerErrorProblemResponse'];
|
|
20880
|
+
};
|
|
20881
|
+
};
|
|
20882
|
+
/** @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. */
|
|
20883
|
+
503: {
|
|
20884
|
+
headers: {
|
|
20885
|
+
[name: string]: unknown;
|
|
20886
|
+
};
|
|
20887
|
+
content: {
|
|
20888
|
+
'application/problem+json': components['schemas']['ServiceUnavailableProblemResponse'];
|
|
20889
|
+
};
|
|
20890
|
+
};
|
|
20891
|
+
/** @description An unexpected error response. */
|
|
20892
|
+
default: {
|
|
20893
|
+
headers: {
|
|
20894
|
+
[name: string]: unknown;
|
|
20895
|
+
};
|
|
20896
|
+
content: {
|
|
20897
|
+
'application/problem+json': components['schemas']['UnexpectedProblemResponse'];
|
|
20898
|
+
};
|
|
20899
|
+
};
|
|
20900
|
+
};
|
|
20901
|
+
};
|
|
20130
20902
|
cancelSubscription: {
|
|
20131
20903
|
parameters: {
|
|
20132
20904
|
query?: never;
|