@stigg/typescript 0.1.0-beta.3 → 0.1.0-beta.31
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 +236 -0
- package/api-promise.d.mts +1 -0
- package/api-promise.d.mts.map +1 -1
- package/api-promise.d.ts +1 -0
- package/api-promise.d.ts.map +1 -1
- package/api-promise.mjs +1 -0
- package/api-promise.mjs.map +1 -1
- package/client.d.mts +3 -0
- package/client.d.mts.map +1 -1
- package/client.d.ts +3 -0
- package/client.d.ts.map +1 -1
- package/client.js +12 -1
- package/client.js.map +1 -1
- package/client.mjs +12 -1
- package/client.mjs.map +1 -1
- package/core/api-promise.d.mts.map +1 -1
- package/core/api-promise.d.ts.map +1 -1
- package/core/api-promise.mjs.map +1 -1
- package/core/error.mjs.map +1 -1
- package/core/pagination.d.mts.map +1 -1
- package/core/pagination.d.ts.map +1 -1
- package/core/pagination.mjs.map +1 -1
- package/core/resource.d.mts.map +1 -1
- package/core/resource.d.ts.map +1 -1
- package/core/uploads.d.mts.map +1 -1
- package/core/uploads.d.ts.map +1 -1
- package/core/uploads.mjs.map +1 -1
- package/error.d.mts +1 -0
- package/error.d.mts.map +1 -1
- package/error.d.ts +1 -0
- package/error.d.ts.map +1 -1
- package/error.mjs +1 -0
- package/error.mjs.map +1 -1
- package/index.d.mts.map +1 -1
- package/index.d.ts.map +1 -1
- package/index.mjs.map +1 -1
- package/internal/detect-platform.mjs.map +1 -1
- package/internal/headers.mjs.map +1 -1
- package/internal/parse.d.mts.map +1 -1
- package/internal/parse.d.ts.map +1 -1
- package/internal/parse.mjs.map +1 -1
- package/internal/qs/formats.d.mts.map +1 -1
- package/internal/qs/formats.d.ts.map +1 -1
- package/internal/qs/index.d.mts +2 -2
- package/internal/qs/index.d.mts.map +1 -1
- package/internal/qs/index.d.ts +2 -2
- package/internal/qs/index.d.ts.map +1 -1
- package/internal/qs/index.mjs.map +1 -1
- package/internal/qs/stringify.d.mts.map +1 -1
- package/internal/qs/stringify.d.ts.map +1 -1
- package/internal/qs/stringify.mjs.map +1 -1
- package/internal/qs/utils.d.mts.map +1 -1
- package/internal/qs/utils.d.ts.map +1 -1
- package/internal/qs/utils.mjs.map +1 -1
- package/internal/request-options.d.mts.map +1 -1
- package/internal/request-options.d.ts.map +1 -1
- package/internal/shims.d.mts +6 -0
- package/internal/shims.d.mts.map +1 -1
- package/internal/shims.d.ts +6 -0
- package/internal/shims.d.ts.map +1 -1
- package/internal/to-file.d.mts.map +1 -1
- package/internal/to-file.d.ts.map +1 -1
- package/internal/to-file.mjs.map +1 -1
- package/internal/types.d.mts +4 -4
- package/internal/types.d.mts.map +1 -1
- package/internal/types.d.ts +4 -4
- package/internal/types.d.ts.map +1 -1
- package/internal/uploads.d.mts.map +1 -1
- package/internal/uploads.d.ts.map +1 -1
- package/internal/uploads.mjs.map +1 -1
- package/internal/utils/base64.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.mjs.map +1 -1
- package/internal/utils/path.mjs.map +1 -1
- package/internal/utils/query.mjs.map +1 -1
- package/internal/utils/values.mjs.map +1 -1
- package/internal/utils.d.mts.map +1 -1
- package/internal/utils.d.ts.map +1 -1
- package/internal/utils.mjs.map +1 -1
- package/package.json +1 -1
- package/pagination.d.mts +1 -0
- package/pagination.d.mts.map +1 -1
- package/pagination.d.ts +1 -0
- package/pagination.d.ts.map +1 -1
- package/pagination.mjs +1 -0
- package/pagination.mjs.map +1 -1
- package/resource.d.mts +1 -0
- package/resource.d.mts.map +1 -1
- package/resource.d.ts +1 -0
- package/resource.d.ts.map +1 -1
- package/resource.mjs +1 -0
- package/resource.mjs.map +1 -1
- package/resources/index.d.mts +1 -0
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +1 -0
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +3 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +1 -0
- package/resources/index.mjs.map +1 -1
- package/resources/v1/addons/addons.d.mts +313 -32
- package/resources/v1/addons/addons.d.mts.map +1 -1
- package/resources/v1/addons/addons.d.ts +313 -32
- package/resources/v1/addons/addons.d.ts.map +1 -1
- package/resources/v1/addons/addons.js +114 -15
- package/resources/v1/addons/addons.js.map +1 -1
- package/resources/v1/addons/addons.mjs +114 -15
- package/resources/v1/addons/addons.mjs.map +1 -1
- package/resources/v1/addons/entitlements.d.mts +92 -5
- package/resources/v1/addons/entitlements.d.mts.map +1 -1
- package/resources/v1/addons/entitlements.d.ts +92 -5
- package/resources/v1/addons/entitlements.d.ts.map +1 -1
- package/resources/v1/addons/entitlements.js +49 -8
- package/resources/v1/addons/entitlements.js.map +1 -1
- package/resources/v1/addons/entitlements.mjs +49 -8
- package/resources/v1/addons/entitlements.mjs.map +1 -1
- package/resources/v1/addons/index.d.mts +2 -2
- package/resources/v1/addons/index.d.mts.map +1 -1
- package/resources/v1/addons/index.d.ts +2 -2
- package/resources/v1/addons/index.d.ts.map +1 -1
- package/resources/v1/addons/index.js.map +1 -1
- package/resources/v1/addons/index.mjs.map +1 -1
- package/resources/v1/addons.d.mts.map +1 -1
- package/resources/v1/addons.d.ts.map +1 -1
- package/resources/v1/addons.mjs.map +1 -1
- package/resources/v1/coupons.d.mts +80 -20
- package/resources/v1/coupons.d.mts.map +1 -1
- package/resources/v1/coupons.d.ts +80 -20
- package/resources/v1/coupons.d.ts.map +1 -1
- package/resources/v1/coupons.js +60 -9
- package/resources/v1/coupons.js.map +1 -1
- package/resources/v1/coupons.mjs +60 -9
- package/resources/v1/coupons.mjs.map +1 -1
- package/resources/v1/credits/credits.d.mts +114 -25
- package/resources/v1/credits/credits.d.mts.map +1 -1
- package/resources/v1/credits/credits.d.ts +114 -25
- package/resources/v1/credits/credits.d.ts.map +1 -1
- package/resources/v1/credits/credits.js +36 -5
- package/resources/v1/credits/credits.js.map +1 -1
- package/resources/v1/credits/credits.mjs +36 -5
- package/resources/v1/credits/credits.mjs.map +1 -1
- package/resources/v1/credits/custom-currencies.d.mts +96 -23
- package/resources/v1/credits/custom-currencies.d.mts.map +1 -1
- package/resources/v1/credits/custom-currencies.d.ts +96 -23
- package/resources/v1/credits/custom-currencies.d.ts.map +1 -1
- package/resources/v1/credits/custom-currencies.js +76 -12
- package/resources/v1/credits/custom-currencies.js.map +1 -1
- package/resources/v1/credits/custom-currencies.mjs +76 -12
- package/resources/v1/credits/custom-currencies.mjs.map +1 -1
- package/resources/v1/credits/grants.d.mts +60 -23
- package/resources/v1/credits/grants.d.mts.map +1 -1
- package/resources/v1/credits/grants.d.ts +60 -23
- package/resources/v1/credits/grants.d.ts.map +1 -1
- package/resources/v1/credits/grants.js +35 -5
- package/resources/v1/credits/grants.js.map +1 -1
- package/resources/v1/credits/grants.mjs +35 -5
- package/resources/v1/credits/grants.mjs.map +1 -1
- package/resources/v1/credits/index.d.mts +2 -2
- package/resources/v1/credits/index.d.mts.map +1 -1
- package/resources/v1/credits/index.d.ts +2 -2
- package/resources/v1/credits/index.d.ts.map +1 -1
- package/resources/v1/credits/index.js.map +1 -1
- package/resources/v1/credits/index.mjs.map +1 -1
- package/resources/v1/credits.d.mts.map +1 -1
- package/resources/v1/credits.d.ts.map +1 -1
- package/resources/v1/credits.mjs.map +1 -1
- package/resources/v1/customers/customers.d.mts +170 -53
- package/resources/v1/customers/customers.d.mts.map +1 -1
- package/resources/v1/customers/customers.d.ts +170 -53
- package/resources/v1/customers/customers.d.ts.map +1 -1
- package/resources/v1/customers/customers.js +124 -19
- package/resources/v1/customers/customers.js.map +1 -1
- package/resources/v1/customers/customers.mjs +124 -19
- package/resources/v1/customers/customers.mjs.map +1 -1
- package/resources/v1/customers/index.d.mts +2 -2
- package/resources/v1/customers/index.d.mts.map +1 -1
- package/resources/v1/customers/index.d.ts +2 -2
- package/resources/v1/customers/index.d.ts.map +1 -1
- package/resources/v1/customers/index.js.map +1 -1
- package/resources/v1/customers/index.mjs +1 -1
- package/resources/v1/customers/index.mjs.map +1 -1
- package/resources/v1/customers/integrations.d.mts +67 -12
- package/resources/v1/customers/integrations.d.mts.map +1 -1
- package/resources/v1/customers/integrations.d.ts +67 -12
- package/resources/v1/customers/integrations.d.ts.map +1 -1
- package/resources/v1/customers/integrations.js +57 -9
- package/resources/v1/customers/integrations.js.map +1 -1
- package/resources/v1/customers/integrations.mjs +57 -9
- package/resources/v1/customers/integrations.mjs.map +1 -1
- package/resources/v1/customers/payment-method.d.mts +32 -8
- package/resources/v1/customers/payment-method.d.mts.map +1 -1
- package/resources/v1/customers/payment-method.d.ts +32 -8
- package/resources/v1/customers/payment-method.d.ts.map +1 -1
- package/resources/v1/customers/payment-method.js +26 -4
- package/resources/v1/customers/payment-method.js.map +1 -1
- package/resources/v1/customers/payment-method.mjs +26 -4
- package/resources/v1/customers/payment-method.mjs.map +1 -1
- package/resources/v1/customers/promotional-entitlements.d.mts +40 -7
- package/resources/v1/customers/promotional-entitlements.d.mts.map +1 -1
- package/resources/v1/customers/promotional-entitlements.d.ts +40 -7
- package/resources/v1/customers/promotional-entitlements.d.ts.map +1 -1
- package/resources/v1/customers/promotional-entitlements.js +38 -6
- package/resources/v1/customers/promotional-entitlements.js.map +1 -1
- package/resources/v1/customers/promotional-entitlements.mjs +38 -6
- package/resources/v1/customers/promotional-entitlements.mjs.map +1 -1
- package/resources/v1/customers.d.mts.map +1 -1
- package/resources/v1/customers.d.ts.map +1 -1
- package/resources/v1/customers.mjs.map +1 -1
- package/resources/v1/events/beta/beta.d.mts +10 -0
- package/resources/v1/events/beta/beta.d.mts.map +1 -0
- package/resources/v1/events/beta/beta.d.ts +10 -0
- package/resources/v1/events/beta/beta.d.ts.map +1 -0
- package/resources/v1/events/beta/beta.js +17 -0
- package/resources/v1/events/beta/beta.js.map +1 -0
- package/resources/v1/events/beta/beta.mjs +12 -0
- package/resources/v1/events/beta/beta.mjs.map +1 -0
- package/resources/v1/events/beta/customers.d.mts +160 -0
- package/resources/v1/events/beta/customers.d.mts.map +1 -0
- package/resources/v1/events/beta/customers.d.ts +160 -0
- package/resources/v1/events/beta/customers.d.ts.map +1 -0
- package/resources/v1/events/beta/customers.js +32 -0
- package/resources/v1/events/beta/customers.js.map +1 -0
- package/resources/v1/events/beta/customers.mjs +28 -0
- package/resources/v1/events/beta/customers.mjs.map +1 -0
- package/resources/v1/events/beta/index.d.mts +3 -0
- package/resources/v1/events/beta/index.d.mts.map +1 -0
- package/resources/v1/events/beta/index.d.ts +3 -0
- package/resources/v1/events/beta/index.d.ts.map +1 -0
- package/resources/v1/events/beta/index.js +9 -0
- package/resources/v1/events/beta/index.js.map +1 -0
- package/resources/v1/events/beta/index.mjs +4 -0
- package/resources/v1/events/beta/index.mjs.map +1 -0
- package/resources/v1/events/beta.d.mts +2 -0
- package/resources/v1/events/beta.d.mts.map +1 -0
- package/resources/v1/events/beta.d.ts +2 -0
- package/resources/v1/events/beta.d.ts.map +1 -0
- package/resources/v1/events/beta.js +6 -0
- package/resources/v1/events/beta.js.map +1 -0
- package/resources/v1/events/beta.mjs +3 -0
- package/resources/v1/events/beta.mjs.map +1 -0
- package/resources/v1/events/data-export/data-export.d.mts +211 -0
- package/resources/v1/events/data-export/data-export.d.mts.map +1 -0
- package/resources/v1/events/data-export/data-export.d.ts +211 -0
- package/resources/v1/events/data-export/data-export.d.ts.map +1 -0
- package/resources/v1/events/data-export/data-export.js +71 -0
- package/resources/v1/events/data-export/data-export.js.map +1 -0
- package/resources/v1/events/data-export/data-export.mjs +66 -0
- package/resources/v1/events/data-export/data-export.mjs.map +1 -0
- package/resources/v1/events/data-export/destinations.d.mts +215 -0
- package/resources/v1/events/data-export/destinations.d.mts.map +1 -0
- package/resources/v1/events/data-export/destinations.d.ts +215 -0
- package/resources/v1/events/data-export/destinations.d.ts.map +1 -0
- package/resources/v1/events/data-export/destinations.js +46 -0
- package/resources/v1/events/data-export/destinations.js.map +1 -0
- package/resources/v1/events/data-export/destinations.mjs +42 -0
- package/resources/v1/events/data-export/destinations.mjs.map +1 -0
- package/resources/v1/events/data-export/index.d.mts +3 -0
- package/resources/v1/events/data-export/index.d.mts.map +1 -0
- package/resources/v1/events/data-export/index.d.ts +3 -0
- package/resources/v1/events/data-export/index.d.ts.map +1 -0
- package/resources/v1/events/data-export/index.js +9 -0
- package/resources/v1/events/data-export/index.js.map +1 -0
- package/resources/v1/events/data-export/index.mjs +4 -0
- package/resources/v1/events/data-export/index.mjs.map +1 -0
- package/resources/v1/events/data-export.d.mts +2 -0
- package/resources/v1/events/data-export.d.mts.map +1 -0
- package/resources/v1/events/data-export.d.ts +2 -0
- package/resources/v1/events/data-export.d.ts.map +1 -0
- package/resources/v1/events/data-export.js +6 -0
- package/resources/v1/events/data-export.js.map +1 -0
- package/resources/v1/events/data-export.mjs +3 -0
- package/resources/v1/events/data-export.mjs.map +1 -0
- package/resources/v1/events/events.d.mts +85 -0
- package/resources/v1/events/events.d.mts.map +1 -0
- package/resources/v1/events/events.d.ts +85 -0
- package/resources/v1/events/events.d.ts.map +1 -0
- package/resources/v1/events/events.js +43 -0
- package/resources/v1/events/events.js.map +1 -0
- package/resources/v1/events/events.mjs +38 -0
- package/resources/v1/events/events.mjs.map +1 -0
- package/resources/v1/events/index.d.mts +4 -0
- package/resources/v1/events/index.d.mts.map +1 -0
- package/resources/v1/events/index.d.ts +4 -0
- package/resources/v1/events/index.d.ts.map +1 -0
- package/resources/v1/events/index.js +11 -0
- package/resources/v1/events/index.js.map +1 -0
- package/resources/v1/events/index.mjs +5 -0
- package/resources/v1/events/index.mjs.map +1 -0
- package/resources/v1/events.d.mts +1 -65
- package/resources/v1/events.d.mts.map +1 -1
- package/resources/v1/events.d.ts +1 -65
- package/resources/v1/events.d.ts.map +1 -1
- package/resources/v1/events.js +2 -15
- package/resources/v1/events.js.map +1 -1
- package/resources/v1/events.mjs +1 -13
- package/resources/v1/events.mjs.map +1 -1
- package/resources/v1/features.d.mts +108 -30
- package/resources/v1/features.d.mts.map +1 -1
- package/resources/v1/features.d.ts +108 -30
- package/resources/v1/features.d.ts.map +1 -1
- package/resources/v1/features.js +72 -11
- package/resources/v1/features.js.map +1 -1
- package/resources/v1/features.mjs +72 -11
- package/resources/v1/features.mjs.map +1 -1
- package/resources/v1/index.d.mts +8 -8
- package/resources/v1/index.d.mts.map +1 -1
- package/resources/v1/index.d.ts +8 -8
- package/resources/v1/index.d.ts.map +1 -1
- package/resources/v1/index.js +6 -6
- package/resources/v1/index.js.map +1 -1
- package/resources/v1/index.mjs +1 -1
- package/resources/v1/index.mjs.map +1 -1
- package/resources/v1/plans/entitlements.d.mts +92 -5
- package/resources/v1/plans/entitlements.d.mts.map +1 -1
- package/resources/v1/plans/entitlements.d.ts +92 -5
- package/resources/v1/plans/entitlements.d.ts.map +1 -1
- package/resources/v1/plans/entitlements.js +49 -8
- package/resources/v1/plans/entitlements.js.map +1 -1
- package/resources/v1/plans/entitlements.mjs +49 -8
- package/resources/v1/plans/entitlements.mjs.map +1 -1
- package/resources/v1/plans/index.d.mts +2 -2
- package/resources/v1/plans/index.d.mts.map +1 -1
- package/resources/v1/plans/index.d.ts +2 -2
- package/resources/v1/plans/index.d.ts.map +1 -1
- package/resources/v1/plans/index.js.map +1 -1
- package/resources/v1/plans/index.mjs.map +1 -1
- package/resources/v1/plans/plans.d.mts +496 -32
- package/resources/v1/plans/plans.d.mts.map +1 -1
- package/resources/v1/plans/plans.d.ts +496 -32
- package/resources/v1/plans/plans.d.ts.map +1 -1
- package/resources/v1/plans/plans.js +135 -16
- package/resources/v1/plans/plans.js.map +1 -1
- package/resources/v1/plans/plans.mjs +135 -16
- package/resources/v1/plans/plans.mjs.map +1 -1
- package/resources/v1/plans.d.mts.map +1 -1
- package/resources/v1/plans.d.ts.map +1 -1
- package/resources/v1/plans.mjs.map +1 -1
- package/resources/v1/products.d.mts +97 -23
- package/resources/v1/products.d.mts.map +1 -1
- package/resources/v1/products.d.ts +97 -23
- package/resources/v1/products.d.ts.map +1 -1
- package/resources/v1/products.js +73 -11
- package/resources/v1/products.js.map +1 -1
- package/resources/v1/products.mjs +73 -11
- package/resources/v1/products.mjs.map +1 -1
- package/resources/v1/subscriptions/future-update.d.mts +29 -3
- package/resources/v1/subscriptions/future-update.d.mts.map +1 -1
- package/resources/v1/subscriptions/future-update.d.ts +29 -3
- package/resources/v1/subscriptions/future-update.d.ts.map +1 -1
- package/resources/v1/subscriptions/future-update.js +25 -4
- package/resources/v1/subscriptions/future-update.js.map +1 -1
- package/resources/v1/subscriptions/future-update.mjs +25 -4
- package/resources/v1/subscriptions/future-update.mjs.map +1 -1
- package/resources/v1/subscriptions/index.d.mts +4 -4
- package/resources/v1/subscriptions/index.d.mts.map +1 -1
- package/resources/v1/subscriptions/index.d.ts +4 -4
- package/resources/v1/subscriptions/index.d.ts.map +1 -1
- package/resources/v1/subscriptions/index.js.map +1 -1
- package/resources/v1/subscriptions/index.mjs +1 -1
- package/resources/v1/subscriptions/index.mjs.map +1 -1
- package/resources/v1/subscriptions/invoice.d.mts +15 -2
- package/resources/v1/subscriptions/invoice.d.mts.map +1 -1
- package/resources/v1/subscriptions/invoice.d.ts +15 -2
- package/resources/v1/subscriptions/invoice.d.ts.map +1 -1
- package/resources/v1/subscriptions/invoice.js +13 -2
- package/resources/v1/subscriptions/invoice.js.map +1 -1
- package/resources/v1/subscriptions/invoice.mjs +13 -2
- package/resources/v1/subscriptions/invoice.mjs.map +1 -1
- package/resources/v1/subscriptions/subscriptions.d.mts +258 -79
- package/resources/v1/subscriptions/subscriptions.d.mts.map +1 -1
- package/resources/v1/subscriptions/subscriptions.d.ts +258 -79
- package/resources/v1/subscriptions/subscriptions.d.ts.map +1 -1
- package/resources/v1/subscriptions/subscriptions.js +126 -19
- package/resources/v1/subscriptions/subscriptions.js.map +1 -1
- package/resources/v1/subscriptions/subscriptions.mjs +128 -21
- package/resources/v1/subscriptions/subscriptions.mjs.map +1 -1
- package/resources/v1/subscriptions/usage.d.mts +29 -4
- package/resources/v1/subscriptions/usage.d.mts.map +1 -1
- package/resources/v1/subscriptions/usage.d.ts +29 -4
- package/resources/v1/subscriptions/usage.d.ts.map +1 -1
- package/resources/v1/subscriptions/usage.js +26 -4
- package/resources/v1/subscriptions/usage.js.map +1 -1
- package/resources/v1/subscriptions/usage.mjs +26 -4
- package/resources/v1/subscriptions/usage.mjs.map +1 -1
- package/resources/v1/subscriptions.d.mts.map +1 -1
- package/resources/v1/subscriptions.d.ts.map +1 -1
- package/resources/v1/subscriptions.mjs.map +1 -1
- package/resources/v1/usage.d.mts +52 -2
- package/resources/v1/usage.d.mts.map +1 -1
- package/resources/v1/usage.d.ts +52 -2
- package/resources/v1/usage.d.ts.map +1 -1
- package/resources/v1/usage.js +26 -4
- package/resources/v1/usage.js.map +1 -1
- package/resources/v1/usage.mjs +26 -4
- package/resources/v1/usage.mjs.map +1 -1
- package/resources/v1/v1.d.mts +16 -16
- package/resources/v1/v1.d.mts.map +1 -1
- package/resources/v1/v1.d.ts +16 -16
- package/resources/v1/v1.d.ts.map +1 -1
- package/resources/v1/v1.js +2 -2
- package/resources/v1/v1.js.map +1 -1
- package/resources/v1/v1.mjs +2 -2
- package/resources/v1/v1.mjs.map +1 -1
- package/resources/v1-beta/customers/assignments.d.mts +245 -0
- package/resources/v1-beta/customers/assignments.d.mts.map +1 -0
- package/resources/v1-beta/customers/assignments.d.ts +245 -0
- package/resources/v1-beta/customers/assignments.d.ts.map +1 -0
- package/resources/v1-beta/customers/assignments.js +84 -0
- package/resources/v1-beta/customers/assignments.js.map +1 -0
- package/resources/v1-beta/customers/assignments.mjs +80 -0
- package/resources/v1-beta/customers/assignments.mjs.map +1 -0
- package/resources/v1-beta/customers/customers.d.mts +18 -0
- package/resources/v1-beta/customers/customers.d.mts.map +1 -0
- package/resources/v1-beta/customers/customers.d.ts +18 -0
- package/resources/v1-beta/customers/customers.d.ts.map +1 -0
- package/resources/v1-beta/customers/customers.js +25 -0
- package/resources/v1-beta/customers/customers.js.map +1 -0
- package/resources/v1-beta/customers/customers.mjs +20 -0
- package/resources/v1-beta/customers/customers.mjs.map +1 -0
- package/resources/v1-beta/customers/entities.d.mts +351 -0
- package/resources/v1-beta/customers/entities.d.mts.map +1 -0
- package/resources/v1-beta/customers/entities.d.ts +351 -0
- package/resources/v1-beta/customers/entities.d.ts.map +1 -0
- package/resources/v1-beta/customers/entities.js +150 -0
- package/resources/v1-beta/customers/entities.js.map +1 -0
- package/resources/v1-beta/customers/entities.mjs +146 -0
- package/resources/v1-beta/customers/entities.mjs.map +1 -0
- package/resources/v1-beta/customers/entitlements.d.mts +261 -0
- package/resources/v1-beta/customers/entitlements.d.mts.map +1 -0
- package/resources/v1-beta/customers/entitlements.d.ts +261 -0
- package/resources/v1-beta/customers/entitlements.d.ts.map +1 -0
- package/resources/v1-beta/customers/entitlements.js +36 -0
- package/resources/v1-beta/customers/entitlements.js.map +1 -0
- package/resources/v1-beta/customers/entitlements.mjs +32 -0
- package/resources/v1-beta/customers/entitlements.mjs.map +1 -0
- package/resources/v1-beta/customers/index.d.mts +5 -0
- package/resources/v1-beta/customers/index.d.mts.map +1 -0
- package/resources/v1-beta/customers/index.d.ts +5 -0
- package/resources/v1-beta/customers/index.d.ts.map +1 -0
- package/resources/v1-beta/customers/index.js +13 -0
- package/resources/v1-beta/customers/index.js.map +1 -0
- package/resources/v1-beta/customers/index.mjs +6 -0
- package/resources/v1-beta/customers/index.mjs.map +1 -0
- package/resources/v1-beta/customers.d.mts +2 -0
- package/resources/v1-beta/customers.d.mts.map +1 -0
- package/resources/v1-beta/customers.d.ts +2 -0
- package/resources/v1-beta/customers.d.ts.map +1 -0
- package/resources/v1-beta/customers.js +6 -0
- package/resources/v1-beta/customers.js.map +1 -0
- package/resources/v1-beta/customers.mjs +3 -0
- package/resources/v1-beta/customers.mjs.map +1 -0
- package/resources/v1-beta/entity-types.d.mts +165 -0
- package/resources/v1-beta/entity-types.d.mts.map +1 -0
- package/resources/v1-beta/entity-types.d.ts +165 -0
- package/resources/v1-beta/entity-types.d.ts.map +1 -0
- package/resources/v1-beta/entity-types.js +75 -0
- package/resources/v1-beta/entity-types.js.map +1 -0
- package/resources/v1-beta/entity-types.mjs +71 -0
- package/resources/v1-beta/entity-types.mjs.map +1 -0
- package/resources/v1-beta/index.d.mts +4 -0
- package/resources/v1-beta/index.d.mts.map +1 -0
- package/resources/v1-beta/index.d.ts +4 -0
- package/resources/v1-beta/index.d.ts.map +1 -0
- package/resources/v1-beta/index.js +11 -0
- package/resources/v1-beta/index.js.map +1 -0
- package/resources/v1-beta/index.mjs +5 -0
- package/resources/v1-beta/index.mjs.map +1 -0
- package/resources/v1-beta/v1-beta.d.mts +14 -0
- package/resources/v1-beta/v1-beta.d.mts.map +1 -0
- package/resources/v1-beta/v1-beta.d.ts +14 -0
- package/resources/v1-beta/v1-beta.d.ts.map +1 -0
- package/resources/v1-beta/v1-beta.js +21 -0
- package/resources/v1-beta/v1-beta.js.map +1 -0
- package/resources/v1-beta/v1-beta.mjs +16 -0
- package/resources/v1-beta/v1-beta.mjs.map +1 -0
- package/resources/v1-beta.d.mts +2 -0
- package/resources/v1-beta.d.mts.map +1 -0
- package/resources/v1-beta.d.ts +2 -0
- package/resources/v1-beta.d.ts.map +1 -0
- package/resources/v1-beta.js +6 -0
- package/resources/v1-beta.js.map +1 -0
- package/resources/v1-beta.mjs +3 -0
- package/resources/v1-beta.mjs.map +1 -0
- package/resources/v1.d.mts.map +1 -1
- package/resources/v1.d.ts.map +1 -1
- package/resources/v1.mjs.map +1 -1
- package/resources.d.mts.map +1 -1
- package/resources.d.ts.map +1 -1
- package/resources.mjs.map +1 -1
- package/src/client.ts +14 -1
- package/src/resources/index.ts +1 -0
- package/src/resources/v1/addons/addons.ts +849 -36
- package/src/resources/v1/addons/entitlements.ts +158 -10
- package/src/resources/v1/addons/index.ts +8 -0
- package/src/resources/v1/coupons.ts +154 -23
- package/src/resources/v1/credits/credits.ts +167 -23
- package/src/resources/v1/credits/custom-currencies.ts +188 -30
- package/src/resources/v1/credits/grants.ts +102 -24
- package/src/resources/v1/credits/index.ts +4 -0
- package/src/resources/v1/customers/customers.ts +333 -62
- package/src/resources/v1/customers/index.ts +8 -1
- package/src/resources/v1/customers/integrations.ts +137 -18
- package/src/resources/v1/customers/payment-method.ts +69 -10
- package/src/resources/v1/customers/promotional-entitlements.ts +82 -11
- package/src/resources/v1/events/beta/beta.ts +19 -0
- package/src/resources/v1/events/beta/customers.ts +212 -0
- package/src/resources/v1/events/beta/index.ts +8 -0
- package/src/resources/v1/events/beta.ts +3 -0
- package/src/resources/v1/events/data-export/data-export.ts +312 -0
- package/src/resources/v1/events/data-export/destinations.ts +290 -0
- package/src/resources/v1/events/data-export/index.ts +18 -0
- package/src/resources/v1/events/data-export.ts +3 -0
- package/src/resources/v1/events/events.ts +132 -0
- package/src/resources/v1/events/index.ts +13 -0
- package/src/resources/v1/events.ts +1 -75
- package/src/resources/v1/features.ts +204 -34
- package/src/resources/v1/index.ts +29 -1
- package/src/resources/v1/plans/entitlements.ts +158 -10
- package/src/resources/v1/plans/index.ts +11 -0
- package/src/resources/v1/plans/plans.ts +1440 -37
- package/src/resources/v1/products.ts +189 -27
- package/src/resources/v1/subscriptions/future-update.ts +68 -5
- package/src/resources/v1/subscriptions/index.ts +9 -2
- package/src/resources/v1/subscriptions/invoice.ts +36 -3
- package/src/resources/v1/subscriptions/subscriptions.ts +429 -86
- package/src/resources/v1/subscriptions/usage.ts +61 -5
- package/src/resources/v1/usage.ts +86 -5
- package/src/resources/v1/v1.ts +58 -2
- package/src/resources/v1-beta/customers/assignments.ts +331 -0
- package/src/resources/v1-beta/customers/customers.ts +71 -0
- package/src/resources/v1-beta/customers/entities.ts +492 -0
- package/src/resources/v1-beta/customers/entitlements.ts +366 -0
- package/src/resources/v1-beta/customers/index.ts +26 -0
- package/src/resources/v1-beta/customers.ts +3 -0
- package/src/resources/v1-beta/entity-types.ts +225 -0
- package/src/resources/v1-beta/index.ts +12 -0
- package/src/resources/v1-beta/v1-beta.ts +35 -0
- package/src/resources/v1-beta.ts +3 -0
- package/src/version.ts +1 -1
- package/uploads.d.mts +1 -0
- package/uploads.d.mts.map +1 -1
- package/uploads.d.ts +1 -0
- package/uploads.d.ts.map +1 -1
- package/uploads.mjs +1 -0
- package/uploads.mjs.map +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
|
@@ -2,13 +2,25 @@
|
|
|
2
2
|
|
|
3
3
|
import { APIResource } from '../../../core/resource';
|
|
4
4
|
import * as FutureUpdateAPI from './future-update';
|
|
5
|
-
import {
|
|
5
|
+
import {
|
|
6
|
+
CancelSubscription,
|
|
7
|
+
FutureUpdate as FutureUpdateAPIFutureUpdate,
|
|
8
|
+
FutureUpdateCancelPendingPaymentParams,
|
|
9
|
+
FutureUpdateCancelScheduleParams,
|
|
10
|
+
} from './future-update';
|
|
6
11
|
import * as InvoiceAPI from './invoice';
|
|
7
|
-
import { Invoice, InvoiceMarkAsPaidResponse } from './invoice';
|
|
12
|
+
import { Invoice, InvoiceMarkAsPaidParams, InvoiceMarkAsPaidResponse } from './invoice';
|
|
8
13
|
import * as UsageAPI from './usage';
|
|
9
|
-
import {
|
|
14
|
+
import {
|
|
15
|
+
Usage,
|
|
16
|
+
UsageChargeUsageParams,
|
|
17
|
+
UsageChargeUsageResponse,
|
|
18
|
+
UsageSyncParams,
|
|
19
|
+
UsageSyncResponse,
|
|
20
|
+
} from './usage';
|
|
10
21
|
import { APIPromise } from '../../../core/api-promise';
|
|
11
22
|
import { MyCursorIDPage, type MyCursorIDPageParams, PagePromise } from '../../../core/pagination';
|
|
23
|
+
import { buildHeaders } from '../../../internal/headers';
|
|
12
24
|
import { RequestOptions } from '../../../internal/request-options';
|
|
13
25
|
import { path } from '../../../internal/utils/path';
|
|
14
26
|
|
|
@@ -21,16 +33,41 @@ export class Subscriptions extends APIResource {
|
|
|
21
33
|
* Retrieves a subscription by its unique identifier, including plan details,
|
|
22
34
|
* billing period, status, and add-ons.
|
|
23
35
|
*/
|
|
24
|
-
retrieve(
|
|
25
|
-
|
|
36
|
+
retrieve(
|
|
37
|
+
id: string,
|
|
38
|
+
params: SubscriptionRetrieveParams | null | undefined = {},
|
|
39
|
+
options?: RequestOptions,
|
|
40
|
+
): APIPromise<Subscription> {
|
|
41
|
+
const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID } = params ?? {};
|
|
42
|
+
return this._client.get(path`/api/v1/subscriptions/${id}`, {
|
|
43
|
+
...options,
|
|
44
|
+
headers: buildHeaders([
|
|
45
|
+
{
|
|
46
|
+
...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
|
|
47
|
+
...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
|
|
48
|
+
},
|
|
49
|
+
options?.headers,
|
|
50
|
+
]),
|
|
51
|
+
});
|
|
26
52
|
}
|
|
27
53
|
|
|
28
54
|
/**
|
|
29
55
|
* Updates an active subscription's properties including billing period, add-ons,
|
|
30
56
|
* unit quantities, and discounts.
|
|
31
57
|
*/
|
|
32
|
-
update(id: string,
|
|
33
|
-
|
|
58
|
+
update(id: string, params: SubscriptionUpdateParams, options?: RequestOptions): APIPromise<Subscription> {
|
|
59
|
+
const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;
|
|
60
|
+
return this._client.patch(path`/api/v1/subscriptions/${id}`, {
|
|
61
|
+
body,
|
|
62
|
+
...options,
|
|
63
|
+
headers: buildHeaders([
|
|
64
|
+
{
|
|
65
|
+
...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
|
|
66
|
+
...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
|
|
67
|
+
},
|
|
68
|
+
options?.headers,
|
|
69
|
+
]),
|
|
70
|
+
});
|
|
34
71
|
}
|
|
35
72
|
|
|
36
73
|
/**
|
|
@@ -38,12 +75,20 @@ export class Subscriptions extends APIResource {
|
|
|
38
75
|
* status, and plan.
|
|
39
76
|
*/
|
|
40
77
|
list(
|
|
41
|
-
|
|
78
|
+
params: SubscriptionListParams | null | undefined = {},
|
|
42
79
|
options?: RequestOptions,
|
|
43
80
|
): PagePromise<SubscriptionListResponsesMyCursorIDPage, SubscriptionListResponse> {
|
|
81
|
+
const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...query } = params ?? {};
|
|
44
82
|
return this._client.getAPIList('/api/v1/subscriptions', MyCursorIDPage<SubscriptionListResponse>, {
|
|
45
83
|
query,
|
|
46
84
|
...options,
|
|
85
|
+
headers: buildHeaders([
|
|
86
|
+
{
|
|
87
|
+
...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
|
|
88
|
+
...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
|
|
89
|
+
},
|
|
90
|
+
options?.headers,
|
|
91
|
+
]),
|
|
47
92
|
});
|
|
48
93
|
}
|
|
49
94
|
|
|
@@ -51,32 +96,80 @@ export class Subscriptions extends APIResource {
|
|
|
51
96
|
* Cancels an active subscription, either immediately or at a specified time such
|
|
52
97
|
* as end of billing period.
|
|
53
98
|
*/
|
|
54
|
-
cancel(id: string,
|
|
55
|
-
|
|
99
|
+
cancel(id: string, params: SubscriptionCancelParams, options?: RequestOptions): APIPromise<Subscription> {
|
|
100
|
+
const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;
|
|
101
|
+
return this._client.post(path`/api/v1/subscriptions/${id}/cancel`, {
|
|
102
|
+
body,
|
|
103
|
+
...options,
|
|
104
|
+
headers: buildHeaders([
|
|
105
|
+
{
|
|
106
|
+
...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
|
|
107
|
+
...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
|
|
108
|
+
},
|
|
109
|
+
options?.headers,
|
|
110
|
+
]),
|
|
111
|
+
});
|
|
56
112
|
}
|
|
57
113
|
|
|
58
114
|
/**
|
|
59
115
|
* Delegates the payment responsibility of a subscription to a different customer.
|
|
60
116
|
* The delegated customer will be billed for this subscription.
|
|
61
117
|
*/
|
|
62
|
-
delegate(
|
|
63
|
-
|
|
118
|
+
delegate(
|
|
119
|
+
id: string,
|
|
120
|
+
params: SubscriptionDelegateParams,
|
|
121
|
+
options?: RequestOptions,
|
|
122
|
+
): APIPromise<Subscription> {
|
|
123
|
+
const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;
|
|
124
|
+
return this._client.post(path`/api/v1/subscriptions/${id}/delegate`, {
|
|
125
|
+
body,
|
|
126
|
+
...options,
|
|
127
|
+
headers: buildHeaders([
|
|
128
|
+
{
|
|
129
|
+
...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
|
|
130
|
+
...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
|
|
131
|
+
},
|
|
132
|
+
options?.headers,
|
|
133
|
+
]),
|
|
134
|
+
});
|
|
64
135
|
}
|
|
65
136
|
|
|
66
137
|
/**
|
|
67
138
|
* Imports multiple subscriptions in bulk. Used for migrating subscription data
|
|
68
139
|
* from external systems.
|
|
69
140
|
*/
|
|
70
|
-
import(
|
|
71
|
-
|
|
141
|
+
import(params: SubscriptionImportParams, options?: RequestOptions): APIPromise<SubscriptionImportResponse> {
|
|
142
|
+
const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;
|
|
143
|
+
return this._client.post('/api/v1/subscriptions/import', {
|
|
144
|
+
body,
|
|
145
|
+
...options,
|
|
146
|
+
headers: buildHeaders([
|
|
147
|
+
{
|
|
148
|
+
...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
|
|
149
|
+
...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
|
|
150
|
+
},
|
|
151
|
+
options?.headers,
|
|
152
|
+
]),
|
|
153
|
+
});
|
|
72
154
|
}
|
|
73
155
|
|
|
74
156
|
/**
|
|
75
157
|
* Migrates a subscription to the latest published version of its plan or add-ons.
|
|
76
158
|
* Handles prorated charges or credits automatically.
|
|
77
159
|
*/
|
|
78
|
-
migrate(id: string,
|
|
79
|
-
|
|
160
|
+
migrate(id: string, params: SubscriptionMigrateParams, options?: RequestOptions): APIPromise<Subscription> {
|
|
161
|
+
const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;
|
|
162
|
+
return this._client.post(path`/api/v1/subscriptions/${id}/migrate`, {
|
|
163
|
+
body,
|
|
164
|
+
...options,
|
|
165
|
+
headers: buildHeaders([
|
|
166
|
+
{
|
|
167
|
+
...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
|
|
168
|
+
...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
|
|
169
|
+
},
|
|
170
|
+
options?.headers,
|
|
171
|
+
]),
|
|
172
|
+
});
|
|
80
173
|
}
|
|
81
174
|
|
|
82
175
|
/**
|
|
@@ -84,10 +177,21 @@ export class Subscriptions extends APIResource {
|
|
|
84
177
|
* making changes. Returns estimated costs, taxes, and proration details.
|
|
85
178
|
*/
|
|
86
179
|
preview(
|
|
87
|
-
|
|
180
|
+
params: SubscriptionPreviewParams,
|
|
88
181
|
options?: RequestOptions,
|
|
89
182
|
): APIPromise<SubscriptionPreviewResponse> {
|
|
90
|
-
|
|
183
|
+
const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;
|
|
184
|
+
return this._client.post('/api/v1/subscriptions/preview', {
|
|
185
|
+
body,
|
|
186
|
+
...options,
|
|
187
|
+
headers: buildHeaders([
|
|
188
|
+
{
|
|
189
|
+
...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
|
|
190
|
+
...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
|
|
191
|
+
},
|
|
192
|
+
options?.headers,
|
|
193
|
+
]),
|
|
194
|
+
});
|
|
91
195
|
}
|
|
92
196
|
|
|
93
197
|
/**
|
|
@@ -95,18 +199,44 @@ export class Subscriptions extends APIResource {
|
|
|
95
199
|
* and no payment method exists, returns a checkout URL.
|
|
96
200
|
*/
|
|
97
201
|
provision(
|
|
98
|
-
|
|
202
|
+
params: SubscriptionProvisionParams,
|
|
99
203
|
options?: RequestOptions,
|
|
100
204
|
): APIPromise<SubscriptionProvisionResponse> {
|
|
101
|
-
|
|
205
|
+
const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;
|
|
206
|
+
return this._client.post('/api/v1/subscriptions', {
|
|
207
|
+
body,
|
|
208
|
+
...options,
|
|
209
|
+
headers: buildHeaders([
|
|
210
|
+
{
|
|
211
|
+
...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
|
|
212
|
+
...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
|
|
213
|
+
},
|
|
214
|
+
options?.headers,
|
|
215
|
+
]),
|
|
216
|
+
});
|
|
102
217
|
}
|
|
103
218
|
|
|
104
219
|
/**
|
|
105
220
|
* Transfers a subscription to a different resource ID. Used for multi-resource
|
|
106
221
|
* products where subscriptions apply to specific entities like websites or apps.
|
|
107
222
|
*/
|
|
108
|
-
transfer(
|
|
109
|
-
|
|
223
|
+
transfer(
|
|
224
|
+
id: string,
|
|
225
|
+
params: SubscriptionTransferParams,
|
|
226
|
+
options?: RequestOptions,
|
|
227
|
+
): APIPromise<Subscription> {
|
|
228
|
+
const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;
|
|
229
|
+
return this._client.post(path`/api/v1/subscriptions/${id}/transfer`, {
|
|
230
|
+
body,
|
|
231
|
+
...options,
|
|
232
|
+
headers: buildHeaders([
|
|
233
|
+
{
|
|
234
|
+
...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
|
|
235
|
+
...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
|
|
236
|
+
},
|
|
237
|
+
options?.headers,
|
|
238
|
+
]),
|
|
239
|
+
});
|
|
110
240
|
}
|
|
111
241
|
}
|
|
112
242
|
|
|
@@ -3883,51 +4013,119 @@ export namespace SubscriptionProvisionResponse {
|
|
|
3883
4013
|
}
|
|
3884
4014
|
}
|
|
3885
4015
|
|
|
4016
|
+
export interface SubscriptionRetrieveParams {
|
|
4017
|
+
/**
|
|
4018
|
+
* Account ID — optional when authenticating with a user JWT (Bearer token); falls
|
|
4019
|
+
* back to the user's first membership. Ignored for API-key auth.
|
|
4020
|
+
*/
|
|
4021
|
+
'X-ACCOUNT-ID'?: string;
|
|
4022
|
+
|
|
4023
|
+
/**
|
|
4024
|
+
* Environment ID — required when authenticating with a user JWT (Bearer token) on
|
|
4025
|
+
* environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the
|
|
4026
|
+
* key).
|
|
4027
|
+
*/
|
|
4028
|
+
'X-ENVIRONMENT-ID'?: string;
|
|
4029
|
+
}
|
|
4030
|
+
|
|
3886
4031
|
export interface SubscriptionUpdateParams {
|
|
4032
|
+
/**
|
|
4033
|
+
* Body param
|
|
4034
|
+
*/
|
|
3887
4035
|
addons?: Array<SubscriptionUpdateParams.Addon>;
|
|
3888
4036
|
|
|
4037
|
+
/**
|
|
4038
|
+
* Body param
|
|
4039
|
+
*/
|
|
3889
4040
|
appliedCoupon?: SubscriptionUpdateParams.AppliedCoupon;
|
|
3890
4041
|
|
|
3891
4042
|
/**
|
|
3892
|
-
* Await payment confirmation
|
|
4043
|
+
* Body param: Await payment confirmation
|
|
3893
4044
|
*/
|
|
3894
4045
|
awaitPaymentConfirmation?: boolean;
|
|
3895
4046
|
|
|
4047
|
+
/**
|
|
4048
|
+
* Body param
|
|
4049
|
+
*/
|
|
3896
4050
|
billingCycleAnchor?: 'UNCHANGED' | 'NOW';
|
|
3897
4051
|
|
|
4052
|
+
/**
|
|
4053
|
+
* Body param
|
|
4054
|
+
*/
|
|
3898
4055
|
billingInformation?: SubscriptionUpdateParams.BillingInformation;
|
|
3899
4056
|
|
|
4057
|
+
/**
|
|
4058
|
+
* Body param
|
|
4059
|
+
*/
|
|
3900
4060
|
billingPeriod?: 'MONTHLY' | 'ANNUALLY';
|
|
3901
4061
|
|
|
4062
|
+
/**
|
|
4063
|
+
* Body param
|
|
4064
|
+
*/
|
|
3902
4065
|
budget?: SubscriptionUpdateParams.Budget | null;
|
|
3903
4066
|
|
|
4067
|
+
/**
|
|
4068
|
+
* Body param: Subscription cancellation date
|
|
4069
|
+
*/
|
|
4070
|
+
cancellationDate?: string | null;
|
|
4071
|
+
|
|
4072
|
+
/**
|
|
4073
|
+
* Body param
|
|
4074
|
+
*/
|
|
3904
4075
|
charges?: Array<SubscriptionUpdateParams.Charge>;
|
|
3905
4076
|
|
|
4077
|
+
/**
|
|
4078
|
+
* Body param
|
|
4079
|
+
*/
|
|
3906
4080
|
entitlements?: Array<SubscriptionUpdateParams.Feature | SubscriptionUpdateParams.Credit>;
|
|
3907
4081
|
|
|
3908
4082
|
/**
|
|
3909
|
-
* Additional metadata for the subscription
|
|
4083
|
+
* Body param: Additional metadata for the subscription
|
|
3910
4084
|
*/
|
|
3911
4085
|
metadata?: { [key: string]: string };
|
|
3912
4086
|
|
|
3913
4087
|
/**
|
|
3914
|
-
* Minimum spend amount
|
|
4088
|
+
* Body param: Minimum spend amount
|
|
3915
4089
|
*/
|
|
3916
4090
|
minimumSpend?: SubscriptionUpdateParams.MinimumSpend | null;
|
|
3917
4091
|
|
|
4092
|
+
/**
|
|
4093
|
+
* Body param
|
|
4094
|
+
*/
|
|
3918
4095
|
priceOverrides?: Array<SubscriptionUpdateParams.PriceOverride>;
|
|
3919
4096
|
|
|
3920
4097
|
/**
|
|
3921
|
-
* Promotion code
|
|
4098
|
+
* Body param: Promotion code
|
|
3922
4099
|
*/
|
|
3923
4100
|
promotionCode?: string;
|
|
3924
4101
|
|
|
4102
|
+
/**
|
|
4103
|
+
* Body param: Salesforce ID
|
|
4104
|
+
*/
|
|
4105
|
+
salesforceId?: string | null;
|
|
4106
|
+
|
|
4107
|
+
/**
|
|
4108
|
+
* Body param
|
|
4109
|
+
*/
|
|
3925
4110
|
scheduleStrategy?: 'END_OF_BILLING_PERIOD' | 'END_OF_BILLING_MONTH' | 'IMMEDIATE';
|
|
3926
4111
|
|
|
3927
4112
|
/**
|
|
3928
|
-
* Subscription trial end date
|
|
4113
|
+
* Body param: Subscription trial end date
|
|
3929
4114
|
*/
|
|
3930
4115
|
trialEndDate?: string;
|
|
4116
|
+
|
|
4117
|
+
/**
|
|
4118
|
+
* Header param: Account ID — optional when authenticating with a user JWT (Bearer
|
|
4119
|
+
* token); falls back to the user's first membership. Ignored for API-key auth.
|
|
4120
|
+
*/
|
|
4121
|
+
'X-ACCOUNT-ID'?: string;
|
|
4122
|
+
|
|
4123
|
+
/**
|
|
4124
|
+
* Header param: Environment ID — required when authenticating with a user JWT
|
|
4125
|
+
* (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is
|
|
4126
|
+
* intrinsic to the key).
|
|
4127
|
+
*/
|
|
4128
|
+
'X-ENVIRONMENT-ID'?: string;
|
|
3931
4129
|
}
|
|
3932
4130
|
|
|
3933
4131
|
export namespace SubscriptionUpdateParams {
|
|
@@ -4610,35 +4808,49 @@ export namespace SubscriptionUpdateParams {
|
|
|
4610
4808
|
|
|
4611
4809
|
export interface SubscriptionListParams extends MyCursorIDPageParams {
|
|
4612
4810
|
/**
|
|
4613
|
-
* Filter by creation date using range operators: gt, gte, lt, lte
|
|
4811
|
+
* Query param: Filter by creation date using range operators: gt, gte, lt, lte
|
|
4614
4812
|
*/
|
|
4615
4813
|
createdAt?: SubscriptionListParams.CreatedAt;
|
|
4616
4814
|
|
|
4617
4815
|
/**
|
|
4618
|
-
* Filter by customer ID
|
|
4816
|
+
* Query param: Filter by customer ID
|
|
4619
4817
|
*/
|
|
4620
4818
|
customerId?: string;
|
|
4621
4819
|
|
|
4622
4820
|
/**
|
|
4623
|
-
* Filter by plan ID
|
|
4821
|
+
* Query param: Filter by plan ID
|
|
4624
4822
|
*/
|
|
4625
4823
|
planId?: string;
|
|
4626
4824
|
|
|
4627
4825
|
/**
|
|
4628
|
-
* Filter by pricing type. Supports comma-separated values for
|
|
4826
|
+
* Query param: Filter by pricing type. Supports comma-separated values for
|
|
4827
|
+
* multiple types
|
|
4629
4828
|
*/
|
|
4630
4829
|
pricingType?: Array<'FREE' | 'PAID' | 'CUSTOM'>;
|
|
4631
4830
|
|
|
4632
4831
|
/**
|
|
4633
|
-
* Filter by resource ID
|
|
4832
|
+
* Query param: Filter by resource ID
|
|
4634
4833
|
*/
|
|
4635
4834
|
resourceId?: string;
|
|
4636
4835
|
|
|
4637
4836
|
/**
|
|
4638
|
-
* Filter by subscription status. Supports comma-separated values for
|
|
4639
|
-
* statuses
|
|
4837
|
+
* Query param: Filter by subscription status. Supports comma-separated values for
|
|
4838
|
+
* multiple statuses
|
|
4640
4839
|
*/
|
|
4641
4840
|
status?: Array<'PAYMENT_PENDING' | 'ACTIVE' | 'EXPIRED' | 'IN_TRIAL' | 'CANCELED' | 'NOT_STARTED'>;
|
|
4841
|
+
|
|
4842
|
+
/**
|
|
4843
|
+
* Header param: Account ID — optional when authenticating with a user JWT (Bearer
|
|
4844
|
+
* token); falls back to the user's first membership. Ignored for API-key auth.
|
|
4845
|
+
*/
|
|
4846
|
+
'X-ACCOUNT-ID'?: string;
|
|
4847
|
+
|
|
4848
|
+
/**
|
|
4849
|
+
* Header param: Environment ID — required when authenticating with a user JWT
|
|
4850
|
+
* (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is
|
|
4851
|
+
* intrinsic to the key).
|
|
4852
|
+
*/
|
|
4853
|
+
'X-ENVIRONMENT-ID'?: string;
|
|
4642
4854
|
}
|
|
4643
4855
|
|
|
4644
4856
|
export namespace SubscriptionListParams {
|
|
@@ -4670,45 +4882,86 @@ export namespace SubscriptionListParams {
|
|
|
4670
4882
|
|
|
4671
4883
|
export interface SubscriptionCancelParams {
|
|
4672
4884
|
/**
|
|
4673
|
-
* Action on cancellation (downgrade or revoke)
|
|
4885
|
+
* Body param: Action on cancellation (downgrade or revoke)
|
|
4674
4886
|
*/
|
|
4675
4887
|
cancellationAction?: 'DEFAULT' | 'REVOKE_ENTITLEMENTS';
|
|
4676
4888
|
|
|
4677
4889
|
/**
|
|
4678
|
-
* When to cancel (immediate, period end, or date)
|
|
4890
|
+
* Body param: When to cancel (immediate, period end, or date)
|
|
4679
4891
|
*/
|
|
4680
4892
|
cancellationTime?: 'END_OF_BILLING_PERIOD' | 'IMMEDIATE' | 'SPECIFIC_DATE';
|
|
4681
4893
|
|
|
4682
4894
|
/**
|
|
4683
|
-
* Subscription end date
|
|
4895
|
+
* Body param: Subscription end date
|
|
4684
4896
|
*/
|
|
4685
4897
|
endDate?: string;
|
|
4686
4898
|
|
|
4687
4899
|
/**
|
|
4688
|
-
* If set, enables or disables prorating of credits on subscription
|
|
4900
|
+
* Body param: If set, enables or disables prorating of credits on subscription
|
|
4901
|
+
* cancellation.
|
|
4689
4902
|
*/
|
|
4690
4903
|
prorate?: boolean;
|
|
4904
|
+
|
|
4905
|
+
/**
|
|
4906
|
+
* Header param: Account ID — optional when authenticating with a user JWT (Bearer
|
|
4907
|
+
* token); falls back to the user's first membership. Ignored for API-key auth.
|
|
4908
|
+
*/
|
|
4909
|
+
'X-ACCOUNT-ID'?: string;
|
|
4910
|
+
|
|
4911
|
+
/**
|
|
4912
|
+
* Header param: Environment ID — required when authenticating with a user JWT
|
|
4913
|
+
* (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is
|
|
4914
|
+
* intrinsic to the key).
|
|
4915
|
+
*/
|
|
4916
|
+
'X-ENVIRONMENT-ID'?: string;
|
|
4691
4917
|
}
|
|
4692
4918
|
|
|
4693
4919
|
export interface SubscriptionDelegateParams {
|
|
4694
4920
|
/**
|
|
4695
|
-
* The unique identifier of the customer who will assume payment
|
|
4696
|
-
* this subscription. This customer must already exist in your
|
|
4697
|
-
* have a valid payment method if the subscription requires
|
|
4921
|
+
* Body param: The unique identifier of the customer who will assume payment
|
|
4922
|
+
* responsibility for this subscription. This customer must already exist in your
|
|
4923
|
+
* Stigg account and have a valid payment method if the subscription requires
|
|
4924
|
+
* payment.
|
|
4698
4925
|
*/
|
|
4699
4926
|
targetCustomerId: string;
|
|
4927
|
+
|
|
4928
|
+
/**
|
|
4929
|
+
* Header param: Account ID — optional when authenticating with a user JWT (Bearer
|
|
4930
|
+
* token); falls back to the user's first membership. Ignored for API-key auth.
|
|
4931
|
+
*/
|
|
4932
|
+
'X-ACCOUNT-ID'?: string;
|
|
4933
|
+
|
|
4934
|
+
/**
|
|
4935
|
+
* Header param: Environment ID — required when authenticating with a user JWT
|
|
4936
|
+
* (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is
|
|
4937
|
+
* intrinsic to the key).
|
|
4938
|
+
*/
|
|
4939
|
+
'X-ENVIRONMENT-ID'?: string;
|
|
4700
4940
|
}
|
|
4701
4941
|
|
|
4702
4942
|
export interface SubscriptionImportParams {
|
|
4703
4943
|
/**
|
|
4704
|
-
* List of subscription objects to import
|
|
4944
|
+
* Body param: List of subscription objects to import
|
|
4705
4945
|
*/
|
|
4706
4946
|
subscriptions: Array<SubscriptionImportParams.Subscription>;
|
|
4707
4947
|
|
|
4708
4948
|
/**
|
|
4709
|
-
* Integration ID to use for importing subscriptions
|
|
4949
|
+
* Body param: Integration ID to use for importing subscriptions
|
|
4710
4950
|
*/
|
|
4711
4951
|
integrationId?: string | null;
|
|
4952
|
+
|
|
4953
|
+
/**
|
|
4954
|
+
* Header param: Account ID — optional when authenticating with a user JWT (Bearer
|
|
4955
|
+
* token); falls back to the user's first membership. Ignored for API-key auth.
|
|
4956
|
+
*/
|
|
4957
|
+
'X-ACCOUNT-ID'?: string;
|
|
4958
|
+
|
|
4959
|
+
/**
|
|
4960
|
+
* Header param: Environment ID — required when authenticating with a user JWT
|
|
4961
|
+
* (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is
|
|
4962
|
+
* intrinsic to the key).
|
|
4963
|
+
*/
|
|
4964
|
+
'X-ENVIRONMENT-ID'?: string;
|
|
4712
4965
|
}
|
|
4713
4966
|
|
|
4714
4967
|
export namespace SubscriptionImportParams {
|
|
@@ -4780,7 +5033,8 @@ export namespace SubscriptionImportParams {
|
|
|
4780
5033
|
}
|
|
4781
5034
|
|
|
4782
5035
|
/**
|
|
4783
|
-
*
|
|
5036
|
+
* A charge selection for a subscription (references a catalog charge with a
|
|
5037
|
+
* quantity).
|
|
4784
5038
|
*/
|
|
4785
5039
|
export interface Charge {
|
|
4786
5040
|
/**
|
|
@@ -4803,91 +5057,117 @@ export namespace SubscriptionImportParams {
|
|
|
4803
5057
|
|
|
4804
5058
|
export interface SubscriptionMigrateParams {
|
|
4805
5059
|
/**
|
|
4806
|
-
* When to migrate (immediate or period end)
|
|
5060
|
+
* Body param: When to migrate (immediate or period end)
|
|
4807
5061
|
*/
|
|
4808
5062
|
subscriptionMigrationTime?: 'END_OF_BILLING_PERIOD' | 'IMMEDIATE';
|
|
5063
|
+
|
|
5064
|
+
/**
|
|
5065
|
+
* Header param: Account ID — optional when authenticating with a user JWT (Bearer
|
|
5066
|
+
* token); falls back to the user's first membership. Ignored for API-key auth.
|
|
5067
|
+
*/
|
|
5068
|
+
'X-ACCOUNT-ID'?: string;
|
|
5069
|
+
|
|
5070
|
+
/**
|
|
5071
|
+
* Header param: Environment ID — required when authenticating with a user JWT
|
|
5072
|
+
* (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is
|
|
5073
|
+
* intrinsic to the key).
|
|
5074
|
+
*/
|
|
5075
|
+
'X-ENVIRONMENT-ID'?: string;
|
|
4809
5076
|
}
|
|
4810
5077
|
|
|
4811
5078
|
export interface SubscriptionPreviewParams {
|
|
4812
5079
|
/**
|
|
4813
|
-
* Customer ID
|
|
5080
|
+
* Body param: Customer ID
|
|
4814
5081
|
*/
|
|
4815
5082
|
customerId: string;
|
|
4816
5083
|
|
|
4817
5084
|
/**
|
|
4818
|
-
* Plan ID
|
|
5085
|
+
* Body param: Plan ID
|
|
4819
5086
|
*/
|
|
4820
5087
|
planId: string;
|
|
4821
5088
|
|
|
4822
5089
|
/**
|
|
4823
|
-
* Addons to include
|
|
5090
|
+
* Body param: Addons to include
|
|
4824
5091
|
*/
|
|
4825
5092
|
addons?: Array<SubscriptionPreviewParams.Addon>;
|
|
4826
5093
|
|
|
4827
5094
|
/**
|
|
4828
|
-
* Coupon or discount to apply
|
|
5095
|
+
* Body param: Coupon or discount to apply
|
|
4829
5096
|
*/
|
|
4830
5097
|
appliedCoupon?: SubscriptionPreviewParams.AppliedCoupon;
|
|
4831
5098
|
|
|
4832
5099
|
/**
|
|
4833
|
-
* Billable features with quantities
|
|
5100
|
+
* Body param: Billable features with quantities
|
|
4834
5101
|
*/
|
|
4835
5102
|
billableFeatures?: Array<SubscriptionPreviewParams.BillableFeature>;
|
|
4836
5103
|
|
|
4837
5104
|
/**
|
|
4838
|
-
* ISO 3166-1 country code for localization
|
|
5105
|
+
* Body param: ISO 3166-1 country code for localization
|
|
4839
5106
|
*/
|
|
4840
5107
|
billingCountryCode?: string;
|
|
4841
5108
|
|
|
4842
5109
|
/**
|
|
4843
|
-
* Billing cycle anchor behavior for the subscription
|
|
5110
|
+
* Body param: Billing cycle anchor behavior for the subscription
|
|
4844
5111
|
*/
|
|
4845
5112
|
billingCycleAnchor?: 'UNCHANGED' | 'NOW';
|
|
4846
5113
|
|
|
4847
5114
|
/**
|
|
4848
|
-
* Billing and tax configuration
|
|
5115
|
+
* Body param: Billing and tax configuration
|
|
4849
5116
|
*/
|
|
4850
5117
|
billingInformation?: SubscriptionPreviewParams.BillingInformation;
|
|
4851
5118
|
|
|
4852
5119
|
/**
|
|
4853
|
-
* Billing period (MONTHLY or ANNUALLY)
|
|
5120
|
+
* Body param: Billing period (MONTHLY or ANNUALLY)
|
|
4854
5121
|
*/
|
|
4855
5122
|
billingPeriod?: 'MONTHLY' | 'ANNUALLY';
|
|
4856
5123
|
|
|
4857
5124
|
/**
|
|
4858
|
-
* One-time or recurring charges
|
|
5125
|
+
* Body param: One-time or recurring charges
|
|
4859
5126
|
*/
|
|
4860
5127
|
charges?: Array<SubscriptionPreviewParams.Charge>;
|
|
4861
5128
|
|
|
4862
5129
|
/**
|
|
4863
|
-
* Paying customer ID for delegated billing
|
|
5130
|
+
* Body param: Paying customer ID for delegated billing
|
|
4864
5131
|
*/
|
|
4865
5132
|
payingCustomerId?: string;
|
|
4866
5133
|
|
|
4867
5134
|
/**
|
|
4868
|
-
* Resource ID for multi-instance subscriptions
|
|
5135
|
+
* Body param: Resource ID for multi-instance subscriptions
|
|
4869
5136
|
*/
|
|
4870
5137
|
resourceId?: string;
|
|
4871
5138
|
|
|
4872
5139
|
/**
|
|
4873
|
-
* When to apply subscription changes
|
|
5140
|
+
* Body param: When to apply subscription changes
|
|
4874
5141
|
*/
|
|
4875
5142
|
scheduleStrategy?: 'END_OF_BILLING_PERIOD' | 'END_OF_BILLING_MONTH' | 'IMMEDIATE';
|
|
4876
5143
|
|
|
4877
5144
|
/**
|
|
4878
|
-
* Subscription start date
|
|
5145
|
+
* Body param: Subscription start date
|
|
4879
5146
|
*/
|
|
4880
5147
|
startDate?: string;
|
|
4881
5148
|
|
|
4882
5149
|
/**
|
|
4883
|
-
* Trial period override settings
|
|
5150
|
+
* Body param: Trial period override settings
|
|
4884
5151
|
*/
|
|
4885
5152
|
trialOverrideConfiguration?: SubscriptionPreviewParams.TrialOverrideConfiguration;
|
|
4886
5153
|
|
|
4887
5154
|
/**
|
|
4888
|
-
* Unit quantity for per-unit pricing. Minimum is 0 (zero is allowed).
|
|
5155
|
+
* Body param: Unit quantity for per-unit pricing. Minimum is 0 (zero is allowed).
|
|
4889
5156
|
*/
|
|
4890
5157
|
unitQuantity?: number;
|
|
5158
|
+
|
|
5159
|
+
/**
|
|
5160
|
+
* Header param: Account ID — optional when authenticating with a user JWT (Bearer
|
|
5161
|
+
* token); falls back to the user's first membership. Ignored for API-key auth.
|
|
5162
|
+
*/
|
|
5163
|
+
'X-ACCOUNT-ID'?: string;
|
|
5164
|
+
|
|
5165
|
+
/**
|
|
5166
|
+
* Header param: Environment ID — required when authenticating with a user JWT
|
|
5167
|
+
* (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is
|
|
5168
|
+
* intrinsic to the key).
|
|
5169
|
+
*/
|
|
5170
|
+
'X-ENVIRONMENT-ID'?: string;
|
|
4891
5171
|
}
|
|
4892
5172
|
|
|
4893
5173
|
export namespace SubscriptionPreviewParams {
|
|
@@ -5218,7 +5498,8 @@ export namespace SubscriptionPreviewParams {
|
|
|
5218
5498
|
}
|
|
5219
5499
|
|
|
5220
5500
|
/**
|
|
5221
|
-
*
|
|
5501
|
+
* A charge selection for a subscription (references a catalog charge with a
|
|
5502
|
+
* quantity).
|
|
5222
5503
|
*/
|
|
5223
5504
|
export interface Charge {
|
|
5224
5505
|
/**
|
|
@@ -5260,116 +5541,153 @@ export namespace SubscriptionPreviewParams {
|
|
|
5260
5541
|
|
|
5261
5542
|
export interface SubscriptionProvisionParams {
|
|
5262
5543
|
/**
|
|
5263
|
-
* Customer ID to provision the subscription for
|
|
5544
|
+
* Body param: Customer ID to provision the subscription for
|
|
5264
5545
|
*/
|
|
5265
5546
|
customerId: string;
|
|
5266
5547
|
|
|
5267
5548
|
/**
|
|
5268
|
-
* Plan ID to provision
|
|
5549
|
+
* Body param: Plan ID to provision
|
|
5269
5550
|
*/
|
|
5270
5551
|
planId: string;
|
|
5271
5552
|
|
|
5272
5553
|
/**
|
|
5273
|
-
* Unique identifier for the subscription
|
|
5554
|
+
* Body param: Unique identifier for the subscription
|
|
5274
5555
|
*/
|
|
5275
5556
|
id?: string;
|
|
5276
5557
|
|
|
5558
|
+
/**
|
|
5559
|
+
* Body param
|
|
5560
|
+
*/
|
|
5277
5561
|
addons?: Array<SubscriptionProvisionParams.Addon>;
|
|
5278
5562
|
|
|
5279
5563
|
/**
|
|
5280
|
-
* Coupon configuration
|
|
5564
|
+
* Body param: Coupon configuration
|
|
5281
5565
|
*/
|
|
5282
5566
|
appliedCoupon?: SubscriptionProvisionParams.AppliedCoupon;
|
|
5283
5567
|
|
|
5284
5568
|
/**
|
|
5285
|
-
* Whether to wait for payment confirmation before returning the
|
|
5569
|
+
* Body param: Whether to wait for payment confirmation before returning the
|
|
5570
|
+
* subscription
|
|
5286
5571
|
*/
|
|
5287
5572
|
awaitPaymentConfirmation?: boolean;
|
|
5288
5573
|
|
|
5289
5574
|
/**
|
|
5290
|
-
* The ISO 3166-1 alpha-2 country code for billing
|
|
5575
|
+
* Body param: The ISO 3166-1 alpha-2 country code for billing
|
|
5291
5576
|
*/
|
|
5292
5577
|
billingCountryCode?: string | null;
|
|
5293
5578
|
|
|
5294
5579
|
/**
|
|
5295
|
-
* Billing cycle anchor behavior for the subscription
|
|
5580
|
+
* Body param: Billing cycle anchor behavior for the subscription
|
|
5296
5581
|
*/
|
|
5297
5582
|
billingCycleAnchor?: 'UNCHANGED' | 'NOW';
|
|
5298
5583
|
|
|
5299
5584
|
/**
|
|
5300
|
-
* External billing system identifier
|
|
5585
|
+
* Body param: External billing system identifier
|
|
5301
5586
|
*/
|
|
5302
5587
|
billingId?: string | null;
|
|
5303
5588
|
|
|
5589
|
+
/**
|
|
5590
|
+
* Body param
|
|
5591
|
+
*/
|
|
5304
5592
|
billingInformation?: SubscriptionProvisionParams.BillingInformation;
|
|
5305
5593
|
|
|
5306
5594
|
/**
|
|
5307
|
-
* Billing period (MONTHLY or ANNUALLY)
|
|
5595
|
+
* Body param: Billing period (MONTHLY or ANNUALLY)
|
|
5308
5596
|
*/
|
|
5309
5597
|
billingPeriod?: 'MONTHLY' | 'ANNUALLY';
|
|
5310
5598
|
|
|
5599
|
+
/**
|
|
5600
|
+
* Body param
|
|
5601
|
+
*/
|
|
5311
5602
|
budget?: SubscriptionProvisionParams.Budget | null;
|
|
5312
5603
|
|
|
5604
|
+
/**
|
|
5605
|
+
* Body param: Subscription cancellation date
|
|
5606
|
+
*/
|
|
5607
|
+
cancellationDate?: string;
|
|
5608
|
+
|
|
5609
|
+
/**
|
|
5610
|
+
* Body param
|
|
5611
|
+
*/
|
|
5313
5612
|
charges?: Array<SubscriptionProvisionParams.Charge>;
|
|
5314
5613
|
|
|
5315
5614
|
/**
|
|
5316
|
-
* Checkout page configuration for payment collection
|
|
5615
|
+
* Body param: Checkout page configuration for payment collection
|
|
5317
5616
|
*/
|
|
5318
5617
|
checkoutOptions?: SubscriptionProvisionParams.CheckoutOptions;
|
|
5319
5618
|
|
|
5619
|
+
/**
|
|
5620
|
+
* Body param
|
|
5621
|
+
*/
|
|
5320
5622
|
entitlements?: Array<SubscriptionProvisionParams.Feature | SubscriptionProvisionParams.Credit>;
|
|
5321
5623
|
|
|
5322
5624
|
/**
|
|
5323
|
-
* Additional metadata for the subscription
|
|
5625
|
+
* Body param: Additional metadata for the subscription
|
|
5324
5626
|
*/
|
|
5325
5627
|
metadata?: { [key: string]: string };
|
|
5326
5628
|
|
|
5327
5629
|
/**
|
|
5328
|
-
* Minimum spend amount
|
|
5630
|
+
* Body param: Minimum spend amount
|
|
5329
5631
|
*/
|
|
5330
5632
|
minimumSpend?: SubscriptionProvisionParams.MinimumSpend | null;
|
|
5331
5633
|
|
|
5332
5634
|
/**
|
|
5333
|
-
* Optional paying customer ID for split billing scenarios
|
|
5635
|
+
* Body param: Optional paying customer ID for split billing scenarios
|
|
5334
5636
|
*/
|
|
5335
5637
|
payingCustomerId?: string | null;
|
|
5336
5638
|
|
|
5337
5639
|
/**
|
|
5338
|
-
* How payments should be collected for this subscription
|
|
5640
|
+
* Body param: How payments should be collected for this subscription
|
|
5339
5641
|
*/
|
|
5340
5642
|
paymentCollectionMethod?: 'CHARGE' | 'INVOICE' | 'NONE';
|
|
5341
5643
|
|
|
5644
|
+
/**
|
|
5645
|
+
* Body param
|
|
5646
|
+
*/
|
|
5342
5647
|
priceOverrides?: Array<SubscriptionProvisionParams.PriceOverride>;
|
|
5343
5648
|
|
|
5344
5649
|
/**
|
|
5345
|
-
* Optional resource ID for multi-instance subscriptions
|
|
5650
|
+
* Body param: Optional resource ID for multi-instance subscriptions
|
|
5346
5651
|
*/
|
|
5347
5652
|
resourceId?: string | null;
|
|
5348
5653
|
|
|
5349
5654
|
/**
|
|
5350
|
-
* Salesforce ID
|
|
5655
|
+
* Body param: Salesforce ID
|
|
5351
5656
|
*/
|
|
5352
5657
|
salesforceId?: string | null;
|
|
5353
5658
|
|
|
5354
5659
|
/**
|
|
5355
|
-
* Strategy for scheduling subscription changes
|
|
5660
|
+
* Body param: Strategy for scheduling subscription changes
|
|
5356
5661
|
*/
|
|
5357
5662
|
scheduleStrategy?: 'END_OF_BILLING_PERIOD' | 'END_OF_BILLING_MONTH' | 'IMMEDIATE';
|
|
5358
5663
|
|
|
5359
5664
|
/**
|
|
5360
|
-
* Subscription start date
|
|
5665
|
+
* Body param: Subscription start date
|
|
5361
5666
|
*/
|
|
5362
5667
|
startDate?: string;
|
|
5363
5668
|
|
|
5364
5669
|
/**
|
|
5365
|
-
* Trial period override settings
|
|
5670
|
+
* Body param: Trial period override settings
|
|
5366
5671
|
*/
|
|
5367
5672
|
trialOverrideConfiguration?: SubscriptionProvisionParams.TrialOverrideConfiguration;
|
|
5368
5673
|
|
|
5369
5674
|
/**
|
|
5370
|
-
* Unit quantity for per-unit pricing. Minimum is 0 (zero is allowed).
|
|
5675
|
+
* Body param: Unit quantity for per-unit pricing. Minimum is 0 (zero is allowed).
|
|
5371
5676
|
*/
|
|
5372
5677
|
unitQuantity?: number;
|
|
5678
|
+
|
|
5679
|
+
/**
|
|
5680
|
+
* Header param: Account ID — optional when authenticating with a user JWT (Bearer
|
|
5681
|
+
* token); falls back to the user's first membership. Ignored for API-key auth.
|
|
5682
|
+
*/
|
|
5683
|
+
'X-ACCOUNT-ID'?: string;
|
|
5684
|
+
|
|
5685
|
+
/**
|
|
5686
|
+
* Header param: Environment ID — required when authenticating with a user JWT
|
|
5687
|
+
* (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is
|
|
5688
|
+
* intrinsic to the key).
|
|
5689
|
+
*/
|
|
5690
|
+
'X-ENVIRONMENT-ID'?: string;
|
|
5373
5691
|
}
|
|
5374
5692
|
|
|
5375
5693
|
export namespace SubscriptionProvisionParams {
|
|
@@ -5694,7 +6012,8 @@ export namespace SubscriptionProvisionParams {
|
|
|
5694
6012
|
}
|
|
5695
6013
|
|
|
5696
6014
|
/**
|
|
5697
|
-
*
|
|
6015
|
+
* A charge selection for a subscription (references a catalog charge with a
|
|
6016
|
+
* quantity).
|
|
5698
6017
|
*/
|
|
5699
6018
|
export interface Charge {
|
|
5700
6019
|
/**
|
|
@@ -6484,9 +6803,22 @@ export namespace SubscriptionProvisionParams {
|
|
|
6484
6803
|
|
|
6485
6804
|
export interface SubscriptionTransferParams {
|
|
6486
6805
|
/**
|
|
6487
|
-
* Resource ID to transfer the subscription to
|
|
6806
|
+
* Body param: Resource ID to transfer the subscription to
|
|
6488
6807
|
*/
|
|
6489
6808
|
destinationResourceId: string;
|
|
6809
|
+
|
|
6810
|
+
/**
|
|
6811
|
+
* Header param: Account ID — optional when authenticating with a user JWT (Bearer
|
|
6812
|
+
* token); falls back to the user's first membership. Ignored for API-key auth.
|
|
6813
|
+
*/
|
|
6814
|
+
'X-ACCOUNT-ID'?: string;
|
|
6815
|
+
|
|
6816
|
+
/**
|
|
6817
|
+
* Header param: Environment ID — required when authenticating with a user JWT
|
|
6818
|
+
* (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is
|
|
6819
|
+
* intrinsic to the key).
|
|
6820
|
+
*/
|
|
6821
|
+
'X-ENVIRONMENT-ID'?: string;
|
|
6490
6822
|
}
|
|
6491
6823
|
|
|
6492
6824
|
Subscriptions.FutureUpdate = FutureUpdateAPIFutureUpdate;
|
|
@@ -6501,6 +6833,7 @@ export declare namespace Subscriptions {
|
|
|
6501
6833
|
type SubscriptionPreviewResponse as SubscriptionPreviewResponse,
|
|
6502
6834
|
type SubscriptionProvisionResponse as SubscriptionProvisionResponse,
|
|
6503
6835
|
type SubscriptionListResponsesMyCursorIDPage as SubscriptionListResponsesMyCursorIDPage,
|
|
6836
|
+
type SubscriptionRetrieveParams as SubscriptionRetrieveParams,
|
|
6504
6837
|
type SubscriptionUpdateParams as SubscriptionUpdateParams,
|
|
6505
6838
|
type SubscriptionListParams as SubscriptionListParams,
|
|
6506
6839
|
type SubscriptionCancelParams as SubscriptionCancelParams,
|
|
@@ -6512,14 +6845,24 @@ export declare namespace Subscriptions {
|
|
|
6512
6845
|
type SubscriptionTransferParams as SubscriptionTransferParams,
|
|
6513
6846
|
};
|
|
6514
6847
|
|
|
6515
|
-
export {
|
|
6848
|
+
export {
|
|
6849
|
+
FutureUpdateAPIFutureUpdate as FutureUpdate,
|
|
6850
|
+
type CancelSubscription as CancelSubscription,
|
|
6851
|
+
type FutureUpdateCancelPendingPaymentParams as FutureUpdateCancelPendingPaymentParams,
|
|
6852
|
+
type FutureUpdateCancelScheduleParams as FutureUpdateCancelScheduleParams,
|
|
6853
|
+
};
|
|
6516
6854
|
|
|
6517
6855
|
export {
|
|
6518
6856
|
Usage as Usage,
|
|
6519
6857
|
type UsageChargeUsageResponse as UsageChargeUsageResponse,
|
|
6520
6858
|
type UsageSyncResponse as UsageSyncResponse,
|
|
6521
6859
|
type UsageChargeUsageParams as UsageChargeUsageParams,
|
|
6860
|
+
type UsageSyncParams as UsageSyncParams,
|
|
6522
6861
|
};
|
|
6523
6862
|
|
|
6524
|
-
export {
|
|
6863
|
+
export {
|
|
6864
|
+
Invoice as Invoice,
|
|
6865
|
+
type InvoiceMarkAsPaidResponse as InvoiceMarkAsPaidResponse,
|
|
6866
|
+
type InvoiceMarkAsPaidParams as InvoiceMarkAsPaidParams,
|
|
6867
|
+
};
|
|
6525
6868
|
}
|