@stigg/typescript 0.1.0-alpha.8 → 0.1.0-beta.1
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 +417 -0
- package/client.d.mts +1 -1
- package/client.d.mts.map +1 -1
- package/client.d.ts +1 -1
- package/client.d.ts.map +1 -1
- package/client.js +19 -7
- package/client.js.map +1 -1
- package/client.mjs +19 -7
- package/client.mjs.map +1 -1
- package/internal/tslib.js +17 -17
- package/internal/types.d.mts +6 -6
- package/internal/types.d.mts.map +1 -1
- package/internal/types.d.ts +6 -6
- package/internal/types.d.ts.map +1 -1
- package/internal/utils/env.js +2 -2
- package/internal/utils/env.js.map +1 -1
- package/internal/utils/env.mjs +2 -2
- package/internal/utils/env.mjs.map +1 -1
- package/internal/utils/log.d.mts.map +1 -1
- package/internal/utils/log.d.ts.map +1 -1
- package/internal/utils/log.js +3 -2
- package/internal/utils/log.js.map +1 -1
- package/internal/utils/log.mjs +3 -2
- package/internal/utils/log.mjs.map +1 -1
- package/internal/utils/query.d.mts +2 -0
- package/internal/utils/query.d.mts.map +1 -0
- package/internal/utils/query.d.ts +2 -0
- package/internal/utils/query.d.ts.map +1 -0
- package/internal/utils/query.js +10 -0
- package/internal/utils/query.js.map +1 -0
- package/internal/utils/query.mjs +6 -0
- package/internal/utils/query.mjs.map +1 -0
- package/internal/utils.d.mts +1 -0
- package/internal/utils.d.ts +1 -0
- package/internal/utils.js +1 -0
- package/internal/utils.js.map +1 -1
- package/internal/utils.mjs +1 -0
- package/package.json +12 -1
- package/resources/v1/addons/addons.d.mts +828 -0
- package/resources/v1/addons/addons.d.mts.map +1 -0
- package/resources/v1/addons/addons.d.ts +828 -0
- package/resources/v1/addons/addons.d.ts.map +1 -0
- package/resources/v1/{events/addons → addons}/addons.js +41 -26
- package/resources/v1/addons/addons.js.map +1 -0
- package/resources/v1/{events/addons → addons}/addons.mjs +40 -25
- package/resources/v1/addons/addons.mjs.map +1 -0
- package/resources/v1/addons/entitlements.d.mts +888 -0
- package/resources/v1/addons/entitlements.d.mts.map +1 -0
- package/resources/v1/addons/entitlements.d.ts +888 -0
- package/resources/v1/addons/entitlements.d.ts.map +1 -0
- package/resources/v1/addons/entitlements.js +36 -0
- package/resources/v1/addons/entitlements.js.map +1 -0
- package/resources/v1/addons/entitlements.mjs +32 -0
- package/resources/v1/addons/entitlements.mjs.map +1 -0
- package/resources/v1/addons/index.d.mts +3 -0
- package/resources/v1/addons/index.d.mts.map +1 -0
- package/resources/v1/addons/index.d.ts +3 -0
- package/resources/v1/addons/index.d.ts.map +1 -0
- package/resources/v1/{events/addons → addons}/index.js +3 -3
- package/resources/v1/addons/index.js.map +1 -0
- package/resources/v1/{events/addons → addons}/index.mjs +1 -1
- package/resources/v1/addons/index.mjs.map +1 -0
- package/resources/v1/addons.d.mts.map +1 -0
- package/resources/v1/addons.d.ts.map +1 -0
- package/resources/v1/{events/addons.js → addons.js} +1 -1
- package/resources/v1/addons.js.map +1 -0
- package/resources/v1/addons.mjs.map +1 -0
- package/resources/v1/coupons.d.mts +19 -4
- package/resources/v1/coupons.d.mts.map +1 -1
- package/resources/v1/coupons.d.ts +19 -4
- package/resources/v1/coupons.d.ts.map +1 -1
- package/resources/v1/coupons.js +3 -0
- package/resources/v1/coupons.js.map +1 -1
- package/resources/v1/coupons.mjs +3 -0
- package/resources/v1/coupons.mjs.map +1 -1
- package/resources/v1/customers/customers.d.mts +1204 -6
- package/resources/v1/customers/customers.d.mts.map +1 -1
- package/resources/v1/customers/customers.d.ts +1204 -6
- package/resources/v1/customers/customers.d.ts.map +1 -1
- package/resources/v1/customers/customers.js +30 -1
- package/resources/v1/customers/customers.js.map +1 -1
- package/resources/v1/customers/customers.mjs +30 -1
- package/resources/v1/customers/customers.mjs.map +1 -1
- package/resources/v1/customers/index.d.mts +2 -1
- package/resources/v1/customers/index.d.mts.map +1 -1
- package/resources/v1/customers/index.d.ts +2 -1
- package/resources/v1/customers/index.d.ts.map +1 -1
- package/resources/v1/customers/index.js +3 -1
- package/resources/v1/customers/index.js.map +1 -1
- package/resources/v1/customers/index.mjs +1 -0
- package/resources/v1/customers/index.mjs.map +1 -1
- package/resources/v1/customers/integrations.d.mts +142 -0
- package/resources/v1/customers/integrations.d.mts.map +1 -0
- package/resources/v1/customers/integrations.d.ts +142 -0
- package/resources/v1/customers/integrations.d.ts.map +1 -0
- package/resources/v1/customers/integrations.js +50 -0
- package/resources/v1/customers/integrations.js.map +1 -0
- package/resources/v1/customers/integrations.mjs +46 -0
- package/resources/v1/customers/integrations.mjs.map +1 -0
- package/resources/v1/customers/payment-method.d.mts +3 -0
- package/resources/v1/customers/payment-method.d.mts.map +1 -1
- package/resources/v1/customers/payment-method.d.ts +3 -0
- package/resources/v1/customers/payment-method.d.ts.map +1 -1
- package/resources/v1/customers/payment-method.js +3 -0
- package/resources/v1/customers/payment-method.js.map +1 -1
- package/resources/v1/customers/payment-method.mjs +3 -0
- package/resources/v1/customers/payment-method.mjs.map +1 -1
- package/resources/v1/customers/promotional-entitlements.d.mts +4 -1
- package/resources/v1/customers/promotional-entitlements.d.mts.map +1 -1
- package/resources/v1/customers/promotional-entitlements.d.ts +4 -1
- package/resources/v1/customers/promotional-entitlements.d.ts.map +1 -1
- package/resources/v1/customers/promotional-entitlements.js +3 -0
- package/resources/v1/customers/promotional-entitlements.js.map +1 -1
- package/resources/v1/customers/promotional-entitlements.mjs +3 -0
- package/resources/v1/customers/promotional-entitlements.mjs.map +1 -1
- package/resources/v1/events/credits/credits.d.mts +274 -0
- package/resources/v1/events/credits/credits.d.mts.map +1 -0
- package/resources/v1/events/credits/credits.d.ts +274 -0
- package/resources/v1/events/credits/credits.d.ts.map +1 -0
- package/resources/v1/events/credits/credits.js +45 -0
- package/resources/v1/events/credits/credits.js.map +1 -0
- package/resources/v1/events/credits/credits.mjs +40 -0
- package/resources/v1/events/credits/credits.mjs.map +1 -0
- package/resources/v1/events/credits/custom-currencies.d.mts +497 -0
- package/resources/v1/events/credits/custom-currencies.d.mts.map +1 -0
- package/resources/v1/events/credits/custom-currencies.d.ts +497 -0
- package/resources/v1/events/credits/custom-currencies.d.ts.map +1 -0
- package/resources/v1/events/credits/custom-currencies.js +56 -0
- package/resources/v1/events/credits/custom-currencies.js.map +1 -0
- package/resources/v1/events/credits/custom-currencies.mjs +52 -0
- package/resources/v1/events/credits/custom-currencies.mjs.map +1 -0
- package/resources/v1/events/credits/grants.d.mts +549 -0
- package/resources/v1/events/credits/grants.d.mts.map +1 -0
- package/resources/v1/events/credits/grants.d.ts +549 -0
- package/resources/v1/events/credits/grants.d.ts.map +1 -0
- package/resources/v1/events/credits/grants.js +37 -0
- package/resources/v1/events/credits/grants.js.map +1 -0
- package/resources/v1/events/credits/grants.mjs +33 -0
- package/resources/v1/events/credits/grants.mjs.map +1 -0
- package/resources/v1/events/credits/index.d.mts +4 -0
- package/resources/v1/events/credits/index.d.mts.map +1 -0
- package/resources/v1/events/credits/index.d.ts +4 -0
- package/resources/v1/events/credits/index.d.ts.map +1 -0
- package/resources/v1/events/credits/index.js +11 -0
- package/resources/v1/events/credits/index.js.map +1 -0
- package/resources/v1/events/credits/index.mjs +5 -0
- package/resources/v1/events/credits/index.mjs.map +1 -0
- package/resources/v1/events/credits.d.mts +2 -0
- package/resources/v1/events/credits.d.mts.map +1 -0
- package/resources/v1/events/credits.d.ts +2 -0
- package/resources/v1/events/credits.d.ts.map +1 -0
- package/resources/v1/events/credits.js +6 -0
- package/resources/v1/events/credits.js.map +1 -0
- package/resources/v1/events/credits.mjs +3 -0
- package/resources/v1/events/credits.mjs.map +1 -0
- package/resources/v1/events/events.d.mts +7 -12
- package/resources/v1/events/events.d.mts.map +1 -1
- package/resources/v1/events/events.d.ts +7 -12
- package/resources/v1/events/events.d.ts.map +1 -1
- package/resources/v1/events/events.js +7 -12
- package/resources/v1/events/events.js.map +1 -1
- package/resources/v1/events/events.mjs +7 -12
- package/resources/v1/events/events.mjs.map +1 -1
- package/resources/v1/events/index.d.mts +1 -3
- package/resources/v1/events/index.d.mts.map +1 -1
- package/resources/v1/events/index.d.ts +1 -3
- package/resources/v1/events/index.d.ts.map +1 -1
- package/resources/v1/events/index.js +3 -7
- package/resources/v1/events/index.js.map +1 -1
- package/resources/v1/events/index.mjs +1 -3
- package/resources/v1/events/index.mjs.map +1 -1
- package/resources/v1/features.d.mts +456 -0
- package/resources/v1/features.d.mts.map +1 -0
- package/resources/v1/features.d.ts +456 -0
- package/resources/v1/features.d.ts.map +1 -0
- package/resources/v1/{events/features.js → features.js} +6 -3
- package/resources/v1/features.js.map +1 -0
- package/resources/v1/{events/features.mjs → features.mjs} +6 -3
- package/resources/v1/features.mjs.map +1 -0
- package/resources/v1/index.d.mts +5 -2
- package/resources/v1/index.d.mts.map +1 -1
- package/resources/v1/index.d.ts +5 -2
- package/resources/v1/index.d.ts.map +1 -1
- package/resources/v1/index.js +13 -7
- package/resources/v1/index.js.map +1 -1
- package/resources/v1/index.mjs +3 -0
- package/resources/v1/index.mjs.map +1 -1
- package/resources/v1/plans/entitlements.d.mts +888 -0
- package/resources/v1/plans/entitlements.d.mts.map +1 -0
- package/resources/v1/plans/entitlements.d.ts +888 -0
- package/resources/v1/plans/entitlements.d.ts.map +1 -0
- package/resources/v1/plans/entitlements.js +36 -0
- package/resources/v1/plans/entitlements.js.map +1 -0
- package/resources/v1/plans/entitlements.mjs +32 -0
- package/resources/v1/plans/entitlements.mjs.map +1 -0
- package/resources/v1/plans/index.d.mts +3 -0
- package/resources/v1/plans/index.d.mts.map +1 -0
- package/resources/v1/plans/index.d.ts +3 -0
- package/resources/v1/plans/index.d.ts.map +1 -0
- package/resources/v1/plans/index.js +9 -0
- package/resources/v1/plans/index.js.map +1 -0
- package/resources/v1/plans/index.mjs +4 -0
- package/resources/v1/plans/index.mjs.map +1 -0
- package/resources/v1/plans/plans.d.mts +977 -0
- package/resources/v1/plans/plans.d.mts.map +1 -0
- package/resources/v1/plans/plans.d.ts +977 -0
- package/resources/v1/plans/plans.d.ts.map +1 -0
- package/resources/v1/plans/plans.js +72 -0
- package/resources/v1/plans/plans.js.map +1 -0
- package/resources/v1/plans/plans.mjs +67 -0
- package/resources/v1/plans/plans.mjs.map +1 -0
- package/resources/v1/plans.d.mts +2 -0
- package/resources/v1/plans.d.mts.map +1 -0
- package/resources/v1/plans.d.ts +2 -0
- package/resources/v1/plans.d.ts.map +1 -0
- package/resources/v1/plans.js +6 -0
- package/resources/v1/plans.js.map +1 -0
- package/resources/v1/plans.mjs +3 -0
- package/resources/v1/plans.mjs.map +1 -0
- package/resources/v1/products.d.mts +25 -358
- package/resources/v1/products.d.mts.map +1 -1
- package/resources/v1/products.d.ts +25 -358
- package/resources/v1/products.d.ts.map +1 -1
- package/resources/v1/products.js +3 -0
- package/resources/v1/products.js.map +1 -1
- package/resources/v1/products.mjs +3 -0
- package/resources/v1/products.mjs.map +1 -1
- package/resources/v1/subscriptions/future-update.d.mts +3 -0
- package/resources/v1/subscriptions/future-update.d.mts.map +1 -1
- package/resources/v1/subscriptions/future-update.d.ts +3 -0
- package/resources/v1/subscriptions/future-update.d.ts.map +1 -1
- package/resources/v1/subscriptions/future-update.js +3 -0
- package/resources/v1/subscriptions/future-update.js.map +1 -1
- package/resources/v1/subscriptions/future-update.mjs +3 -0
- package/resources/v1/subscriptions/future-update.mjs.map +1 -1
- package/resources/v1/subscriptions/invoice.d.mts +3 -0
- package/resources/v1/subscriptions/invoice.d.mts.map +1 -1
- package/resources/v1/subscriptions/invoice.d.ts +3 -0
- package/resources/v1/subscriptions/invoice.d.ts.map +1 -1
- package/resources/v1/subscriptions/invoice.js +3 -0
- package/resources/v1/subscriptions/invoice.js.map +1 -1
- package/resources/v1/subscriptions/invoice.mjs +3 -0
- package/resources/v1/subscriptions/invoice.mjs.map +1 -1
- package/resources/v1/subscriptions/subscriptions.d.mts +1131 -166
- package/resources/v1/subscriptions/subscriptions.d.mts.map +1 -1
- package/resources/v1/subscriptions/subscriptions.d.ts +1131 -166
- package/resources/v1/subscriptions/subscriptions.d.ts.map +1 -1
- package/resources/v1/subscriptions/subscriptions.js.map +1 -1
- package/resources/v1/subscriptions/subscriptions.mjs +2 -2
- package/resources/v1/subscriptions/subscriptions.mjs.map +1 -1
- package/resources/v1/subscriptions/usage.d.mts +3 -0
- package/resources/v1/subscriptions/usage.d.mts.map +1 -1
- package/resources/v1/subscriptions/usage.d.ts +3 -0
- package/resources/v1/subscriptions/usage.d.ts.map +1 -1
- package/resources/v1/subscriptions/usage.js +3 -0
- package/resources/v1/subscriptions/usage.js.map +1 -1
- package/resources/v1/subscriptions/usage.mjs +3 -0
- package/resources/v1/subscriptions/usage.mjs.map +1 -1
- package/resources/v1/usage.d.mts +4 -1
- package/resources/v1/usage.d.mts.map +1 -1
- package/resources/v1/usage.d.ts +4 -1
- package/resources/v1/usage.d.ts.map +1 -1
- package/resources/v1/usage.js +3 -0
- package/resources/v1/usage.js.map +1 -1
- package/resources/v1/usage.mjs +3 -0
- package/resources/v1/usage.mjs.map +1 -1
- package/resources/v1/v1.d.mts +16 -4
- package/resources/v1/v1.d.mts.map +1 -1
- package/resources/v1/v1.d.ts +16 -4
- package/resources/v1/v1.d.ts.map +1 -1
- package/resources/v1/v1.js +12 -0
- package/resources/v1/v1.js.map +1 -1
- package/resources/v1/v1.mjs +12 -0
- package/resources/v1/v1.mjs.map +1 -1
- package/src/client.ts +23 -10
- package/src/internal/types.ts +6 -8
- package/src/internal/utils/env.ts +2 -2
- package/src/internal/utils/log.ts +2 -1
- package/src/internal/utils/query.ts +7 -0
- package/src/internal/utils.ts +1 -0
- package/src/resources/v1/addons/addons.ts +1856 -0
- package/src/resources/v1/addons/entitlements.ts +1153 -0
- package/src/resources/v1/addons/index.ts +23 -0
- package/src/resources/v1/coupons.ts +17 -4
- package/src/resources/v1/customers/customers.ts +2526 -69
- package/src/resources/v1/customers/index.ts +15 -0
- package/src/resources/v1/customers/integrations.ts +252 -0
- package/src/resources/v1/customers/payment-method.ts +3 -0
- package/src/resources/v1/customers/promotional-entitlements.ts +4 -1
- package/src/resources/v1/events/credits/credits.ts +402 -0
- package/src/resources/v1/events/credits/custom-currencies.ts +615 -0
- package/src/resources/v1/events/credits/grants.ts +795 -0
- package/src/resources/v1/events/credits/index.ts +33 -0
- package/src/resources/v1/events/credits.ts +3 -0
- package/src/resources/v1/events/events.ts +23 -80
- package/src/resources/v1/events/index.ts +9 -35
- package/src/resources/v1/{events/features.ts → features.ts} +29 -512
- package/src/resources/v1/index.ts +39 -5
- package/src/resources/v1/plans/entitlements.ts +1145 -0
- package/src/resources/v1/plans/index.ts +23 -0
- package/src/resources/v1/plans/plans.ts +2029 -0
- package/src/resources/v1/plans.ts +3 -0
- package/src/resources/v1/products.ts +26 -425
- package/src/resources/v1/subscriptions/future-update.ts +3 -0
- package/src/resources/v1/subscriptions/invoice.ts +3 -0
- package/src/resources/v1/subscriptions/subscriptions.ts +3901 -1324
- package/src/resources/v1/subscriptions/usage.ts +3 -0
- package/src/resources/v1/usage.ts +4 -1
- package/src/resources/v1/v1.ts +90 -10
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.mts.map +1 -1
- package/version.d.ts +1 -1
- package/version.d.ts.map +1 -1
- package/version.js +1 -1
- package/version.js.map +1 -1
- package/version.mjs +1 -1
- package/version.mjs.map +1 -1
- package/resources/v1/events/addons/addons.d.mts +0 -605
- package/resources/v1/events/addons/addons.d.mts.map +0 -1
- package/resources/v1/events/addons/addons.d.ts +0 -605
- package/resources/v1/events/addons/addons.d.ts.map +0 -1
- package/resources/v1/events/addons/addons.js.map +0 -1
- package/resources/v1/events/addons/addons.mjs.map +0 -1
- package/resources/v1/events/addons/draft.d.mts +0 -121
- package/resources/v1/events/addons/draft.d.mts.map +0 -1
- package/resources/v1/events/addons/draft.d.ts +0 -121
- package/resources/v1/events/addons/draft.d.ts.map +0 -1
- package/resources/v1/events/addons/draft.js +0 -22
- package/resources/v1/events/addons/draft.js.map +0 -1
- package/resources/v1/events/addons/draft.mjs +0 -18
- package/resources/v1/events/addons/draft.mjs.map +0 -1
- package/resources/v1/events/addons/index.d.mts +0 -3
- package/resources/v1/events/addons/index.d.mts.map +0 -1
- package/resources/v1/events/addons/index.d.ts +0 -3
- package/resources/v1/events/addons/index.d.ts.map +0 -1
- package/resources/v1/events/addons/index.js.map +0 -1
- package/resources/v1/events/addons/index.mjs.map +0 -1
- package/resources/v1/events/addons.d.mts.map +0 -1
- package/resources/v1/events/addons.d.ts.map +0 -1
- package/resources/v1/events/addons.js.map +0 -1
- package/resources/v1/events/addons.mjs.map +0 -1
- package/resources/v1/events/features.d.mts +0 -856
- package/resources/v1/events/features.d.mts.map +0 -1
- package/resources/v1/events/features.d.ts +0 -856
- package/resources/v1/events/features.d.ts.map +0 -1
- package/resources/v1/events/features.js.map +0 -1
- package/resources/v1/events/features.mjs.map +0 -1
- package/resources/v1/events/plans.d.mts +0 -348
- package/resources/v1/events/plans.d.mts.map +0 -1
- package/resources/v1/events/plans.d.ts +0 -348
- package/resources/v1/events/plans.d.ts.map +0 -1
- package/resources/v1/events/plans.js +0 -30
- package/resources/v1/events/plans.js.map +0 -1
- package/resources/v1/events/plans.mjs +0 -26
- package/resources/v1/events/plans.mjs.map +0 -1
- package/src/resources/v1/events/addons/addons.ts +0 -761
- package/src/resources/v1/events/addons/draft.ts +0 -151
- package/src/resources/v1/events/addons/index.ts +0 -17
- package/src/resources/v1/events/plans.ts +0 -429
- /package/resources/v1/{events/addons.d.mts → addons.d.mts} +0 -0
- /package/resources/v1/{events/addons.d.ts → addons.d.ts} +0 -0
- /package/resources/v1/{events/addons.mjs → addons.mjs} +0 -0
- /package/src/resources/v1/{events/addons.ts → addons.ts} +0 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { APIResource } from "../../../core/resource.mjs";
|
|
2
2
|
import * as FutureUpdateAPI from "./future-update.mjs";
|
|
3
|
-
import { CancelSubscription, FutureUpdate } from "./future-update.mjs";
|
|
3
|
+
import { CancelSubscription, FutureUpdate as FutureUpdateAPIFutureUpdate } from "./future-update.mjs";
|
|
4
4
|
import * as InvoiceAPI from "./invoice.mjs";
|
|
5
5
|
import { Invoice, InvoiceMarkAsPaidResponse } from "./invoice.mjs";
|
|
6
6
|
import * as UsageAPI from "./usage.mjs";
|
|
@@ -114,6 +114,15 @@ export declare namespace Subscription {
|
|
|
114
114
|
* Subscription status
|
|
115
115
|
*/
|
|
116
116
|
status: 'PAYMENT_PENDING' | 'ACTIVE' | 'EXPIRED' | 'IN_TRIAL' | 'CANCELED' | 'NOT_STARTED';
|
|
117
|
+
addons?: Array<Data.Addon>;
|
|
118
|
+
/**
|
|
119
|
+
* Billing cycle anchor date
|
|
120
|
+
*/
|
|
121
|
+
billingCycleAnchor?: string | null;
|
|
122
|
+
/**
|
|
123
|
+
* Budget configuration
|
|
124
|
+
*/
|
|
125
|
+
budget?: Data.Budget | null;
|
|
117
126
|
/**
|
|
118
127
|
* Subscription cancellation date
|
|
119
128
|
*/
|
|
@@ -122,6 +131,10 @@ export declare namespace Subscription {
|
|
|
122
131
|
* Subscription cancel reason
|
|
123
132
|
*/
|
|
124
133
|
cancelReason?: 'UPGRADE_OR_DOWNGRADE' | 'CANCELLED_BY_BILLING' | 'EXPIRED' | 'DETACH_BILLING' | 'TRIAL_ENDED' | 'Immediate' | 'TRIAL_CONVERTED' | 'PENDING_PAYMENT_EXPIRED' | 'ScheduledCancellation' | 'CustomerArchived' | 'AutoCancellationRule' | null;
|
|
134
|
+
/**
|
|
135
|
+
* Coupons applied to the subscription
|
|
136
|
+
*/
|
|
137
|
+
coupons?: Array<Data.Coupon>;
|
|
125
138
|
/**
|
|
126
139
|
* End of the current billing period
|
|
127
140
|
*/
|
|
@@ -138,12 +151,24 @@ export declare namespace Subscription {
|
|
|
138
151
|
* Subscription end date
|
|
139
152
|
*/
|
|
140
153
|
endDate?: string | null;
|
|
154
|
+
/**
|
|
155
|
+
* Scheduled future updates for the subscription
|
|
156
|
+
*/
|
|
157
|
+
futureUpdates?: Array<Data.FutureUpdate>;
|
|
158
|
+
/**
|
|
159
|
+
* Latest invoice for the subscription
|
|
160
|
+
*/
|
|
161
|
+
latestInvoice?: Data.LatestInvoice | null;
|
|
141
162
|
/**
|
|
142
163
|
* Additional metadata for the subscription
|
|
143
164
|
*/
|
|
144
165
|
metadata?: {
|
|
145
166
|
[key: string]: string;
|
|
146
167
|
};
|
|
168
|
+
/**
|
|
169
|
+
* Minimum spend configuration
|
|
170
|
+
*/
|
|
171
|
+
minimumSpend?: Data.MinimumSpend | null;
|
|
147
172
|
/**
|
|
148
173
|
* Paying customer ID for delegated billing
|
|
149
174
|
*/
|
|
@@ -157,26 +182,268 @@ export declare namespace Subscription {
|
|
|
157
182
|
* Resource ID
|
|
158
183
|
*/
|
|
159
184
|
resourceId?: string | null;
|
|
185
|
+
/**
|
|
186
|
+
* Entitlements associated with the subscription
|
|
187
|
+
*/
|
|
188
|
+
subscriptionEntitlements?: Array<Data.SubscriptionEntitlement>;
|
|
189
|
+
/**
|
|
190
|
+
* Trial configuration
|
|
191
|
+
*/
|
|
192
|
+
trial?: Data.Trial | null;
|
|
160
193
|
/**
|
|
161
194
|
* Subscription trial end date
|
|
162
195
|
*/
|
|
163
196
|
trialEndDate?: string | null;
|
|
164
197
|
}
|
|
165
198
|
namespace Data {
|
|
166
|
-
|
|
199
|
+
/**
|
|
200
|
+
* Addon configuration
|
|
201
|
+
*/
|
|
202
|
+
interface Addon {
|
|
167
203
|
/**
|
|
168
|
-
*
|
|
204
|
+
* Addon ID
|
|
205
|
+
*/
|
|
206
|
+
id: string;
|
|
207
|
+
/**
|
|
208
|
+
* Number of addon instances
|
|
209
|
+
*/
|
|
210
|
+
quantity: number;
|
|
211
|
+
}
|
|
212
|
+
/**
|
|
213
|
+
* Budget configuration
|
|
214
|
+
*/
|
|
215
|
+
interface Budget {
|
|
216
|
+
/**
|
|
217
|
+
* Whether the budget is a soft limit
|
|
218
|
+
*/
|
|
219
|
+
hasSoftLimit: boolean;
|
|
220
|
+
/**
|
|
221
|
+
* Maximum spending limit
|
|
222
|
+
*/
|
|
223
|
+
limit: number;
|
|
224
|
+
}
|
|
225
|
+
/**
|
|
226
|
+
* Coupon applied to a subscription
|
|
227
|
+
*/
|
|
228
|
+
interface Coupon {
|
|
229
|
+
/**
|
|
230
|
+
* Coupon ID
|
|
169
231
|
*/
|
|
170
232
|
id: string;
|
|
171
233
|
/**
|
|
172
|
-
*
|
|
234
|
+
* Coupon name
|
|
235
|
+
*/
|
|
236
|
+
name: string;
|
|
237
|
+
/**
|
|
238
|
+
* Coupon status
|
|
239
|
+
*/
|
|
240
|
+
status: 'ACTIVE' | 'EXPIRED' | 'REMOVED';
|
|
241
|
+
/**
|
|
242
|
+
* Fixed amount discounts by currency
|
|
243
|
+
*/
|
|
244
|
+
amountsOff?: Array<Coupon.AmountsOff> | null;
|
|
245
|
+
/**
|
|
246
|
+
* Percentage discount
|
|
247
|
+
*/
|
|
248
|
+
percentOff?: number | null;
|
|
249
|
+
}
|
|
250
|
+
namespace Coupon {
|
|
251
|
+
interface AmountsOff {
|
|
252
|
+
/**
|
|
253
|
+
* The price amount
|
|
254
|
+
*/
|
|
255
|
+
amount?: number;
|
|
256
|
+
/**
|
|
257
|
+
* The price currency
|
|
258
|
+
*/
|
|
259
|
+
currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
|
|
260
|
+
}
|
|
261
|
+
}
|
|
262
|
+
/**
|
|
263
|
+
* Scheduled subscription update
|
|
264
|
+
*/
|
|
265
|
+
interface FutureUpdate {
|
|
266
|
+
/**
|
|
267
|
+
* Scheduled execution time
|
|
268
|
+
*/
|
|
269
|
+
scheduledExecutionTime: string;
|
|
270
|
+
/**
|
|
271
|
+
* Status of the scheduled update
|
|
272
|
+
*/
|
|
273
|
+
scheduleStatus: 'PENDING_PAYMENT' | 'SCHEDULED' | 'CANCELED' | 'DONE' | 'FAILED';
|
|
274
|
+
/**
|
|
275
|
+
* Type of scheduled change
|
|
276
|
+
*/
|
|
277
|
+
subscriptionScheduleType: 'DOWNGRADE' | 'PLAN' | 'BILLING_PERIOD' | 'UNIT_AMOUNT' | 'RECURRING_CREDITS' | 'PRICE_OVERRIDE' | 'ADDON' | 'COUPON' | 'MIGRATE_TO_LATEST' | 'ADDITIONAL_META_DATA' | 'BILLING_INFO_METADATA';
|
|
278
|
+
/**
|
|
279
|
+
* Target package for the update
|
|
280
|
+
*/
|
|
281
|
+
targetPackage?: FutureUpdate.TargetPackage | null;
|
|
282
|
+
}
|
|
283
|
+
namespace FutureUpdate {
|
|
284
|
+
/**
|
|
285
|
+
* Target package for the update
|
|
286
|
+
*/
|
|
287
|
+
interface TargetPackage {
|
|
288
|
+
/**
|
|
289
|
+
* Target package for the update
|
|
290
|
+
*/
|
|
291
|
+
id: string;
|
|
292
|
+
}
|
|
293
|
+
}
|
|
294
|
+
/**
|
|
295
|
+
* Latest invoice for the subscription
|
|
296
|
+
*/
|
|
297
|
+
interface LatestInvoice {
|
|
298
|
+
/**
|
|
299
|
+
* Invoice billing ID
|
|
300
|
+
*/
|
|
301
|
+
billingId: string;
|
|
302
|
+
/**
|
|
303
|
+
* Invoice creation date
|
|
173
304
|
*/
|
|
174
305
|
createdAt: string;
|
|
175
306
|
/**
|
|
176
|
-
*
|
|
307
|
+
* Whether payment requires action
|
|
177
308
|
*/
|
|
178
|
-
|
|
179
|
-
|
|
309
|
+
requiresAction: boolean;
|
|
310
|
+
/**
|
|
311
|
+
* Invoice status
|
|
312
|
+
*/
|
|
313
|
+
status: 'OPEN' | 'CANCELED' | 'PAID';
|
|
314
|
+
/**
|
|
315
|
+
* Amount due
|
|
316
|
+
*/
|
|
317
|
+
amountDue?: number | null;
|
|
318
|
+
/**
|
|
319
|
+
* Billing reason
|
|
320
|
+
*/
|
|
321
|
+
billingReason?: 'BILLING_CYCLE' | 'SUBSCRIPTION_CREATION' | 'SUBSCRIPTION_UPDATE' | 'MANUAL' | 'MINIMUM_INVOICE_AMOUNT_EXCEEDED' | 'OTHER' | null;
|
|
322
|
+
/**
|
|
323
|
+
* Invoice currency
|
|
324
|
+
*/
|
|
325
|
+
currency?: string | null;
|
|
326
|
+
/**
|
|
327
|
+
* Invoice PDF URL
|
|
328
|
+
*/
|
|
329
|
+
pdfUrl?: string | null;
|
|
330
|
+
/**
|
|
331
|
+
* Total amount
|
|
332
|
+
*/
|
|
333
|
+
total?: number | null;
|
|
334
|
+
}
|
|
335
|
+
/**
|
|
336
|
+
* Minimum spend configuration
|
|
337
|
+
*/
|
|
338
|
+
interface MinimumSpend {
|
|
339
|
+
/**
|
|
340
|
+
* The price amount
|
|
341
|
+
*/
|
|
342
|
+
amount?: number;
|
|
343
|
+
/**
|
|
344
|
+
* The price currency
|
|
345
|
+
*/
|
|
346
|
+
currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
|
|
347
|
+
}
|
|
348
|
+
interface Price {
|
|
349
|
+
/**
|
|
350
|
+
* Addon identifier for the price override
|
|
351
|
+
*/
|
|
352
|
+
addonId?: string | null;
|
|
353
|
+
/**
|
|
354
|
+
* The price amount
|
|
355
|
+
*/
|
|
356
|
+
amount?: number;
|
|
357
|
+
/**
|
|
358
|
+
* Whether this is a base charge override
|
|
359
|
+
*/
|
|
360
|
+
baseCharge?: boolean;
|
|
361
|
+
/**
|
|
362
|
+
* The billing country code of the price
|
|
363
|
+
*/
|
|
364
|
+
billingCountryCode?: string;
|
|
365
|
+
/**
|
|
366
|
+
* Block size for pricing
|
|
367
|
+
*/
|
|
368
|
+
blockSize?: number;
|
|
369
|
+
/**
|
|
370
|
+
* The price currency
|
|
371
|
+
*/
|
|
372
|
+
currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
|
|
373
|
+
/**
|
|
374
|
+
* Feature identifier for the price override
|
|
375
|
+
*/
|
|
376
|
+
featureId?: string | null;
|
|
377
|
+
/**
|
|
378
|
+
* Pricing tiers configuration
|
|
379
|
+
*/
|
|
380
|
+
tiers?: Array<Price.Tier>;
|
|
381
|
+
}
|
|
382
|
+
namespace Price {
|
|
383
|
+
interface Tier {
|
|
384
|
+
/**
|
|
385
|
+
* The flat fee price of the price tier
|
|
386
|
+
*/
|
|
387
|
+
flatPrice?: Tier.FlatPrice;
|
|
388
|
+
/**
|
|
389
|
+
* The unit price of the price tier
|
|
390
|
+
*/
|
|
391
|
+
unitPrice?: Tier.UnitPrice;
|
|
392
|
+
/**
|
|
393
|
+
* The up to quantity of the price tier
|
|
394
|
+
*/
|
|
395
|
+
upTo?: number;
|
|
396
|
+
}
|
|
397
|
+
namespace Tier {
|
|
398
|
+
/**
|
|
399
|
+
* The flat fee price of the price tier
|
|
400
|
+
*/
|
|
401
|
+
interface FlatPrice {
|
|
402
|
+
/**
|
|
403
|
+
* The price amount
|
|
404
|
+
*/
|
|
405
|
+
amount: number;
|
|
406
|
+
/**
|
|
407
|
+
* ISO 4217 currency code
|
|
408
|
+
*/
|
|
409
|
+
currency: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
|
|
410
|
+
}
|
|
411
|
+
/**
|
|
412
|
+
* The unit price of the price tier
|
|
413
|
+
*/
|
|
414
|
+
interface UnitPrice {
|
|
415
|
+
/**
|
|
416
|
+
* The price amount
|
|
417
|
+
*/
|
|
418
|
+
amount: number;
|
|
419
|
+
/**
|
|
420
|
+
* ISO 4217 currency code
|
|
421
|
+
*/
|
|
422
|
+
currency: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
|
|
423
|
+
}
|
|
424
|
+
}
|
|
425
|
+
}
|
|
426
|
+
/**
|
|
427
|
+
* Subscription entitlement reference
|
|
428
|
+
*/
|
|
429
|
+
interface SubscriptionEntitlement {
|
|
430
|
+
/**
|
|
431
|
+
* Feature ID or currency ID
|
|
432
|
+
*/
|
|
433
|
+
id: string;
|
|
434
|
+
/**
|
|
435
|
+
* Entitlement type (FEATURE or CREDIT)
|
|
436
|
+
*/
|
|
437
|
+
type: 'FEATURE' | 'CREDIT';
|
|
438
|
+
}
|
|
439
|
+
/**
|
|
440
|
+
* Trial configuration
|
|
441
|
+
*/
|
|
442
|
+
interface Trial {
|
|
443
|
+
/**
|
|
444
|
+
* Behavior when the trial ends
|
|
445
|
+
*/
|
|
446
|
+
trialEndBehavior: 'CONVERT_TO_PAID' | 'CANCEL_SUBSCRIPTION';
|
|
180
447
|
}
|
|
181
448
|
}
|
|
182
449
|
}
|
|
@@ -220,6 +487,15 @@ export interface SubscriptionListResponse {
|
|
|
220
487
|
* Subscription status
|
|
221
488
|
*/
|
|
222
489
|
status: 'PAYMENT_PENDING' | 'ACTIVE' | 'EXPIRED' | 'IN_TRIAL' | 'CANCELED' | 'NOT_STARTED';
|
|
490
|
+
addons?: Array<SubscriptionListResponse.Addon>;
|
|
491
|
+
/**
|
|
492
|
+
* Billing cycle anchor date
|
|
493
|
+
*/
|
|
494
|
+
billingCycleAnchor?: string | null;
|
|
495
|
+
/**
|
|
496
|
+
* Budget configuration
|
|
497
|
+
*/
|
|
498
|
+
budget?: SubscriptionListResponse.Budget | null;
|
|
223
499
|
/**
|
|
224
500
|
* Subscription cancellation date
|
|
225
501
|
*/
|
|
@@ -228,6 +504,10 @@ export interface SubscriptionListResponse {
|
|
|
228
504
|
* Subscription cancel reason
|
|
229
505
|
*/
|
|
230
506
|
cancelReason?: 'UPGRADE_OR_DOWNGRADE' | 'CANCELLED_BY_BILLING' | 'EXPIRED' | 'DETACH_BILLING' | 'TRIAL_ENDED' | 'Immediate' | 'TRIAL_CONVERTED' | 'PENDING_PAYMENT_EXPIRED' | 'ScheduledCancellation' | 'CustomerArchived' | 'AutoCancellationRule' | null;
|
|
507
|
+
/**
|
|
508
|
+
* Coupons applied to the subscription
|
|
509
|
+
*/
|
|
510
|
+
coupons?: Array<SubscriptionListResponse.Coupon>;
|
|
231
511
|
/**
|
|
232
512
|
* End of the current billing period
|
|
233
513
|
*/
|
|
@@ -244,12 +524,24 @@ export interface SubscriptionListResponse {
|
|
|
244
524
|
* Subscription end date
|
|
245
525
|
*/
|
|
246
526
|
endDate?: string | null;
|
|
527
|
+
/**
|
|
528
|
+
* Scheduled future updates for the subscription
|
|
529
|
+
*/
|
|
530
|
+
futureUpdates?: Array<SubscriptionListResponse.FutureUpdate>;
|
|
531
|
+
/**
|
|
532
|
+
* Latest invoice for the subscription
|
|
533
|
+
*/
|
|
534
|
+
latestInvoice?: SubscriptionListResponse.LatestInvoice | null;
|
|
247
535
|
/**
|
|
248
536
|
* Additional metadata for the subscription
|
|
249
537
|
*/
|
|
250
538
|
metadata?: {
|
|
251
539
|
[key: string]: string;
|
|
252
540
|
};
|
|
541
|
+
/**
|
|
542
|
+
* Minimum spend configuration
|
|
543
|
+
*/
|
|
544
|
+
minimumSpend?: SubscriptionListResponse.MinimumSpend | null;
|
|
253
545
|
/**
|
|
254
546
|
* Paying customer ID for delegated billing
|
|
255
547
|
*/
|
|
@@ -264,25 +556,267 @@ export interface SubscriptionListResponse {
|
|
|
264
556
|
*/
|
|
265
557
|
resourceId?: string | null;
|
|
266
558
|
/**
|
|
267
|
-
*
|
|
559
|
+
* Entitlements associated with the subscription
|
|
560
|
+
*/
|
|
561
|
+
subscriptionEntitlements?: Array<SubscriptionListResponse.SubscriptionEntitlement>;
|
|
562
|
+
/**
|
|
563
|
+
* Trial configuration
|
|
564
|
+
*/
|
|
565
|
+
trial?: SubscriptionListResponse.Trial | null;
|
|
566
|
+
/**
|
|
567
|
+
* Subscription trial end date
|
|
568
|
+
*/
|
|
569
|
+
trialEndDate?: string | null;
|
|
570
|
+
}
|
|
571
|
+
export declare namespace SubscriptionListResponse {
|
|
572
|
+
/**
|
|
573
|
+
* Addon configuration
|
|
574
|
+
*/
|
|
575
|
+
interface Addon {
|
|
576
|
+
/**
|
|
577
|
+
* Addon ID
|
|
578
|
+
*/
|
|
579
|
+
id: string;
|
|
580
|
+
/**
|
|
581
|
+
* Number of addon instances
|
|
582
|
+
*/
|
|
583
|
+
quantity: number;
|
|
584
|
+
}
|
|
585
|
+
/**
|
|
586
|
+
* Budget configuration
|
|
587
|
+
*/
|
|
588
|
+
interface Budget {
|
|
589
|
+
/**
|
|
590
|
+
* Whether the budget is a soft limit
|
|
591
|
+
*/
|
|
592
|
+
hasSoftLimit: boolean;
|
|
593
|
+
/**
|
|
594
|
+
* Maximum spending limit
|
|
595
|
+
*/
|
|
596
|
+
limit: number;
|
|
597
|
+
}
|
|
598
|
+
/**
|
|
599
|
+
* Coupon applied to a subscription
|
|
600
|
+
*/
|
|
601
|
+
interface Coupon {
|
|
602
|
+
/**
|
|
603
|
+
* Coupon ID
|
|
604
|
+
*/
|
|
605
|
+
id: string;
|
|
606
|
+
/**
|
|
607
|
+
* Coupon name
|
|
608
|
+
*/
|
|
609
|
+
name: string;
|
|
610
|
+
/**
|
|
611
|
+
* Coupon status
|
|
612
|
+
*/
|
|
613
|
+
status: 'ACTIVE' | 'EXPIRED' | 'REMOVED';
|
|
614
|
+
/**
|
|
615
|
+
* Fixed amount discounts by currency
|
|
616
|
+
*/
|
|
617
|
+
amountsOff?: Array<Coupon.AmountsOff> | null;
|
|
618
|
+
/**
|
|
619
|
+
* Percentage discount
|
|
620
|
+
*/
|
|
621
|
+
percentOff?: number | null;
|
|
622
|
+
}
|
|
623
|
+
namespace Coupon {
|
|
624
|
+
interface AmountsOff {
|
|
625
|
+
/**
|
|
626
|
+
* The price amount
|
|
627
|
+
*/
|
|
628
|
+
amount?: number;
|
|
629
|
+
/**
|
|
630
|
+
* The price currency
|
|
631
|
+
*/
|
|
632
|
+
currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
|
|
633
|
+
}
|
|
634
|
+
}
|
|
635
|
+
/**
|
|
636
|
+
* Scheduled subscription update
|
|
637
|
+
*/
|
|
638
|
+
interface FutureUpdate {
|
|
639
|
+
/**
|
|
640
|
+
* Scheduled execution time
|
|
641
|
+
*/
|
|
642
|
+
scheduledExecutionTime: string;
|
|
643
|
+
/**
|
|
644
|
+
* Status of the scheduled update
|
|
645
|
+
*/
|
|
646
|
+
scheduleStatus: 'PENDING_PAYMENT' | 'SCHEDULED' | 'CANCELED' | 'DONE' | 'FAILED';
|
|
647
|
+
/**
|
|
648
|
+
* Type of scheduled change
|
|
649
|
+
*/
|
|
650
|
+
subscriptionScheduleType: 'DOWNGRADE' | 'PLAN' | 'BILLING_PERIOD' | 'UNIT_AMOUNT' | 'RECURRING_CREDITS' | 'PRICE_OVERRIDE' | 'ADDON' | 'COUPON' | 'MIGRATE_TO_LATEST' | 'ADDITIONAL_META_DATA' | 'BILLING_INFO_METADATA';
|
|
651
|
+
/**
|
|
652
|
+
* Target package for the update
|
|
653
|
+
*/
|
|
654
|
+
targetPackage?: FutureUpdate.TargetPackage | null;
|
|
655
|
+
}
|
|
656
|
+
namespace FutureUpdate {
|
|
657
|
+
/**
|
|
658
|
+
* Target package for the update
|
|
659
|
+
*/
|
|
660
|
+
interface TargetPackage {
|
|
661
|
+
/**
|
|
662
|
+
* Target package for the update
|
|
663
|
+
*/
|
|
664
|
+
id: string;
|
|
665
|
+
}
|
|
666
|
+
}
|
|
667
|
+
/**
|
|
668
|
+
* Latest invoice for the subscription
|
|
669
|
+
*/
|
|
670
|
+
interface LatestInvoice {
|
|
671
|
+
/**
|
|
672
|
+
* Invoice billing ID
|
|
673
|
+
*/
|
|
674
|
+
billingId: string;
|
|
675
|
+
/**
|
|
676
|
+
* Invoice creation date
|
|
677
|
+
*/
|
|
678
|
+
createdAt: string;
|
|
679
|
+
/**
|
|
680
|
+
* Whether payment requires action
|
|
681
|
+
*/
|
|
682
|
+
requiresAction: boolean;
|
|
683
|
+
/**
|
|
684
|
+
* Invoice status
|
|
685
|
+
*/
|
|
686
|
+
status: 'OPEN' | 'CANCELED' | 'PAID';
|
|
687
|
+
/**
|
|
688
|
+
* Amount due
|
|
689
|
+
*/
|
|
690
|
+
amountDue?: number | null;
|
|
691
|
+
/**
|
|
692
|
+
* Billing reason
|
|
693
|
+
*/
|
|
694
|
+
billingReason?: 'BILLING_CYCLE' | 'SUBSCRIPTION_CREATION' | 'SUBSCRIPTION_UPDATE' | 'MANUAL' | 'MINIMUM_INVOICE_AMOUNT_EXCEEDED' | 'OTHER' | null;
|
|
695
|
+
/**
|
|
696
|
+
* Invoice currency
|
|
697
|
+
*/
|
|
698
|
+
currency?: string | null;
|
|
699
|
+
/**
|
|
700
|
+
* Invoice PDF URL
|
|
701
|
+
*/
|
|
702
|
+
pdfUrl?: string | null;
|
|
703
|
+
/**
|
|
704
|
+
* Total amount
|
|
705
|
+
*/
|
|
706
|
+
total?: number | null;
|
|
707
|
+
}
|
|
708
|
+
/**
|
|
709
|
+
* Minimum spend configuration
|
|
710
|
+
*/
|
|
711
|
+
interface MinimumSpend {
|
|
712
|
+
/**
|
|
713
|
+
* The price amount
|
|
714
|
+
*/
|
|
715
|
+
amount?: number;
|
|
716
|
+
/**
|
|
717
|
+
* The price currency
|
|
718
|
+
*/
|
|
719
|
+
currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
|
|
720
|
+
}
|
|
721
|
+
interface Price {
|
|
722
|
+
/**
|
|
723
|
+
* Addon identifier for the price override
|
|
724
|
+
*/
|
|
725
|
+
addonId?: string | null;
|
|
726
|
+
/**
|
|
727
|
+
* The price amount
|
|
728
|
+
*/
|
|
729
|
+
amount?: number;
|
|
730
|
+
/**
|
|
731
|
+
* Whether this is a base charge override
|
|
732
|
+
*/
|
|
733
|
+
baseCharge?: boolean;
|
|
734
|
+
/**
|
|
735
|
+
* The billing country code of the price
|
|
736
|
+
*/
|
|
737
|
+
billingCountryCode?: string;
|
|
738
|
+
/**
|
|
739
|
+
* Block size for pricing
|
|
740
|
+
*/
|
|
741
|
+
blockSize?: number;
|
|
742
|
+
/**
|
|
743
|
+
* The price currency
|
|
744
|
+
*/
|
|
745
|
+
currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
|
|
746
|
+
/**
|
|
747
|
+
* Feature identifier for the price override
|
|
748
|
+
*/
|
|
749
|
+
featureId?: string | null;
|
|
750
|
+
/**
|
|
751
|
+
* Pricing tiers configuration
|
|
752
|
+
*/
|
|
753
|
+
tiers?: Array<Price.Tier>;
|
|
754
|
+
}
|
|
755
|
+
namespace Price {
|
|
756
|
+
interface Tier {
|
|
757
|
+
/**
|
|
758
|
+
* The flat fee price of the price tier
|
|
759
|
+
*/
|
|
760
|
+
flatPrice?: Tier.FlatPrice;
|
|
761
|
+
/**
|
|
762
|
+
* The unit price of the price tier
|
|
763
|
+
*/
|
|
764
|
+
unitPrice?: Tier.UnitPrice;
|
|
765
|
+
/**
|
|
766
|
+
* The up to quantity of the price tier
|
|
767
|
+
*/
|
|
768
|
+
upTo?: number;
|
|
769
|
+
}
|
|
770
|
+
namespace Tier {
|
|
771
|
+
/**
|
|
772
|
+
* The flat fee price of the price tier
|
|
773
|
+
*/
|
|
774
|
+
interface FlatPrice {
|
|
775
|
+
/**
|
|
776
|
+
* The price amount
|
|
777
|
+
*/
|
|
778
|
+
amount: number;
|
|
779
|
+
/**
|
|
780
|
+
* ISO 4217 currency code
|
|
781
|
+
*/
|
|
782
|
+
currency: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
|
|
783
|
+
}
|
|
784
|
+
/**
|
|
785
|
+
* The unit price of the price tier
|
|
786
|
+
*/
|
|
787
|
+
interface UnitPrice {
|
|
788
|
+
/**
|
|
789
|
+
* The price amount
|
|
790
|
+
*/
|
|
791
|
+
amount: number;
|
|
792
|
+
/**
|
|
793
|
+
* ISO 4217 currency code
|
|
794
|
+
*/
|
|
795
|
+
currency: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
|
|
796
|
+
}
|
|
797
|
+
}
|
|
798
|
+
}
|
|
799
|
+
/**
|
|
800
|
+
* Subscription entitlement reference
|
|
268
801
|
*/
|
|
269
|
-
|
|
270
|
-
}
|
|
271
|
-
export declare namespace SubscriptionListResponse {
|
|
272
|
-
interface Price {
|
|
802
|
+
interface SubscriptionEntitlement {
|
|
273
803
|
/**
|
|
274
|
-
*
|
|
804
|
+
* Feature ID or currency ID
|
|
275
805
|
*/
|
|
276
806
|
id: string;
|
|
277
807
|
/**
|
|
278
|
-
*
|
|
808
|
+
* Entitlement type (FEATURE or CREDIT)
|
|
279
809
|
*/
|
|
280
|
-
|
|
810
|
+
type: 'FEATURE' | 'CREDIT';
|
|
811
|
+
}
|
|
812
|
+
/**
|
|
813
|
+
* Trial configuration
|
|
814
|
+
*/
|
|
815
|
+
interface Trial {
|
|
281
816
|
/**
|
|
282
|
-
*
|
|
817
|
+
* Behavior when the trial ends
|
|
283
818
|
*/
|
|
284
|
-
|
|
285
|
-
[k: string]: unknown;
|
|
819
|
+
trialEndBehavior: 'CONVERT_TO_PAID' | 'CANCEL_SUBSCRIPTION';
|
|
286
820
|
}
|
|
287
821
|
}
|
|
288
822
|
/**
|
|
@@ -468,15 +1002,15 @@ export declare namespace SubscriptionPreviewResponse {
|
|
|
468
1002
|
start?: string;
|
|
469
1003
|
}
|
|
470
1004
|
/**
|
|
471
|
-
*
|
|
1005
|
+
* Addon configuration
|
|
472
1006
|
*/
|
|
473
1007
|
interface FreeItem {
|
|
474
1008
|
/**
|
|
475
1009
|
* Addon ID
|
|
476
1010
|
*/
|
|
477
|
-
|
|
1011
|
+
id: string;
|
|
478
1012
|
/**
|
|
479
|
-
*
|
|
1013
|
+
* Number of addon instances
|
|
480
1014
|
*/
|
|
481
1015
|
quantity: number;
|
|
482
1016
|
}
|
|
@@ -673,6 +1207,10 @@ export declare namespace SubscriptionProvisionResponse {
|
|
|
673
1207
|
}
|
|
674
1208
|
namespace UnionObjectVariant0 {
|
|
675
1209
|
interface Feature {
|
|
1210
|
+
/**
|
|
1211
|
+
* The unique reference ID of the entitlement.
|
|
1212
|
+
*/
|
|
1213
|
+
id: string;
|
|
676
1214
|
/**
|
|
677
1215
|
* The human-readable name of the entitlement, shown in UI elements.
|
|
678
1216
|
*/
|
|
@@ -685,10 +1223,6 @@ export declare namespace SubscriptionProvisionResponse {
|
|
|
685
1223
|
* The type of feature associated with the entitlement.
|
|
686
1224
|
*/
|
|
687
1225
|
featureType: 'BOOLEAN' | 'NUMBER' | 'ENUM';
|
|
688
|
-
/**
|
|
689
|
-
* The unique reference ID of the entitlement.
|
|
690
|
-
*/
|
|
691
|
-
refId: string;
|
|
692
1226
|
}
|
|
693
1227
|
}
|
|
694
1228
|
interface UnionObjectVariant1 {
|
|
@@ -727,6 +1261,28 @@ export declare namespace SubscriptionProvisionResponse {
|
|
|
727
1261
|
* The unique identifier of the custom currency.
|
|
728
1262
|
*/
|
|
729
1263
|
currencyId: string;
|
|
1264
|
+
/**
|
|
1265
|
+
* The display name of the currency.
|
|
1266
|
+
*/
|
|
1267
|
+
displayName: string;
|
|
1268
|
+
/**
|
|
1269
|
+
* A description of the currency.
|
|
1270
|
+
*/
|
|
1271
|
+
description?: string | null;
|
|
1272
|
+
/**
|
|
1273
|
+
* Additional metadata associated with the currency.
|
|
1274
|
+
*/
|
|
1275
|
+
metadata?: {
|
|
1276
|
+
[key: string]: string;
|
|
1277
|
+
} | null;
|
|
1278
|
+
/**
|
|
1279
|
+
* The plural form of the currency unit.
|
|
1280
|
+
*/
|
|
1281
|
+
unitPlural?: string | null;
|
|
1282
|
+
/**
|
|
1283
|
+
* The singular form of the currency unit.
|
|
1284
|
+
*/
|
|
1285
|
+
unitSingular?: string | null;
|
|
730
1286
|
}
|
|
731
1287
|
}
|
|
732
1288
|
/**
|
|
@@ -769,6 +1325,15 @@ export declare namespace SubscriptionProvisionResponse {
|
|
|
769
1325
|
* Subscription status
|
|
770
1326
|
*/
|
|
771
1327
|
status: 'PAYMENT_PENDING' | 'ACTIVE' | 'EXPIRED' | 'IN_TRIAL' | 'CANCELED' | 'NOT_STARTED';
|
|
1328
|
+
addons?: Array<Subscription.Addon>;
|
|
1329
|
+
/**
|
|
1330
|
+
* Billing cycle anchor date
|
|
1331
|
+
*/
|
|
1332
|
+
billingCycleAnchor?: string | null;
|
|
1333
|
+
/**
|
|
1334
|
+
* Budget configuration
|
|
1335
|
+
*/
|
|
1336
|
+
budget?: Subscription.Budget | null;
|
|
772
1337
|
/**
|
|
773
1338
|
* Subscription cancellation date
|
|
774
1339
|
*/
|
|
@@ -777,6 +1342,10 @@ export declare namespace SubscriptionProvisionResponse {
|
|
|
777
1342
|
* Subscription cancel reason
|
|
778
1343
|
*/
|
|
779
1344
|
cancelReason?: 'UPGRADE_OR_DOWNGRADE' | 'CANCELLED_BY_BILLING' | 'EXPIRED' | 'DETACH_BILLING' | 'TRIAL_ENDED' | 'Immediate' | 'TRIAL_CONVERTED' | 'PENDING_PAYMENT_EXPIRED' | 'ScheduledCancellation' | 'CustomerArchived' | 'AutoCancellationRule' | null;
|
|
1345
|
+
/**
|
|
1346
|
+
* Coupons applied to the subscription
|
|
1347
|
+
*/
|
|
1348
|
+
coupons?: Array<Subscription.Coupon>;
|
|
780
1349
|
/**
|
|
781
1350
|
* End of the current billing period
|
|
782
1351
|
*/
|
|
@@ -793,12 +1362,24 @@ export declare namespace SubscriptionProvisionResponse {
|
|
|
793
1362
|
* Subscription end date
|
|
794
1363
|
*/
|
|
795
1364
|
endDate?: string | null;
|
|
1365
|
+
/**
|
|
1366
|
+
* Scheduled future updates for the subscription
|
|
1367
|
+
*/
|
|
1368
|
+
futureUpdates?: Array<Subscription.FutureUpdate>;
|
|
1369
|
+
/**
|
|
1370
|
+
* Latest invoice for the subscription
|
|
1371
|
+
*/
|
|
1372
|
+
latestInvoice?: Subscription.LatestInvoice | null;
|
|
796
1373
|
/**
|
|
797
1374
|
* Additional metadata for the subscription
|
|
798
1375
|
*/
|
|
799
1376
|
metadata?: {
|
|
800
1377
|
[key: string]: string;
|
|
801
1378
|
};
|
|
1379
|
+
/**
|
|
1380
|
+
* Minimum spend configuration
|
|
1381
|
+
*/
|
|
1382
|
+
minimumSpend?: Subscription.MinimumSpend | null;
|
|
802
1383
|
/**
|
|
803
1384
|
* Paying customer ID for delegated billing
|
|
804
1385
|
*/
|
|
@@ -812,56 +1393,204 @@ export declare namespace SubscriptionProvisionResponse {
|
|
|
812
1393
|
* Resource ID
|
|
813
1394
|
*/
|
|
814
1395
|
resourceId?: string | null;
|
|
1396
|
+
/**
|
|
1397
|
+
* Entitlements associated with the subscription
|
|
1398
|
+
*/
|
|
1399
|
+
subscriptionEntitlements?: Array<Subscription.SubscriptionEntitlement>;
|
|
1400
|
+
/**
|
|
1401
|
+
* Trial configuration
|
|
1402
|
+
*/
|
|
1403
|
+
trial?: Subscription.Trial | null;
|
|
815
1404
|
/**
|
|
816
1405
|
* Subscription trial end date
|
|
817
1406
|
*/
|
|
818
1407
|
trialEndDate?: string | null;
|
|
819
1408
|
}
|
|
820
1409
|
namespace Subscription {
|
|
821
|
-
|
|
1410
|
+
/**
|
|
1411
|
+
* Addon configuration
|
|
1412
|
+
*/
|
|
1413
|
+
interface Addon {
|
|
822
1414
|
/**
|
|
823
|
-
* Addon
|
|
1415
|
+
* Addon ID
|
|
824
1416
|
*/
|
|
825
|
-
|
|
1417
|
+
id: string;
|
|
826
1418
|
/**
|
|
827
|
-
*
|
|
1419
|
+
* Number of addon instances
|
|
828
1420
|
*/
|
|
829
|
-
|
|
1421
|
+
quantity: number;
|
|
1422
|
+
}
|
|
1423
|
+
/**
|
|
1424
|
+
* Budget configuration
|
|
1425
|
+
*/
|
|
1426
|
+
interface Budget {
|
|
830
1427
|
/**
|
|
831
|
-
*
|
|
1428
|
+
* Whether the budget is a soft limit
|
|
832
1429
|
*/
|
|
833
|
-
|
|
1430
|
+
hasSoftLimit: boolean;
|
|
834
1431
|
/**
|
|
835
|
-
*
|
|
1432
|
+
* Maximum spending limit
|
|
836
1433
|
*/
|
|
837
|
-
|
|
1434
|
+
limit: number;
|
|
1435
|
+
}
|
|
1436
|
+
/**
|
|
1437
|
+
* Coupon applied to a subscription
|
|
1438
|
+
*/
|
|
1439
|
+
interface Coupon {
|
|
838
1440
|
/**
|
|
839
|
-
*
|
|
1441
|
+
* Coupon ID
|
|
840
1442
|
*/
|
|
841
|
-
|
|
1443
|
+
id: string;
|
|
842
1444
|
/**
|
|
843
|
-
*
|
|
1445
|
+
* Coupon name
|
|
844
1446
|
*/
|
|
845
|
-
|
|
846
|
-
|
|
847
|
-
|
|
1447
|
+
name: string;
|
|
1448
|
+
/**
|
|
1449
|
+
* Coupon status
|
|
1450
|
+
*/
|
|
1451
|
+
status: 'ACTIVE' | 'EXPIRED' | 'REMOVED';
|
|
1452
|
+
/**
|
|
1453
|
+
* Fixed amount discounts by currency
|
|
1454
|
+
*/
|
|
1455
|
+
amountsOff?: Array<Coupon.AmountsOff> | null;
|
|
848
1456
|
/**
|
|
849
|
-
*
|
|
1457
|
+
* Percentage discount
|
|
850
1458
|
*/
|
|
851
|
-
|
|
1459
|
+
percentOff?: number | null;
|
|
1460
|
+
}
|
|
1461
|
+
namespace Coupon {
|
|
1462
|
+
interface AmountsOff {
|
|
852
1463
|
/**
|
|
853
1464
|
* The price amount
|
|
854
1465
|
*/
|
|
855
1466
|
amount?: number;
|
|
856
|
-
/**
|
|
857
|
-
* The billing country code of the price
|
|
858
|
-
*/
|
|
859
|
-
billingCountryCode?: string | null;
|
|
860
1467
|
/**
|
|
861
1468
|
* The price currency
|
|
862
1469
|
*/
|
|
863
1470
|
currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
|
|
864
1471
|
}
|
|
1472
|
+
}
|
|
1473
|
+
/**
|
|
1474
|
+
* Scheduled subscription update
|
|
1475
|
+
*/
|
|
1476
|
+
interface FutureUpdate {
|
|
1477
|
+
/**
|
|
1478
|
+
* Scheduled execution time
|
|
1479
|
+
*/
|
|
1480
|
+
scheduledExecutionTime: string;
|
|
1481
|
+
/**
|
|
1482
|
+
* Status of the scheduled update
|
|
1483
|
+
*/
|
|
1484
|
+
scheduleStatus: 'PENDING_PAYMENT' | 'SCHEDULED' | 'CANCELED' | 'DONE' | 'FAILED';
|
|
1485
|
+
/**
|
|
1486
|
+
* Type of scheduled change
|
|
1487
|
+
*/
|
|
1488
|
+
subscriptionScheduleType: 'DOWNGRADE' | 'PLAN' | 'BILLING_PERIOD' | 'UNIT_AMOUNT' | 'RECURRING_CREDITS' | 'PRICE_OVERRIDE' | 'ADDON' | 'COUPON' | 'MIGRATE_TO_LATEST' | 'ADDITIONAL_META_DATA' | 'BILLING_INFO_METADATA';
|
|
1489
|
+
/**
|
|
1490
|
+
* Target package for the update
|
|
1491
|
+
*/
|
|
1492
|
+
targetPackage?: FutureUpdate.TargetPackage | null;
|
|
1493
|
+
}
|
|
1494
|
+
namespace FutureUpdate {
|
|
1495
|
+
/**
|
|
1496
|
+
* Target package for the update
|
|
1497
|
+
*/
|
|
1498
|
+
interface TargetPackage {
|
|
1499
|
+
/**
|
|
1500
|
+
* Target package for the update
|
|
1501
|
+
*/
|
|
1502
|
+
id: string;
|
|
1503
|
+
}
|
|
1504
|
+
}
|
|
1505
|
+
/**
|
|
1506
|
+
* Latest invoice for the subscription
|
|
1507
|
+
*/
|
|
1508
|
+
interface LatestInvoice {
|
|
1509
|
+
/**
|
|
1510
|
+
* Invoice billing ID
|
|
1511
|
+
*/
|
|
1512
|
+
billingId: string;
|
|
1513
|
+
/**
|
|
1514
|
+
* Invoice creation date
|
|
1515
|
+
*/
|
|
1516
|
+
createdAt: string;
|
|
1517
|
+
/**
|
|
1518
|
+
* Whether payment requires action
|
|
1519
|
+
*/
|
|
1520
|
+
requiresAction: boolean;
|
|
1521
|
+
/**
|
|
1522
|
+
* Invoice status
|
|
1523
|
+
*/
|
|
1524
|
+
status: 'OPEN' | 'CANCELED' | 'PAID';
|
|
1525
|
+
/**
|
|
1526
|
+
* Amount due
|
|
1527
|
+
*/
|
|
1528
|
+
amountDue?: number | null;
|
|
1529
|
+
/**
|
|
1530
|
+
* Billing reason
|
|
1531
|
+
*/
|
|
1532
|
+
billingReason?: 'BILLING_CYCLE' | 'SUBSCRIPTION_CREATION' | 'SUBSCRIPTION_UPDATE' | 'MANUAL' | 'MINIMUM_INVOICE_AMOUNT_EXCEEDED' | 'OTHER' | null;
|
|
1533
|
+
/**
|
|
1534
|
+
* Invoice currency
|
|
1535
|
+
*/
|
|
1536
|
+
currency?: string | null;
|
|
1537
|
+
/**
|
|
1538
|
+
* Invoice PDF URL
|
|
1539
|
+
*/
|
|
1540
|
+
pdfUrl?: string | null;
|
|
1541
|
+
/**
|
|
1542
|
+
* Total amount
|
|
1543
|
+
*/
|
|
1544
|
+
total?: number | null;
|
|
1545
|
+
}
|
|
1546
|
+
/**
|
|
1547
|
+
* Minimum spend configuration
|
|
1548
|
+
*/
|
|
1549
|
+
interface MinimumSpend {
|
|
1550
|
+
/**
|
|
1551
|
+
* The price amount
|
|
1552
|
+
*/
|
|
1553
|
+
amount?: number;
|
|
1554
|
+
/**
|
|
1555
|
+
* The price currency
|
|
1556
|
+
*/
|
|
1557
|
+
currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
|
|
1558
|
+
}
|
|
1559
|
+
interface Price {
|
|
1560
|
+
/**
|
|
1561
|
+
* Addon identifier for the price override
|
|
1562
|
+
*/
|
|
1563
|
+
addonId?: string | null;
|
|
1564
|
+
/**
|
|
1565
|
+
* The price amount
|
|
1566
|
+
*/
|
|
1567
|
+
amount?: number;
|
|
1568
|
+
/**
|
|
1569
|
+
* Whether this is a base charge override
|
|
1570
|
+
*/
|
|
1571
|
+
baseCharge?: boolean;
|
|
1572
|
+
/**
|
|
1573
|
+
* The billing country code of the price
|
|
1574
|
+
*/
|
|
1575
|
+
billingCountryCode?: string;
|
|
1576
|
+
/**
|
|
1577
|
+
* Block size for pricing
|
|
1578
|
+
*/
|
|
1579
|
+
blockSize?: number;
|
|
1580
|
+
/**
|
|
1581
|
+
* The price currency
|
|
1582
|
+
*/
|
|
1583
|
+
currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
|
|
1584
|
+
/**
|
|
1585
|
+
* Feature identifier for the price override
|
|
1586
|
+
*/
|
|
1587
|
+
featureId?: string | null;
|
|
1588
|
+
/**
|
|
1589
|
+
* Pricing tiers configuration
|
|
1590
|
+
*/
|
|
1591
|
+
tiers?: Array<Price.Tier>;
|
|
1592
|
+
}
|
|
1593
|
+
namespace Price {
|
|
865
1594
|
interface Tier {
|
|
866
1595
|
/**
|
|
867
1596
|
* The flat fee price of the price tier
|
|
@@ -884,15 +1613,11 @@ export declare namespace SubscriptionProvisionResponse {
|
|
|
884
1613
|
/**
|
|
885
1614
|
* The price amount
|
|
886
1615
|
*/
|
|
887
|
-
amount
|
|
888
|
-
/**
|
|
889
|
-
* The billing country code of the price
|
|
890
|
-
*/
|
|
891
|
-
billingCountryCode?: string | null;
|
|
1616
|
+
amount: number;
|
|
892
1617
|
/**
|
|
893
|
-
*
|
|
1618
|
+
* ISO 4217 currency code
|
|
894
1619
|
*/
|
|
895
|
-
currency
|
|
1620
|
+
currency: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
|
|
896
1621
|
}
|
|
897
1622
|
/**
|
|
898
1623
|
* The unit price of the price tier
|
|
@@ -901,56 +1626,93 @@ export declare namespace SubscriptionProvisionResponse {
|
|
|
901
1626
|
/**
|
|
902
1627
|
* The price amount
|
|
903
1628
|
*/
|
|
904
|
-
amount
|
|
905
|
-
/**
|
|
906
|
-
* The billing country code of the price
|
|
907
|
-
*/
|
|
908
|
-
billingCountryCode?: string | null;
|
|
1629
|
+
amount: number;
|
|
909
1630
|
/**
|
|
910
|
-
*
|
|
1631
|
+
* ISO 4217 currency code
|
|
911
1632
|
*/
|
|
912
|
-
currency
|
|
1633
|
+
currency: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
|
|
913
1634
|
}
|
|
914
1635
|
}
|
|
915
1636
|
}
|
|
1637
|
+
/**
|
|
1638
|
+
* Subscription entitlement reference
|
|
1639
|
+
*/
|
|
1640
|
+
interface SubscriptionEntitlement {
|
|
1641
|
+
/**
|
|
1642
|
+
* Feature ID or currency ID
|
|
1643
|
+
*/
|
|
1644
|
+
id: string;
|
|
1645
|
+
/**
|
|
1646
|
+
* Entitlement type (FEATURE or CREDIT)
|
|
1647
|
+
*/
|
|
1648
|
+
type: 'FEATURE' | 'CREDIT';
|
|
1649
|
+
}
|
|
1650
|
+
/**
|
|
1651
|
+
* Trial configuration
|
|
1652
|
+
*/
|
|
1653
|
+
interface Trial {
|
|
1654
|
+
/**
|
|
1655
|
+
* Behavior when the trial ends
|
|
1656
|
+
*/
|
|
1657
|
+
trialEndBehavior: 'CONVERT_TO_PAID' | 'CANCEL_SUBSCRIPTION';
|
|
1658
|
+
}
|
|
916
1659
|
}
|
|
917
1660
|
}
|
|
918
1661
|
}
|
|
919
1662
|
export interface SubscriptionUpdateParams {
|
|
920
1663
|
addons?: Array<SubscriptionUpdateParams.Addon>;
|
|
921
1664
|
appliedCoupon?: SubscriptionUpdateParams.AppliedCoupon;
|
|
1665
|
+
/**
|
|
1666
|
+
* Await payment confirmation
|
|
1667
|
+
*/
|
|
922
1668
|
awaitPaymentConfirmation?: boolean;
|
|
1669
|
+
billingCycleAnchor?: 'UNCHANGED' | 'NOW';
|
|
923
1670
|
billingInformation?: SubscriptionUpdateParams.BillingInformation;
|
|
924
1671
|
billingPeriod?: 'MONTHLY' | 'ANNUALLY';
|
|
925
1672
|
budget?: SubscriptionUpdateParams.Budget | null;
|
|
926
1673
|
charges?: Array<SubscriptionUpdateParams.Charge>;
|
|
1674
|
+
entitlements?: Array<SubscriptionUpdateParams.Feature | SubscriptionUpdateParams.Credit>;
|
|
927
1675
|
/**
|
|
928
1676
|
* Additional metadata for the subscription
|
|
929
1677
|
*/
|
|
930
1678
|
metadata?: {
|
|
931
1679
|
[key: string]: string;
|
|
932
1680
|
};
|
|
1681
|
+
/**
|
|
1682
|
+
* Minimum spend amount
|
|
1683
|
+
*/
|
|
933
1684
|
minimumSpend?: SubscriptionUpdateParams.MinimumSpend | null;
|
|
934
1685
|
priceOverrides?: Array<SubscriptionUpdateParams.PriceOverride>;
|
|
1686
|
+
/**
|
|
1687
|
+
* Promotion code
|
|
1688
|
+
*/
|
|
935
1689
|
promotionCode?: string;
|
|
936
1690
|
scheduleStrategy?: 'END_OF_BILLING_PERIOD' | 'END_OF_BILLING_MONTH' | 'IMMEDIATE';
|
|
937
|
-
subscriptionEntitlements?: Array<SubscriptionUpdateParams.SubscriptionEntitlement>;
|
|
938
1691
|
/**
|
|
939
1692
|
* Subscription trial end date
|
|
940
1693
|
*/
|
|
941
1694
|
trialEndDate?: string;
|
|
942
1695
|
}
|
|
943
1696
|
export declare namespace SubscriptionUpdateParams {
|
|
1697
|
+
/**
|
|
1698
|
+
* Addon configuration
|
|
1699
|
+
*/
|
|
944
1700
|
interface Addon {
|
|
945
1701
|
/**
|
|
946
1702
|
* Addon ID
|
|
947
1703
|
*/
|
|
948
|
-
|
|
1704
|
+
id: string;
|
|
1705
|
+
/**
|
|
1706
|
+
* Number of addon instances
|
|
1707
|
+
*/
|
|
949
1708
|
quantity: number;
|
|
950
1709
|
}
|
|
951
1710
|
interface AppliedCoupon {
|
|
952
1711
|
billingCouponId?: string;
|
|
953
1712
|
configuration?: AppliedCoupon.Configuration;
|
|
1713
|
+
/**
|
|
1714
|
+
* Stigg coupon ID
|
|
1715
|
+
*/
|
|
954
1716
|
couponId?: string;
|
|
955
1717
|
discount?: AppliedCoupon.Discount;
|
|
956
1718
|
promotionCode?: string | null;
|
|
@@ -970,9 +1732,18 @@ export declare namespace SubscriptionUpdateParams {
|
|
|
970
1732
|
percentOff?: number;
|
|
971
1733
|
}
|
|
972
1734
|
namespace Discount {
|
|
1735
|
+
/**
|
|
1736
|
+
* Monetary amount with currency
|
|
1737
|
+
*/
|
|
973
1738
|
interface AmountsOff {
|
|
1739
|
+
/**
|
|
1740
|
+
* The price amount
|
|
1741
|
+
*/
|
|
974
1742
|
amount: number;
|
|
975
|
-
|
|
1743
|
+
/**
|
|
1744
|
+
* ISO 4217 currency code
|
|
1745
|
+
*/
|
|
1746
|
+
currency: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
|
|
976
1747
|
}
|
|
977
1748
|
}
|
|
978
1749
|
}
|
|
@@ -991,7 +1762,7 @@ export declare namespace SubscriptionUpdateParams {
|
|
|
991
1762
|
* Additional metadata for the subscription
|
|
992
1763
|
*/
|
|
993
1764
|
metadata?: {
|
|
994
|
-
[key: string]:
|
|
1765
|
+
[key: string]: string;
|
|
995
1766
|
};
|
|
996
1767
|
prorationBehavior?: 'INVOICE_IMMEDIATELY' | 'CREATE_PRORATIONS' | 'NONE';
|
|
997
1768
|
taxIds?: Array<BillingInformation.TaxID>;
|
|
@@ -1034,7 +1805,13 @@ export declare namespace SubscriptionUpdateParams {
|
|
|
1034
1805
|
}
|
|
1035
1806
|
}
|
|
1036
1807
|
interface Budget {
|
|
1808
|
+
/**
|
|
1809
|
+
* Whether the budget is a soft limit
|
|
1810
|
+
*/
|
|
1037
1811
|
hasSoftLimit: boolean;
|
|
1812
|
+
/**
|
|
1813
|
+
* Maximum spending limit
|
|
1814
|
+
*/
|
|
1038
1815
|
limit: number;
|
|
1039
1816
|
}
|
|
1040
1817
|
interface Charge {
|
|
@@ -1045,62 +1822,136 @@ export declare namespace SubscriptionUpdateParams {
|
|
|
1045
1822
|
quantity: number;
|
|
1046
1823
|
type: 'FEATURE' | 'CREDIT';
|
|
1047
1824
|
}
|
|
1048
|
-
|
|
1049
|
-
|
|
1050
|
-
|
|
1051
|
-
|
|
1052
|
-
interface Minimum {
|
|
1053
|
-
amount: number;
|
|
1054
|
-
currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
|
|
1055
|
-
}
|
|
1056
|
-
}
|
|
1057
|
-
interface PriceOverride {
|
|
1825
|
+
/**
|
|
1826
|
+
* Feature entitlement configuration for a subscription
|
|
1827
|
+
*/
|
|
1828
|
+
interface Feature {
|
|
1058
1829
|
/**
|
|
1059
|
-
*
|
|
1830
|
+
* The feature ID to attach the entitlement to
|
|
1060
1831
|
*/
|
|
1061
|
-
|
|
1832
|
+
id: string;
|
|
1062
1833
|
/**
|
|
1063
|
-
*
|
|
1834
|
+
* SubscriptionFeatureEntitlementRequest
|
|
1064
1835
|
*/
|
|
1065
|
-
|
|
1836
|
+
type: 'FEATURE';
|
|
1066
1837
|
/**
|
|
1067
|
-
*
|
|
1838
|
+
* Whether the usage limit is a soft limit
|
|
1068
1839
|
*/
|
|
1069
|
-
|
|
1840
|
+
hasSoftLimit?: boolean;
|
|
1070
1841
|
/**
|
|
1071
|
-
*
|
|
1842
|
+
* Whether usage is unlimited
|
|
1072
1843
|
*/
|
|
1073
|
-
featureId?: string;
|
|
1074
|
-
price?: PriceOverride.Price;
|
|
1075
|
-
}
|
|
1076
|
-
namespace PriceOverride {
|
|
1077
|
-
interface Price {
|
|
1078
|
-
amount: number;
|
|
1079
|
-
currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
|
|
1080
|
-
}
|
|
1081
|
-
}
|
|
1082
|
-
interface SubscriptionEntitlement {
|
|
1083
|
-
id?: string;
|
|
1084
|
-
featureId?: string;
|
|
1085
|
-
hasSoftLimit?: boolean;
|
|
1086
1844
|
hasUnlimitedUsage?: boolean;
|
|
1087
|
-
|
|
1845
|
+
/**
|
|
1846
|
+
* Configuration for monthly reset period
|
|
1847
|
+
*/
|
|
1848
|
+
monthlyResetPeriodConfiguration?: Feature.MonthlyResetPeriodConfiguration | null;
|
|
1849
|
+
/**
|
|
1850
|
+
* Period at which usage resets
|
|
1851
|
+
*/
|
|
1088
1852
|
resetPeriod?: 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR';
|
|
1853
|
+
/**
|
|
1854
|
+
* Maximum allowed usage for the feature
|
|
1855
|
+
*/
|
|
1089
1856
|
usageLimit?: number;
|
|
1090
|
-
|
|
1091
|
-
|
|
1857
|
+
/**
|
|
1858
|
+
* Configuration for weekly reset period
|
|
1859
|
+
*/
|
|
1860
|
+
weeklyResetPeriodConfiguration?: Feature.WeeklyResetPeriodConfiguration | null;
|
|
1861
|
+
/**
|
|
1862
|
+
* Configuration for yearly reset period
|
|
1863
|
+
*/
|
|
1864
|
+
yearlyResetPeriodConfiguration?: Feature.YearlyResetPeriodConfiguration | null;
|
|
1092
1865
|
}
|
|
1093
|
-
namespace
|
|
1866
|
+
namespace Feature {
|
|
1867
|
+
/**
|
|
1868
|
+
* Configuration for monthly reset period
|
|
1869
|
+
*/
|
|
1094
1870
|
interface MonthlyResetPeriodConfiguration {
|
|
1871
|
+
/**
|
|
1872
|
+
* Reset anchor (SubscriptionStart or StartOfTheMonth)
|
|
1873
|
+
*/
|
|
1095
1874
|
accordingTo: 'SubscriptionStart' | 'StartOfTheMonth';
|
|
1096
1875
|
}
|
|
1876
|
+
/**
|
|
1877
|
+
* Configuration for weekly reset period
|
|
1878
|
+
*/
|
|
1097
1879
|
interface WeeklyResetPeriodConfiguration {
|
|
1880
|
+
/**
|
|
1881
|
+
* Reset anchor (SubscriptionStart or specific day)
|
|
1882
|
+
*/
|
|
1098
1883
|
accordingTo: 'SubscriptionStart' | 'EverySunday' | 'EveryMonday' | 'EveryTuesday' | 'EveryWednesday' | 'EveryThursday' | 'EveryFriday' | 'EverySaturday';
|
|
1099
1884
|
}
|
|
1885
|
+
/**
|
|
1886
|
+
* Configuration for yearly reset period
|
|
1887
|
+
*/
|
|
1100
1888
|
interface YearlyResetPeriodConfiguration {
|
|
1889
|
+
/**
|
|
1890
|
+
* Reset anchor (SubscriptionStart)
|
|
1891
|
+
*/
|
|
1101
1892
|
accordingTo: 'SubscriptionStart';
|
|
1102
1893
|
}
|
|
1103
1894
|
}
|
|
1895
|
+
/**
|
|
1896
|
+
* Credit entitlement configuration for a subscription
|
|
1897
|
+
*/
|
|
1898
|
+
interface Credit {
|
|
1899
|
+
/**
|
|
1900
|
+
* The custom currency ID for the credit entitlement
|
|
1901
|
+
*/
|
|
1902
|
+
id: string;
|
|
1903
|
+
/**
|
|
1904
|
+
* Credit grant amount
|
|
1905
|
+
*/
|
|
1906
|
+
amount: number;
|
|
1907
|
+
/**
|
|
1908
|
+
* Credit grant cadence (MONTH or YEAR)
|
|
1909
|
+
*/
|
|
1910
|
+
cadence: 'MONTH' | 'YEAR';
|
|
1911
|
+
/**
|
|
1912
|
+
* SubscriptionCreditEntitlementRequest
|
|
1913
|
+
*/
|
|
1914
|
+
type: 'CREDIT';
|
|
1915
|
+
}
|
|
1916
|
+
/**
|
|
1917
|
+
* Minimum spend amount
|
|
1918
|
+
*/
|
|
1919
|
+
interface MinimumSpend {
|
|
1920
|
+
/**
|
|
1921
|
+
* The price amount
|
|
1922
|
+
*/
|
|
1923
|
+
amount?: number;
|
|
1924
|
+
/**
|
|
1925
|
+
* The price currency
|
|
1926
|
+
*/
|
|
1927
|
+
currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
|
|
1928
|
+
}
|
|
1929
|
+
interface PriceOverride {
|
|
1930
|
+
/**
|
|
1931
|
+
* Addon ID
|
|
1932
|
+
*/
|
|
1933
|
+
addonId?: string;
|
|
1934
|
+
/**
|
|
1935
|
+
* The price amount
|
|
1936
|
+
*/
|
|
1937
|
+
amount?: number;
|
|
1938
|
+
/**
|
|
1939
|
+
* Whether this is a base charge override
|
|
1940
|
+
*/
|
|
1941
|
+
baseCharge?: boolean;
|
|
1942
|
+
/**
|
|
1943
|
+
* The price currency
|
|
1944
|
+
*/
|
|
1945
|
+
currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
|
|
1946
|
+
/**
|
|
1947
|
+
* The corresponding custom currency id of the recurring credits price
|
|
1948
|
+
*/
|
|
1949
|
+
currencyId?: string;
|
|
1950
|
+
/**
|
|
1951
|
+
* Feature ID
|
|
1952
|
+
*/
|
|
1953
|
+
featureId?: string;
|
|
1954
|
+
}
|
|
1104
1955
|
}
|
|
1105
1956
|
export interface SubscriptionListParams extends MyCursorIDPageParams {
|
|
1106
1957
|
/**
|
|
@@ -1118,7 +1969,7 @@ export interface SubscriptionListParams extends MyCursorIDPageParams {
|
|
|
1118
1969
|
/**
|
|
1119
1970
|
* Filter by pricing type. Supports comma-separated values for multiple types
|
|
1120
1971
|
*/
|
|
1121
|
-
pricingType?:
|
|
1972
|
+
pricingType?: Array<'FREE' | 'PAID' | 'CUSTOM'>;
|
|
1122
1973
|
/**
|
|
1123
1974
|
* Filter by resource ID
|
|
1124
1975
|
*/
|
|
@@ -1127,7 +1978,7 @@ export interface SubscriptionListParams extends MyCursorIDPageParams {
|
|
|
1127
1978
|
* Filter by subscription status. Supports comma-separated values for multiple
|
|
1128
1979
|
* statuses
|
|
1129
1980
|
*/
|
|
1130
|
-
status?:
|
|
1981
|
+
status?: Array<'PAYMENT_PENDING' | 'ACTIVE' | 'EXPIRED' | 'IN_TRIAL' | 'CANCELED' | 'NOT_STARTED'>;
|
|
1131
1982
|
}
|
|
1132
1983
|
export declare namespace SubscriptionListParams {
|
|
1133
1984
|
/**
|
|
@@ -1202,10 +2053,16 @@ export declare namespace SubscriptionImportParams {
|
|
|
1202
2053
|
* Plan ID
|
|
1203
2054
|
*/
|
|
1204
2055
|
planId: string;
|
|
2056
|
+
addons?: Array<Subscription.Addon>;
|
|
1205
2057
|
/**
|
|
1206
2058
|
* Billing ID
|
|
1207
2059
|
*/
|
|
1208
2060
|
billingId?: string | null;
|
|
2061
|
+
/**
|
|
2062
|
+
* Billing period (MONTHLY or ANNUALLY)
|
|
2063
|
+
*/
|
|
2064
|
+
billingPeriod?: 'MONTHLY' | 'ANNUALLY';
|
|
2065
|
+
charges?: Array<Subscription.Charge>;
|
|
1209
2066
|
/**
|
|
1210
2067
|
* Subscription end date
|
|
1211
2068
|
*/
|
|
@@ -1225,6 +2082,38 @@ export declare namespace SubscriptionImportParams {
|
|
|
1225
2082
|
*/
|
|
1226
2083
|
startDate?: string;
|
|
1227
2084
|
}
|
|
2085
|
+
namespace Subscription {
|
|
2086
|
+
/**
|
|
2087
|
+
* Addon configuration
|
|
2088
|
+
*/
|
|
2089
|
+
interface Addon {
|
|
2090
|
+
/**
|
|
2091
|
+
* Addon ID
|
|
2092
|
+
*/
|
|
2093
|
+
id: string;
|
|
2094
|
+
/**
|
|
2095
|
+
* Number of addon instances
|
|
2096
|
+
*/
|
|
2097
|
+
quantity: number;
|
|
2098
|
+
}
|
|
2099
|
+
/**
|
|
2100
|
+
* Charge item
|
|
2101
|
+
*/
|
|
2102
|
+
interface Charge {
|
|
2103
|
+
/**
|
|
2104
|
+
* Charge ID
|
|
2105
|
+
*/
|
|
2106
|
+
id: string;
|
|
2107
|
+
/**
|
|
2108
|
+
* Charge quantity
|
|
2109
|
+
*/
|
|
2110
|
+
quantity: number;
|
|
2111
|
+
/**
|
|
2112
|
+
* Charge type
|
|
2113
|
+
*/
|
|
2114
|
+
type: 'FEATURE' | 'CREDIT';
|
|
2115
|
+
}
|
|
2116
|
+
}
|
|
1228
2117
|
}
|
|
1229
2118
|
export interface SubscriptionMigrateParams {
|
|
1230
2119
|
/**
|
|
@@ -1257,6 +2146,10 @@ export interface SubscriptionPreviewParams {
|
|
|
1257
2146
|
* ISO 3166-1 country code for localization
|
|
1258
2147
|
*/
|
|
1259
2148
|
billingCountryCode?: string;
|
|
2149
|
+
/**
|
|
2150
|
+
* Billing cycle anchor behavior for the subscription
|
|
2151
|
+
*/
|
|
2152
|
+
billingCycleAnchor?: 'UNCHANGED' | 'NOW';
|
|
1260
2153
|
/**
|
|
1261
2154
|
* Billing and tax configuration
|
|
1262
2155
|
*/
|
|
@@ -1302,11 +2195,11 @@ export declare namespace SubscriptionPreviewParams {
|
|
|
1302
2195
|
/**
|
|
1303
2196
|
* Addon ID
|
|
1304
2197
|
*/
|
|
1305
|
-
|
|
2198
|
+
id: string;
|
|
1306
2199
|
/**
|
|
1307
2200
|
* Number of addon instances
|
|
1308
2201
|
*/
|
|
1309
|
-
quantity
|
|
2202
|
+
quantity: number;
|
|
1310
2203
|
}
|
|
1311
2204
|
/**
|
|
1312
2205
|
* Coupon or discount to apply
|
|
@@ -1375,7 +2268,7 @@ export declare namespace SubscriptionPreviewParams {
|
|
|
1375
2268
|
*/
|
|
1376
2269
|
amount: number;
|
|
1377
2270
|
/**
|
|
1378
|
-
*
|
|
2271
|
+
* ISO 4217 currency code
|
|
1379
2272
|
*/
|
|
1380
2273
|
currency: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
|
|
1381
2274
|
}
|
|
@@ -1425,7 +2318,9 @@ export declare namespace SubscriptionPreviewParams {
|
|
|
1425
2318
|
/**
|
|
1426
2319
|
* Additional billing metadata
|
|
1427
2320
|
*/
|
|
1428
|
-
metadata?:
|
|
2321
|
+
metadata?: {
|
|
2322
|
+
[key: string]: string;
|
|
2323
|
+
};
|
|
1429
2324
|
/**
|
|
1430
2325
|
* Proration behavior
|
|
1431
2326
|
*/
|
|
@@ -1530,6 +2425,10 @@ export interface SubscriptionProvisionParams {
|
|
|
1530
2425
|
* The ISO 3166-1 alpha-2 country code for billing
|
|
1531
2426
|
*/
|
|
1532
2427
|
billingCountryCode?: string | null;
|
|
2428
|
+
/**
|
|
2429
|
+
* Billing cycle anchor behavior for the subscription
|
|
2430
|
+
*/
|
|
2431
|
+
billingCycleAnchor?: 'UNCHANGED' | 'NOW';
|
|
1533
2432
|
/**
|
|
1534
2433
|
* External billing system identifier
|
|
1535
2434
|
*/
|
|
@@ -1545,12 +2444,16 @@ export interface SubscriptionProvisionParams {
|
|
|
1545
2444
|
* Checkout page configuration for payment collection
|
|
1546
2445
|
*/
|
|
1547
2446
|
checkoutOptions?: SubscriptionProvisionParams.CheckoutOptions;
|
|
2447
|
+
entitlements?: Array<SubscriptionProvisionParams.Feature | SubscriptionProvisionParams.Credit>;
|
|
1548
2448
|
/**
|
|
1549
2449
|
* Additional metadata for the subscription
|
|
1550
2450
|
*/
|
|
1551
2451
|
metadata?: {
|
|
1552
2452
|
[key: string]: string;
|
|
1553
2453
|
};
|
|
2454
|
+
/**
|
|
2455
|
+
* Minimum spend amount
|
|
2456
|
+
*/
|
|
1554
2457
|
minimumSpend?: SubscriptionProvisionParams.MinimumSpend | null;
|
|
1555
2458
|
/**
|
|
1556
2459
|
* Optional paying customer ID for split billing scenarios
|
|
@@ -1577,23 +2480,28 @@ export interface SubscriptionProvisionParams {
|
|
|
1577
2480
|
* Subscription start date
|
|
1578
2481
|
*/
|
|
1579
2482
|
startDate?: string;
|
|
1580
|
-
subscriptionEntitlements?: Array<SubscriptionProvisionParams.SubscriptionEntitlement>;
|
|
1581
2483
|
/**
|
|
1582
2484
|
* Trial period override settings
|
|
1583
2485
|
*/
|
|
1584
2486
|
trialOverrideConfiguration?: SubscriptionProvisionParams.TrialOverrideConfiguration;
|
|
2487
|
+
/**
|
|
2488
|
+
* Unit quantity
|
|
2489
|
+
*/
|
|
1585
2490
|
unitQuantity?: number;
|
|
1586
2491
|
}
|
|
1587
2492
|
export declare namespace SubscriptionProvisionParams {
|
|
2493
|
+
/**
|
|
2494
|
+
* Addon configuration
|
|
2495
|
+
*/
|
|
1588
2496
|
interface Addon {
|
|
1589
2497
|
/**
|
|
1590
|
-
* Addon
|
|
2498
|
+
* Addon ID
|
|
1591
2499
|
*/
|
|
1592
|
-
|
|
2500
|
+
id: string;
|
|
1593
2501
|
/**
|
|
1594
|
-
* Number of addon
|
|
2502
|
+
* Number of addon instances
|
|
1595
2503
|
*/
|
|
1596
|
-
quantity
|
|
2504
|
+
quantity: number;
|
|
1597
2505
|
}
|
|
1598
2506
|
/**
|
|
1599
2507
|
* Coupon configuration
|
|
@@ -1662,7 +2570,7 @@ export declare namespace SubscriptionProvisionParams {
|
|
|
1662
2570
|
*/
|
|
1663
2571
|
amount: number;
|
|
1664
2572
|
/**
|
|
1665
|
-
*
|
|
2573
|
+
* ISO 4217 currency code
|
|
1666
2574
|
*/
|
|
1667
2575
|
currency: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
|
|
1668
2576
|
}
|
|
@@ -1728,6 +2636,9 @@ export declare namespace SubscriptionProvisionParams {
|
|
|
1728
2636
|
postalCode?: string;
|
|
1729
2637
|
state?: string;
|
|
1730
2638
|
}
|
|
2639
|
+
/**
|
|
2640
|
+
* Tax identifier with type and value for customer tax exemptions.
|
|
2641
|
+
*/
|
|
1731
2642
|
interface TaxID {
|
|
1732
2643
|
/**
|
|
1733
2644
|
* The type of tax exemption identifier, such as VAT.
|
|
@@ -1799,40 +2710,127 @@ export declare namespace SubscriptionProvisionParams {
|
|
|
1799
2710
|
*/
|
|
1800
2711
|
referenceId?: string | null;
|
|
1801
2712
|
}
|
|
1802
|
-
|
|
2713
|
+
/**
|
|
2714
|
+
* Feature entitlement configuration for a subscription
|
|
2715
|
+
*/
|
|
2716
|
+
interface Feature {
|
|
2717
|
+
/**
|
|
2718
|
+
* The feature ID to attach the entitlement to
|
|
2719
|
+
*/
|
|
2720
|
+
id: string;
|
|
2721
|
+
/**
|
|
2722
|
+
* SubscriptionFeatureEntitlementRequest
|
|
2723
|
+
*/
|
|
2724
|
+
type: 'FEATURE';
|
|
2725
|
+
/**
|
|
2726
|
+
* Whether the usage limit is a soft limit
|
|
2727
|
+
*/
|
|
2728
|
+
hasSoftLimit?: boolean;
|
|
2729
|
+
/**
|
|
2730
|
+
* Whether usage is unlimited
|
|
2731
|
+
*/
|
|
2732
|
+
hasUnlimitedUsage?: boolean;
|
|
2733
|
+
/**
|
|
2734
|
+
* Configuration for monthly reset period
|
|
2735
|
+
*/
|
|
2736
|
+
monthlyResetPeriodConfiguration?: Feature.MonthlyResetPeriodConfiguration | null;
|
|
2737
|
+
/**
|
|
2738
|
+
* Period at which usage resets
|
|
2739
|
+
*/
|
|
2740
|
+
resetPeriod?: 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR';
|
|
2741
|
+
/**
|
|
2742
|
+
* Maximum allowed usage for the feature
|
|
2743
|
+
*/
|
|
2744
|
+
usageLimit?: number;
|
|
1803
2745
|
/**
|
|
1804
|
-
*
|
|
2746
|
+
* Configuration for weekly reset period
|
|
1805
2747
|
*/
|
|
1806
|
-
|
|
2748
|
+
weeklyResetPeriodConfiguration?: Feature.WeeklyResetPeriodConfiguration | null;
|
|
2749
|
+
/**
|
|
2750
|
+
* Configuration for yearly reset period
|
|
2751
|
+
*/
|
|
2752
|
+
yearlyResetPeriodConfiguration?: Feature.YearlyResetPeriodConfiguration | null;
|
|
1807
2753
|
}
|
|
1808
|
-
namespace
|
|
2754
|
+
namespace Feature {
|
|
1809
2755
|
/**
|
|
1810
|
-
*
|
|
2756
|
+
* Configuration for monthly reset period
|
|
1811
2757
|
*/
|
|
1812
|
-
interface
|
|
2758
|
+
interface MonthlyResetPeriodConfiguration {
|
|
1813
2759
|
/**
|
|
1814
|
-
*
|
|
2760
|
+
* Reset anchor (SubscriptionStart or StartOfTheMonth)
|
|
1815
2761
|
*/
|
|
1816
|
-
|
|
2762
|
+
accordingTo: 'SubscriptionStart' | 'StartOfTheMonth';
|
|
2763
|
+
}
|
|
2764
|
+
/**
|
|
2765
|
+
* Configuration for weekly reset period
|
|
2766
|
+
*/
|
|
2767
|
+
interface WeeklyResetPeriodConfiguration {
|
|
1817
2768
|
/**
|
|
1818
|
-
*
|
|
2769
|
+
* Reset anchor (SubscriptionStart or specific day)
|
|
1819
2770
|
*/
|
|
1820
|
-
|
|
2771
|
+
accordingTo: 'SubscriptionStart' | 'EverySunday' | 'EveryMonday' | 'EveryTuesday' | 'EveryWednesday' | 'EveryThursday' | 'EveryFriday' | 'EverySaturday';
|
|
2772
|
+
}
|
|
2773
|
+
/**
|
|
2774
|
+
* Configuration for yearly reset period
|
|
2775
|
+
*/
|
|
2776
|
+
interface YearlyResetPeriodConfiguration {
|
|
1821
2777
|
/**
|
|
1822
|
-
*
|
|
2778
|
+
* Reset anchor (SubscriptionStart)
|
|
1823
2779
|
*/
|
|
1824
|
-
|
|
2780
|
+
accordingTo: 'SubscriptionStart';
|
|
1825
2781
|
}
|
|
1826
2782
|
}
|
|
2783
|
+
/**
|
|
2784
|
+
* Credit entitlement configuration for a subscription
|
|
2785
|
+
*/
|
|
2786
|
+
interface Credit {
|
|
2787
|
+
/**
|
|
2788
|
+
* The custom currency ID for the credit entitlement
|
|
2789
|
+
*/
|
|
2790
|
+
id: string;
|
|
2791
|
+
/**
|
|
2792
|
+
* Credit grant amount
|
|
2793
|
+
*/
|
|
2794
|
+
amount: number;
|
|
2795
|
+
/**
|
|
2796
|
+
* Credit grant cadence (MONTH or YEAR)
|
|
2797
|
+
*/
|
|
2798
|
+
cadence: 'MONTH' | 'YEAR';
|
|
2799
|
+
/**
|
|
2800
|
+
* SubscriptionCreditEntitlementRequest
|
|
2801
|
+
*/
|
|
2802
|
+
type: 'CREDIT';
|
|
2803
|
+
}
|
|
2804
|
+
/**
|
|
2805
|
+
* Minimum spend amount
|
|
2806
|
+
*/
|
|
2807
|
+
interface MinimumSpend {
|
|
2808
|
+
/**
|
|
2809
|
+
* The price amount
|
|
2810
|
+
*/
|
|
2811
|
+
amount?: number;
|
|
2812
|
+
/**
|
|
2813
|
+
* The price currency
|
|
2814
|
+
*/
|
|
2815
|
+
currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
|
|
2816
|
+
}
|
|
1827
2817
|
interface PriceOverride {
|
|
1828
2818
|
/**
|
|
1829
2819
|
* Addon identifier for the price override
|
|
1830
2820
|
*/
|
|
1831
2821
|
addonId?: string | null;
|
|
2822
|
+
/**
|
|
2823
|
+
* The price amount
|
|
2824
|
+
*/
|
|
2825
|
+
amount?: number;
|
|
1832
2826
|
/**
|
|
1833
2827
|
* Whether this is a base charge override
|
|
1834
2828
|
*/
|
|
1835
2829
|
baseCharge?: boolean;
|
|
2830
|
+
/**
|
|
2831
|
+
* The billing country code of the price
|
|
2832
|
+
*/
|
|
2833
|
+
billingCountryCode?: string;
|
|
1836
2834
|
/**
|
|
1837
2835
|
* Block size for pricing
|
|
1838
2836
|
*/
|
|
@@ -1840,13 +2838,13 @@ export declare namespace SubscriptionProvisionParams {
|
|
|
1840
2838
|
creditGrantCadence?: 'BEGINNING_OF_BILLING_PERIOD' | 'MONTHLY';
|
|
1841
2839
|
creditRate?: PriceOverride.CreditRate;
|
|
1842
2840
|
/**
|
|
1843
|
-
*
|
|
2841
|
+
* The price currency
|
|
1844
2842
|
*/
|
|
1845
|
-
|
|
2843
|
+
currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
|
|
1846
2844
|
/**
|
|
1847
|
-
*
|
|
2845
|
+
* Feature identifier for the price override
|
|
1848
2846
|
*/
|
|
1849
|
-
|
|
2847
|
+
featureId?: string | null;
|
|
1850
2848
|
/**
|
|
1851
2849
|
* Pricing tiers configuration
|
|
1852
2850
|
*/
|
|
@@ -1867,23 +2865,6 @@ export declare namespace SubscriptionProvisionParams {
|
|
|
1867
2865
|
*/
|
|
1868
2866
|
costFormula?: string | null;
|
|
1869
2867
|
}
|
|
1870
|
-
/**
|
|
1871
|
-
* Override price amount
|
|
1872
|
-
*/
|
|
1873
|
-
interface Price {
|
|
1874
|
-
/**
|
|
1875
|
-
* The price amount
|
|
1876
|
-
*/
|
|
1877
|
-
amount?: number;
|
|
1878
|
-
/**
|
|
1879
|
-
* The billing country code of the price
|
|
1880
|
-
*/
|
|
1881
|
-
billingCountryCode?: string | null;
|
|
1882
|
-
/**
|
|
1883
|
-
* The price currency
|
|
1884
|
-
*/
|
|
1885
|
-
currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
|
|
1886
|
-
}
|
|
1887
2868
|
interface Tier {
|
|
1888
2869
|
/**
|
|
1889
2870
|
* The flat fee price of the price tier
|
|
@@ -1906,15 +2887,11 @@ export declare namespace SubscriptionProvisionParams {
|
|
|
1906
2887
|
/**
|
|
1907
2888
|
* The price amount
|
|
1908
2889
|
*/
|
|
1909
|
-
amount
|
|
1910
|
-
/**
|
|
1911
|
-
* The billing country code of the price
|
|
1912
|
-
*/
|
|
1913
|
-
billingCountryCode?: string | null;
|
|
2890
|
+
amount: number;
|
|
1914
2891
|
/**
|
|
1915
|
-
*
|
|
2892
|
+
* ISO 4217 currency code
|
|
1916
2893
|
*/
|
|
1917
|
-
currency
|
|
2894
|
+
currency: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
|
|
1918
2895
|
}
|
|
1919
2896
|
/**
|
|
1920
2897
|
* The unit price of the price tier
|
|
@@ -1923,26 +2900,14 @@ export declare namespace SubscriptionProvisionParams {
|
|
|
1923
2900
|
/**
|
|
1924
2901
|
* The price amount
|
|
1925
2902
|
*/
|
|
1926
|
-
amount
|
|
1927
|
-
/**
|
|
1928
|
-
* The billing country code of the price
|
|
1929
|
-
*/
|
|
1930
|
-
billingCountryCode?: string | null;
|
|
2903
|
+
amount: number;
|
|
1931
2904
|
/**
|
|
1932
|
-
*
|
|
2905
|
+
* ISO 4217 currency code
|
|
1933
2906
|
*/
|
|
1934
|
-
currency
|
|
2907
|
+
currency: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
|
|
1935
2908
|
}
|
|
1936
2909
|
}
|
|
1937
2910
|
}
|
|
1938
|
-
interface SubscriptionEntitlement {
|
|
1939
|
-
/**
|
|
1940
|
-
* Feature ID
|
|
1941
|
-
*/
|
|
1942
|
-
featureId: string;
|
|
1943
|
-
usageLimit: number;
|
|
1944
|
-
isGranted?: boolean;
|
|
1945
|
-
}
|
|
1946
2911
|
/**
|
|
1947
2912
|
* Trial period override settings
|
|
1948
2913
|
*/
|
|
@@ -1969,7 +2934,7 @@ export interface SubscriptionTransferParams {
|
|
|
1969
2934
|
}
|
|
1970
2935
|
export declare namespace Subscriptions {
|
|
1971
2936
|
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, };
|
|
1972
|
-
export {
|
|
2937
|
+
export { FutureUpdateAPIFutureUpdate as FutureUpdate, type CancelSubscription as CancelSubscription };
|
|
1973
2938
|
export { Usage as Usage, type UsageChargeUsageResponse as UsageChargeUsageResponse, type UsageSyncResponse as UsageSyncResponse, type UsageChargeUsageParams as UsageChargeUsageParams, };
|
|
1974
2939
|
export { Invoice as Invoice, type InvoiceMarkAsPaidResponse as InvoiceMarkAsPaidResponse };
|
|
1975
2940
|
}
|