@stigg/typescript 0.1.0-beta.20 → 0.1.0-beta.21
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/CHANGELOG.md +8 -0
- package/package.json +1 -1
- package/resources/v1/addons/addons.d.mts +143 -33
- package/resources/v1/addons/addons.d.mts.map +1 -1
- package/resources/v1/addons/addons.d.ts +143 -33
- package/resources/v1/addons/addons.d.ts.map +1 -1
- package/resources/v1/addons/addons.js +110 -17
- package/resources/v1/addons/addons.js.map +1 -1
- package/resources/v1/addons/addons.mjs +110 -17
- package/resources/v1/addons/addons.mjs.map +1 -1
- package/resources/v1/addons/entitlements.d.mts +62 -5
- package/resources/v1/addons/entitlements.d.mts.map +1 -1
- package/resources/v1/addons/entitlements.d.ts +62 -5
- package/resources/v1/addons/entitlements.d.ts.map +1 -1
- package/resources/v1/addons/entitlements.js +49 -8
- package/resources/v1/addons/entitlements.js.map +1 -1
- package/resources/v1/addons/entitlements.mjs +49 -8
- package/resources/v1/addons/entitlements.mjs.map +1 -1
- package/resources/v1/addons/index.d.mts +2 -2
- package/resources/v1/addons/index.d.mts.map +1 -1
- package/resources/v1/addons/index.d.ts +2 -2
- package/resources/v1/addons/index.d.ts.map +1 -1
- package/resources/v1/addons/index.js.map +1 -1
- package/resources/v1/addons/index.mjs.map +1 -1
- package/resources/v1/coupons.d.mts +80 -20
- package/resources/v1/coupons.d.mts.map +1 -1
- package/resources/v1/coupons.d.ts +80 -20
- package/resources/v1/coupons.d.ts.map +1 -1
- package/resources/v1/coupons.js +60 -9
- package/resources/v1/coupons.js.map +1 -1
- package/resources/v1/coupons.mjs +60 -9
- package/resources/v1/coupons.mjs.map +1 -1
- package/resources/v1/credits/credits.d.mts +59 -26
- package/resources/v1/credits/credits.d.mts.map +1 -1
- package/resources/v1/credits/credits.d.ts +59 -26
- package/resources/v1/credits/credits.d.ts.map +1 -1
- package/resources/v1/credits/credits.js +36 -5
- package/resources/v1/credits/credits.js.map +1 -1
- package/resources/v1/credits/credits.mjs +36 -5
- package/resources/v1/credits/credits.mjs.map +1 -1
- package/resources/v1/credits/custom-currencies.d.mts +96 -23
- package/resources/v1/credits/custom-currencies.d.mts.map +1 -1
- package/resources/v1/credits/custom-currencies.d.ts +96 -23
- package/resources/v1/credits/custom-currencies.d.ts.map +1 -1
- package/resources/v1/credits/custom-currencies.js +76 -12
- package/resources/v1/credits/custom-currencies.js.map +1 -1
- package/resources/v1/credits/custom-currencies.mjs +76 -12
- package/resources/v1/credits/custom-currencies.mjs.map +1 -1
- package/resources/v1/credits/grants.d.mts +60 -23
- package/resources/v1/credits/grants.d.mts.map +1 -1
- package/resources/v1/credits/grants.d.ts +60 -23
- package/resources/v1/credits/grants.d.ts.map +1 -1
- package/resources/v1/credits/grants.js +35 -5
- package/resources/v1/credits/grants.js.map +1 -1
- package/resources/v1/credits/grants.mjs +35 -5
- package/resources/v1/credits/grants.mjs.map +1 -1
- package/resources/v1/credits/index.d.mts +2 -2
- package/resources/v1/credits/index.d.mts.map +1 -1
- package/resources/v1/credits/index.d.ts +2 -2
- package/resources/v1/credits/index.d.ts.map +1 -1
- package/resources/v1/credits/index.js.map +1 -1
- package/resources/v1/credits/index.mjs.map +1 -1
- package/resources/v1/customers/customers.d.mts +165 -48
- package/resources/v1/customers/customers.d.mts.map +1 -1
- package/resources/v1/customers/customers.d.ts +165 -48
- package/resources/v1/customers/customers.d.ts.map +1 -1
- package/resources/v1/customers/customers.js +124 -19
- package/resources/v1/customers/customers.js.map +1 -1
- package/resources/v1/customers/customers.mjs +124 -19
- package/resources/v1/customers/customers.mjs.map +1 -1
- package/resources/v1/customers/index.d.mts +2 -2
- package/resources/v1/customers/index.d.mts.map +1 -1
- package/resources/v1/customers/index.d.ts +2 -2
- package/resources/v1/customers/index.d.ts.map +1 -1
- package/resources/v1/customers/index.js.map +1 -1
- package/resources/v1/customers/index.mjs +1 -1
- package/resources/v1/customers/index.mjs.map +1 -1
- package/resources/v1/customers/integrations.d.mts +64 -9
- package/resources/v1/customers/integrations.d.mts.map +1 -1
- package/resources/v1/customers/integrations.d.ts +64 -9
- package/resources/v1/customers/integrations.d.ts.map +1 -1
- package/resources/v1/customers/integrations.js +57 -9
- package/resources/v1/customers/integrations.js.map +1 -1
- package/resources/v1/customers/integrations.mjs +57 -9
- package/resources/v1/customers/integrations.mjs.map +1 -1
- package/resources/v1/customers/payment-method.d.mts +31 -7
- package/resources/v1/customers/payment-method.d.mts.map +1 -1
- package/resources/v1/customers/payment-method.d.ts +31 -7
- package/resources/v1/customers/payment-method.d.ts.map +1 -1
- package/resources/v1/customers/payment-method.js +26 -4
- package/resources/v1/customers/payment-method.js.map +1 -1
- package/resources/v1/customers/payment-method.mjs +26 -4
- package/resources/v1/customers/payment-method.mjs.map +1 -1
- package/resources/v1/customers/promotional-entitlements.d.mts +40 -7
- package/resources/v1/customers/promotional-entitlements.d.mts.map +1 -1
- package/resources/v1/customers/promotional-entitlements.d.ts +40 -7
- package/resources/v1/customers/promotional-entitlements.d.ts.map +1 -1
- package/resources/v1/customers/promotional-entitlements.js +38 -6
- package/resources/v1/customers/promotional-entitlements.js.map +1 -1
- package/resources/v1/customers/promotional-entitlements.mjs +38 -6
- package/resources/v1/customers/promotional-entitlements.mjs.map +1 -1
- package/resources/v1/events/beta/customers/assignments.d.mts +27 -5
- package/resources/v1/events/beta/customers/assignments.d.mts.map +1 -1
- package/resources/v1/events/beta/customers/assignments.d.ts +27 -5
- package/resources/v1/events/beta/customers/assignments.d.ts.map +1 -1
- package/resources/v1/events/beta/customers/assignments.js +27 -4
- package/resources/v1/events/beta/customers/assignments.js.map +1 -1
- package/resources/v1/events/beta/customers/assignments.mjs +27 -4
- package/resources/v1/events/beta/customers/assignments.mjs.map +1 -1
- package/resources/v1/events/beta/customers/entities.d.mts +66 -10
- package/resources/v1/events/beta/customers/entities.d.mts.map +1 -1
- package/resources/v1/events/beta/customers/entities.d.ts +66 -10
- package/resources/v1/events/beta/customers/entities.d.ts.map +1 -1
- package/resources/v1/events/beta/customers/entities.js +64 -10
- package/resources/v1/events/beta/customers/entities.js.map +1 -1
- package/resources/v1/events/beta/customers/entities.mjs +64 -10
- package/resources/v1/events/beta/customers/entities.mjs.map +1 -1
- package/resources/v1/events/beta/customers/entitlements.d.mts +23 -10
- package/resources/v1/events/beta/customers/entitlements.d.mts.map +1 -1
- package/resources/v1/events/beta/customers/entitlements.d.ts +23 -10
- package/resources/v1/events/beta/customers/entitlements.d.ts.map +1 -1
- package/resources/v1/events/beta/customers/entitlements.js +14 -2
- package/resources/v1/events/beta/customers/entitlements.js.map +1 -1
- package/resources/v1/events/beta/customers/entitlements.mjs +14 -2
- package/resources/v1/events/beta/customers/entitlements.mjs.map +1 -1
- package/resources/v1/events/beta/entity-types.d.mts +25 -3
- package/resources/v1/events/beta/entity-types.d.mts.map +1 -1
- package/resources/v1/events/beta/entity-types.d.ts +25 -3
- package/resources/v1/events/beta/entity-types.d.ts.map +1 -1
- package/resources/v1/events/beta/entity-types.js +23 -3
- package/resources/v1/events/beta/entity-types.js.map +1 -1
- package/resources/v1/events/beta/entity-types.mjs +23 -3
- package/resources/v1/events/beta/entity-types.mjs.map +1 -1
- package/resources/v1/events/events.d.mts +13 -2
- package/resources/v1/events/events.d.mts.map +1 -1
- package/resources/v1/events/events.d.ts +13 -2
- package/resources/v1/events/events.d.ts.map +1 -1
- package/resources/v1/events/events.js +14 -2
- package/resources/v1/events/events.js.map +1 -1
- package/resources/v1/events/events.mjs +14 -2
- package/resources/v1/events/events.mjs.map +1 -1
- package/resources/v1/features.d.mts +108 -30
- package/resources/v1/features.d.mts.map +1 -1
- package/resources/v1/features.d.ts +108 -30
- package/resources/v1/features.d.ts.map +1 -1
- package/resources/v1/features.js +72 -11
- package/resources/v1/features.js.map +1 -1
- package/resources/v1/features.mjs +72 -11
- package/resources/v1/features.mjs.map +1 -1
- package/resources/v1/index.d.mts +7 -7
- package/resources/v1/index.d.mts.map +1 -1
- package/resources/v1/index.d.ts +7 -7
- package/resources/v1/index.d.ts.map +1 -1
- package/resources/v1/index.js.map +1 -1
- package/resources/v1/index.mjs.map +1 -1
- package/resources/v1/plans/entitlements.d.mts +62 -5
- package/resources/v1/plans/entitlements.d.mts.map +1 -1
- package/resources/v1/plans/entitlements.d.ts +62 -5
- package/resources/v1/plans/entitlements.d.ts.map +1 -1
- package/resources/v1/plans/entitlements.js +49 -8
- package/resources/v1/plans/entitlements.js.map +1 -1
- package/resources/v1/plans/entitlements.mjs +49 -8
- package/resources/v1/plans/entitlements.mjs.map +1 -1
- package/resources/v1/plans/index.d.mts +2 -2
- package/resources/v1/plans/index.d.mts.map +1 -1
- package/resources/v1/plans/index.d.ts +2 -2
- package/resources/v1/plans/index.d.ts.map +1 -1
- package/resources/v1/plans/index.js.map +1 -1
- package/resources/v1/plans/index.mjs.map +1 -1
- package/resources/v1/plans/plans.d.mts +156 -34
- package/resources/v1/plans/plans.d.mts.map +1 -1
- package/resources/v1/plans/plans.d.ts +156 -34
- package/resources/v1/plans/plans.d.ts.map +1 -1
- package/resources/v1/plans/plans.js +127 -20
- package/resources/v1/plans/plans.js.map +1 -1
- package/resources/v1/plans/plans.mjs +127 -20
- package/resources/v1/plans/plans.mjs.map +1 -1
- package/resources/v1/products.d.mts +97 -23
- package/resources/v1/products.d.mts.map +1 -1
- package/resources/v1/products.d.ts +97 -23
- package/resources/v1/products.d.ts.map +1 -1
- package/resources/v1/products.js +73 -11
- package/resources/v1/products.js.map +1 -1
- package/resources/v1/products.mjs +73 -11
- package/resources/v1/products.mjs.map +1 -1
- package/resources/v1/subscriptions/future-update.d.mts +29 -3
- package/resources/v1/subscriptions/future-update.d.mts.map +1 -1
- package/resources/v1/subscriptions/future-update.d.ts +29 -3
- package/resources/v1/subscriptions/future-update.d.ts.map +1 -1
- package/resources/v1/subscriptions/future-update.js +25 -4
- package/resources/v1/subscriptions/future-update.js.map +1 -1
- package/resources/v1/subscriptions/future-update.mjs +25 -4
- package/resources/v1/subscriptions/future-update.mjs.map +1 -1
- package/resources/v1/subscriptions/index.d.mts +4 -4
- package/resources/v1/subscriptions/index.d.mts.map +1 -1
- package/resources/v1/subscriptions/index.d.ts +4 -4
- package/resources/v1/subscriptions/index.d.ts.map +1 -1
- package/resources/v1/subscriptions/index.js.map +1 -1
- package/resources/v1/subscriptions/index.mjs +1 -1
- package/resources/v1/subscriptions/index.mjs.map +1 -1
- package/resources/v1/subscriptions/invoice.d.mts +15 -2
- package/resources/v1/subscriptions/invoice.d.mts.map +1 -1
- package/resources/v1/subscriptions/invoice.d.ts +15 -2
- package/resources/v1/subscriptions/invoice.d.ts.map +1 -1
- package/resources/v1/subscriptions/invoice.js +13 -2
- package/resources/v1/subscriptions/invoice.js.map +1 -1
- package/resources/v1/subscriptions/invoice.mjs +13 -2
- package/resources/v1/subscriptions/invoice.mjs.map +1 -1
- package/resources/v1/subscriptions/subscriptions.d.mts +242 -78
- package/resources/v1/subscriptions/subscriptions.d.mts.map +1 -1
- package/resources/v1/subscriptions/subscriptions.d.ts +242 -78
- package/resources/v1/subscriptions/subscriptions.d.ts.map +1 -1
- package/resources/v1/subscriptions/subscriptions.js +126 -19
- package/resources/v1/subscriptions/subscriptions.js.map +1 -1
- package/resources/v1/subscriptions/subscriptions.mjs +128 -21
- package/resources/v1/subscriptions/subscriptions.mjs.map +1 -1
- package/resources/v1/subscriptions/usage.d.mts +29 -4
- package/resources/v1/subscriptions/usage.d.mts.map +1 -1
- package/resources/v1/subscriptions/usage.d.ts +29 -4
- package/resources/v1/subscriptions/usage.d.ts.map +1 -1
- package/resources/v1/subscriptions/usage.js +26 -4
- package/resources/v1/subscriptions/usage.js.map +1 -1
- package/resources/v1/subscriptions/usage.mjs +26 -4
- package/resources/v1/subscriptions/usage.mjs.map +1 -1
- package/resources/v1/usage.d.mts +24 -2
- package/resources/v1/usage.d.mts.map +1 -1
- package/resources/v1/usage.d.ts +24 -2
- package/resources/v1/usage.d.ts.map +1 -1
- package/resources/v1/usage.js +26 -4
- package/resources/v1/usage.js.map +1 -1
- package/resources/v1/usage.mjs +26 -4
- package/resources/v1/usage.mjs.map +1 -1
- package/resources/v1/v1.d.mts +14 -14
- package/resources/v1/v1.d.mts.map +1 -1
- package/resources/v1/v1.d.ts +14 -14
- package/resources/v1/v1.d.ts.map +1 -1
- package/resources/v1/v1.js.map +1 -1
- package/resources/v1/v1.mjs.map +1 -1
- package/src/resources/v1/addons/addons.ts +286 -39
- package/src/resources/v1/addons/entitlements.ts +123 -10
- package/src/resources/v1/addons/index.ts +5 -0
- package/src/resources/v1/coupons.ts +154 -23
- package/src/resources/v1/credits/credits.ts +102 -24
- package/src/resources/v1/credits/custom-currencies.ts +188 -30
- package/src/resources/v1/credits/grants.ts +102 -24
- package/src/resources/v1/credits/index.ts +4 -0
- package/src/resources/v1/customers/customers.ts +318 -57
- package/src/resources/v1/customers/index.ts +8 -1
- package/src/resources/v1/customers/integrations.ts +129 -16
- package/src/resources/v1/customers/payment-method.ts +66 -9
- package/src/resources/v1/customers/promotional-entitlements.ts +82 -11
- package/src/resources/v1/events/beta/customers/assignments.ts +56 -7
- package/src/resources/v1/events/beta/customers/entities.ts +136 -16
- package/src/resources/v1/events/beta/customers/entitlements.ts +38 -11
- package/src/resources/v1/events/beta/entity-types.ts +51 -5
- package/src/resources/v1/events/events.ts +28 -3
- package/src/resources/v1/features.ts +204 -34
- package/src/resources/v1/index.ts +19 -0
- package/src/resources/v1/plans/entitlements.ts +123 -10
- package/src/resources/v1/plans/index.ts +5 -0
- package/src/resources/v1/plans/plans.ts +314 -43
- package/src/resources/v1/products.ts +189 -27
- package/src/resources/v1/subscriptions/future-update.ts +68 -5
- package/src/resources/v1/subscriptions/index.ts +9 -2
- package/src/resources/v1/subscriptions/invoice.ts +36 -3
- package/src/resources/v1/subscriptions/subscriptions.ts +410 -85
- package/src/resources/v1/subscriptions/usage.ts +61 -5
- package/src/resources/v1/usage.ts +53 -5
- package/src/resources/v1/v1.ts +38 -0
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
import { APIResource } from "../../../core/resource.js";
|
|
2
2
|
import * as FutureUpdateAPI from "./future-update.js";
|
|
3
|
-
import { CancelSubscription, FutureUpdate as FutureUpdateAPIFutureUpdate } from "./future-update.js";
|
|
3
|
+
import { CancelSubscription, FutureUpdate as FutureUpdateAPIFutureUpdate, FutureUpdateCancelPendingPaymentParams, FutureUpdateCancelScheduleParams } from "./future-update.js";
|
|
4
4
|
import * as InvoiceAPI from "./invoice.js";
|
|
5
|
-
import { Invoice, InvoiceMarkAsPaidResponse } from "./invoice.js";
|
|
5
|
+
import { Invoice, InvoiceMarkAsPaidParams, InvoiceMarkAsPaidResponse } from "./invoice.js";
|
|
6
6
|
import * as UsageAPI from "./usage.js";
|
|
7
|
-
import { Usage, UsageChargeUsageParams, UsageChargeUsageResponse, UsageSyncResponse } from "./usage.js";
|
|
7
|
+
import { Usage, UsageChargeUsageParams, UsageChargeUsageResponse, UsageSyncParams, UsageSyncResponse } from "./usage.js";
|
|
8
8
|
import { APIPromise } from "../../../core/api-promise.js";
|
|
9
9
|
import { MyCursorIDPage, type MyCursorIDPageParams, PagePromise } from "../../../core/pagination.js";
|
|
10
10
|
import { RequestOptions } from "../../../internal/request-options.js";
|
|
@@ -23,7 +23,7 @@ export declare class Subscriptions extends APIResource {
|
|
|
23
23
|
* );
|
|
24
24
|
* ```
|
|
25
25
|
*/
|
|
26
|
-
retrieve(id: string, options?: RequestOptions): APIPromise<Subscription>;
|
|
26
|
+
retrieve(id: string, params?: SubscriptionRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<Subscription>;
|
|
27
27
|
/**
|
|
28
28
|
* Updates an active subscription's properties including billing period, add-ons,
|
|
29
29
|
* unit quantities, and discounts.
|
|
@@ -35,7 +35,7 @@ export declare class Subscriptions extends APIResource {
|
|
|
35
35
|
* );
|
|
36
36
|
* ```
|
|
37
37
|
*/
|
|
38
|
-
update(id: string,
|
|
38
|
+
update(id: string, params: SubscriptionUpdateParams, options?: RequestOptions): APIPromise<Subscription>;
|
|
39
39
|
/**
|
|
40
40
|
* Retrieves a paginated list of subscriptions, with optional filters for customer,
|
|
41
41
|
* status, and plan.
|
|
@@ -48,7 +48,7 @@ export declare class Subscriptions extends APIResource {
|
|
|
48
48
|
* }
|
|
49
49
|
* ```
|
|
50
50
|
*/
|
|
51
|
-
list(
|
|
51
|
+
list(params?: SubscriptionListParams | null | undefined, options?: RequestOptions): PagePromise<SubscriptionListResponsesMyCursorIDPage, SubscriptionListResponse>;
|
|
52
52
|
/**
|
|
53
53
|
* Cancels an active subscription, either immediately or at a specified time such
|
|
54
54
|
* as end of billing period.
|
|
@@ -60,7 +60,7 @@ export declare class Subscriptions extends APIResource {
|
|
|
60
60
|
* );
|
|
61
61
|
* ```
|
|
62
62
|
*/
|
|
63
|
-
cancel(id: string,
|
|
63
|
+
cancel(id: string, params: SubscriptionCancelParams, options?: RequestOptions): APIPromise<Subscription>;
|
|
64
64
|
/**
|
|
65
65
|
* Delegates the payment responsibility of a subscription to a different customer.
|
|
66
66
|
* The delegated customer will be billed for this subscription.
|
|
@@ -73,7 +73,7 @@ export declare class Subscriptions extends APIResource {
|
|
|
73
73
|
* );
|
|
74
74
|
* ```
|
|
75
75
|
*/
|
|
76
|
-
delegate(id: string,
|
|
76
|
+
delegate(id: string, params: SubscriptionDelegateParams, options?: RequestOptions): APIPromise<Subscription>;
|
|
77
77
|
/**
|
|
78
78
|
* Imports multiple subscriptions in bulk. Used for migrating subscription data
|
|
79
79
|
* from external systems.
|
|
@@ -91,7 +91,7 @@ export declare class Subscriptions extends APIResource {
|
|
|
91
91
|
* });
|
|
92
92
|
* ```
|
|
93
93
|
*/
|
|
94
|
-
import(
|
|
94
|
+
import(params: SubscriptionImportParams, options?: RequestOptions): APIPromise<SubscriptionImportResponse>;
|
|
95
95
|
/**
|
|
96
96
|
* Migrates a subscription to the latest published version of its plan or add-ons.
|
|
97
97
|
* Handles prorated charges or credits automatically.
|
|
@@ -103,7 +103,7 @@ export declare class Subscriptions extends APIResource {
|
|
|
103
103
|
* );
|
|
104
104
|
* ```
|
|
105
105
|
*/
|
|
106
|
-
migrate(id: string,
|
|
106
|
+
migrate(id: string, params: SubscriptionMigrateParams, options?: RequestOptions): APIPromise<Subscription>;
|
|
107
107
|
/**
|
|
108
108
|
* Previews the pricing impact of creating or updating a subscription without
|
|
109
109
|
* making changes. Returns estimated costs, taxes, and proration details.
|
|
@@ -116,7 +116,7 @@ export declare class Subscriptions extends APIResource {
|
|
|
116
116
|
* });
|
|
117
117
|
* ```
|
|
118
118
|
*/
|
|
119
|
-
preview(
|
|
119
|
+
preview(params: SubscriptionPreviewParams, options?: RequestOptions): APIPromise<SubscriptionPreviewResponse>;
|
|
120
120
|
/**
|
|
121
121
|
* Creates a new subscription for an existing customer. When payment is required
|
|
122
122
|
* and no payment method exists, returns a checkout URL.
|
|
@@ -129,7 +129,7 @@ export declare class Subscriptions extends APIResource {
|
|
|
129
129
|
* });
|
|
130
130
|
* ```
|
|
131
131
|
*/
|
|
132
|
-
provision(
|
|
132
|
+
provision(params: SubscriptionProvisionParams, options?: RequestOptions): APIPromise<SubscriptionProvisionResponse>;
|
|
133
133
|
/**
|
|
134
134
|
* Transfers a subscription to a different resource ID. Used for multi-resource
|
|
135
135
|
* products where subscriptions apply to specific entities like websites or apps.
|
|
@@ -142,7 +142,7 @@ export declare class Subscriptions extends APIResource {
|
|
|
142
142
|
* );
|
|
143
143
|
* ```
|
|
144
144
|
*/
|
|
145
|
-
transfer(id: string,
|
|
145
|
+
transfer(id: string, params: SubscriptionTransferParams, options?: RequestOptions): APIPromise<Subscription>;
|
|
146
146
|
}
|
|
147
147
|
export type SubscriptionListResponsesMyCursorIDPage = MyCursorIDPage<SubscriptionListResponse>;
|
|
148
148
|
/**
|
|
@@ -1740,43 +1740,97 @@ export declare namespace SubscriptionProvisionResponse {
|
|
|
1740
1740
|
}
|
|
1741
1741
|
}
|
|
1742
1742
|
}
|
|
1743
|
+
export interface SubscriptionRetrieveParams {
|
|
1744
|
+
/**
|
|
1745
|
+
* Account ID — optional when authenticating with a user JWT (Bearer token); falls
|
|
1746
|
+
* back to the user's first membership. Ignored for API-key auth.
|
|
1747
|
+
*/
|
|
1748
|
+
'X-ACCOUNT-ID'?: string;
|
|
1749
|
+
/**
|
|
1750
|
+
* Environment ID — required when authenticating with a user JWT (Bearer token) on
|
|
1751
|
+
* environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the
|
|
1752
|
+
* key).
|
|
1753
|
+
*/
|
|
1754
|
+
'X-ENVIRONMENT-ID'?: string;
|
|
1755
|
+
}
|
|
1743
1756
|
export interface SubscriptionUpdateParams {
|
|
1757
|
+
/**
|
|
1758
|
+
* Body param
|
|
1759
|
+
*/
|
|
1744
1760
|
addons?: Array<SubscriptionUpdateParams.Addon>;
|
|
1761
|
+
/**
|
|
1762
|
+
* Body param
|
|
1763
|
+
*/
|
|
1745
1764
|
appliedCoupon?: SubscriptionUpdateParams.AppliedCoupon;
|
|
1746
1765
|
/**
|
|
1747
|
-
* Await payment confirmation
|
|
1766
|
+
* Body param: Await payment confirmation
|
|
1748
1767
|
*/
|
|
1749
1768
|
awaitPaymentConfirmation?: boolean;
|
|
1769
|
+
/**
|
|
1770
|
+
* Body param
|
|
1771
|
+
*/
|
|
1750
1772
|
billingCycleAnchor?: 'UNCHANGED' | 'NOW';
|
|
1773
|
+
/**
|
|
1774
|
+
* Body param
|
|
1775
|
+
*/
|
|
1751
1776
|
billingInformation?: SubscriptionUpdateParams.BillingInformation;
|
|
1777
|
+
/**
|
|
1778
|
+
* Body param
|
|
1779
|
+
*/
|
|
1752
1780
|
billingPeriod?: 'MONTHLY' | 'ANNUALLY';
|
|
1781
|
+
/**
|
|
1782
|
+
* Body param
|
|
1783
|
+
*/
|
|
1753
1784
|
budget?: SubscriptionUpdateParams.Budget | null;
|
|
1754
1785
|
/**
|
|
1755
|
-
* Subscription cancellation date
|
|
1786
|
+
* Body param: Subscription cancellation date
|
|
1756
1787
|
*/
|
|
1757
1788
|
cancellationDate?: string | null;
|
|
1789
|
+
/**
|
|
1790
|
+
* Body param
|
|
1791
|
+
*/
|
|
1758
1792
|
charges?: Array<SubscriptionUpdateParams.Charge>;
|
|
1793
|
+
/**
|
|
1794
|
+
* Body param
|
|
1795
|
+
*/
|
|
1759
1796
|
entitlements?: Array<SubscriptionUpdateParams.Feature | SubscriptionUpdateParams.Credit>;
|
|
1760
1797
|
/**
|
|
1761
|
-
* Additional metadata for the subscription
|
|
1798
|
+
* Body param: Additional metadata for the subscription
|
|
1762
1799
|
*/
|
|
1763
1800
|
metadata?: {
|
|
1764
1801
|
[key: string]: string;
|
|
1765
1802
|
};
|
|
1766
1803
|
/**
|
|
1767
|
-
* Minimum spend amount
|
|
1804
|
+
* Body param: Minimum spend amount
|
|
1768
1805
|
*/
|
|
1769
1806
|
minimumSpend?: SubscriptionUpdateParams.MinimumSpend | null;
|
|
1807
|
+
/**
|
|
1808
|
+
* Body param
|
|
1809
|
+
*/
|
|
1770
1810
|
priceOverrides?: Array<SubscriptionUpdateParams.PriceOverride>;
|
|
1771
1811
|
/**
|
|
1772
|
-
* Promotion code
|
|
1812
|
+
* Body param: Promotion code
|
|
1773
1813
|
*/
|
|
1774
1814
|
promotionCode?: string;
|
|
1815
|
+
/**
|
|
1816
|
+
* Body param
|
|
1817
|
+
*/
|
|
1775
1818
|
scheduleStrategy?: 'END_OF_BILLING_PERIOD' | 'END_OF_BILLING_MONTH' | 'IMMEDIATE';
|
|
1776
1819
|
/**
|
|
1777
|
-
* Subscription trial end date
|
|
1820
|
+
* Body param: Subscription trial end date
|
|
1778
1821
|
*/
|
|
1779
1822
|
trialEndDate?: string;
|
|
1823
|
+
/**
|
|
1824
|
+
* Header param: Account ID — optional when authenticating with a user JWT (Bearer
|
|
1825
|
+
* token); falls back to the user's first membership. Ignored for API-key auth.
|
|
1826
|
+
*/
|
|
1827
|
+
'X-ACCOUNT-ID'?: string;
|
|
1828
|
+
/**
|
|
1829
|
+
* Header param: Environment ID — required when authenticating with a user JWT
|
|
1830
|
+
* (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is
|
|
1831
|
+
* intrinsic to the key).
|
|
1832
|
+
*/
|
|
1833
|
+
'X-ENVIRONMENT-ID'?: string;
|
|
1780
1834
|
}
|
|
1781
1835
|
export declare namespace SubscriptionUpdateParams {
|
|
1782
1836
|
/**
|
|
@@ -2040,30 +2094,42 @@ export declare namespace SubscriptionUpdateParams {
|
|
|
2040
2094
|
}
|
|
2041
2095
|
export interface SubscriptionListParams extends MyCursorIDPageParams {
|
|
2042
2096
|
/**
|
|
2043
|
-
* Filter by creation date using range operators: gt, gte, lt, lte
|
|
2097
|
+
* Query param: Filter by creation date using range operators: gt, gte, lt, lte
|
|
2044
2098
|
*/
|
|
2045
2099
|
createdAt?: SubscriptionListParams.CreatedAt;
|
|
2046
2100
|
/**
|
|
2047
|
-
* Filter by customer ID
|
|
2101
|
+
* Query param: Filter by customer ID
|
|
2048
2102
|
*/
|
|
2049
2103
|
customerId?: string;
|
|
2050
2104
|
/**
|
|
2051
|
-
* Filter by plan ID
|
|
2105
|
+
* Query param: Filter by plan ID
|
|
2052
2106
|
*/
|
|
2053
2107
|
planId?: string;
|
|
2054
2108
|
/**
|
|
2055
|
-
* Filter by pricing type. Supports comma-separated values for
|
|
2109
|
+
* Query param: Filter by pricing type. Supports comma-separated values for
|
|
2110
|
+
* multiple types
|
|
2056
2111
|
*/
|
|
2057
2112
|
pricingType?: Array<'FREE' | 'PAID' | 'CUSTOM'>;
|
|
2058
2113
|
/**
|
|
2059
|
-
* Filter by resource ID
|
|
2114
|
+
* Query param: Filter by resource ID
|
|
2060
2115
|
*/
|
|
2061
2116
|
resourceId?: string;
|
|
2062
2117
|
/**
|
|
2063
|
-
* Filter by subscription status. Supports comma-separated values for
|
|
2064
|
-
* statuses
|
|
2118
|
+
* Query param: Filter by subscription status. Supports comma-separated values for
|
|
2119
|
+
* multiple statuses
|
|
2065
2120
|
*/
|
|
2066
2121
|
status?: Array<'PAYMENT_PENDING' | 'ACTIVE' | 'EXPIRED' | 'IN_TRIAL' | 'CANCELED' | 'NOT_STARTED'>;
|
|
2122
|
+
/**
|
|
2123
|
+
* Header param: Account ID — optional when authenticating with a user JWT (Bearer
|
|
2124
|
+
* token); falls back to the user's first membership. Ignored for API-key auth.
|
|
2125
|
+
*/
|
|
2126
|
+
'X-ACCOUNT-ID'?: string;
|
|
2127
|
+
/**
|
|
2128
|
+
* Header param: Environment ID — required when authenticating with a user JWT
|
|
2129
|
+
* (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is
|
|
2130
|
+
* intrinsic to the key).
|
|
2131
|
+
*/
|
|
2132
|
+
'X-ENVIRONMENT-ID'?: string;
|
|
2067
2133
|
}
|
|
2068
2134
|
export declare namespace SubscriptionListParams {
|
|
2069
2135
|
/**
|
|
@@ -2090,39 +2156,74 @@ export declare namespace SubscriptionListParams {
|
|
|
2090
2156
|
}
|
|
2091
2157
|
export interface SubscriptionCancelParams {
|
|
2092
2158
|
/**
|
|
2093
|
-
* Action on cancellation (downgrade or revoke)
|
|
2159
|
+
* Body param: Action on cancellation (downgrade or revoke)
|
|
2094
2160
|
*/
|
|
2095
2161
|
cancellationAction?: 'DEFAULT' | 'REVOKE_ENTITLEMENTS';
|
|
2096
2162
|
/**
|
|
2097
|
-
* When to cancel (immediate, period end, or date)
|
|
2163
|
+
* Body param: When to cancel (immediate, period end, or date)
|
|
2098
2164
|
*/
|
|
2099
2165
|
cancellationTime?: 'END_OF_BILLING_PERIOD' | 'IMMEDIATE' | 'SPECIFIC_DATE';
|
|
2100
2166
|
/**
|
|
2101
|
-
* Subscription end date
|
|
2167
|
+
* Body param: Subscription end date
|
|
2102
2168
|
*/
|
|
2103
2169
|
endDate?: string;
|
|
2104
2170
|
/**
|
|
2105
|
-
* If set, enables or disables prorating of credits on subscription
|
|
2171
|
+
* Body param: If set, enables or disables prorating of credits on subscription
|
|
2172
|
+
* cancellation.
|
|
2106
2173
|
*/
|
|
2107
2174
|
prorate?: boolean;
|
|
2175
|
+
/**
|
|
2176
|
+
* Header param: Account ID — optional when authenticating with a user JWT (Bearer
|
|
2177
|
+
* token); falls back to the user's first membership. Ignored for API-key auth.
|
|
2178
|
+
*/
|
|
2179
|
+
'X-ACCOUNT-ID'?: string;
|
|
2180
|
+
/**
|
|
2181
|
+
* Header param: Environment ID — required when authenticating with a user JWT
|
|
2182
|
+
* (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is
|
|
2183
|
+
* intrinsic to the key).
|
|
2184
|
+
*/
|
|
2185
|
+
'X-ENVIRONMENT-ID'?: string;
|
|
2108
2186
|
}
|
|
2109
2187
|
export interface SubscriptionDelegateParams {
|
|
2110
2188
|
/**
|
|
2111
|
-
* The unique identifier of the customer who will assume payment
|
|
2112
|
-
* this subscription. This customer must already exist in your
|
|
2113
|
-
* have a valid payment method if the subscription requires
|
|
2189
|
+
* Body param: The unique identifier of the customer who will assume payment
|
|
2190
|
+
* responsibility for this subscription. This customer must already exist in your
|
|
2191
|
+
* Stigg account and have a valid payment method if the subscription requires
|
|
2192
|
+
* payment.
|
|
2114
2193
|
*/
|
|
2115
2194
|
targetCustomerId: string;
|
|
2195
|
+
/**
|
|
2196
|
+
* Header param: Account ID — optional when authenticating with a user JWT (Bearer
|
|
2197
|
+
* token); falls back to the user's first membership. Ignored for API-key auth.
|
|
2198
|
+
*/
|
|
2199
|
+
'X-ACCOUNT-ID'?: string;
|
|
2200
|
+
/**
|
|
2201
|
+
* Header param: Environment ID — required when authenticating with a user JWT
|
|
2202
|
+
* (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is
|
|
2203
|
+
* intrinsic to the key).
|
|
2204
|
+
*/
|
|
2205
|
+
'X-ENVIRONMENT-ID'?: string;
|
|
2116
2206
|
}
|
|
2117
2207
|
export interface SubscriptionImportParams {
|
|
2118
2208
|
/**
|
|
2119
|
-
* List of subscription objects to import
|
|
2209
|
+
* Body param: List of subscription objects to import
|
|
2120
2210
|
*/
|
|
2121
2211
|
subscriptions: Array<SubscriptionImportParams.Subscription>;
|
|
2122
2212
|
/**
|
|
2123
|
-
* Integration ID to use for importing subscriptions
|
|
2213
|
+
* Body param: Integration ID to use for importing subscriptions
|
|
2124
2214
|
*/
|
|
2125
2215
|
integrationId?: string | null;
|
|
2216
|
+
/**
|
|
2217
|
+
* Header param: Account ID — optional when authenticating with a user JWT (Bearer
|
|
2218
|
+
* token); falls back to the user's first membership. Ignored for API-key auth.
|
|
2219
|
+
*/
|
|
2220
|
+
'X-ACCOUNT-ID'?: string;
|
|
2221
|
+
/**
|
|
2222
|
+
* Header param: Environment ID — required when authenticating with a user JWT
|
|
2223
|
+
* (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is
|
|
2224
|
+
* intrinsic to the key).
|
|
2225
|
+
*/
|
|
2226
|
+
'X-ENVIRONMENT-ID'?: string;
|
|
2126
2227
|
}
|
|
2127
2228
|
export declare namespace SubscriptionImportParams {
|
|
2128
2229
|
interface Subscription {
|
|
@@ -2203,75 +2304,97 @@ export declare namespace SubscriptionImportParams {
|
|
|
2203
2304
|
}
|
|
2204
2305
|
export interface SubscriptionMigrateParams {
|
|
2205
2306
|
/**
|
|
2206
|
-
* When to migrate (immediate or period end)
|
|
2307
|
+
* Body param: When to migrate (immediate or period end)
|
|
2207
2308
|
*/
|
|
2208
2309
|
subscriptionMigrationTime?: 'END_OF_BILLING_PERIOD' | 'IMMEDIATE';
|
|
2310
|
+
/**
|
|
2311
|
+
* Header param: Account ID — optional when authenticating with a user JWT (Bearer
|
|
2312
|
+
* token); falls back to the user's first membership. Ignored for API-key auth.
|
|
2313
|
+
*/
|
|
2314
|
+
'X-ACCOUNT-ID'?: string;
|
|
2315
|
+
/**
|
|
2316
|
+
* Header param: Environment ID — required when authenticating with a user JWT
|
|
2317
|
+
* (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is
|
|
2318
|
+
* intrinsic to the key).
|
|
2319
|
+
*/
|
|
2320
|
+
'X-ENVIRONMENT-ID'?: string;
|
|
2209
2321
|
}
|
|
2210
2322
|
export interface SubscriptionPreviewParams {
|
|
2211
2323
|
/**
|
|
2212
|
-
* Customer ID
|
|
2324
|
+
* Body param: Customer ID
|
|
2213
2325
|
*/
|
|
2214
2326
|
customerId: string;
|
|
2215
2327
|
/**
|
|
2216
|
-
* Plan ID
|
|
2328
|
+
* Body param: Plan ID
|
|
2217
2329
|
*/
|
|
2218
2330
|
planId: string;
|
|
2219
2331
|
/**
|
|
2220
|
-
* Addons to include
|
|
2332
|
+
* Body param: Addons to include
|
|
2221
2333
|
*/
|
|
2222
2334
|
addons?: Array<SubscriptionPreviewParams.Addon>;
|
|
2223
2335
|
/**
|
|
2224
|
-
* Coupon or discount to apply
|
|
2336
|
+
* Body param: Coupon or discount to apply
|
|
2225
2337
|
*/
|
|
2226
2338
|
appliedCoupon?: SubscriptionPreviewParams.AppliedCoupon;
|
|
2227
2339
|
/**
|
|
2228
|
-
* Billable features with quantities
|
|
2340
|
+
* Body param: Billable features with quantities
|
|
2229
2341
|
*/
|
|
2230
2342
|
billableFeatures?: Array<SubscriptionPreviewParams.BillableFeature>;
|
|
2231
2343
|
/**
|
|
2232
|
-
* ISO 3166-1 country code for localization
|
|
2344
|
+
* Body param: ISO 3166-1 country code for localization
|
|
2233
2345
|
*/
|
|
2234
2346
|
billingCountryCode?: string;
|
|
2235
2347
|
/**
|
|
2236
|
-
* Billing cycle anchor behavior for the subscription
|
|
2348
|
+
* Body param: Billing cycle anchor behavior for the subscription
|
|
2237
2349
|
*/
|
|
2238
2350
|
billingCycleAnchor?: 'UNCHANGED' | 'NOW';
|
|
2239
2351
|
/**
|
|
2240
|
-
* Billing and tax configuration
|
|
2352
|
+
* Body param: Billing and tax configuration
|
|
2241
2353
|
*/
|
|
2242
2354
|
billingInformation?: SubscriptionPreviewParams.BillingInformation;
|
|
2243
2355
|
/**
|
|
2244
|
-
* Billing period (MONTHLY or ANNUALLY)
|
|
2356
|
+
* Body param: Billing period (MONTHLY or ANNUALLY)
|
|
2245
2357
|
*/
|
|
2246
2358
|
billingPeriod?: 'MONTHLY' | 'ANNUALLY';
|
|
2247
2359
|
/**
|
|
2248
|
-
* One-time or recurring charges
|
|
2360
|
+
* Body param: One-time or recurring charges
|
|
2249
2361
|
*/
|
|
2250
2362
|
charges?: Array<SubscriptionPreviewParams.Charge>;
|
|
2251
2363
|
/**
|
|
2252
|
-
* Paying customer ID for delegated billing
|
|
2364
|
+
* Body param: Paying customer ID for delegated billing
|
|
2253
2365
|
*/
|
|
2254
2366
|
payingCustomerId?: string;
|
|
2255
2367
|
/**
|
|
2256
|
-
* Resource ID for multi-instance subscriptions
|
|
2368
|
+
* Body param: Resource ID for multi-instance subscriptions
|
|
2257
2369
|
*/
|
|
2258
2370
|
resourceId?: string;
|
|
2259
2371
|
/**
|
|
2260
|
-
* When to apply subscription changes
|
|
2372
|
+
* Body param: When to apply subscription changes
|
|
2261
2373
|
*/
|
|
2262
2374
|
scheduleStrategy?: 'END_OF_BILLING_PERIOD' | 'END_OF_BILLING_MONTH' | 'IMMEDIATE';
|
|
2263
2375
|
/**
|
|
2264
|
-
* Subscription start date
|
|
2376
|
+
* Body param: Subscription start date
|
|
2265
2377
|
*/
|
|
2266
2378
|
startDate?: string;
|
|
2267
2379
|
/**
|
|
2268
|
-
* Trial period override settings
|
|
2380
|
+
* Body param: Trial period override settings
|
|
2269
2381
|
*/
|
|
2270
2382
|
trialOverrideConfiguration?: SubscriptionPreviewParams.TrialOverrideConfiguration;
|
|
2271
2383
|
/**
|
|
2272
|
-
* Unit quantity for per-unit pricing. Minimum is 0 (zero is allowed).
|
|
2384
|
+
* Body param: Unit quantity for per-unit pricing. Minimum is 0 (zero is allowed).
|
|
2273
2385
|
*/
|
|
2274
2386
|
unitQuantity?: number;
|
|
2387
|
+
/**
|
|
2388
|
+
* Header param: Account ID — optional when authenticating with a user JWT (Bearer
|
|
2389
|
+
* token); falls back to the user's first membership. Ignored for API-key auth.
|
|
2390
|
+
*/
|
|
2391
|
+
'X-ACCOUNT-ID'?: string;
|
|
2392
|
+
/**
|
|
2393
|
+
* Header param: Environment ID — required when authenticating with a user JWT
|
|
2394
|
+
* (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is
|
|
2395
|
+
* intrinsic to the key).
|
|
2396
|
+
*/
|
|
2397
|
+
'X-ENVIRONMENT-ID'?: string;
|
|
2275
2398
|
}
|
|
2276
2399
|
export declare namespace SubscriptionPreviewParams {
|
|
2277
2400
|
/**
|
|
@@ -2488,97 +2611,127 @@ export declare namespace SubscriptionPreviewParams {
|
|
|
2488
2611
|
}
|
|
2489
2612
|
export interface SubscriptionProvisionParams {
|
|
2490
2613
|
/**
|
|
2491
|
-
* Customer ID to provision the subscription for
|
|
2614
|
+
* Body param: Customer ID to provision the subscription for
|
|
2492
2615
|
*/
|
|
2493
2616
|
customerId: string;
|
|
2494
2617
|
/**
|
|
2495
|
-
* Plan ID to provision
|
|
2618
|
+
* Body param: Plan ID to provision
|
|
2496
2619
|
*/
|
|
2497
2620
|
planId: string;
|
|
2498
2621
|
/**
|
|
2499
|
-
* Unique identifier for the subscription
|
|
2622
|
+
* Body param: Unique identifier for the subscription
|
|
2500
2623
|
*/
|
|
2501
2624
|
id?: string;
|
|
2625
|
+
/**
|
|
2626
|
+
* Body param
|
|
2627
|
+
*/
|
|
2502
2628
|
addons?: Array<SubscriptionProvisionParams.Addon>;
|
|
2503
2629
|
/**
|
|
2504
|
-
* Coupon configuration
|
|
2630
|
+
* Body param: Coupon configuration
|
|
2505
2631
|
*/
|
|
2506
2632
|
appliedCoupon?: SubscriptionProvisionParams.AppliedCoupon;
|
|
2507
2633
|
/**
|
|
2508
|
-
* Whether to wait for payment confirmation before returning the
|
|
2634
|
+
* Body param: Whether to wait for payment confirmation before returning the
|
|
2635
|
+
* subscription
|
|
2509
2636
|
*/
|
|
2510
2637
|
awaitPaymentConfirmation?: boolean;
|
|
2511
2638
|
/**
|
|
2512
|
-
* The ISO 3166-1 alpha-2 country code for billing
|
|
2639
|
+
* Body param: The ISO 3166-1 alpha-2 country code for billing
|
|
2513
2640
|
*/
|
|
2514
2641
|
billingCountryCode?: string | null;
|
|
2515
2642
|
/**
|
|
2516
|
-
* Billing cycle anchor behavior for the subscription
|
|
2643
|
+
* Body param: Billing cycle anchor behavior for the subscription
|
|
2517
2644
|
*/
|
|
2518
2645
|
billingCycleAnchor?: 'UNCHANGED' | 'NOW';
|
|
2519
2646
|
/**
|
|
2520
|
-
* External billing system identifier
|
|
2647
|
+
* Body param: External billing system identifier
|
|
2521
2648
|
*/
|
|
2522
2649
|
billingId?: string | null;
|
|
2650
|
+
/**
|
|
2651
|
+
* Body param
|
|
2652
|
+
*/
|
|
2523
2653
|
billingInformation?: SubscriptionProvisionParams.BillingInformation;
|
|
2524
2654
|
/**
|
|
2525
|
-
* Billing period (MONTHLY or ANNUALLY)
|
|
2655
|
+
* Body param: Billing period (MONTHLY or ANNUALLY)
|
|
2526
2656
|
*/
|
|
2527
2657
|
billingPeriod?: 'MONTHLY' | 'ANNUALLY';
|
|
2658
|
+
/**
|
|
2659
|
+
* Body param
|
|
2660
|
+
*/
|
|
2528
2661
|
budget?: SubscriptionProvisionParams.Budget | null;
|
|
2529
2662
|
/**
|
|
2530
|
-
* Subscription cancellation date
|
|
2663
|
+
* Body param: Subscription cancellation date
|
|
2531
2664
|
*/
|
|
2532
2665
|
cancellationDate?: string;
|
|
2666
|
+
/**
|
|
2667
|
+
* Body param
|
|
2668
|
+
*/
|
|
2533
2669
|
charges?: Array<SubscriptionProvisionParams.Charge>;
|
|
2534
2670
|
/**
|
|
2535
|
-
* Checkout page configuration for payment collection
|
|
2671
|
+
* Body param: Checkout page configuration for payment collection
|
|
2536
2672
|
*/
|
|
2537
2673
|
checkoutOptions?: SubscriptionProvisionParams.CheckoutOptions;
|
|
2674
|
+
/**
|
|
2675
|
+
* Body param
|
|
2676
|
+
*/
|
|
2538
2677
|
entitlements?: Array<SubscriptionProvisionParams.Feature | SubscriptionProvisionParams.Credit>;
|
|
2539
2678
|
/**
|
|
2540
|
-
* Additional metadata for the subscription
|
|
2679
|
+
* Body param: Additional metadata for the subscription
|
|
2541
2680
|
*/
|
|
2542
2681
|
metadata?: {
|
|
2543
2682
|
[key: string]: string;
|
|
2544
2683
|
};
|
|
2545
2684
|
/**
|
|
2546
|
-
* Minimum spend amount
|
|
2685
|
+
* Body param: Minimum spend amount
|
|
2547
2686
|
*/
|
|
2548
2687
|
minimumSpend?: SubscriptionProvisionParams.MinimumSpend | null;
|
|
2549
2688
|
/**
|
|
2550
|
-
* Optional paying customer ID for split billing scenarios
|
|
2689
|
+
* Body param: Optional paying customer ID for split billing scenarios
|
|
2551
2690
|
*/
|
|
2552
2691
|
payingCustomerId?: string | null;
|
|
2553
2692
|
/**
|
|
2554
|
-
* How payments should be collected for this subscription
|
|
2693
|
+
* Body param: How payments should be collected for this subscription
|
|
2555
2694
|
*/
|
|
2556
2695
|
paymentCollectionMethod?: 'CHARGE' | 'INVOICE' | 'NONE';
|
|
2696
|
+
/**
|
|
2697
|
+
* Body param
|
|
2698
|
+
*/
|
|
2557
2699
|
priceOverrides?: Array<SubscriptionProvisionParams.PriceOverride>;
|
|
2558
2700
|
/**
|
|
2559
|
-
* Optional resource ID for multi-instance subscriptions
|
|
2701
|
+
* Body param: Optional resource ID for multi-instance subscriptions
|
|
2560
2702
|
*/
|
|
2561
2703
|
resourceId?: string | null;
|
|
2562
2704
|
/**
|
|
2563
|
-
* Salesforce ID
|
|
2705
|
+
* Body param: Salesforce ID
|
|
2564
2706
|
*/
|
|
2565
2707
|
salesforceId?: string | null;
|
|
2566
2708
|
/**
|
|
2567
|
-
* Strategy for scheduling subscription changes
|
|
2709
|
+
* Body param: Strategy for scheduling subscription changes
|
|
2568
2710
|
*/
|
|
2569
2711
|
scheduleStrategy?: 'END_OF_BILLING_PERIOD' | 'END_OF_BILLING_MONTH' | 'IMMEDIATE';
|
|
2570
2712
|
/**
|
|
2571
|
-
* Subscription start date
|
|
2713
|
+
* Body param: Subscription start date
|
|
2572
2714
|
*/
|
|
2573
2715
|
startDate?: string;
|
|
2574
2716
|
/**
|
|
2575
|
-
* Trial period override settings
|
|
2717
|
+
* Body param: Trial period override settings
|
|
2576
2718
|
*/
|
|
2577
2719
|
trialOverrideConfiguration?: SubscriptionProvisionParams.TrialOverrideConfiguration;
|
|
2578
2720
|
/**
|
|
2579
|
-
* Unit quantity for per-unit pricing. Minimum is 0 (zero is allowed).
|
|
2721
|
+
* Body param: Unit quantity for per-unit pricing. Minimum is 0 (zero is allowed).
|
|
2580
2722
|
*/
|
|
2581
2723
|
unitQuantity?: number;
|
|
2724
|
+
/**
|
|
2725
|
+
* Header param: Account ID — optional when authenticating with a user JWT (Bearer
|
|
2726
|
+
* token); falls back to the user's first membership. Ignored for API-key auth.
|
|
2727
|
+
*/
|
|
2728
|
+
'X-ACCOUNT-ID'?: string;
|
|
2729
|
+
/**
|
|
2730
|
+
* Header param: Environment ID — required when authenticating with a user JWT
|
|
2731
|
+
* (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is
|
|
2732
|
+
* intrinsic to the key).
|
|
2733
|
+
*/
|
|
2734
|
+
'X-ENVIRONMENT-ID'?: string;
|
|
2582
2735
|
}
|
|
2583
2736
|
export declare namespace SubscriptionProvisionParams {
|
|
2584
2737
|
/**
|
|
@@ -3020,14 +3173,25 @@ export declare namespace SubscriptionProvisionParams {
|
|
|
3020
3173
|
}
|
|
3021
3174
|
export interface SubscriptionTransferParams {
|
|
3022
3175
|
/**
|
|
3023
|
-
* Resource ID to transfer the subscription to
|
|
3176
|
+
* Body param: Resource ID to transfer the subscription to
|
|
3024
3177
|
*/
|
|
3025
3178
|
destinationResourceId: string;
|
|
3179
|
+
/**
|
|
3180
|
+
* Header param: Account ID — optional when authenticating with a user JWT (Bearer
|
|
3181
|
+
* token); falls back to the user's first membership. Ignored for API-key auth.
|
|
3182
|
+
*/
|
|
3183
|
+
'X-ACCOUNT-ID'?: string;
|
|
3184
|
+
/**
|
|
3185
|
+
* Header param: Environment ID — required when authenticating with a user JWT
|
|
3186
|
+
* (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is
|
|
3187
|
+
* intrinsic to the key).
|
|
3188
|
+
*/
|
|
3189
|
+
'X-ENVIRONMENT-ID'?: string;
|
|
3026
3190
|
}
|
|
3027
3191
|
export declare namespace Subscriptions {
|
|
3028
|
-
export { type Subscription as Subscription, type SubscriptionListResponse as SubscriptionListResponse, type SubscriptionImportResponse as SubscriptionImportResponse, type SubscriptionPreviewResponse as SubscriptionPreviewResponse, type SubscriptionProvisionResponse as SubscriptionProvisionResponse, type SubscriptionListResponsesMyCursorIDPage as SubscriptionListResponsesMyCursorIDPage, type SubscriptionUpdateParams as SubscriptionUpdateParams, type SubscriptionListParams as SubscriptionListParams, type SubscriptionCancelParams as SubscriptionCancelParams, type SubscriptionDelegateParams as SubscriptionDelegateParams, type SubscriptionImportParams as SubscriptionImportParams, type SubscriptionMigrateParams as SubscriptionMigrateParams, type SubscriptionPreviewParams as SubscriptionPreviewParams, type SubscriptionProvisionParams as SubscriptionProvisionParams, type SubscriptionTransferParams as SubscriptionTransferParams, };
|
|
3029
|
-
export { FutureUpdateAPIFutureUpdate as FutureUpdate, type CancelSubscription as CancelSubscription };
|
|
3030
|
-
export { Usage as Usage, type UsageChargeUsageResponse as UsageChargeUsageResponse, type UsageSyncResponse as UsageSyncResponse, type UsageChargeUsageParams as UsageChargeUsageParams, };
|
|
3031
|
-
export { Invoice as Invoice, type InvoiceMarkAsPaidResponse as InvoiceMarkAsPaidResponse };
|
|
3192
|
+
export { type Subscription as Subscription, type SubscriptionListResponse as SubscriptionListResponse, type SubscriptionImportResponse as SubscriptionImportResponse, type SubscriptionPreviewResponse as SubscriptionPreviewResponse, type SubscriptionProvisionResponse as SubscriptionProvisionResponse, type SubscriptionListResponsesMyCursorIDPage as SubscriptionListResponsesMyCursorIDPage, type SubscriptionRetrieveParams as SubscriptionRetrieveParams, type SubscriptionUpdateParams as SubscriptionUpdateParams, type SubscriptionListParams as SubscriptionListParams, type SubscriptionCancelParams as SubscriptionCancelParams, type SubscriptionDelegateParams as SubscriptionDelegateParams, type SubscriptionImportParams as SubscriptionImportParams, type SubscriptionMigrateParams as SubscriptionMigrateParams, type SubscriptionPreviewParams as SubscriptionPreviewParams, type SubscriptionProvisionParams as SubscriptionProvisionParams, type SubscriptionTransferParams as SubscriptionTransferParams, };
|
|
3193
|
+
export { FutureUpdateAPIFutureUpdate as FutureUpdate, type CancelSubscription as CancelSubscription, type FutureUpdateCancelPendingPaymentParams as FutureUpdateCancelPendingPaymentParams, type FutureUpdateCancelScheduleParams as FutureUpdateCancelScheduleParams, };
|
|
3194
|
+
export { Usage as Usage, type UsageChargeUsageResponse as UsageChargeUsageResponse, type UsageSyncResponse as UsageSyncResponse, type UsageChargeUsageParams as UsageChargeUsageParams, type UsageSyncParams as UsageSyncParams, };
|
|
3195
|
+
export { Invoice as Invoice, type InvoiceMarkAsPaidResponse as InvoiceMarkAsPaidResponse, type InvoiceMarkAsPaidParams as InvoiceMarkAsPaidParams, };
|
|
3032
3196
|
}
|
|
3033
3197
|
//# sourceMappingURL=subscriptions.d.ts.map
|