@peable.to/contracts 1.2.0 → 3.0.0
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/resources/catalog/index.js +1 -5
- package/dist/cjs/resources/checkout/checkoutSessions.js +0 -4
- package/dist/cjs/resources/events/events.js +1 -32
- package/dist/cjs/resources/tax/calculations.js +33 -30
- package/dist/cjs/resources/tax/reports.js +4 -4
- package/dist/cjs/resources/tax/shared.js +7 -11
- package/dist/cjs/resources/tax/transactions.js +7 -10
- package/dist/cjs/vocabulary/catalog.js +1 -17
- package/dist/cjs/vocabulary/errors.js +0 -13
- package/dist/cjs/vocabulary/events.js +0 -1
- package/dist/esm/resources/catalog/index.js +1 -5
- package/dist/esm/resources/checkout/checkoutSessions.js +0 -4
- package/dist/esm/resources/events/events.js +0 -31
- package/dist/esm/resources/tax/calculations.js +29 -26
- package/dist/esm/resources/tax/reports.js +6 -6
- package/dist/esm/resources/tax/shared.js +6 -10
- package/dist/esm/resources/tax/transactions.js +8 -11
- package/dist/esm/vocabulary/catalog.js +0 -16
- package/dist/esm/vocabulary/errors.js +0 -13
- package/dist/esm/vocabulary/events.js +0 -1
- package/dist/types/resources/catalog/index.d.ts +1 -851
- package/dist/types/resources/checkout/checkoutSessions.d.ts +13 -61
- package/dist/types/resources/checkout/index.d.ts +10 -46
- package/dist/types/resources/events/events.d.ts +0 -22
- package/dist/types/resources/events/index.d.ts +2 -15
- package/dist/types/resources/events/webhookDeliveries.d.ts +0 -3
- package/dist/types/resources/events/webhookEndpoints.d.ts +4 -16
- package/dist/types/resources/payments/index.d.ts +10 -10
- package/dist/types/resources/payments/paymentIntents.d.ts +10 -10
- package/dist/types/resources/payments/testHelpers.d.ts +1 -1
- package/dist/types/resources/tax/calculations.d.ts +37 -37
- package/dist/types/resources/tax/index.d.ts +57 -57
- package/dist/types/resources/tax/registrations.d.ts +2 -2
- package/dist/types/resources/tax/reports.d.ts +6 -6
- package/dist/types/resources/tax/shared.d.ts +6 -7
- package/dist/types/resources/tax/transactions.d.ts +61 -61
- package/dist/types/vocabulary/catalog.d.ts +0 -9
- package/dist/types/vocabulary/errors.d.ts +0 -13
- package/dist/types/vocabulary/events.d.ts +0 -1
- package/package.json +1 -1
- package/dist/cjs/resources/catalog/billing.js +0 -755
- package/dist/esm/resources/catalog/billing.js +0 -752
- package/dist/types/resources/catalog/billing.d.ts +0 -1723
|
@@ -1,4 +1,3 @@
|
|
|
1
|
-
export * from './billing';
|
|
2
1
|
export * from './billingSettings';
|
|
3
2
|
export * from './coupons';
|
|
4
3
|
export * from './entitlements';
|
|
@@ -10,8 +9,7 @@ export * from './testClocks';
|
|
|
10
9
|
export { baseUnitAmountParam, queryFlag, queryIdList } from './shared';
|
|
11
10
|
/**
|
|
12
11
|
* The catalog (products, prices, coupons, promotion codes), entitlements, the
|
|
13
|
-
* billing engine's platform objects (test clocks, billing settings, meters)
|
|
14
|
-
* and the recurring billing transport (`/v1/billing/*`).
|
|
12
|
+
* billing engine's platform objects (test clocks, billing settings, meters).
|
|
15
13
|
*/
|
|
16
14
|
export declare const catalogRoutes: readonly [{
|
|
17
15
|
readonly operationId: "createProduct";
|
|
@@ -2304,852 +2302,4 @@ export declare const catalogRoutes: readonly [{
|
|
|
2304
2302
|
created: import("zod").ZodNumber;
|
|
2305
2303
|
}, import("zod/v4/core").$strict>;
|
|
2306
2304
|
readonly sdk: "billing.meterEvents.create";
|
|
2307
|
-
}, {
|
|
2308
|
-
readonly operationId: "listBillingRails";
|
|
2309
|
-
readonly method: "get";
|
|
2310
|
-
readonly path: "/v1/billing/rails";
|
|
2311
|
-
readonly tag: "Recurring billing";
|
|
2312
|
-
readonly summary: "List the settlement rails";
|
|
2313
|
-
readonly description: "The rails this merchant's payers can choose between (card and other fiat providers, FairCoin), default first, with each rail's offers. Pass the payer's choice as `rail` to `ensureCustomer`.";
|
|
2314
|
-
readonly auth: "service";
|
|
2315
|
-
readonly scope: "payments:read";
|
|
2316
|
-
readonly response: import("zod").ZodObject<{
|
|
2317
|
-
object: import("zod").ZodLiteral<"list">;
|
|
2318
|
-
data: import("zod").ZodArray<import("zod").ZodObject<{
|
|
2319
|
-
rail: import("zod").ZodString;
|
|
2320
|
-
settlement: import("zod").ZodEnum<{
|
|
2321
|
-
faircoin: "faircoin";
|
|
2322
|
-
fiat: "fiat";
|
|
2323
|
-
}>;
|
|
2324
|
-
default: import("zod").ZodBoolean;
|
|
2325
|
-
tax_quotes: import("zod").ZodBoolean;
|
|
2326
|
-
renewal: import("zod").ZodEnum<{
|
|
2327
|
-
automatic: "automatic";
|
|
2328
|
-
payer_initiated: "payer_initiated";
|
|
2329
|
-
}>;
|
|
2330
|
-
offers: import("zod").ZodNullable<import("zod").ZodArray<import("zod").ZodObject<{
|
|
2331
|
-
provider_price_id: import("zod").ZodString;
|
|
2332
|
-
plan_id: import("zod").ZodString;
|
|
2333
|
-
interval: import("zod").ZodEnum<{
|
|
2334
|
-
month: "month";
|
|
2335
|
-
year: "year";
|
|
2336
|
-
}>;
|
|
2337
|
-
currency: import("zod").ZodString;
|
|
2338
|
-
gross_minor_units: import("zod").ZodNumber;
|
|
2339
|
-
tax_treatment: import("zod").ZodEnum<{
|
|
2340
|
-
inclusive: "inclusive";
|
|
2341
|
-
exclusive: "exclusive";
|
|
2342
|
-
}>;
|
|
2343
|
-
}, import("zod/v4/core").$strict>>>;
|
|
2344
|
-
}, import("zod/v4/core").$strict>>;
|
|
2345
|
-
}, import("zod/v4/core").$strict>;
|
|
2346
|
-
readonly sdk: "billing.listRails";
|
|
2347
|
-
}, {
|
|
2348
|
-
readonly operationId: "createBillingTaxQuote";
|
|
2349
|
-
readonly method: "post";
|
|
2350
|
-
readonly path: "/v1/billing/tax_quotes";
|
|
2351
|
-
readonly tag: "Recurring billing";
|
|
2352
|
-
readonly summary: "Quote the tax of a plan";
|
|
2353
|
-
readonly description: "A signed Peable Tax quote for one plan and one customer location. Verify its signature against the pinned keys before passing it to a checkout.";
|
|
2354
|
-
readonly auth: "service";
|
|
2355
|
-
readonly scope: "payments:read";
|
|
2356
|
-
readonly body: import("zod").ZodObject<{
|
|
2357
|
-
rail: import("zod").ZodOptional<import("zod").ZodString>;
|
|
2358
|
-
store_id: import("zod").ZodString;
|
|
2359
|
-
plan_id: import("zod").ZodString;
|
|
2360
|
-
provider_price_id: import("zod").ZodOptional<import("zod").ZodString>;
|
|
2361
|
-
customer_location_evidence_id: import("zod").ZodString;
|
|
2362
|
-
}, import("zod/v4/core").$strict>;
|
|
2363
|
-
readonly response: import("zod").ZodObject<{
|
|
2364
|
-
schema_version: import("zod").ZodLiteral<2>;
|
|
2365
|
-
source: import("zod").ZodObject<{
|
|
2366
|
-
merchant_id: import("zod").ZodString;
|
|
2367
|
-
app_id: import("zod").ZodString;
|
|
2368
|
-
store_id: import("zod").ZodString;
|
|
2369
|
-
plan_id: import("zod").ZodString;
|
|
2370
|
-
mode: import("zod").ZodEnum<{
|
|
2371
|
-
test: "test";
|
|
2372
|
-
live: "live";
|
|
2373
|
-
}>;
|
|
2374
|
-
environment: import("zod").ZodEnum<{
|
|
2375
|
-
development: "development";
|
|
2376
|
-
staging: "staging";
|
|
2377
|
-
production: "production";
|
|
2378
|
-
}>;
|
|
2379
|
-
}, import("zod/v4/core").$strict>;
|
|
2380
|
-
quote: import("zod").ZodObject<{
|
|
2381
|
-
id: import("zod").ZodString;
|
|
2382
|
-
currency: import("zod").ZodString;
|
|
2383
|
-
gross_minor_units: import("zod").ZodNumber;
|
|
2384
|
-
net_minor_units: import("zod").ZodNumber;
|
|
2385
|
-
tax_minor_units: import("zod").ZodNumber;
|
|
2386
|
-
tax_treatment: import("zod").ZodEnum<{
|
|
2387
|
-
inclusive: "inclusive";
|
|
2388
|
-
exclusive: "exclusive";
|
|
2389
|
-
}>;
|
|
2390
|
-
seller_id: import("zod").ZodString;
|
|
2391
|
-
invoice_issuer_id: import("zod").ZodString;
|
|
2392
|
-
tax_remitter_id: import("zod").ZodString;
|
|
2393
|
-
tax_service_ref: import("zod").ZodString;
|
|
2394
|
-
country: import("zod").ZodString;
|
|
2395
|
-
coverage_evidence_id: import("zod").ZodString;
|
|
2396
|
-
tax_rate_evidence_id: import("zod").ZodString;
|
|
2397
|
-
customer_location_evidence_id: import("zod").ZodString;
|
|
2398
|
-
quoted_at: import("zod").ZodNumber;
|
|
2399
|
-
expires_at: import("zod").ZodNumber;
|
|
2400
|
-
}, import("zod/v4/core").$strict>;
|
|
2401
|
-
signature: import("zod").ZodObject<{
|
|
2402
|
-
algorithm: import("zod").ZodLiteral<"Ed25519">;
|
|
2403
|
-
key_id: import("zod").ZodString;
|
|
2404
|
-
value: import("zod").ZodString;
|
|
2405
|
-
}, import("zod/v4/core").$strict>;
|
|
2406
|
-
}, import("zod/v4/core").$strict>;
|
|
2407
|
-
readonly sdk: "billing.createTaxQuote";
|
|
2408
|
-
}, {
|
|
2409
|
-
readonly operationId: "ensureBillingCustomer";
|
|
2410
|
-
readonly method: "post";
|
|
2411
|
-
readonly path: "/v1/billing/customers";
|
|
2412
|
-
readonly tag: "Recurring billing";
|
|
2413
|
-
readonly summary: "Ensure the billing customer of a store";
|
|
2414
|
-
readonly description: "The same store always answers the same customer. Requires an `Idempotency-Key` header: it is the operation’s identity at the provider.";
|
|
2415
|
-
readonly auth: "service";
|
|
2416
|
-
readonly scope: "payments:write";
|
|
2417
|
-
readonly body: import("zod").ZodObject<{
|
|
2418
|
-
store_id: import("zod").ZodString;
|
|
2419
|
-
store_name: import("zod").ZodString;
|
|
2420
|
-
rail: import("zod").ZodOptional<import("zod").ZodString>;
|
|
2421
|
-
}, import("zod/v4/core").$strict>;
|
|
2422
|
-
readonly response: import("zod").ZodObject<{
|
|
2423
|
-
provider_customer_id: import("zod").ZodString;
|
|
2424
|
-
}, import("zod/v4/core").$strict>;
|
|
2425
|
-
readonly sdk: "billing.ensureCustomer";
|
|
2426
|
-
}, {
|
|
2427
|
-
readonly operationId: "createBillingCheckoutSession";
|
|
2428
|
-
readonly method: "post";
|
|
2429
|
-
readonly path: "/v1/billing/checkout_sessions";
|
|
2430
|
-
readonly tag: "Recurring billing";
|
|
2431
|
-
readonly summary: "Create a subscription checkout";
|
|
2432
|
-
readonly description: "A hosted checkout for one plan. Completing it is not paid evidence: read the subscription and its paid invoice. Requires an `Idempotency-Key` header: it is the operation’s identity at the provider.";
|
|
2433
|
-
readonly auth: "service";
|
|
2434
|
-
readonly scope: "payments:write";
|
|
2435
|
-
readonly body: import("zod").ZodObject<{
|
|
2436
|
-
rail: import("zod").ZodOptional<import("zod").ZodString>;
|
|
2437
|
-
provider_customer_id: import("zod").ZodString;
|
|
2438
|
-
provider_price_id: import("zod").ZodString;
|
|
2439
|
-
trial_days: import("zod").ZodNumber;
|
|
2440
|
-
tax_quote: import("zod").ZodOptional<import("zod").ZodObject<{
|
|
2441
|
-
schema_version: import("zod").ZodLiteral<2>;
|
|
2442
|
-
source: import("zod").ZodObject<{
|
|
2443
|
-
merchant_id: import("zod").ZodString;
|
|
2444
|
-
app_id: import("zod").ZodString;
|
|
2445
|
-
store_id: import("zod").ZodString;
|
|
2446
|
-
plan_id: import("zod").ZodString;
|
|
2447
|
-
mode: import("zod").ZodEnum<{
|
|
2448
|
-
test: "test";
|
|
2449
|
-
live: "live";
|
|
2450
|
-
}>;
|
|
2451
|
-
environment: import("zod").ZodEnum<{
|
|
2452
|
-
development: "development";
|
|
2453
|
-
staging: "staging";
|
|
2454
|
-
production: "production";
|
|
2455
|
-
}>;
|
|
2456
|
-
}, import("zod/v4/core").$strict>;
|
|
2457
|
-
quote: import("zod").ZodObject<{
|
|
2458
|
-
id: import("zod").ZodString;
|
|
2459
|
-
currency: import("zod").ZodString;
|
|
2460
|
-
gross_minor_units: import("zod").ZodNumber;
|
|
2461
|
-
net_minor_units: import("zod").ZodNumber;
|
|
2462
|
-
tax_minor_units: import("zod").ZodNumber;
|
|
2463
|
-
tax_treatment: import("zod").ZodEnum<{
|
|
2464
|
-
inclusive: "inclusive";
|
|
2465
|
-
exclusive: "exclusive";
|
|
2466
|
-
}>;
|
|
2467
|
-
seller_id: import("zod").ZodString;
|
|
2468
|
-
invoice_issuer_id: import("zod").ZodString;
|
|
2469
|
-
tax_remitter_id: import("zod").ZodString;
|
|
2470
|
-
tax_service_ref: import("zod").ZodString;
|
|
2471
|
-
country: import("zod").ZodString;
|
|
2472
|
-
coverage_evidence_id: import("zod").ZodString;
|
|
2473
|
-
tax_rate_evidence_id: import("zod").ZodString;
|
|
2474
|
-
customer_location_evidence_id: import("zod").ZodString;
|
|
2475
|
-
quoted_at: import("zod").ZodNumber;
|
|
2476
|
-
expires_at: import("zod").ZodNumber;
|
|
2477
|
-
}, import("zod/v4/core").$strict>;
|
|
2478
|
-
signature: import("zod").ZodObject<{
|
|
2479
|
-
algorithm: import("zod").ZodLiteral<"Ed25519">;
|
|
2480
|
-
key_id: import("zod").ZodString;
|
|
2481
|
-
value: import("zod").ZodString;
|
|
2482
|
-
}, import("zod/v4/core").$strict>;
|
|
2483
|
-
}, import("zod/v4/core").$strict>>;
|
|
2484
|
-
return_url: import("zod").ZodString;
|
|
2485
|
-
store_id: import("zod").ZodString;
|
|
2486
|
-
plan_id: import("zod").ZodString;
|
|
2487
|
-
}, import("zod/v4/core").$strict>;
|
|
2488
|
-
readonly response: import("zod").ZodObject<{
|
|
2489
|
-
id: import("zod").ZodString;
|
|
2490
|
-
url: import("zod").ZodString;
|
|
2491
|
-
expires_at: import("zod").ZodNumber;
|
|
2492
|
-
}, import("zod/v4/core").$strict>;
|
|
2493
|
-
readonly sdk: "billing.createCheckoutSession";
|
|
2494
|
-
}, {
|
|
2495
|
-
readonly operationId: "retrieveBillingEmbeddedCheckoutConfiguration";
|
|
2496
|
-
readonly method: "get";
|
|
2497
|
-
readonly path: "/v1/billing/embedded_checkout_configuration";
|
|
2498
|
-
readonly tag: "Recurring billing";
|
|
2499
|
-
readonly summary: "Retrieve the embedded checkout configuration";
|
|
2500
|
-
readonly auth: "service";
|
|
2501
|
-
readonly scope: "payments:read";
|
|
2502
|
-
readonly response: import("zod").ZodObject<{
|
|
2503
|
-
scope: import("zod").ZodObject<{
|
|
2504
|
-
merchant_id: import("zod").ZodString;
|
|
2505
|
-
app_id: import("zod").ZodString;
|
|
2506
|
-
environment: import("zod").ZodEnum<{
|
|
2507
|
-
development: "development";
|
|
2508
|
-
staging: "staging";
|
|
2509
|
-
production: "production";
|
|
2510
|
-
}>;
|
|
2511
|
-
mode: import("zod").ZodEnum<{
|
|
2512
|
-
test: "test";
|
|
2513
|
-
live: "live";
|
|
2514
|
-
}>;
|
|
2515
|
-
}, import("zod/v4/core").$strict>;
|
|
2516
|
-
publishable_key: import("zod").ZodString;
|
|
2517
|
-
payment_methods: import("zod").ZodArray<import("zod").ZodObject<{
|
|
2518
|
-
id: import("zod").ZodLiteral<"card">;
|
|
2519
|
-
available: import("zod").ZodBoolean;
|
|
2520
|
-
}, import("zod/v4/core").$strict>>;
|
|
2521
|
-
}, import("zod/v4/core").$strict>;
|
|
2522
|
-
readonly sdk: "billing.embeddedCheckoutConfiguration";
|
|
2523
|
-
}, {
|
|
2524
|
-
readonly operationId: "createBillingEmbeddedCheckoutSession";
|
|
2525
|
-
readonly method: "post";
|
|
2526
|
-
readonly path: "/v1/billing/embedded_checkout_sessions";
|
|
2527
|
-
readonly tag: "Recurring billing";
|
|
2528
|
-
readonly summary: "Create an embedded subscription checkout";
|
|
2529
|
-
readonly description: "Fiscal checkout only: `tax_quote` is required. Requires an `Idempotency-Key` header: it is the operation’s identity at the provider.";
|
|
2530
|
-
readonly auth: "service";
|
|
2531
|
-
readonly scope: "payments:write";
|
|
2532
|
-
readonly body: import("zod").ZodObject<{
|
|
2533
|
-
rail: import("zod").ZodOptional<import("zod").ZodString>;
|
|
2534
|
-
provider_customer_id: import("zod").ZodString;
|
|
2535
|
-
provider_price_id: import("zod").ZodString;
|
|
2536
|
-
trial_days: import("zod").ZodNumber;
|
|
2537
|
-
tax_quote: import("zod").ZodOptional<import("zod").ZodObject<{
|
|
2538
|
-
schema_version: import("zod").ZodLiteral<2>;
|
|
2539
|
-
source: import("zod").ZodObject<{
|
|
2540
|
-
merchant_id: import("zod").ZodString;
|
|
2541
|
-
app_id: import("zod").ZodString;
|
|
2542
|
-
store_id: import("zod").ZodString;
|
|
2543
|
-
plan_id: import("zod").ZodString;
|
|
2544
|
-
mode: import("zod").ZodEnum<{
|
|
2545
|
-
test: "test";
|
|
2546
|
-
live: "live";
|
|
2547
|
-
}>;
|
|
2548
|
-
environment: import("zod").ZodEnum<{
|
|
2549
|
-
development: "development";
|
|
2550
|
-
staging: "staging";
|
|
2551
|
-
production: "production";
|
|
2552
|
-
}>;
|
|
2553
|
-
}, import("zod/v4/core").$strict>;
|
|
2554
|
-
quote: import("zod").ZodObject<{
|
|
2555
|
-
id: import("zod").ZodString;
|
|
2556
|
-
currency: import("zod").ZodString;
|
|
2557
|
-
gross_minor_units: import("zod").ZodNumber;
|
|
2558
|
-
net_minor_units: import("zod").ZodNumber;
|
|
2559
|
-
tax_minor_units: import("zod").ZodNumber;
|
|
2560
|
-
tax_treatment: import("zod").ZodEnum<{
|
|
2561
|
-
inclusive: "inclusive";
|
|
2562
|
-
exclusive: "exclusive";
|
|
2563
|
-
}>;
|
|
2564
|
-
seller_id: import("zod").ZodString;
|
|
2565
|
-
invoice_issuer_id: import("zod").ZodString;
|
|
2566
|
-
tax_remitter_id: import("zod").ZodString;
|
|
2567
|
-
tax_service_ref: import("zod").ZodString;
|
|
2568
|
-
country: import("zod").ZodString;
|
|
2569
|
-
coverage_evidence_id: import("zod").ZodString;
|
|
2570
|
-
tax_rate_evidence_id: import("zod").ZodString;
|
|
2571
|
-
customer_location_evidence_id: import("zod").ZodString;
|
|
2572
|
-
quoted_at: import("zod").ZodNumber;
|
|
2573
|
-
expires_at: import("zod").ZodNumber;
|
|
2574
|
-
}, import("zod/v4/core").$strict>;
|
|
2575
|
-
signature: import("zod").ZodObject<{
|
|
2576
|
-
algorithm: import("zod").ZodLiteral<"Ed25519">;
|
|
2577
|
-
key_id: import("zod").ZodString;
|
|
2578
|
-
value: import("zod").ZodString;
|
|
2579
|
-
}, import("zod/v4/core").$strict>;
|
|
2580
|
-
}, import("zod/v4/core").$strict>>;
|
|
2581
|
-
return_url: import("zod").ZodString;
|
|
2582
|
-
store_id: import("zod").ZodString;
|
|
2583
|
-
plan_id: import("zod").ZodString;
|
|
2584
|
-
}, import("zod/v4/core").$strict>;
|
|
2585
|
-
readonly response: import("zod").ZodObject<{
|
|
2586
|
-
id: import("zod").ZodString;
|
|
2587
|
-
presentation: import("zod").ZodLiteral<"embedded">;
|
|
2588
|
-
expires_at: import("zod").ZodNumber;
|
|
2589
|
-
}, import("zod/v4/core").$strict>;
|
|
2590
|
-
readonly sdk: "billing.createEmbeddedCheckoutSession";
|
|
2591
|
-
}, {
|
|
2592
|
-
readonly operationId: "retrieveBillingEmbeddedCheckoutAction";
|
|
2593
|
-
readonly method: "get";
|
|
2594
|
-
readonly path: "/v1/billing/embedded_checkout_sessions/{id}/client_action";
|
|
2595
|
-
readonly tag: "Recurring billing";
|
|
2596
|
-
readonly summary: "Retrieve an embedded checkout’s client action";
|
|
2597
|
-
readonly description: "The ephemeral processor capability to mount the embedded checkout, released only to the owning workload; `action` is `null` once the session is complete or expired.";
|
|
2598
|
-
readonly auth: "service";
|
|
2599
|
-
readonly scope: "payments:read";
|
|
2600
|
-
readonly params: {
|
|
2601
|
-
readonly id: "The embedded checkout session (`cs_…`).";
|
|
2602
|
-
};
|
|
2603
|
-
readonly response: import("zod").ZodObject<{
|
|
2604
|
-
status: import("zod").ZodEnum<{
|
|
2605
|
-
open: "open";
|
|
2606
|
-
complete: "complete";
|
|
2607
|
-
expired: "expired";
|
|
2608
|
-
}>;
|
|
2609
|
-
action: import("zod").ZodNullable<import("zod").ZodObject<{
|
|
2610
|
-
kind: import("zod").ZodLiteral<"checkout_session">;
|
|
2611
|
-
provider: import("zod").ZodLiteral<"stripe">;
|
|
2612
|
-
session_id: import("zod").ZodString;
|
|
2613
|
-
client_secret: import("zod").ZodString;
|
|
2614
|
-
publishable_key: import("zod").ZodString;
|
|
2615
|
-
amount_minor_units: import("zod").ZodNumber;
|
|
2616
|
-
currency: import("zod").ZodString;
|
|
2617
|
-
}, import("zod/v4/core").$strict>>;
|
|
2618
|
-
scope: import("zod").ZodObject<{
|
|
2619
|
-
merchant_id: import("zod").ZodString;
|
|
2620
|
-
app_id: import("zod").ZodString;
|
|
2621
|
-
environment: import("zod").ZodEnum<{
|
|
2622
|
-
development: "development";
|
|
2623
|
-
staging: "staging";
|
|
2624
|
-
production: "production";
|
|
2625
|
-
}>;
|
|
2626
|
-
mode: import("zod").ZodEnum<{
|
|
2627
|
-
test: "test";
|
|
2628
|
-
live: "live";
|
|
2629
|
-
}>;
|
|
2630
|
-
store_id: import("zod").ZodString;
|
|
2631
|
-
plan_id: import("zod").ZodString;
|
|
2632
|
-
provider_customer_id: import("zod").ZodString;
|
|
2633
|
-
provider_price_id: import("zod").ZodString;
|
|
2634
|
-
}, import("zod/v4/core").$strict>;
|
|
2635
|
-
tax_quote: import("zod").ZodObject<{
|
|
2636
|
-
schema_version: import("zod").ZodLiteral<2>;
|
|
2637
|
-
source: import("zod").ZodObject<{
|
|
2638
|
-
merchant_id: import("zod").ZodString;
|
|
2639
|
-
app_id: import("zod").ZodString;
|
|
2640
|
-
store_id: import("zod").ZodString;
|
|
2641
|
-
plan_id: import("zod").ZodString;
|
|
2642
|
-
mode: import("zod").ZodEnum<{
|
|
2643
|
-
test: "test";
|
|
2644
|
-
live: "live";
|
|
2645
|
-
}>;
|
|
2646
|
-
environment: import("zod").ZodEnum<{
|
|
2647
|
-
development: "development";
|
|
2648
|
-
staging: "staging";
|
|
2649
|
-
production: "production";
|
|
2650
|
-
}>;
|
|
2651
|
-
}, import("zod/v4/core").$strict>;
|
|
2652
|
-
quote: import("zod").ZodObject<{
|
|
2653
|
-
id: import("zod").ZodString;
|
|
2654
|
-
currency: import("zod").ZodString;
|
|
2655
|
-
gross_minor_units: import("zod").ZodNumber;
|
|
2656
|
-
net_minor_units: import("zod").ZodNumber;
|
|
2657
|
-
tax_minor_units: import("zod").ZodNumber;
|
|
2658
|
-
tax_treatment: import("zod").ZodEnum<{
|
|
2659
|
-
inclusive: "inclusive";
|
|
2660
|
-
exclusive: "exclusive";
|
|
2661
|
-
}>;
|
|
2662
|
-
seller_id: import("zod").ZodString;
|
|
2663
|
-
invoice_issuer_id: import("zod").ZodString;
|
|
2664
|
-
tax_remitter_id: import("zod").ZodString;
|
|
2665
|
-
tax_service_ref: import("zod").ZodString;
|
|
2666
|
-
country: import("zod").ZodString;
|
|
2667
|
-
coverage_evidence_id: import("zod").ZodString;
|
|
2668
|
-
tax_rate_evidence_id: import("zod").ZodString;
|
|
2669
|
-
customer_location_evidence_id: import("zod").ZodString;
|
|
2670
|
-
quoted_at: import("zod").ZodNumber;
|
|
2671
|
-
expires_at: import("zod").ZodNumber;
|
|
2672
|
-
}, import("zod/v4/core").$strict>;
|
|
2673
|
-
signature: import("zod").ZodObject<{
|
|
2674
|
-
algorithm: import("zod").ZodLiteral<"Ed25519">;
|
|
2675
|
-
key_id: import("zod").ZodString;
|
|
2676
|
-
value: import("zod").ZodString;
|
|
2677
|
-
}, import("zod/v4/core").$strict>;
|
|
2678
|
-
}, import("zod/v4/core").$strict>;
|
|
2679
|
-
expires_at: import("zod").ZodNumber;
|
|
2680
|
-
}, import("zod/v4/core").$strict>;
|
|
2681
|
-
readonly sdk: "billing.retrieveEmbeddedCheckoutAction";
|
|
2682
|
-
}, {
|
|
2683
|
-
readonly operationId: "createRecurringBillingPortalSession";
|
|
2684
|
-
readonly method: "post";
|
|
2685
|
-
readonly path: "/v1/billing/portal_sessions";
|
|
2686
|
-
readonly tag: "Recurring billing";
|
|
2687
|
-
readonly summary: "Open the provider's billing portal";
|
|
2688
|
-
readonly description: "A short-lived, owner-only URL. Requires an `Idempotency-Key` header: it is the operation’s identity at the provider.";
|
|
2689
|
-
readonly auth: "service";
|
|
2690
|
-
readonly scope: "payments:write";
|
|
2691
|
-
readonly body: import("zod").ZodObject<{
|
|
2692
|
-
provider_customer_id: import("zod").ZodString;
|
|
2693
|
-
return_url: import("zod").ZodString;
|
|
2694
|
-
}, import("zod/v4/core").$strict>;
|
|
2695
|
-
readonly response: import("zod").ZodObject<{
|
|
2696
|
-
url: import("zod").ZodString;
|
|
2697
|
-
expires_at: import("zod").ZodNumber;
|
|
2698
|
-
}, import("zod/v4/core").$strict>;
|
|
2699
|
-
readonly sdk: "billing.createPortalSession";
|
|
2700
|
-
}, {
|
|
2701
|
-
readonly operationId: "retrieveBillingCheckoutOperation";
|
|
2702
|
-
readonly method: "get";
|
|
2703
|
-
readonly path: "/v1/billing/checkout_operations/{key}";
|
|
2704
|
-
readonly tag: "Recurring billing";
|
|
2705
|
-
readonly summary: "Recover a checkout operation";
|
|
2706
|
-
readonly description: "Reads the state of a checkout attempted under this `Idempotency-Key`, even after its quote or session expired. Missing, pending or indeterminate never authorizes another create or a cancellation.";
|
|
2707
|
-
readonly auth: "service";
|
|
2708
|
-
readonly scope: "payments:read";
|
|
2709
|
-
readonly params: {
|
|
2710
|
-
readonly key: "The `Idempotency-Key` the checkout was created with.";
|
|
2711
|
-
};
|
|
2712
|
-
readonly query: import("zod").ZodObject<{
|
|
2713
|
-
provider_customer_id: import("zod").ZodString;
|
|
2714
|
-
provider_price_id: import("zod").ZodString;
|
|
2715
|
-
store_id: import("zod").ZodString;
|
|
2716
|
-
plan_id: import("zod").ZodString;
|
|
2717
|
-
}, import("zod/v4/core").$strict>;
|
|
2718
|
-
readonly response: import("zod").ZodUnion<readonly [import("zod").ZodObject<{
|
|
2719
|
-
state: import("zod").ZodEnum<{
|
|
2720
|
-
not_found: "not_found";
|
|
2721
|
-
pending: "pending";
|
|
2722
|
-
indeterminate: "indeterminate";
|
|
2723
|
-
}>;
|
|
2724
|
-
source: import("zod").ZodObject<{
|
|
2725
|
-
idempotency_key: import("zod").ZodString;
|
|
2726
|
-
provider_customer_id: import("zod").ZodString;
|
|
2727
|
-
provider_price_id: import("zod").ZodString;
|
|
2728
|
-
store_id: import("zod").ZodString;
|
|
2729
|
-
plan_id: import("zod").ZodString;
|
|
2730
|
-
tax_quote_id: import("zod").ZodNullable<import("zod").ZodString>;
|
|
2731
|
-
merchant_id: import("zod").ZodString;
|
|
2732
|
-
app_id: import("zod").ZodString;
|
|
2733
|
-
mode: import("zod").ZodEnum<{
|
|
2734
|
-
test: "test";
|
|
2735
|
-
live: "live";
|
|
2736
|
-
}>;
|
|
2737
|
-
environment: import("zod").ZodEnum<{
|
|
2738
|
-
development: "development";
|
|
2739
|
-
staging: "staging";
|
|
2740
|
-
production: "production";
|
|
2741
|
-
}>;
|
|
2742
|
-
}, import("zod/v4/core").$strict>;
|
|
2743
|
-
}, import("zod/v4/core").$strict>, import("zod").ZodObject<{
|
|
2744
|
-
state: import("zod").ZodLiteral<"succeeded">;
|
|
2745
|
-
source: import("zod").ZodObject<{
|
|
2746
|
-
idempotency_key: import("zod").ZodString;
|
|
2747
|
-
provider_customer_id: import("zod").ZodString;
|
|
2748
|
-
provider_price_id: import("zod").ZodString;
|
|
2749
|
-
store_id: import("zod").ZodString;
|
|
2750
|
-
plan_id: import("zod").ZodString;
|
|
2751
|
-
tax_quote_id: import("zod").ZodNullable<import("zod").ZodString>;
|
|
2752
|
-
merchant_id: import("zod").ZodString;
|
|
2753
|
-
app_id: import("zod").ZodString;
|
|
2754
|
-
mode: import("zod").ZodEnum<{
|
|
2755
|
-
test: "test";
|
|
2756
|
-
live: "live";
|
|
2757
|
-
}>;
|
|
2758
|
-
environment: import("zod").ZodEnum<{
|
|
2759
|
-
development: "development";
|
|
2760
|
-
staging: "staging";
|
|
2761
|
-
production: "production";
|
|
2762
|
-
}>;
|
|
2763
|
-
}, import("zod/v4/core").$strict>;
|
|
2764
|
-
checkout: import("zod").ZodObject<{
|
|
2765
|
-
id: import("zod").ZodString;
|
|
2766
|
-
expires_at: import("zod").ZodNumber;
|
|
2767
|
-
url: import("zod").ZodOptional<import("zod").ZodString>;
|
|
2768
|
-
}, import("zod/v4/core").$strict>;
|
|
2769
|
-
}, import("zod/v4/core").$strict>]>;
|
|
2770
|
-
readonly sdk: "billing.retrieveCheckoutOperation";
|
|
2771
|
-
}, {
|
|
2772
|
-
readonly operationId: "retrieveBillingCheckoutSession";
|
|
2773
|
-
readonly method: "get";
|
|
2774
|
-
readonly path: "/v1/billing/checkout_sessions/{id}";
|
|
2775
|
-
readonly tag: "Recurring billing";
|
|
2776
|
-
readonly summary: "Retrieve a subscription checkout";
|
|
2777
|
-
readonly auth: "service";
|
|
2778
|
-
readonly scope: "payments:read";
|
|
2779
|
-
readonly params: {
|
|
2780
|
-
readonly id: "The checkout session (`cs_…`).";
|
|
2781
|
-
};
|
|
2782
|
-
readonly response: import("zod").ZodObject<{
|
|
2783
|
-
initial_invoice_id: import("zod").ZodNullable<import("zod").ZodString>;
|
|
2784
|
-
id: import("zod").ZodString;
|
|
2785
|
-
status: import("zod").ZodEnum<{
|
|
2786
|
-
open: "open";
|
|
2787
|
-
complete: "complete";
|
|
2788
|
-
expired: "expired";
|
|
2789
|
-
}>;
|
|
2790
|
-
store_id: import("zod").ZodString;
|
|
2791
|
-
plan_id: import("zod").ZodString;
|
|
2792
|
-
provider_customer_id: import("zod").ZodString;
|
|
2793
|
-
provider_price_id: import("zod").ZodString;
|
|
2794
|
-
subscription: import("zod").ZodNullable<import("zod").ZodObject<{
|
|
2795
|
-
provider_subscription_id: import("zod").ZodString;
|
|
2796
|
-
latest_invoice_id: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodString>>;
|
|
2797
|
-
provider_customer_id: import("zod").ZodString;
|
|
2798
|
-
provider_price_id: import("zod").ZodString;
|
|
2799
|
-
store_id: import("zod").ZodString;
|
|
2800
|
-
plan_id: import("zod").ZodString;
|
|
2801
|
-
livemode: import("zod").ZodBoolean;
|
|
2802
|
-
status: import("zod").ZodEnum<{
|
|
2803
|
-
active: "active";
|
|
2804
|
-
incomplete: "incomplete";
|
|
2805
|
-
incomplete_expired: "incomplete_expired";
|
|
2806
|
-
trialing: "trialing";
|
|
2807
|
-
past_due: "past_due";
|
|
2808
|
-
unpaid: "unpaid";
|
|
2809
|
-
canceled: "canceled";
|
|
2810
|
-
paused: "paused";
|
|
2811
|
-
}>;
|
|
2812
|
-
interval: import("zod").ZodEnum<{
|
|
2813
|
-
month: "month";
|
|
2814
|
-
year: "year";
|
|
2815
|
-
}>;
|
|
2816
|
-
cancel_at_period_end: import("zod").ZodBoolean;
|
|
2817
|
-
current_period_start: import("zod").ZodNumber;
|
|
2818
|
-
current_period_end: import("zod").ZodNumber;
|
|
2819
|
-
trial_ends_at: import("zod").ZodNullable<import("zod").ZodNumber>;
|
|
2820
|
-
cancel_at: import("zod").ZodNullable<import("zod").ZodNumber>;
|
|
2821
|
-
cancelled_at: import("zod").ZodNullable<import("zod").ZodNumber>;
|
|
2822
|
-
}, import("zod/v4/core").$strict>>;
|
|
2823
|
-
}, import("zod/v4/core").$strict>;
|
|
2824
|
-
readonly sdk: "billing.retrieveCheckout";
|
|
2825
|
-
}, {
|
|
2826
|
-
readonly operationId: "retrieveBillingInvoiceAuthority";
|
|
2827
|
-
readonly method: "get";
|
|
2828
|
-
readonly path: "/v1/billing/subscriptions/{id}/invoice_authorities/{invoiceId}";
|
|
2829
|
-
readonly tag: "Recurring billing";
|
|
2830
|
-
readonly summary: "Retrieve the signed final invoice authority";
|
|
2831
|
-
readonly description: "Signed fiscal evidence of one paid invoice. Verify the signature against the pinned keys (`PEABLE_BILLING_AUTHORITY_KEYS`).";
|
|
2832
|
-
readonly auth: "service";
|
|
2833
|
-
readonly scope: "payments:read";
|
|
2834
|
-
readonly params: {
|
|
2835
|
-
invoiceId: string;
|
|
2836
|
-
id: string;
|
|
2837
|
-
};
|
|
2838
|
-
readonly query: import("zod").ZodObject<{
|
|
2839
|
-
include: import("zod").ZodOptional<import("zod").ZodLiteral<"tax_lines">>;
|
|
2840
|
-
}, import("zod/v4/core").$strip>;
|
|
2841
|
-
readonly response: import("zod").ZodObject<{
|
|
2842
|
-
schema_version: import("zod").ZodLiteral<2>;
|
|
2843
|
-
source: import("zod").ZodObject<{
|
|
2844
|
-
invoice_id: import("zod").ZodString;
|
|
2845
|
-
payment_intent_id: import("zod").ZodString;
|
|
2846
|
-
customer_id: import("zod").ZodString;
|
|
2847
|
-
subscription_id: import("zod").ZodString;
|
|
2848
|
-
price_id: import("zod").ZodString;
|
|
2849
|
-
plan_id: import("zod").ZodString;
|
|
2850
|
-
merchant_id: import("zod").ZodString;
|
|
2851
|
-
app_id: import("zod").ZodString;
|
|
2852
|
-
mode: import("zod").ZodEnum<{
|
|
2853
|
-
test: "test";
|
|
2854
|
-
live: "live";
|
|
2855
|
-
}>;
|
|
2856
|
-
environment: import("zod").ZodEnum<{
|
|
2857
|
-
development: "development";
|
|
2858
|
-
staging: "staging";
|
|
2859
|
-
production: "production";
|
|
2860
|
-
}>;
|
|
2861
|
-
}, import("zod/v4/core").$strict>;
|
|
2862
|
-
invoice: import("zod").ZodObject<{
|
|
2863
|
-
platform: import("zod").ZodLiteral<"peable">;
|
|
2864
|
-
currency: import("zod").ZodString;
|
|
2865
|
-
gross_minor_units: import("zod").ZodNumber;
|
|
2866
|
-
net_minor_units: import("zod").ZodNumber;
|
|
2867
|
-
tax_minor_units: import("zod").ZodNumber;
|
|
2868
|
-
merchant_fee_minor_units: import("zod").ZodNumber;
|
|
2869
|
-
tax_treatment: import("zod").ZodEnum<{
|
|
2870
|
-
inclusive: "inclusive";
|
|
2871
|
-
exclusive: "exclusive";
|
|
2872
|
-
}>;
|
|
2873
|
-
seller_id: import("zod").ZodString;
|
|
2874
|
-
invoice_issuer_id: import("zod").ZodString;
|
|
2875
|
-
tax_quote_id: import("zod").ZodString;
|
|
2876
|
-
customer_location_evidence_id: import("zod").ZodString;
|
|
2877
|
-
tax_rate_evidence_id: import("zod").ZodString;
|
|
2878
|
-
context: import("zod").ZodObject<{
|
|
2879
|
-
payer_account_id: import("zod").ZodString;
|
|
2880
|
-
beneficiary_account_id: import("zod").ZodString;
|
|
2881
|
-
provider_subscription_id: import("zod").ZodString;
|
|
2882
|
-
offer_id: import("zod").ZodString;
|
|
2883
|
-
offer_version: import("zod").ZodNumber;
|
|
2884
|
-
period_start: import("zod").ZodNumber;
|
|
2885
|
-
period_end: import("zod").ZodNumber;
|
|
2886
|
-
mode: import("zod").ZodEnum<{
|
|
2887
|
-
test: "test";
|
|
2888
|
-
live: "live";
|
|
2889
|
-
}>;
|
|
2890
|
-
environment: import("zod").ZodEnum<{
|
|
2891
|
-
development: "development";
|
|
2892
|
-
staging: "staging";
|
|
2893
|
-
production: "production";
|
|
2894
|
-
}>;
|
|
2895
|
-
}, import("zod/v4/core").$strict>;
|
|
2896
|
-
issued_at: import("zod").ZodNumber;
|
|
2897
|
-
expires_at: import("zod").ZodNumber;
|
|
2898
|
-
faircoin_quote: import("zod").ZodOptional<import("zod").ZodObject<{
|
|
2899
|
-
id: import("zod").ZodString;
|
|
2900
|
-
amount_base_units: import("zod").ZodString;
|
|
2901
|
-
quoted_at: import("zod").ZodNumber;
|
|
2902
|
-
expires_at: import("zod").ZodNumber;
|
|
2903
|
-
rounding_evidence_id: import("zod").ZodString;
|
|
2904
|
-
}, import("zod/v4/core").$strict>>;
|
|
2905
|
-
tax_lines: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodObject<{
|
|
2906
|
-
calculation_id: import("zod").ZodString;
|
|
2907
|
-
country: import("zod").ZodString;
|
|
2908
|
-
state: import("zod").ZodNullable<import("zod").ZodString>;
|
|
2909
|
-
tax_type: import("zod").ZodNullable<import("zod").ZodString>;
|
|
2910
|
-
rate_percentage: import("zod").ZodNullable<import("zod").ZodString>;
|
|
2911
|
-
taxable_minor_units: import("zod").ZodNumber;
|
|
2912
|
-
tax_minor_units: import("zod").ZodNumber;
|
|
2913
|
-
inclusive: import("zod").ZodBoolean;
|
|
2914
|
-
taxability_reason: import("zod").ZodString;
|
|
2915
|
-
}, import("zod/v4/core").$strict>>>;
|
|
2916
|
-
}, import("zod/v4/core").$strict>;
|
|
2917
|
-
method: import("zod").ZodEnum<{
|
|
2918
|
-
card: "card";
|
|
2919
|
-
faircoin: "faircoin";
|
|
2920
|
-
}>;
|
|
2921
|
-
signature: import("zod").ZodObject<{
|
|
2922
|
-
algorithm: import("zod").ZodLiteral<"Ed25519">;
|
|
2923
|
-
key_id: import("zod").ZodString;
|
|
2924
|
-
value: import("zod").ZodString;
|
|
2925
|
-
}, import("zod/v4/core").$strict>;
|
|
2926
|
-
}, import("zod/v4/core").$strict>;
|
|
2927
|
-
readonly sdk: "billing.retrieveFinalInvoiceAuthority";
|
|
2928
|
-
}, {
|
|
2929
|
-
readonly operationId: "retrieveBillingInvoiceState";
|
|
2930
|
-
readonly method: "get";
|
|
2931
|
-
readonly path: "/v1/billing/subscriptions/{id}/invoice_states/{invoiceId}";
|
|
2932
|
-
readonly tag: "Recurring billing";
|
|
2933
|
-
readonly summary: "Retrieve the refund state of a paid invoice";
|
|
2934
|
-
readonly auth: "service";
|
|
2935
|
-
readonly scope: "payments:read";
|
|
2936
|
-
readonly params: {
|
|
2937
|
-
invoiceId: string;
|
|
2938
|
-
id: string;
|
|
2939
|
-
};
|
|
2940
|
-
readonly response: import("zod").ZodObject<{
|
|
2941
|
-
invoice_id: import("zod").ZodString;
|
|
2942
|
-
line_id: import("zod").ZodString;
|
|
2943
|
-
payment_intent_id: import("zod").ZodString;
|
|
2944
|
-
provider_subscription_id: import("zod").ZodString;
|
|
2945
|
-
provider_customer_id: import("zod").ZodString;
|
|
2946
|
-
provider_price_id: import("zod").ZodString;
|
|
2947
|
-
store_id: import("zod").ZodString;
|
|
2948
|
-
plan_id: import("zod").ZodString;
|
|
2949
|
-
livemode: import("zod").ZodBoolean;
|
|
2950
|
-
currency: import("zod").ZodString;
|
|
2951
|
-
amount_paid: import("zod").ZodString;
|
|
2952
|
-
net_amount: import("zod").ZodNullable<import("zod").ZodString>;
|
|
2953
|
-
tax_amount: import("zod").ZodNullable<import("zod").ZodString>;
|
|
2954
|
-
period_start: import("zod").ZodNumber;
|
|
2955
|
-
period_end: import("zod").ZodNumber;
|
|
2956
|
-
paid_at: import("zod").ZodNumber;
|
|
2957
|
-
observed_at: import("zod").ZodNumber;
|
|
2958
|
-
charge_id: import("zod").ZodString;
|
|
2959
|
-
amount_refunded: import("zod").ZodString;
|
|
2960
|
-
state: import("zod").ZodEnum<{
|
|
2961
|
-
paid: "paid";
|
|
2962
|
-
fully_refunded: "fully_refunded";
|
|
2963
|
-
partially_refunded: "partially_refunded";
|
|
2964
|
-
}>;
|
|
2965
|
-
}, import("zod/v4/core").$strict>;
|
|
2966
|
-
readonly sdk: "billing.retrieveInvoiceState";
|
|
2967
|
-
}, {
|
|
2968
|
-
readonly operationId: "retrieveBillingPaidInvoice";
|
|
2969
|
-
readonly method: "get";
|
|
2970
|
-
readonly path: "/v1/billing/subscriptions/{id}/paid_invoices/{invoiceId}";
|
|
2971
|
-
readonly tag: "Recurring billing";
|
|
2972
|
-
readonly summary: "Retrieve a paid invoice";
|
|
2973
|
-
readonly description: "Paid-period evidence: answers only for a settled, full, non-prorated invoice.";
|
|
2974
|
-
readonly auth: "service";
|
|
2975
|
-
readonly scope: "payments:read";
|
|
2976
|
-
readonly params: {
|
|
2977
|
-
invoiceId: string;
|
|
2978
|
-
id: string;
|
|
2979
|
-
};
|
|
2980
|
-
readonly response: import("zod").ZodObject<{
|
|
2981
|
-
invoice_id: import("zod").ZodString;
|
|
2982
|
-
line_id: import("zod").ZodString;
|
|
2983
|
-
payment_intent_id: import("zod").ZodString;
|
|
2984
|
-
provider_subscription_id: import("zod").ZodString;
|
|
2985
|
-
provider_customer_id: import("zod").ZodString;
|
|
2986
|
-
provider_price_id: import("zod").ZodString;
|
|
2987
|
-
store_id: import("zod").ZodString;
|
|
2988
|
-
plan_id: import("zod").ZodString;
|
|
2989
|
-
livemode: import("zod").ZodBoolean;
|
|
2990
|
-
currency: import("zod").ZodString;
|
|
2991
|
-
amount_paid: import("zod").ZodString;
|
|
2992
|
-
net_amount: import("zod").ZodNullable<import("zod").ZodString>;
|
|
2993
|
-
tax_amount: import("zod").ZodNullable<import("zod").ZodString>;
|
|
2994
|
-
period_start: import("zod").ZodNumber;
|
|
2995
|
-
period_end: import("zod").ZodNumber;
|
|
2996
|
-
paid_at: import("zod").ZodNumber;
|
|
2997
|
-
observed_at: import("zod").ZodNumber;
|
|
2998
|
-
}, import("zod/v4/core").$strict>;
|
|
2999
|
-
readonly sdk: "billing.retrievePaidInvoice";
|
|
3000
|
-
}, {
|
|
3001
|
-
readonly operationId: "retrieveBillingSubscription";
|
|
3002
|
-
readonly method: "get";
|
|
3003
|
-
readonly path: "/v1/billing/subscriptions/{id}";
|
|
3004
|
-
readonly tag: "Recurring billing";
|
|
3005
|
-
readonly summary: "Retrieve a subscription";
|
|
3006
|
-
readonly auth: "service";
|
|
3007
|
-
readonly scope: "payments:read";
|
|
3008
|
-
readonly params: {
|
|
3009
|
-
id: string;
|
|
3010
|
-
};
|
|
3011
|
-
readonly response: import("zod").ZodObject<{
|
|
3012
|
-
provider_subscription_id: import("zod").ZodString;
|
|
3013
|
-
latest_invoice_id: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodString>>;
|
|
3014
|
-
provider_customer_id: import("zod").ZodString;
|
|
3015
|
-
provider_price_id: import("zod").ZodString;
|
|
3016
|
-
store_id: import("zod").ZodString;
|
|
3017
|
-
plan_id: import("zod").ZodString;
|
|
3018
|
-
livemode: import("zod").ZodBoolean;
|
|
3019
|
-
status: import("zod").ZodEnum<{
|
|
3020
|
-
active: "active";
|
|
3021
|
-
incomplete: "incomplete";
|
|
3022
|
-
incomplete_expired: "incomplete_expired";
|
|
3023
|
-
trialing: "trialing";
|
|
3024
|
-
past_due: "past_due";
|
|
3025
|
-
unpaid: "unpaid";
|
|
3026
|
-
canceled: "canceled";
|
|
3027
|
-
paused: "paused";
|
|
3028
|
-
}>;
|
|
3029
|
-
interval: import("zod").ZodEnum<{
|
|
3030
|
-
month: "month";
|
|
3031
|
-
year: "year";
|
|
3032
|
-
}>;
|
|
3033
|
-
cancel_at_period_end: import("zod").ZodBoolean;
|
|
3034
|
-
current_period_start: import("zod").ZodNumber;
|
|
3035
|
-
current_period_end: import("zod").ZodNumber;
|
|
3036
|
-
trial_ends_at: import("zod").ZodNullable<import("zod").ZodNumber>;
|
|
3037
|
-
cancel_at: import("zod").ZodNullable<import("zod").ZodNumber>;
|
|
3038
|
-
cancelled_at: import("zod").ZodNullable<import("zod").ZodNumber>;
|
|
3039
|
-
}, import("zod/v4/core").$strict>;
|
|
3040
|
-
readonly sdk: "billing.retrieveSubscription";
|
|
3041
|
-
}, {
|
|
3042
|
-
readonly operationId: "renewBillingSubscription";
|
|
3043
|
-
readonly method: "post";
|
|
3044
|
-
readonly path: "/v1/billing/subscriptions/{id}/renew";
|
|
3045
|
-
readonly tag: "Recurring billing";
|
|
3046
|
-
readonly summary: "Renew a payer-initiated subscription";
|
|
3047
|
-
readonly description: "Opens a new expiring FAIR payment for one monthly period. Never auto-debits. Requires an `Idempotency-Key` header: it is the operation’s identity at the provider.";
|
|
3048
|
-
readonly auth: "service";
|
|
3049
|
-
readonly scope: "payments:write";
|
|
3050
|
-
readonly params: {
|
|
3051
|
-
id: string;
|
|
3052
|
-
};
|
|
3053
|
-
readonly body: import("zod").ZodObject<{
|
|
3054
|
-
rail: import("zod").ZodOptional<import("zod").ZodString>;
|
|
3055
|
-
provider_customer_id: import("zod").ZodString;
|
|
3056
|
-
provider_price_id: import("zod").ZodString;
|
|
3057
|
-
trial_days: import("zod").ZodNumber;
|
|
3058
|
-
tax_quote: import("zod").ZodOptional<import("zod").ZodObject<{
|
|
3059
|
-
schema_version: import("zod").ZodLiteral<2>;
|
|
3060
|
-
source: import("zod").ZodObject<{
|
|
3061
|
-
merchant_id: import("zod").ZodString;
|
|
3062
|
-
app_id: import("zod").ZodString;
|
|
3063
|
-
store_id: import("zod").ZodString;
|
|
3064
|
-
plan_id: import("zod").ZodString;
|
|
3065
|
-
mode: import("zod").ZodEnum<{
|
|
3066
|
-
test: "test";
|
|
3067
|
-
live: "live";
|
|
3068
|
-
}>;
|
|
3069
|
-
environment: import("zod").ZodEnum<{
|
|
3070
|
-
development: "development";
|
|
3071
|
-
staging: "staging";
|
|
3072
|
-
production: "production";
|
|
3073
|
-
}>;
|
|
3074
|
-
}, import("zod/v4/core").$strict>;
|
|
3075
|
-
quote: import("zod").ZodObject<{
|
|
3076
|
-
id: import("zod").ZodString;
|
|
3077
|
-
currency: import("zod").ZodString;
|
|
3078
|
-
gross_minor_units: import("zod").ZodNumber;
|
|
3079
|
-
net_minor_units: import("zod").ZodNumber;
|
|
3080
|
-
tax_minor_units: import("zod").ZodNumber;
|
|
3081
|
-
tax_treatment: import("zod").ZodEnum<{
|
|
3082
|
-
inclusive: "inclusive";
|
|
3083
|
-
exclusive: "exclusive";
|
|
3084
|
-
}>;
|
|
3085
|
-
seller_id: import("zod").ZodString;
|
|
3086
|
-
invoice_issuer_id: import("zod").ZodString;
|
|
3087
|
-
tax_remitter_id: import("zod").ZodString;
|
|
3088
|
-
tax_service_ref: import("zod").ZodString;
|
|
3089
|
-
country: import("zod").ZodString;
|
|
3090
|
-
coverage_evidence_id: import("zod").ZodString;
|
|
3091
|
-
tax_rate_evidence_id: import("zod").ZodString;
|
|
3092
|
-
customer_location_evidence_id: import("zod").ZodString;
|
|
3093
|
-
quoted_at: import("zod").ZodNumber;
|
|
3094
|
-
expires_at: import("zod").ZodNumber;
|
|
3095
|
-
}, import("zod/v4/core").$strict>;
|
|
3096
|
-
signature: import("zod").ZodObject<{
|
|
3097
|
-
algorithm: import("zod").ZodLiteral<"Ed25519">;
|
|
3098
|
-
key_id: import("zod").ZodString;
|
|
3099
|
-
value: import("zod").ZodString;
|
|
3100
|
-
}, import("zod/v4/core").$strict>;
|
|
3101
|
-
}, import("zod/v4/core").$strict>>;
|
|
3102
|
-
return_url: import("zod").ZodString;
|
|
3103
|
-
store_id: import("zod").ZodString;
|
|
3104
|
-
plan_id: import("zod").ZodString;
|
|
3105
|
-
}, import("zod/v4/core").$strict>;
|
|
3106
|
-
readonly response: import("zod").ZodObject<{
|
|
3107
|
-
id: import("zod").ZodString;
|
|
3108
|
-
url: import("zod").ZodString;
|
|
3109
|
-
expires_at: import("zod").ZodNumber;
|
|
3110
|
-
}, import("zod/v4/core").$strict>;
|
|
3111
|
-
readonly sdk: "billing.renewSubscription";
|
|
3112
|
-
}, {
|
|
3113
|
-
readonly operationId: "cancelBillingSubscriptionAtPeriodEnd";
|
|
3114
|
-
readonly method: "post";
|
|
3115
|
-
readonly path: "/v1/billing/subscriptions/{id}/cancel_at_period_end";
|
|
3116
|
-
readonly tag: "Recurring billing";
|
|
3117
|
-
readonly summary: "Cancel a subscription at period end";
|
|
3118
|
-
readonly description: "Access continues to the end of the paid period. Requires an `Idempotency-Key` header: it is the operation’s identity at the provider.";
|
|
3119
|
-
readonly auth: "service";
|
|
3120
|
-
readonly scope: "payments:write";
|
|
3121
|
-
readonly params: {
|
|
3122
|
-
id: string;
|
|
3123
|
-
};
|
|
3124
|
-
readonly body: import("zod").ZodObject<{}, import("zod/v4/core").$strict>;
|
|
3125
|
-
readonly response: import("zod").ZodObject<{
|
|
3126
|
-
provider_subscription_id: import("zod").ZodString;
|
|
3127
|
-
latest_invoice_id: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodString>>;
|
|
3128
|
-
provider_customer_id: import("zod").ZodString;
|
|
3129
|
-
provider_price_id: import("zod").ZodString;
|
|
3130
|
-
store_id: import("zod").ZodString;
|
|
3131
|
-
plan_id: import("zod").ZodString;
|
|
3132
|
-
livemode: import("zod").ZodBoolean;
|
|
3133
|
-
status: import("zod").ZodEnum<{
|
|
3134
|
-
active: "active";
|
|
3135
|
-
incomplete: "incomplete";
|
|
3136
|
-
incomplete_expired: "incomplete_expired";
|
|
3137
|
-
trialing: "trialing";
|
|
3138
|
-
past_due: "past_due";
|
|
3139
|
-
unpaid: "unpaid";
|
|
3140
|
-
canceled: "canceled";
|
|
3141
|
-
paused: "paused";
|
|
3142
|
-
}>;
|
|
3143
|
-
interval: import("zod").ZodEnum<{
|
|
3144
|
-
month: "month";
|
|
3145
|
-
year: "year";
|
|
3146
|
-
}>;
|
|
3147
|
-
cancel_at_period_end: import("zod").ZodBoolean;
|
|
3148
|
-
current_period_start: import("zod").ZodNumber;
|
|
3149
|
-
current_period_end: import("zod").ZodNumber;
|
|
3150
|
-
trial_ends_at: import("zod").ZodNullable<import("zod").ZodNumber>;
|
|
3151
|
-
cancel_at: import("zod").ZodNullable<import("zod").ZodNumber>;
|
|
3152
|
-
cancelled_at: import("zod").ZodNullable<import("zod").ZodNumber>;
|
|
3153
|
-
}, import("zod/v4/core").$strict>;
|
|
3154
|
-
readonly sdk: "billing.cancelAtPeriodEnd";
|
|
3155
2305
|
}];
|