@aimee.shop/sdk 0.19.0 → 0.20.0-dev.155
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.
|
@@ -7892,7 +7892,7 @@ export interface paths {
|
|
|
7892
7892
|
};
|
|
7893
7893
|
/**
|
|
7894
7894
|
* Get platform billing usage for a UTC calendar month
|
|
7895
|
-
* @description Returns billable order GMV (discounted merchandise + shipping, excluding tax) aggregated per currency and per store for the organization (tenant). Fee is
|
|
7895
|
+
* @description Returns billable order GMV (discounted merchandise + shipping, excluding tax) aggregated per currency and per store for the organization (tenant). Fee is the rate card's graduated GMV line, estimated at read time. Sandbox store orders are excluded. This is a mutable event-backed read model; do not charge from it directly (#63).
|
|
7896
7896
|
*/
|
|
7897
7897
|
get: operations['BillingUsageController_getUsage'];
|
|
7898
7898
|
put?: never;
|
|
@@ -7950,7 +7950,10 @@ export interface paths {
|
|
|
7950
7950
|
path?: never;
|
|
7951
7951
|
cookie?: never;
|
|
7952
7952
|
};
|
|
7953
|
-
/**
|
|
7953
|
+
/**
|
|
7954
|
+
* Get a finalized platform invoice by id
|
|
7955
|
+
* @description Includes the rated lines with their tier breakdown (core-api#71).
|
|
7956
|
+
*/
|
|
7954
7957
|
get: operations['PlatformInvoicesController_getOne'];
|
|
7955
7958
|
put?: never;
|
|
7956
7959
|
post?: never;
|
|
@@ -7978,6 +7981,149 @@ export interface paths {
|
|
|
7978
7981
|
patch?: never;
|
|
7979
7982
|
trace?: never;
|
|
7980
7983
|
};
|
|
7984
|
+
'/v1/billing/rate-card': {
|
|
7985
|
+
parameters: {
|
|
7986
|
+
query?: never;
|
|
7987
|
+
header?: never;
|
|
7988
|
+
path?: never;
|
|
7989
|
+
cookie?: never;
|
|
7990
|
+
};
|
|
7991
|
+
/**
|
|
7992
|
+
* Get the rate card version that rates the organization
|
|
7993
|
+
* @description The organization's own negotiated card when it has one in effect, else the platform default.
|
|
7994
|
+
*/
|
|
7995
|
+
get: operations['PlatformBillingRatesController_getRateCard'];
|
|
7996
|
+
put?: never;
|
|
7997
|
+
post?: never;
|
|
7998
|
+
delete?: never;
|
|
7999
|
+
options?: never;
|
|
8000
|
+
head?: never;
|
|
8001
|
+
patch?: never;
|
|
8002
|
+
trace?: never;
|
|
8003
|
+
};
|
|
8004
|
+
'/v1/billing/estimate': {
|
|
8005
|
+
parameters: {
|
|
8006
|
+
query?: never;
|
|
8007
|
+
header?: never;
|
|
8008
|
+
path?: never;
|
|
8009
|
+
cookie?: never;
|
|
8010
|
+
};
|
|
8011
|
+
/**
|
|
8012
|
+
* Get the provisional platform fee for an open period
|
|
8013
|
+
* @description Rates the period so far with the same code as invoice finalization: one estimate per open currency, with lines and tier breakdown.
|
|
8014
|
+
*/
|
|
8015
|
+
get: operations['PlatformBillingRatesController_getEstimate'];
|
|
8016
|
+
put?: never;
|
|
8017
|
+
post?: never;
|
|
8018
|
+
delete?: never;
|
|
8019
|
+
options?: never;
|
|
8020
|
+
head?: never;
|
|
8021
|
+
patch?: never;
|
|
8022
|
+
trace?: never;
|
|
8023
|
+
};
|
|
8024
|
+
'/v1/billing/metered-usage': {
|
|
8025
|
+
parameters: {
|
|
8026
|
+
query?: never;
|
|
8027
|
+
header?: never;
|
|
8028
|
+
path?: never;
|
|
8029
|
+
cookie?: never;
|
|
8030
|
+
};
|
|
8031
|
+
/**
|
|
8032
|
+
* Get metered AimeeBot token usage for a period
|
|
8033
|
+
* @description Input and output tokens, with whether the rate card charges for each (billed = false is shown as not charged).
|
|
8034
|
+
*/
|
|
8035
|
+
get: operations['PlatformBillingRatesController_getMeteredUsage'];
|
|
8036
|
+
put?: never;
|
|
8037
|
+
post?: never;
|
|
8038
|
+
delete?: never;
|
|
8039
|
+
options?: never;
|
|
8040
|
+
head?: never;
|
|
8041
|
+
patch?: never;
|
|
8042
|
+
trace?: never;
|
|
8043
|
+
};
|
|
8044
|
+
'/v1/billing/admin/rate-cards': {
|
|
8045
|
+
parameters: {
|
|
8046
|
+
query?: never;
|
|
8047
|
+
header?: never;
|
|
8048
|
+
path?: never;
|
|
8049
|
+
cookie?: never;
|
|
8050
|
+
};
|
|
8051
|
+
/**
|
|
8052
|
+
* List rate card versions (system admin)
|
|
8053
|
+
* @description A tenant's versions with tenantId, else the platform default's. Newest version first per currency.
|
|
8054
|
+
*/
|
|
8055
|
+
get: operations['RateCardsAdminController_list'];
|
|
8056
|
+
put?: never;
|
|
8057
|
+
/**
|
|
8058
|
+
* Create a rate card version (system admin)
|
|
8059
|
+
* @description Adds the next version for a tenant (or the platform default when tenantId is omitted), effective from a period boundary no earlier than the current period. Versions are immutable.
|
|
8060
|
+
*/
|
|
8061
|
+
post: operations['RateCardsAdminController_create'];
|
|
8062
|
+
delete?: never;
|
|
8063
|
+
options?: never;
|
|
8064
|
+
head?: never;
|
|
8065
|
+
patch?: never;
|
|
8066
|
+
trace?: never;
|
|
8067
|
+
};
|
|
8068
|
+
'/v1/billing/admin/rate-cards/{id}': {
|
|
8069
|
+
parameters: {
|
|
8070
|
+
query?: never;
|
|
8071
|
+
header?: never;
|
|
8072
|
+
path?: never;
|
|
8073
|
+
cookie?: never;
|
|
8074
|
+
};
|
|
8075
|
+
/** Get a rate card version (system admin) */
|
|
8076
|
+
get: operations['RateCardsAdminController_getOne'];
|
|
8077
|
+
put?: never;
|
|
8078
|
+
post?: never;
|
|
8079
|
+
/**
|
|
8080
|
+
* Delete an unused rate card version (system admin)
|
|
8081
|
+
* @description Only a version no invoice used. A platform default version already in effect cannot be deleted.
|
|
8082
|
+
*/
|
|
8083
|
+
delete: operations['RateCardsAdminController_remove'];
|
|
8084
|
+
options?: never;
|
|
8085
|
+
head?: never;
|
|
8086
|
+
patch?: never;
|
|
8087
|
+
trace?: never;
|
|
8088
|
+
};
|
|
8089
|
+
'/v1/billing/admin/charges': {
|
|
8090
|
+
parameters: {
|
|
8091
|
+
query?: never;
|
|
8092
|
+
header?: never;
|
|
8093
|
+
path?: never;
|
|
8094
|
+
cookie?: never;
|
|
8095
|
+
};
|
|
8096
|
+
/** List a tenant's one-off charges (system admin) */
|
|
8097
|
+
get: operations['BillingChargesAdminController_list'];
|
|
8098
|
+
put?: never;
|
|
8099
|
+
/**
|
|
8100
|
+
* Add a one-off charge or credit (system admin)
|
|
8101
|
+
* @description Lands on the period's invoice as a one_off line. The period must be the current one or later and not finalized. A credit (category credit) has a negative unitPriceCents.
|
|
8102
|
+
*/
|
|
8103
|
+
post: operations['BillingChargesAdminController_create'];
|
|
8104
|
+
delete?: never;
|
|
8105
|
+
options?: never;
|
|
8106
|
+
head?: never;
|
|
8107
|
+
patch?: never;
|
|
8108
|
+
trace?: never;
|
|
8109
|
+
};
|
|
8110
|
+
'/v1/billing/admin/charges/{id}': {
|
|
8111
|
+
parameters: {
|
|
8112
|
+
query?: never;
|
|
8113
|
+
header?: never;
|
|
8114
|
+
path?: never;
|
|
8115
|
+
cookie?: never;
|
|
8116
|
+
};
|
|
8117
|
+
get?: never;
|
|
8118
|
+
put?: never;
|
|
8119
|
+
post?: never;
|
|
8120
|
+
/** Remove a one-off charge from an open period (system admin) */
|
|
8121
|
+
delete: operations['BillingChargesAdminController_remove'];
|
|
8122
|
+
options?: never;
|
|
8123
|
+
head?: never;
|
|
8124
|
+
patch?: never;
|
|
8125
|
+
trace?: never;
|
|
8126
|
+
};
|
|
7981
8127
|
'/v1/returns': {
|
|
7982
8128
|
parameters: {
|
|
7983
8129
|
query?: never;
|
|
@@ -31236,7 +31382,7 @@ export interface components {
|
|
|
31236
31382
|
*/
|
|
31237
31383
|
gmvCents: string;
|
|
31238
31384
|
/**
|
|
31239
|
-
* @description
|
|
31385
|
+
* @description Estimated GMV fee in cents (the rate card's GMV line; a store's share by GMV); negative is a credit
|
|
31240
31386
|
* @example 3000
|
|
31241
31387
|
*/
|
|
31242
31388
|
feeCents: string;
|
|
@@ -31265,8 +31411,8 @@ export interface components {
|
|
|
31265
31411
|
/** @example 2026-07 */
|
|
31266
31412
|
period: string;
|
|
31267
31413
|
/**
|
|
31268
|
-
* @description
|
|
31269
|
-
* @example 0.
|
|
31414
|
+
* @description Effective GMV rate of the estimate as a fraction (0.0085 = 0.85%)
|
|
31415
|
+
* @example 0.0085
|
|
31270
31416
|
*/
|
|
31271
31417
|
rate: number;
|
|
31272
31418
|
currencies: components['schemas']['BillingUsageCurrencyTotalDto'][];
|
|
@@ -31288,6 +31434,52 @@ export interface components {
|
|
|
31288
31434
|
/** @example -2000 */
|
|
31289
31435
|
adjustmentGmvCents: string;
|
|
31290
31436
|
};
|
|
31437
|
+
TierBreakdownResponseDto: {
|
|
31438
|
+
/**
|
|
31439
|
+
* @description Bracket or tier lower bound (GMV brackets are on trailing-12-period net GMV, in cents)
|
|
31440
|
+
* @example 0
|
|
31441
|
+
*/
|
|
31442
|
+
fromQuantity: string;
|
|
31443
|
+
/** @example 200000000 */
|
|
31444
|
+
toQuantity: string | null;
|
|
31445
|
+
/**
|
|
31446
|
+
* @description Part of the period quantity in this bracket (signed for GMV)
|
|
31447
|
+
* @example 1250000
|
|
31448
|
+
*/
|
|
31449
|
+
quantity: string;
|
|
31450
|
+
/**
|
|
31451
|
+
* @description GMV brackets: rate in basis points
|
|
31452
|
+
* @example 100
|
|
31453
|
+
*/
|
|
31454
|
+
basisPoints: number | null;
|
|
31455
|
+
/** @description Usage tiers: cents per unitSize */
|
|
31456
|
+
unitPriceCents: string | null;
|
|
31457
|
+
/** @example 12500 */
|
|
31458
|
+
amountCents: string;
|
|
31459
|
+
};
|
|
31460
|
+
PlatformInvoiceLineResponseDto: {
|
|
31461
|
+
/** @enum {string} */
|
|
31462
|
+
type: 'gmv_graduated' | 'usage_graduated' | 'recurring_flat' | 'minimum' | 'one_off';
|
|
31463
|
+
/** @example Platform fee on net GMV */
|
|
31464
|
+
description: string;
|
|
31465
|
+
/** @description gmv, ai_input_tokens, ai_output_tokens; null otherwise */
|
|
31466
|
+
metric: string | null;
|
|
31467
|
+
/**
|
|
31468
|
+
* @description Quantity rated (signed for GMV)
|
|
31469
|
+
* @example 1250000
|
|
31470
|
+
*/
|
|
31471
|
+
quantity: string;
|
|
31472
|
+
/** @enum {string} */
|
|
31473
|
+
unit: 'cents' | 'tokens' | 'period' | 'each';
|
|
31474
|
+
/**
|
|
31475
|
+
* @description Signed amount in cents
|
|
31476
|
+
* @example 12500
|
|
31477
|
+
*/
|
|
31478
|
+
amountCents: string;
|
|
31479
|
+
tierBreakdown: components['schemas']['TierBreakdownResponseDto'][] | null;
|
|
31480
|
+
rateCardLineId: string | null;
|
|
31481
|
+
billingChargeId: string | null;
|
|
31482
|
+
};
|
|
31291
31483
|
PlatformInvoiceResponseDto: {
|
|
31292
31484
|
id: string;
|
|
31293
31485
|
/** @example 2026-07 */
|
|
@@ -31295,10 +31487,12 @@ export interface components {
|
|
|
31295
31487
|
/** @example USD */
|
|
31296
31488
|
currency: string;
|
|
31297
31489
|
/**
|
|
31298
|
-
* @description
|
|
31299
|
-
* @example 0.
|
|
31490
|
+
* @description Effective GMV rate: the GMV line over net GMV (0.0085 = 0.85%). Invoices finalized before rate cards hold the flat 0.02.
|
|
31491
|
+
* @example 0.0085
|
|
31300
31492
|
*/
|
|
31301
31493
|
rate: number;
|
|
31494
|
+
/** @description Rate card version that rated the invoice; null before rate cards */
|
|
31495
|
+
rateCardId: string | null;
|
|
31302
31496
|
/**
|
|
31303
31497
|
* @description Net billable GMV cents as string
|
|
31304
31498
|
* @example 150000
|
|
@@ -31309,7 +31503,7 @@ export interface components {
|
|
|
31309
31503
|
/** @example -10000 */
|
|
31310
31504
|
adjustmentGmvCents: string;
|
|
31311
31505
|
/**
|
|
31312
|
-
* @description
|
|
31506
|
+
* @description Platform fee cents: the sum of the lines, floored at 0 (a negative sum is creditGeneratedCents)
|
|
31313
31507
|
* @example 3000
|
|
31314
31508
|
*/
|
|
31315
31509
|
feeCents: string;
|
|
@@ -31345,6 +31539,8 @@ export interface components {
|
|
|
31345
31539
|
collectionUpdatedAt?: string | null;
|
|
31346
31540
|
finalizedAt: string;
|
|
31347
31541
|
storeBreakdown?: components['schemas']['PlatformInvoiceStoreBreakdownDto'][];
|
|
31542
|
+
/** @description Rated lines with tier breakdown (detail only; empty before rate cards) */
|
|
31543
|
+
lines?: components['schemas']['PlatformInvoiceLineResponseDto'][];
|
|
31348
31544
|
};
|
|
31349
31545
|
PlatformInvoiceListResponseDto: {
|
|
31350
31546
|
invoices: components['schemas']['PlatformInvoiceResponseDto'][];
|
|
@@ -31383,6 +31579,225 @@ export interface components {
|
|
|
31383
31579
|
/** Format: date-time */
|
|
31384
31580
|
createdAt: string;
|
|
31385
31581
|
};
|
|
31582
|
+
GmvTierResponseDto: {
|
|
31583
|
+
/** @example 200000000 */
|
|
31584
|
+
upToCents: string | null;
|
|
31585
|
+
/** @example 100 */
|
|
31586
|
+
basisPoints: number;
|
|
31587
|
+
};
|
|
31588
|
+
UsageTierResponseDto: {
|
|
31589
|
+
/** @example 10000000 */
|
|
31590
|
+
upToQuantity: string | null;
|
|
31591
|
+
/** @example 300 */
|
|
31592
|
+
unitPriceCents: string;
|
|
31593
|
+
};
|
|
31594
|
+
RateCardLineResponseDto: {
|
|
31595
|
+
id: string;
|
|
31596
|
+
/** @enum {string} */
|
|
31597
|
+
type: 'gmv_graduated' | 'usage_graduated' | 'recurring_flat' | 'minimum';
|
|
31598
|
+
description: string;
|
|
31599
|
+
metric: string | null;
|
|
31600
|
+
unitSize: string | null;
|
|
31601
|
+
includedQuantity: string | null;
|
|
31602
|
+
gmvTiers: components['schemas']['GmvTierResponseDto'][] | null;
|
|
31603
|
+
usageTiers: components['schemas']['UsageTierResponseDto'][] | null;
|
|
31604
|
+
amountCents: string | null;
|
|
31605
|
+
startPeriod: string | null;
|
|
31606
|
+
endPeriod: string | null;
|
|
31607
|
+
};
|
|
31608
|
+
RateCardResponseDto: {
|
|
31609
|
+
id: string;
|
|
31610
|
+
tenantId: string | null;
|
|
31611
|
+
/** @description True for a platform default version */
|
|
31612
|
+
isPlatformDefault: boolean;
|
|
31613
|
+
/** @example USD */
|
|
31614
|
+
currency: string;
|
|
31615
|
+
/** @example 1 */
|
|
31616
|
+
version: number;
|
|
31617
|
+
/** @example 2026-11 */
|
|
31618
|
+
effectiveFromPeriod: string;
|
|
31619
|
+
name: string;
|
|
31620
|
+
createdAt: string;
|
|
31621
|
+
lines: components['schemas']['RateCardLineResponseDto'][];
|
|
31622
|
+
};
|
|
31623
|
+
PlatformFeeCurrencyEstimateDto: {
|
|
31624
|
+
/** @example USD */
|
|
31625
|
+
currency: string;
|
|
31626
|
+
rateCardId: string;
|
|
31627
|
+
/** @example 1 */
|
|
31628
|
+
rateCardVersion: number;
|
|
31629
|
+
rateCardName: string;
|
|
31630
|
+
isPlatformDefault: boolean;
|
|
31631
|
+
/** @description Period net GMV so far, in cents */
|
|
31632
|
+
gmvCents: string;
|
|
31633
|
+
/** @description Net GMV of the previous 11 periods: where this period starts on the bracket ladder */
|
|
31634
|
+
priorGmvCents: string;
|
|
31635
|
+
/** @description Signed sum of the lines before credits; a negative sum becomes credit */
|
|
31636
|
+
totalCents: string;
|
|
31637
|
+
lines: components['schemas']['PlatformInvoiceLineResponseDto'][];
|
|
31638
|
+
};
|
|
31639
|
+
PlatformFeeEstimateResponseDto: {
|
|
31640
|
+
/** @example 2026-11 */
|
|
31641
|
+
period: string;
|
|
31642
|
+
/** @description One estimate per currency still open for the period. Provisional: usage can still change; finalized periods are on the invoices. */
|
|
31643
|
+
currencies: components['schemas']['PlatformFeeCurrencyEstimateDto'][];
|
|
31644
|
+
};
|
|
31645
|
+
MeteredUsageMetricDto: {
|
|
31646
|
+
/** @enum {string} */
|
|
31647
|
+
metric: 'ai_input_tokens' | 'ai_output_tokens';
|
|
31648
|
+
/** @example 1250000 */
|
|
31649
|
+
quantity: string;
|
|
31650
|
+
/** @description Whether the tenant's rate card (default currency) charges for this metric; false = shown as not charged */
|
|
31651
|
+
billed: boolean;
|
|
31652
|
+
};
|
|
31653
|
+
MeteredUsageResponseDto: {
|
|
31654
|
+
/** @example 2026-11 */
|
|
31655
|
+
period: string;
|
|
31656
|
+
metrics: components['schemas']['MeteredUsageMetricDto'][];
|
|
31657
|
+
};
|
|
31658
|
+
AdminRateCardResponseDto: {
|
|
31659
|
+
id: string;
|
|
31660
|
+
tenantId: string | null;
|
|
31661
|
+
/** @description True for a platform default version */
|
|
31662
|
+
isPlatformDefault: boolean;
|
|
31663
|
+
/** @example USD */
|
|
31664
|
+
currency: string;
|
|
31665
|
+
/** @example 1 */
|
|
31666
|
+
version: number;
|
|
31667
|
+
/** @example 2026-11 */
|
|
31668
|
+
effectiveFromPeriod: string;
|
|
31669
|
+
name: string;
|
|
31670
|
+
createdAt: string;
|
|
31671
|
+
lines: components['schemas']['RateCardLineResponseDto'][];
|
|
31672
|
+
/** @description Finalized invoices rated by this version (0 = deletable) */
|
|
31673
|
+
invoiceCount: number;
|
|
31674
|
+
};
|
|
31675
|
+
AdminRateCardListResponseDto: {
|
|
31676
|
+
rateCards: components['schemas']['AdminRateCardResponseDto'][];
|
|
31677
|
+
};
|
|
31678
|
+
GmvTierInputDto: {
|
|
31679
|
+
/**
|
|
31680
|
+
* @description Upper bound of the bracket on trailing-12-period net GMV, in cents. Null on the last (open) bracket.
|
|
31681
|
+
* @example 200000000
|
|
31682
|
+
*/
|
|
31683
|
+
upToCents: number | null;
|
|
31684
|
+
/**
|
|
31685
|
+
* @description Rate in basis points (100 = 1%)
|
|
31686
|
+
* @example 100
|
|
31687
|
+
*/
|
|
31688
|
+
basisPoints: number;
|
|
31689
|
+
};
|
|
31690
|
+
UsageTierInputDto: {
|
|
31691
|
+
/**
|
|
31692
|
+
* @description Upper bound of the tier on the period quantity (included quantity counts). Null on the last (open) tier.
|
|
31693
|
+
* @example 10000000
|
|
31694
|
+
*/
|
|
31695
|
+
upToQuantity: number | null;
|
|
31696
|
+
/**
|
|
31697
|
+
* @description Price in cents per unitSize of quantity in this tier
|
|
31698
|
+
* @example 300
|
|
31699
|
+
*/
|
|
31700
|
+
unitPriceCents: number;
|
|
31701
|
+
};
|
|
31702
|
+
RateCardLineInputDto: {
|
|
31703
|
+
/** @enum {string} */
|
|
31704
|
+
type: 'gmv_graduated' | 'usage_graduated' | 'recurring_flat' | 'minimum';
|
|
31705
|
+
/** @example Platform fee on net GMV */
|
|
31706
|
+
description: string;
|
|
31707
|
+
/**
|
|
31708
|
+
* @description usage_graduated: metered metric
|
|
31709
|
+
* @enum {string}
|
|
31710
|
+
*/
|
|
31711
|
+
metric?: 'ai_input_tokens' | 'ai_output_tokens';
|
|
31712
|
+
/**
|
|
31713
|
+
* @description usage_graduated: quantity one unitPriceCents buys
|
|
31714
|
+
* @example 1000000
|
|
31715
|
+
*/
|
|
31716
|
+
unitSize?: number;
|
|
31717
|
+
/**
|
|
31718
|
+
* @description usage_graduated: quantity free each period
|
|
31719
|
+
* @example 0
|
|
31720
|
+
*/
|
|
31721
|
+
includedQuantity?: number;
|
|
31722
|
+
/** @description gmv_graduated: brackets, lowest first; last is open */
|
|
31723
|
+
gmvTiers?: components['schemas']['GmvTierInputDto'][];
|
|
31724
|
+
/** @description usage_graduated: tiers, lowest first; last is open */
|
|
31725
|
+
usageTiers?: components['schemas']['UsageTierInputDto'][];
|
|
31726
|
+
/**
|
|
31727
|
+
* @description recurring_flat: amount per period; minimum: floor on the card lines, in cents
|
|
31728
|
+
* @example 50000
|
|
31729
|
+
*/
|
|
31730
|
+
amountCents?: number;
|
|
31731
|
+
/**
|
|
31732
|
+
* @description recurring_flat: first period billed (YYYY-MM)
|
|
31733
|
+
* @example 2026-11
|
|
31734
|
+
*/
|
|
31735
|
+
startPeriod?: string;
|
|
31736
|
+
/**
|
|
31737
|
+
* @description recurring_flat: last period billed (YYYY-MM); omit for open
|
|
31738
|
+
* @example 2027-10
|
|
31739
|
+
*/
|
|
31740
|
+
endPeriod?: string;
|
|
31741
|
+
};
|
|
31742
|
+
CreateRateCardVersionDto: {
|
|
31743
|
+
/** @description Tenant the version belongs to. Omit for a new platform default version. */
|
|
31744
|
+
tenantId?: string;
|
|
31745
|
+
/** @example USD */
|
|
31746
|
+
currency: string;
|
|
31747
|
+
/**
|
|
31748
|
+
* @description First UTC period this version rates; the current period or later
|
|
31749
|
+
* @example 2026-11
|
|
31750
|
+
*/
|
|
31751
|
+
effectiveFromPeriod: string;
|
|
31752
|
+
/** @example SoClean negotiated terms 2026 */
|
|
31753
|
+
name: string;
|
|
31754
|
+
lines: components['schemas']['RateCardLineInputDto'][];
|
|
31755
|
+
};
|
|
31756
|
+
BillingChargeResponseDto: {
|
|
31757
|
+
id: string;
|
|
31758
|
+
tenantId: string;
|
|
31759
|
+
/** @example 2026-11 */
|
|
31760
|
+
period: string;
|
|
31761
|
+
/** @example USD */
|
|
31762
|
+
currency: string;
|
|
31763
|
+
/** @enum {string} */
|
|
31764
|
+
category: 'consulting' | 'addon' | 'service' | 'credit';
|
|
31765
|
+
description: string;
|
|
31766
|
+
quantity: number;
|
|
31767
|
+
/** @example 15000 */
|
|
31768
|
+
unitPriceCents: string;
|
|
31769
|
+
/** @example 120000 */
|
|
31770
|
+
amountCents: string;
|
|
31771
|
+
reference: string | null;
|
|
31772
|
+
createdBy: string;
|
|
31773
|
+
createdAt: string;
|
|
31774
|
+
};
|
|
31775
|
+
BillingChargeListResponseDto: {
|
|
31776
|
+
charges: components['schemas']['BillingChargeResponseDto'][];
|
|
31777
|
+
};
|
|
31778
|
+
CreateBillingChargeDto: {
|
|
31779
|
+
tenantId: string;
|
|
31780
|
+
/**
|
|
31781
|
+
* @description Open UTC period YYYY-MM: the current period or later
|
|
31782
|
+
* @example 2026-11
|
|
31783
|
+
*/
|
|
31784
|
+
period: string;
|
|
31785
|
+
/** @example USD */
|
|
31786
|
+
currency: string;
|
|
31787
|
+
/** @enum {string} */
|
|
31788
|
+
category: 'consulting' | 'addon' | 'service' | 'credit';
|
|
31789
|
+
/** @example Catalog migration consulting (8h) */
|
|
31790
|
+
description: string;
|
|
31791
|
+
/** @example 8 */
|
|
31792
|
+
quantity: number;
|
|
31793
|
+
/**
|
|
31794
|
+
* @description Cents per unit; negative for a credit, positive otherwise
|
|
31795
|
+
* @example 15000
|
|
31796
|
+
*/
|
|
31797
|
+
unitPriceCents: number;
|
|
31798
|
+
/** @description Contract, ticket or PO reference */
|
|
31799
|
+
reference?: string;
|
|
31800
|
+
};
|
|
31386
31801
|
ReturnItemDto: {
|
|
31387
31802
|
/**
|
|
31388
31803
|
* @description Order item ID to return
|
|
@@ -55017,6 +55432,392 @@ export interface operations {
|
|
|
55017
55432
|
};
|
|
55018
55433
|
};
|
|
55019
55434
|
};
|
|
55435
|
+
PlatformBillingRatesController_getRateCard: {
|
|
55436
|
+
parameters: {
|
|
55437
|
+
query?: {
|
|
55438
|
+
currency?: string;
|
|
55439
|
+
/** @description UTC period YYYY-MM (defaults to the current UTC month) */
|
|
55440
|
+
period?: string;
|
|
55441
|
+
};
|
|
55442
|
+
header?: never;
|
|
55443
|
+
path?: never;
|
|
55444
|
+
cookie?: never;
|
|
55445
|
+
};
|
|
55446
|
+
requestBody?: never;
|
|
55447
|
+
responses: {
|
|
55448
|
+
200: {
|
|
55449
|
+
headers: {
|
|
55450
|
+
[name: string]: unknown;
|
|
55451
|
+
};
|
|
55452
|
+
content: {
|
|
55453
|
+
'application/json': components['schemas']['RateCardResponseDto'];
|
|
55454
|
+
};
|
|
55455
|
+
};
|
|
55456
|
+
/** @description Missing platform-billing:read */
|
|
55457
|
+
403: {
|
|
55458
|
+
headers: {
|
|
55459
|
+
[name: string]: unknown;
|
|
55460
|
+
};
|
|
55461
|
+
content?: never;
|
|
55462
|
+
};
|
|
55463
|
+
/** @description No card for the currency */
|
|
55464
|
+
404: {
|
|
55465
|
+
headers: {
|
|
55466
|
+
[name: string]: unknown;
|
|
55467
|
+
};
|
|
55468
|
+
content?: never;
|
|
55469
|
+
};
|
|
55470
|
+
};
|
|
55471
|
+
};
|
|
55472
|
+
PlatformBillingRatesController_getEstimate: {
|
|
55473
|
+
parameters: {
|
|
55474
|
+
query?: {
|
|
55475
|
+
/** @description UTC period YYYY-MM (defaults to the current UTC month) */
|
|
55476
|
+
period?: string;
|
|
55477
|
+
};
|
|
55478
|
+
header?: never;
|
|
55479
|
+
path?: never;
|
|
55480
|
+
cookie?: never;
|
|
55481
|
+
};
|
|
55482
|
+
requestBody?: never;
|
|
55483
|
+
responses: {
|
|
55484
|
+
200: {
|
|
55485
|
+
headers: {
|
|
55486
|
+
[name: string]: unknown;
|
|
55487
|
+
};
|
|
55488
|
+
content: {
|
|
55489
|
+
'application/json': components['schemas']['PlatformFeeEstimateResponseDto'];
|
|
55490
|
+
};
|
|
55491
|
+
};
|
|
55492
|
+
/** @description Invalid period key */
|
|
55493
|
+
400: {
|
|
55494
|
+
headers: {
|
|
55495
|
+
[name: string]: unknown;
|
|
55496
|
+
};
|
|
55497
|
+
content?: never;
|
|
55498
|
+
};
|
|
55499
|
+
/** @description Missing platform-billing:read */
|
|
55500
|
+
403: {
|
|
55501
|
+
headers: {
|
|
55502
|
+
[name: string]: unknown;
|
|
55503
|
+
};
|
|
55504
|
+
content?: never;
|
|
55505
|
+
};
|
|
55506
|
+
};
|
|
55507
|
+
};
|
|
55508
|
+
PlatformBillingRatesController_getMeteredUsage: {
|
|
55509
|
+
parameters: {
|
|
55510
|
+
query?: {
|
|
55511
|
+
/** @description UTC period YYYY-MM (defaults to the current UTC month) */
|
|
55512
|
+
period?: string;
|
|
55513
|
+
};
|
|
55514
|
+
header?: never;
|
|
55515
|
+
path?: never;
|
|
55516
|
+
cookie?: never;
|
|
55517
|
+
};
|
|
55518
|
+
requestBody?: never;
|
|
55519
|
+
responses: {
|
|
55520
|
+
200: {
|
|
55521
|
+
headers: {
|
|
55522
|
+
[name: string]: unknown;
|
|
55523
|
+
};
|
|
55524
|
+
content: {
|
|
55525
|
+
'application/json': components['schemas']['MeteredUsageResponseDto'];
|
|
55526
|
+
};
|
|
55527
|
+
};
|
|
55528
|
+
/** @description Invalid period key */
|
|
55529
|
+
400: {
|
|
55530
|
+
headers: {
|
|
55531
|
+
[name: string]: unknown;
|
|
55532
|
+
};
|
|
55533
|
+
content?: never;
|
|
55534
|
+
};
|
|
55535
|
+
/** @description Missing platform-billing:read */
|
|
55536
|
+
403: {
|
|
55537
|
+
headers: {
|
|
55538
|
+
[name: string]: unknown;
|
|
55539
|
+
};
|
|
55540
|
+
content?: never;
|
|
55541
|
+
};
|
|
55542
|
+
};
|
|
55543
|
+
};
|
|
55544
|
+
RateCardsAdminController_list: {
|
|
55545
|
+
parameters: {
|
|
55546
|
+
query?: {
|
|
55547
|
+
/** @description Tenant whose versions to list. Omit for the platform default's versions. */
|
|
55548
|
+
tenantId?: string;
|
|
55549
|
+
};
|
|
55550
|
+
header?: never;
|
|
55551
|
+
path?: never;
|
|
55552
|
+
cookie?: never;
|
|
55553
|
+
};
|
|
55554
|
+
requestBody?: never;
|
|
55555
|
+
responses: {
|
|
55556
|
+
200: {
|
|
55557
|
+
headers: {
|
|
55558
|
+
[name: string]: unknown;
|
|
55559
|
+
};
|
|
55560
|
+
content: {
|
|
55561
|
+
'application/json': components['schemas']['AdminRateCardListResponseDto'];
|
|
55562
|
+
};
|
|
55563
|
+
};
|
|
55564
|
+
/** @description System admin required */
|
|
55565
|
+
403: {
|
|
55566
|
+
headers: {
|
|
55567
|
+
[name: string]: unknown;
|
|
55568
|
+
};
|
|
55569
|
+
content?: never;
|
|
55570
|
+
};
|
|
55571
|
+
};
|
|
55572
|
+
};
|
|
55573
|
+
RateCardsAdminController_create: {
|
|
55574
|
+
parameters: {
|
|
55575
|
+
query?: never;
|
|
55576
|
+
header?: never;
|
|
55577
|
+
path?: never;
|
|
55578
|
+
cookie?: never;
|
|
55579
|
+
};
|
|
55580
|
+
requestBody: {
|
|
55581
|
+
content: {
|
|
55582
|
+
'application/json': components['schemas']['CreateRateCardVersionDto'];
|
|
55583
|
+
};
|
|
55584
|
+
};
|
|
55585
|
+
responses: {
|
|
55586
|
+
201: {
|
|
55587
|
+
headers: {
|
|
55588
|
+
[name: string]: unknown;
|
|
55589
|
+
};
|
|
55590
|
+
content: {
|
|
55591
|
+
'application/json': components['schemas']['AdminRateCardResponseDto'];
|
|
55592
|
+
};
|
|
55593
|
+
};
|
|
55594
|
+
/** @description Invalid lines or period */
|
|
55595
|
+
400: {
|
|
55596
|
+
headers: {
|
|
55597
|
+
[name: string]: unknown;
|
|
55598
|
+
};
|
|
55599
|
+
content?: never;
|
|
55600
|
+
};
|
|
55601
|
+
/** @description System admin required */
|
|
55602
|
+
403: {
|
|
55603
|
+
headers: {
|
|
55604
|
+
[name: string]: unknown;
|
|
55605
|
+
};
|
|
55606
|
+
content?: never;
|
|
55607
|
+
};
|
|
55608
|
+
/** @description Tenant not found */
|
|
55609
|
+
404: {
|
|
55610
|
+
headers: {
|
|
55611
|
+
[name: string]: unknown;
|
|
55612
|
+
};
|
|
55613
|
+
content?: never;
|
|
55614
|
+
};
|
|
55615
|
+
/** @description A version already starts in that period, or an invoice from it on is finalized */
|
|
55616
|
+
409: {
|
|
55617
|
+
headers: {
|
|
55618
|
+
[name: string]: unknown;
|
|
55619
|
+
};
|
|
55620
|
+
content?: never;
|
|
55621
|
+
};
|
|
55622
|
+
};
|
|
55623
|
+
};
|
|
55624
|
+
RateCardsAdminController_getOne: {
|
|
55625
|
+
parameters: {
|
|
55626
|
+
query?: never;
|
|
55627
|
+
header?: never;
|
|
55628
|
+
path: {
|
|
55629
|
+
id: string;
|
|
55630
|
+
};
|
|
55631
|
+
cookie?: never;
|
|
55632
|
+
};
|
|
55633
|
+
requestBody?: never;
|
|
55634
|
+
responses: {
|
|
55635
|
+
200: {
|
|
55636
|
+
headers: {
|
|
55637
|
+
[name: string]: unknown;
|
|
55638
|
+
};
|
|
55639
|
+
content: {
|
|
55640
|
+
'application/json': components['schemas']['AdminRateCardResponseDto'];
|
|
55641
|
+
};
|
|
55642
|
+
};
|
|
55643
|
+
/** @description System admin required */
|
|
55644
|
+
403: {
|
|
55645
|
+
headers: {
|
|
55646
|
+
[name: string]: unknown;
|
|
55647
|
+
};
|
|
55648
|
+
content?: never;
|
|
55649
|
+
};
|
|
55650
|
+
/** @description Not found */
|
|
55651
|
+
404: {
|
|
55652
|
+
headers: {
|
|
55653
|
+
[name: string]: unknown;
|
|
55654
|
+
};
|
|
55655
|
+
content?: never;
|
|
55656
|
+
};
|
|
55657
|
+
};
|
|
55658
|
+
};
|
|
55659
|
+
RateCardsAdminController_remove: {
|
|
55660
|
+
parameters: {
|
|
55661
|
+
query?: never;
|
|
55662
|
+
header?: never;
|
|
55663
|
+
path: {
|
|
55664
|
+
id: string;
|
|
55665
|
+
};
|
|
55666
|
+
cookie?: never;
|
|
55667
|
+
};
|
|
55668
|
+
requestBody?: never;
|
|
55669
|
+
responses: {
|
|
55670
|
+
/** @description Deleted */
|
|
55671
|
+
204: {
|
|
55672
|
+
headers: {
|
|
55673
|
+
[name: string]: unknown;
|
|
55674
|
+
};
|
|
55675
|
+
content?: never;
|
|
55676
|
+
};
|
|
55677
|
+
/** @description System admin required */
|
|
55678
|
+
403: {
|
|
55679
|
+
headers: {
|
|
55680
|
+
[name: string]: unknown;
|
|
55681
|
+
};
|
|
55682
|
+
content?: never;
|
|
55683
|
+
};
|
|
55684
|
+
/** @description Not found */
|
|
55685
|
+
404: {
|
|
55686
|
+
headers: {
|
|
55687
|
+
[name: string]: unknown;
|
|
55688
|
+
};
|
|
55689
|
+
content?: never;
|
|
55690
|
+
};
|
|
55691
|
+
/** @description Version in use */
|
|
55692
|
+
409: {
|
|
55693
|
+
headers: {
|
|
55694
|
+
[name: string]: unknown;
|
|
55695
|
+
};
|
|
55696
|
+
content?: never;
|
|
55697
|
+
};
|
|
55698
|
+
};
|
|
55699
|
+
};
|
|
55700
|
+
BillingChargesAdminController_list: {
|
|
55701
|
+
parameters: {
|
|
55702
|
+
query: {
|
|
55703
|
+
tenantId: string;
|
|
55704
|
+
period?: string;
|
|
55705
|
+
};
|
|
55706
|
+
header?: never;
|
|
55707
|
+
path?: never;
|
|
55708
|
+
cookie?: never;
|
|
55709
|
+
};
|
|
55710
|
+
requestBody?: never;
|
|
55711
|
+
responses: {
|
|
55712
|
+
200: {
|
|
55713
|
+
headers: {
|
|
55714
|
+
[name: string]: unknown;
|
|
55715
|
+
};
|
|
55716
|
+
content: {
|
|
55717
|
+
'application/json': components['schemas']['BillingChargeListResponseDto'];
|
|
55718
|
+
};
|
|
55719
|
+
};
|
|
55720
|
+
/** @description System admin required */
|
|
55721
|
+
403: {
|
|
55722
|
+
headers: {
|
|
55723
|
+
[name: string]: unknown;
|
|
55724
|
+
};
|
|
55725
|
+
content?: never;
|
|
55726
|
+
};
|
|
55727
|
+
};
|
|
55728
|
+
};
|
|
55729
|
+
BillingChargesAdminController_create: {
|
|
55730
|
+
parameters: {
|
|
55731
|
+
query?: never;
|
|
55732
|
+
header?: never;
|
|
55733
|
+
path?: never;
|
|
55734
|
+
cookie?: never;
|
|
55735
|
+
};
|
|
55736
|
+
requestBody: {
|
|
55737
|
+
content: {
|
|
55738
|
+
'application/json': components['schemas']['CreateBillingChargeDto'];
|
|
55739
|
+
};
|
|
55740
|
+
};
|
|
55741
|
+
responses: {
|
|
55742
|
+
201: {
|
|
55743
|
+
headers: {
|
|
55744
|
+
[name: string]: unknown;
|
|
55745
|
+
};
|
|
55746
|
+
content: {
|
|
55747
|
+
'application/json': components['schemas']['BillingChargeResponseDto'];
|
|
55748
|
+
};
|
|
55749
|
+
};
|
|
55750
|
+
/** @description Invalid amount or period */
|
|
55751
|
+
400: {
|
|
55752
|
+
headers: {
|
|
55753
|
+
[name: string]: unknown;
|
|
55754
|
+
};
|
|
55755
|
+
content?: never;
|
|
55756
|
+
};
|
|
55757
|
+
/** @description System admin required */
|
|
55758
|
+
403: {
|
|
55759
|
+
headers: {
|
|
55760
|
+
[name: string]: unknown;
|
|
55761
|
+
};
|
|
55762
|
+
content?: never;
|
|
55763
|
+
};
|
|
55764
|
+
/** @description Tenant not found */
|
|
55765
|
+
404: {
|
|
55766
|
+
headers: {
|
|
55767
|
+
[name: string]: unknown;
|
|
55768
|
+
};
|
|
55769
|
+
content?: never;
|
|
55770
|
+
};
|
|
55771
|
+
/** @description Period already finalized */
|
|
55772
|
+
409: {
|
|
55773
|
+
headers: {
|
|
55774
|
+
[name: string]: unknown;
|
|
55775
|
+
};
|
|
55776
|
+
content?: never;
|
|
55777
|
+
};
|
|
55778
|
+
};
|
|
55779
|
+
};
|
|
55780
|
+
BillingChargesAdminController_remove: {
|
|
55781
|
+
parameters: {
|
|
55782
|
+
query?: never;
|
|
55783
|
+
header?: never;
|
|
55784
|
+
path: {
|
|
55785
|
+
id: string;
|
|
55786
|
+
};
|
|
55787
|
+
cookie?: never;
|
|
55788
|
+
};
|
|
55789
|
+
requestBody?: never;
|
|
55790
|
+
responses: {
|
|
55791
|
+
/** @description Removed */
|
|
55792
|
+
204: {
|
|
55793
|
+
headers: {
|
|
55794
|
+
[name: string]: unknown;
|
|
55795
|
+
};
|
|
55796
|
+
content?: never;
|
|
55797
|
+
};
|
|
55798
|
+
/** @description System admin required */
|
|
55799
|
+
403: {
|
|
55800
|
+
headers: {
|
|
55801
|
+
[name: string]: unknown;
|
|
55802
|
+
};
|
|
55803
|
+
content?: never;
|
|
55804
|
+
};
|
|
55805
|
+
/** @description Not found */
|
|
55806
|
+
404: {
|
|
55807
|
+
headers: {
|
|
55808
|
+
[name: string]: unknown;
|
|
55809
|
+
};
|
|
55810
|
+
content?: never;
|
|
55811
|
+
};
|
|
55812
|
+
/** @description Period already finalized */
|
|
55813
|
+
409: {
|
|
55814
|
+
headers: {
|
|
55815
|
+
[name: string]: unknown;
|
|
55816
|
+
};
|
|
55817
|
+
content?: never;
|
|
55818
|
+
};
|
|
55819
|
+
};
|
|
55820
|
+
};
|
|
55020
55821
|
ReturnsController_listReturns: {
|
|
55021
55822
|
parameters: {
|
|
55022
55823
|
query?: {
|