@leaflow/sdk 0.0.0-dev.529.g6a1b7de → 0.0.0-dev.535.g1eeb8a5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/billing/type/checkout/v1/generated/models.d.ts +5 -0
- package/dist/billing/type/checkout/v1/generated/validators/checkoutOptions.zod.d.ts +2 -0
- package/dist/billing/type/checkout/v1/generated/validators/checkoutOptions.zod.js +5 -0
- package/dist/billing/v1/generated/functions.d.ts +105 -90
- package/dist/billing/v1/generated/functions.js +107 -92
- package/dist/billing/v1/generated/models.d.ts +338 -164
- package/dist/billing/v1/generated/models.js +16 -10
- package/dist/billing/v1/generated/schemas.zod.d.ts +93 -70
- package/dist/billing/v1/generated/schemas.zod.js +98 -72
- package/dist/billing/v1/generated/validators/activeResource.zod.d.ts +1 -0
- package/dist/billing/v1/generated/validators/activeResource.zod.js +3 -2
- package/dist/billing/v1/generated/validators/activeResourceList.zod.d.ts +1 -0
- package/dist/billing/v1/generated/validators/allowance.zod.d.ts +1 -0
- package/dist/billing/v1/generated/validators/allowance.zod.js +5 -1
- package/dist/billing/v1/generated/validators/allowanceList.zod.d.ts +1 -0
- package/dist/billing/v1/generated/validators/cancellation.zod.d.ts +1 -0
- package/dist/billing/v1/generated/validators/cancellation.zod.js +2 -2
- package/dist/billing/v1/generated/validators/cancellationCreate.zod.d.ts +4 -2
- package/dist/billing/v1/generated/validators/cancellationCreate.zod.js +5 -4
- package/dist/billing/v1/generated/validators/cancellationItem.zod.d.ts +1 -0
- package/dist/billing/v1/generated/validators/cancellationItem.zod.js +5 -4
- package/dist/billing/v1/generated/validators/cancellationItemInput.zod.d.ts +13 -0
- package/dist/billing/v1/generated/validators/{autoRenewSet.zod.d.ts → cancellationItemInput.zod.js} +5 -5
- package/dist/billing/v1/generated/validators/cancellationList.zod.d.ts +1 -0
- package/dist/billing/v1/generated/validators/cancellationPreview.zod.d.ts +1 -0
- package/dist/billing/v1/generated/validators/cancellationPreview.zod.js +2 -2
- package/dist/billing/v1/generated/validators/cancellationPreviewItem.zod.d.ts +1 -0
- package/dist/billing/v1/generated/validators/cancellationPreviewItem.zod.js +4 -3
- package/dist/billing/v1/generated/validators/cancellationPreviewRequest.zod.d.ts +4 -2
- package/dist/billing/v1/generated/validators/cancellationPreviewRequest.zod.js +8 -7
- package/dist/billing/v1/generated/validators/checkoutOptions.zod.d.ts +2 -0
- package/dist/billing/v1/generated/validators/checkoutOptions.zod.js +5 -0
- package/dist/billing/v1/generated/validators/checkoutSession.zod.d.ts +6 -0
- package/dist/billing/v1/generated/validators/checkoutSession.zod.js +7 -3
- package/dist/billing/v1/generated/validators/checkoutSessionCreate.zod.d.ts +4 -1
- package/dist/billing/v1/generated/validators/checkoutSessionCreate.zod.js +8 -2
- package/dist/billing/v1/generated/validators/checkoutSessionItem.zod.d.ts +3 -1
- package/dist/billing/v1/generated/validators/checkoutSessionItem.zod.js +7 -2
- package/dist/billing/v1/generated/validators/checkoutSessionItemList.zod.d.ts +2 -1
- package/dist/billing/v1/generated/validators/checkoutSessionList.zod.d.ts +6 -0
- package/dist/billing/v1/generated/validators/checkoutSessionResult.zod.d.ts +7 -0
- package/dist/billing/v1/generated/validators/checkoutSessionSubscription.zod.d.ts +15 -0
- package/dist/billing/v1/generated/validators/checkoutSessionSubscription.zod.js +24 -0
- package/dist/billing/v1/generated/validators/checkoutSessionSubscriptionInput.zod.d.ts +13 -0
- package/dist/billing/v1/generated/validators/{autoRenewSet.zod.js → checkoutSessionSubscriptionInput.zod.js} +5 -3
- package/dist/billing/v1/generated/validators/entitlement.zod.js +1 -1
- package/dist/billing/v1/generated/validators/invoiceItem.zod.js +1 -1
- package/dist/billing/v1/generated/validators/invoiceItemProration.zod.js +1 -1
- package/dist/billing/v1/generated/validators/listActiveResourcesParams.zod.js +2 -2
- package/dist/billing/v1/generated/validators/listAllowancesParams.zod.js +2 -2
- package/dist/billing/v1/generated/validators/listCancellationsParams.zod.d.ts +1 -0
- package/dist/billing/v1/generated/validators/listCancellationsParams.zod.js +1 -0
- package/dist/billing/v1/generated/validators/listEntitlementsParams.zod.js +2 -2
- package/dist/billing/v1/generated/validators/listFeatureGrantsParams.zod.js +2 -2
- package/dist/billing/v1/generated/validators/listPricesParams.zod.js +2 -2
- package/dist/billing/v1/generated/validators/{listRenewalPricesParams.zod.d.ts → listRenewalOptionsParams.zod.d.ts} +7 -7
- package/dist/billing/v1/generated/validators/{listRenewalPricesParams.zod.js → listRenewalOptionsParams.zod.js} +9 -9
- package/dist/billing/v1/generated/validators/listSpendParams.zod.js +2 -2
- package/dist/billing/v1/generated/validators/listSubscriptionsParams.zod.d.ts +4 -1
- package/dist/billing/v1/generated/validators/listSubscriptionsParams.zod.js +7 -1
- package/dist/billing/v1/generated/validators/listUsageChargesParams.zod.js +2 -2
- package/dist/billing/v1/generated/validators/order.zod.d.ts +1 -0
- package/dist/billing/v1/generated/validators/order.zod.js +2 -2
- package/dist/billing/v1/generated/validators/orderItem.zod.d.ts +1 -0
- package/dist/billing/v1/generated/validators/orderItem.zod.js +8 -4
- package/dist/billing/v1/generated/validators/orderItemList.zod.d.ts +1 -0
- package/dist/billing/v1/generated/validators/orderItemStatus.zod.js +1 -1
- package/dist/billing/v1/generated/validators/orderList.zod.d.ts +1 -0
- package/dist/billing/v1/generated/validators/plan.zod.js +2 -2
- package/dist/billing/v1/generated/validators/price.zod.js +2 -2
- package/dist/billing/v1/generated/validators/priceSearch.zod.js +2 -2
- package/dist/billing/v1/generated/validators/product.zod.js +2 -2
- package/dist/billing/v1/generated/validators/{productID.zod.d.ts → productId.zod.d.ts} +5 -5
- package/dist/billing/v1/generated/validators/{productID.zod.js → productId.zod.js} +5 -5
- package/dist/billing/v1/generated/validators/quote.zod.d.ts +8 -1
- package/dist/billing/v1/generated/validators/quote.zod.js +1 -1
- package/dist/billing/v1/generated/validators/quoteChangeInput.zod.d.ts +1 -1
- package/dist/billing/v1/generated/validators/quoteChangeInput.zod.js +7 -7
- package/dist/billing/v1/generated/validators/quoteDowngradeRefund.zod.js +1 -1
- package/dist/billing/v1/generated/validators/quoteItem.zod.d.ts +1 -0
- package/dist/billing/v1/generated/validators/quoteItem.zod.js +7 -3
- package/dist/billing/v1/generated/validators/quoteItemInput.zod.d.ts +1 -0
- package/dist/billing/v1/generated/validators/quoteItemInput.zod.js +6 -2
- package/dist/billing/v1/generated/validators/quoteRenewal.zod.d.ts +0 -1
- package/dist/billing/v1/generated/validators/quoteRenewal.zod.js +2 -3
- package/dist/billing/v1/generated/validators/quoteRenewalItem.zod.d.ts +17 -0
- package/dist/billing/v1/generated/validators/quoteRenewalItem.zod.js +18 -0
- package/dist/billing/v1/generated/validators/quoteRenewalResult.zod.d.ts +7 -1
- package/dist/billing/v1/generated/validators/quoteRenewalResult.zod.js +6 -3
- package/dist/billing/v1/generated/validators/quoteRequest.zod.d.ts +2 -2
- package/dist/billing/v1/generated/validators/quoteRequest.zod.js +3 -3
- package/dist/billing/v1/generated/validators/refundReason.zod.js +1 -1
- package/dist/billing/v1/generated/validators/renewRequest.zod.js +3 -3
- package/dist/billing/v1/generated/validators/{renewalPriceList.zod.d.ts → renewalOption.zod.d.ts} +15 -18
- package/dist/billing/v1/generated/validators/renewalOption.zod.js +22 -0
- package/dist/billing/v1/generated/validators/{renewalPrice.zod.d.ts → renewalOptionItem.zod.d.ts} +6 -13
- package/dist/billing/v1/generated/validators/{renewalPrice.zod.js → renewalOptionItem.zod.js} +10 -10
- package/dist/billing/v1/generated/validators/renewalOptionList.zod.d.ts +44 -0
- package/dist/billing/v1/generated/validators/{renewalPriceList.zod.js → renewalOptionList.zod.js} +3 -3
- package/dist/billing/v1/generated/validators/scheduledChange.zod.js +1 -1
- package/dist/billing/v1/generated/validators/subscription.zod.d.ts +131 -112
- package/dist/billing/v1/generated/validators/subscription.zod.js +39 -73
- package/dist/billing/v1/generated/validators/subscriptionItem.zod.d.ts +104 -0
- package/dist/billing/v1/generated/validators/subscriptionItem.zod.js +74 -0
- package/dist/billing/v1/generated/validators/{subscriptionCancellation.zod.d.ts → subscriptionItemCancellation.zod.d.ts} +4 -4
- package/dist/billing/v1/generated/validators/{subscriptionCancellation.zod.js → subscriptionItemCancellation.zod.js} +4 -4
- package/dist/billing/v1/generated/validators/subscriptionList.zod.d.ts +131 -111
- package/dist/billing/v1/generated/validators/subscriptionStatus.zod.d.ts +1 -0
- package/dist/billing/v1/generated/validators/subscriptionStatus.zod.js +2 -2
- package/dist/billing/v1/generated/validators/subscriptionUpdate.zod.d.ts +13 -0
- package/dist/billing/v1/generated/validators/subscriptionUpdate.zod.js +13 -0
- package/dist/billing/v1/generated/validators/trialEndBehavior.zod.d.ts +18 -0
- package/dist/billing/v1/generated/validators/trialEndBehavior.zod.js +17 -0
- package/dist/billing/v1/generated/validators/trialSettings.zod.d.ts +20 -0
- package/dist/billing/v1/generated/validators/trialSettings.zod.js +14 -0
- package/dist/billing/v1/generated/validators/usageCharge.zod.d.ts +1 -0
- package/dist/billing/v1/generated/validators/usageCharge.zod.js +2 -1
- package/dist/billing/v1/generated/validators/usageChargeList.zod.d.ts +1 -0
- package/dist/billing/v1/generated/validators/usageEstimateInput.zod.js +2 -2
- package/dist/canopy/v1/generated/models.d.ts +5 -0
- package/dist/canopy/v1/generated/schemas.zod.d.ts +1 -0
- package/dist/canopy/v1/generated/validators/checkoutOptions.zod.d.ts +2 -0
- package/dist/canopy/v1/generated/validators/checkoutOptions.zod.js +5 -0
- package/dist/canopy/v1/generated/validators/createServiceRequestBody.zod.d.ts +1 -0
- package/dist/compute/v2/generated/functions.d.ts +372 -284
- package/dist/compute/v2/generated/functions.js +232 -76
- package/dist/compute/v2/generated/models.d.ts +368 -334
- package/dist/compute/v2/generated/models.js +9 -9
- package/dist/compute/v2/generated/schemas.zod.d.ts +165 -97
- package/dist/compute/v2/generated/schemas.zod.js +156 -84
- package/dist/compute/v2/generated/validators/{associateElasticIPRequestBody.zod.d.ts → associateElasticIpRequestBody.zod.d.ts} +4 -4
- package/dist/compute/v2/generated/validators/{associateElasticIPRequestBody.zod.js → associateElasticIpRequestBody.zod.js} +2 -2
- package/dist/compute/v2/generated/validators/attachNetworkInterfaceRequestBody.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/attachNetworkInterfaceRequestBody.zod.js +3 -3
- package/dist/compute/v2/generated/validators/attachVolumeRequestBody.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/attachVolumeRequestBody.zod.js +3 -3
- package/dist/compute/v2/generated/validators/{imageID.zod.d.ts → availabilityZoneId.zod.d.ts} +7 -7
- package/dist/compute/v2/generated/validators/availabilityZoneId.zod.js +44 -0
- package/dist/compute/v2/generated/validators/availabilityZoneListResponseBody.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/availabilityZoneListResponseBody.zod.js +1 -1
- package/dist/compute/v2/generated/validators/availabilityZoneResource.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/availabilityZoneResource.zod.js +5 -5
- package/dist/compute/v2/generated/validators/billingCancellation.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/billingCancellation.zod.js +3 -3
- package/dist/compute/v2/generated/validators/billingChoice.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/billingChoice.zod.js +1 -1
- package/dist/compute/v2/generated/validators/billingComponent.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/billingComponent.zod.js +1 -1
- package/dist/compute/v2/generated/validators/billingLineQuantity.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/billingLineQuantity.zod.js +1 -1
- package/dist/compute/v2/generated/validators/billingMeter.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/billingMeter.zod.js +1 -1
- package/dist/compute/v2/generated/validators/billingPeriod.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/billingPeriod.zod.js +1 -1
- package/dist/compute/v2/generated/validators/billingQuantity.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/billingQuantity.zod.js +1 -1
- package/dist/compute/v2/generated/validators/bootVolume.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/bootVolume.zod.js +1 -1
- package/dist/compute/v2/generated/validators/cancellationMode.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/cancellationMode.zod.js +1 -1
- package/dist/compute/v2/generated/validators/{updateElasticIPRequestBody.zod.d.ts → changeElasticIpBandwidthRequestBody.zod.d.ts} +6 -9
- package/dist/compute/v2/generated/validators/changeElasticIpBandwidthRequestBody.zod.js +47 -0
- package/dist/compute/v2/generated/validators/changeElasticIpChargeTypeRequestBody.zod.d.ts +43 -0
- package/dist/compute/v2/generated/validators/changeElasticIpChargeTypeRequestBody.zod.js +39 -0
- package/dist/compute/v2/generated/validators/checkoutMode.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/checkoutMode.zod.js +1 -1
- package/dist/compute/v2/generated/validators/checkoutOptions.zod.d.ts +3 -1
- package/dist/compute/v2/generated/validators/checkoutOptions.zod.js +6 -1
- package/dist/compute/v2/generated/validators/consoleResponseBody.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/consoleResponseBody.zod.js +1 -1
- package/dist/compute/v2/generated/validators/{createElasticIPRequestBody.zod.d.ts → createElasticIpRequestBody.zod.d.ts} +9 -7
- package/dist/compute/v2/generated/validators/{createElasticIPRequestBody.zod.js → createElasticIpRequestBody.zod.js} +12 -10
- package/dist/compute/v2/generated/validators/{createElasticIPResponseBody.zod.d.ts → createElasticIpResponseBody.zod.d.ts} +8 -6
- package/dist/compute/v2/generated/validators/{createElasticIPResponseBody.zod.js → createElasticIpResponseBody.zod.js} +4 -4
- package/dist/compute/v2/generated/validators/createInstanceRequestBody.zod.d.ts +2 -1
- package/dist/compute/v2/generated/validators/createInstanceRequestBody.zod.js +3 -3
- package/dist/compute/v2/generated/validators/createInstanceResponseBody.zod.d.ts +3 -1
- package/dist/compute/v2/generated/validators/createInstanceResponseBody.zod.js +1 -1
- package/dist/compute/v2/generated/validators/createLaunchTemplateRequestBody.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/createLaunchTemplateRequestBody.zod.js +3 -3
- package/dist/compute/v2/generated/validators/createLaunchTemplateResponseBody.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/createLaunchTemplateResponseBody.zod.js +1 -1
- package/dist/compute/v2/generated/validators/createNetworkInterfaceAddressRequestBody.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/createNetworkInterfaceAddressRequestBody.zod.js +1 -1
- package/dist/compute/v2/generated/validators/createNetworkInterfaceRequestBody.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/createNetworkInterfaceRequestBody.zod.js +5 -5
- package/dist/compute/v2/generated/validators/createPrivateImageRequestBody.zod.d.ts +2 -1
- package/dist/compute/v2/generated/validators/createPrivateImageRequestBody.zod.js +3 -3
- package/dist/compute/v2/generated/validators/createPrivateImageResponseBody.zod.d.ts +3 -1
- package/dist/compute/v2/generated/validators/createPrivateImageResponseBody.zod.js +1 -1
- package/dist/compute/v2/generated/validators/createSecurityGroupRequestBody.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/createSecurityGroupRequestBody.zod.js +3 -3
- package/dist/compute/v2/generated/validators/createSecurityGroupRuleRequestBody.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/createSecurityGroupRuleRequestBody.zod.js +1 -1
- package/dist/compute/v2/generated/validators/createVirtualPrivateCloudPeeringRequestBody.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/createVirtualPrivateCloudPeeringRequestBody.zod.js +4 -4
- package/dist/compute/v2/generated/validators/createVirtualPrivateCloudRequestBody.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/createVirtualPrivateCloudRequestBody.zod.js +3 -3
- package/dist/compute/v2/generated/validators/createVirtualPrivateCloudRouteRequestBody.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/createVirtualPrivateCloudRouteRequestBody.zod.js +1 -1
- package/dist/compute/v2/generated/validators/createVirtualPrivateCloudSubnetRequestBody.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/createVirtualPrivateCloudSubnetRequestBody.zod.js +1 -1
- package/dist/compute/v2/generated/validators/createVolumeBackupRequestBody.zod.d.ts +2 -1
- package/dist/compute/v2/generated/validators/createVolumeBackupRequestBody.zod.js +3 -3
- package/dist/compute/v2/generated/validators/createVolumeBackupResponseBody.zod.d.ts +3 -1
- package/dist/compute/v2/generated/validators/createVolumeBackupResponseBody.zod.js +1 -1
- package/dist/compute/v2/generated/validators/createVolumeRequestBody.zod.d.ts +5 -3
- package/dist/compute/v2/generated/validators/createVolumeRequestBody.zod.js +10 -8
- package/dist/compute/v2/generated/validators/createVolumeResponseBody.zod.d.ts +3 -1
- package/dist/compute/v2/generated/validators/createVolumeResponseBody.zod.js +1 -1
- package/dist/compute/v2/generated/validators/createVolumeSnapshotRequestBody.zod.d.ts +2 -1
- package/dist/compute/v2/generated/validators/createVolumeSnapshotRequestBody.zod.js +3 -3
- package/dist/compute/v2/generated/validators/createVolumeSnapshotResponseBody.zod.d.ts +3 -1
- package/dist/compute/v2/generated/validators/createVolumeSnapshotResponseBody.zod.js +1 -1
- package/dist/compute/v2/generated/validators/cursorPagination.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/cursorPagination.zod.js +1 -1
- package/dist/compute/v2/generated/validators/deleteElasticIpParams.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/deleteElasticIpParams.zod.js +1 -1
- package/dist/compute/v2/generated/validators/{deleteElasticIPResponseBody.zod.d.ts → deleteElasticIpResponseBody.zod.d.ts} +8 -6
- package/dist/compute/v2/generated/validators/{deleteElasticIPResponseBody.zod.js → deleteElasticIpResponseBody.zod.js} +6 -6
- package/dist/compute/v2/generated/validators/deleteInstanceParams.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/deleteInstanceParams.zod.js +1 -1
- package/dist/compute/v2/generated/validators/deleteInstanceResponseBody.zod.d.ts +3 -1
- package/dist/compute/v2/generated/validators/deleteInstanceResponseBody.zod.js +3 -3
- package/dist/compute/v2/generated/validators/deletePrivateImageParams.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/deletePrivateImageParams.zod.js +1 -1
- package/dist/compute/v2/generated/validators/deletePrivateImageResponseBody.zod.d.ts +3 -1
- package/dist/compute/v2/generated/validators/deletePrivateImageResponseBody.zod.js +3 -3
- package/dist/compute/v2/generated/validators/deleteVolumeBackupParams.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/deleteVolumeBackupParams.zod.js +1 -1
- package/dist/compute/v2/generated/validators/deleteVolumeBackupResponseBody.zod.d.ts +3 -1
- package/dist/compute/v2/generated/validators/deleteVolumeBackupResponseBody.zod.js +3 -3
- package/dist/compute/v2/generated/validators/deleteVolumeParams.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/deleteVolumeParams.zod.js +1 -1
- package/dist/compute/v2/generated/validators/deleteVolumeResponseBody.zod.d.ts +3 -1
- package/dist/compute/v2/generated/validators/deleteVolumeResponseBody.zod.js +3 -3
- package/dist/compute/v2/generated/validators/deleteVolumeSnapshotParams.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/deleteVolumeSnapshotParams.zod.js +1 -1
- package/dist/compute/v2/generated/validators/deleteVolumeSnapshotResponseBody.zod.d.ts +3 -1
- package/dist/compute/v2/generated/validators/deleteVolumeSnapshotResponseBody.zod.js +3 -3
- package/dist/compute/v2/generated/validators/{elasticIP.zod.d.ts → elasticIp.zod.d.ts} +8 -6
- package/dist/compute/v2/generated/validators/{elasticIP.zod.js → elasticIp.zod.js} +22 -18
- package/dist/compute/v2/generated/validators/{elasticIPAssociation.zod.d.ts → elasticIpAssociation.zod.d.ts} +4 -4
- package/dist/compute/v2/generated/validators/{elasticIPAssociation.zod.js → elasticIpAssociation.zod.js} +11 -11
- package/dist/compute/v2/generated/validators/elasticIpAssociationId.zod.d.ts +41 -0
- package/dist/compute/v2/generated/validators/elasticIpAssociationId.zod.js +44 -0
- package/dist/compute/v2/generated/validators/{updateElasticIPResponseBody.zod.d.ts → elasticIpChangeResponseBody.zod.d.ts} +8 -6
- package/dist/compute/v2/generated/validators/elasticIpChangeResponseBody.zod.js +49 -0
- package/dist/compute/v2/generated/validators/elasticIpId.zod.d.ts +41 -0
- package/dist/compute/v2/generated/validators/{elasticIPID.zod.js → elasticIpId.zod.js} +8 -8
- package/dist/compute/v2/generated/validators/{elasticIPLine.zod.d.ts → elasticIpLine.zod.d.ts} +7 -7
- package/dist/compute/v2/generated/validators/{elasticIPLine.zod.js → elasticIpLine.zod.js} +12 -12
- package/dist/compute/v2/generated/validators/elasticIpLineId.zod.d.ts +41 -0
- package/dist/compute/v2/generated/validators/elasticIpLineId.zod.js +44 -0
- package/dist/compute/v2/generated/validators/{elasticIPLineListResponseBody.zod.d.ts → elasticIpLineListResponseBody.zod.d.ts} +4 -4
- package/dist/compute/v2/generated/validators/{elasticIPListResponseBody.zod.js → elasticIpLineListResponseBody.zod.js} +4 -4
- package/dist/compute/v2/generated/validators/{elasticIPListResponseBody.zod.d.ts → elasticIpListResponseBody.zod.d.ts} +8 -6
- package/dist/compute/v2/generated/validators/{elasticIPLineListResponseBody.zod.js → elasticIpListResponseBody.zod.js} +4 -4
- package/dist/compute/v2/generated/validators/{elasticIPReleaseResource.zod.d.ts → elasticIpReleaseResource.zod.d.ts} +4 -4
- package/dist/compute/v2/generated/validators/{elasticIPReleaseResource.zod.js → elasticIpReleaseResource.zod.js} +4 -4
- package/dist/compute/v2/generated/validators/error.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/error.zod.js +1 -1
- package/dist/compute/v2/generated/validators/errorStatus.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/errorStatus.zod.js +1 -1
- package/dist/compute/v2/generated/validators/existingBootVolume.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/existingBootVolume.zod.js +3 -3
- package/dist/compute/v2/generated/validators/{existingElasticIP.zod.d.ts → existingElasticIp.zod.d.ts} +4 -4
- package/dist/compute/v2/generated/validators/{existingElasticIP.zod.js → existingElasticIp.zod.js} +4 -4
- package/dist/compute/v2/generated/validators/existingPrimaryNetworkInterface.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/existingPrimaryNetworkInterface.zod.js +3 -3
- package/dist/compute/v2/generated/validators/fieldViolation.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/fieldViolation.zod.js +1 -1
- package/dist/compute/v2/generated/validators/freeSubnetCidr.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/freeSubnetCidr.zod.js +1 -1
- package/dist/compute/v2/generated/validators/generatedPassword.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/generatedPassword.zod.js +1 -1
- package/dist/compute/v2/generated/validators/getVirtualPrivateCloudFreeSubnetCidrParams.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/getVirtualPrivateCloudFreeSubnetCidrParams.zod.js +1 -1
- package/dist/compute/v2/generated/validators/imageId.zod.d.ts +41 -0
- package/dist/compute/v2/generated/validators/{imageID.zod.js → imageId.zod.js} +8 -8
- package/dist/compute/v2/generated/validators/instance.zod.d.ts +3 -1
- package/dist/compute/v2/generated/validators/instance.zod.js +25 -21
- package/dist/compute/v2/generated/validators/instanceAssociationTarget.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/instanceAssociationTarget.zod.js +3 -3
- package/dist/compute/v2/generated/validators/{instanceElasticIP.zod.d.ts → instanceElasticIp.zod.d.ts} +4 -4
- package/dist/compute/v2/generated/validators/{instanceElasticIP.zod.js → instanceElasticIp.zod.js} +5 -5
- package/dist/compute/v2/generated/validators/instanceFamily.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/instanceFamily.zod.js +5 -5
- package/dist/compute/v2/generated/validators/instanceFamilyCategory.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/instanceFamilyCategory.zod.js +1 -1
- package/dist/compute/v2/generated/validators/instanceFamilyId.zod.d.ts +41 -0
- package/dist/compute/v2/generated/validators/{instanceFamilyID.zod.js → instanceFamilyId.zod.js} +8 -8
- package/dist/compute/v2/generated/validators/instanceFamilyListResponseBody.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/instanceFamilyListResponseBody.zod.js +1 -1
- package/dist/compute/v2/generated/validators/instanceId.zod.d.ts +41 -0
- package/dist/compute/v2/generated/validators/{instanceID.zod.js → instanceId.zod.js} +8 -8
- package/dist/compute/v2/generated/validators/instanceListResponseBody.zod.d.ts +3 -1
- package/dist/compute/v2/generated/validators/instanceListResponseBody.zod.js +1 -1
- package/dist/compute/v2/generated/validators/instanceNetworkInterfaceId.zod.d.ts +41 -0
- package/dist/compute/v2/generated/validators/instanceNetworkInterfaceId.zod.js +44 -0
- package/dist/compute/v2/generated/validators/instanceReleaseResource.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/instanceReleaseResource.zod.js +3 -3
- package/dist/compute/v2/generated/validators/instanceRestriction.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/instanceRestriction.zod.js +4 -4
- package/dist/compute/v2/generated/validators/instanceType.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/instanceType.zod.js +9 -9
- package/dist/compute/v2/generated/validators/instanceTypeId.zod.d.ts +41 -0
- package/dist/compute/v2/generated/validators/{instanceTypeID.zod.js → instanceTypeId.zod.js} +8 -8
- package/dist/compute/v2/generated/validators/instanceTypeListResponseBody.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/instanceTypeListResponseBody.zod.js +1 -1
- package/dist/compute/v2/generated/validators/instanceVolumeId.zod.d.ts +41 -0
- package/dist/compute/v2/generated/validators/{instanceVolumeID.zod.js → instanceVolumeId.zod.js} +8 -8
- package/dist/compute/v2/generated/validators/internetChargeType.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/internetChargeType.zod.js +2 -2
- package/dist/compute/v2/generated/validators/ipv4HostAddress.zod.d.ts +41 -0
- package/dist/compute/v2/generated/validators/{iPv4HostAddress.zod.js → ipv4HostAddress.zod.js} +8 -8
- package/dist/compute/v2/generated/validators/latestOperation.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/latestOperation.zod.js +1 -1
- package/dist/compute/v2/generated/validators/launchTemplate.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/launchTemplate.zod.js +5 -5
- package/dist/compute/v2/generated/validators/launchTemplateBootVolume.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/launchTemplateBootVolume.zod.js +5 -5
- package/dist/compute/v2/generated/validators/launchTemplateDataVolume.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/launchTemplateDataVolume.zod.js +3 -3
- package/dist/compute/v2/generated/validators/{launchTemplateElasticIP.zod.d.ts → launchTemplateElasticIp.zod.d.ts} +5 -5
- package/dist/compute/v2/generated/validators/{launchTemplateElasticIP.zod.js → launchTemplateElasticIp.zod.js} +6 -6
- package/dist/compute/v2/generated/validators/launchTemplateId.zod.d.ts +41 -0
- package/dist/compute/v2/generated/validators/{launchTemplateID.zod.js → launchTemplateId.zod.js} +8 -8
- package/dist/compute/v2/generated/validators/launchTemplateListResponseBody.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/launchTemplateListResponseBody.zod.js +1 -1
- package/dist/compute/v2/generated/validators/launchTemplateNetworkInterface.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/launchTemplateNetworkInterface.zod.js +5 -5
- package/dist/compute/v2/generated/validators/launchTemplateReference.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/launchTemplateReference.zod.js +3 -3
- package/dist/compute/v2/generated/validators/launchTemplateVersion.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/launchTemplateVersion.zod.js +7 -7
- package/dist/compute/v2/generated/validators/launchTemplateVersionListResponseBody.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/launchTemplateVersionListResponseBody.zod.js +1 -1
- package/dist/compute/v2/generated/validators/listAvailabilityZonesParams.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/listAvailabilityZonesParams.zod.js +3 -3
- package/dist/compute/v2/generated/validators/listElasticIpLinesParams.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/listElasticIpLinesParams.zod.js +3 -3
- package/dist/compute/v2/generated/validators/listElasticIpTrafficUsageParams.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/listElasticIpTrafficUsageParams.zod.js +1 -1
- package/dist/compute/v2/generated/validators/listElasticIpsParams.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/listElasticIpsParams.zod.js +1 -1
- package/dist/compute/v2/generated/validators/listInstanceFamiliesParams.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/listInstanceFamiliesParams.zod.js +3 -3
- package/dist/compute/v2/generated/validators/listInstanceNetworkInterfacesParams.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/listInstanceNetworkInterfacesParams.zod.js +1 -1
- package/dist/compute/v2/generated/validators/listInstanceTypesParams.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/listInstanceTypesParams.zod.js +7 -7
- package/dist/compute/v2/generated/validators/listInstanceVolumesParams.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/listInstanceVolumesParams.zod.js +1 -1
- package/dist/compute/v2/generated/validators/listInstancesParams.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/listInstancesParams.zod.js +1 -1
- package/dist/compute/v2/generated/validators/listLaunchTemplateVersionsParams.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/listLaunchTemplateVersionsParams.zod.js +1 -1
- package/dist/compute/v2/generated/validators/listLaunchTemplatesParams.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/listLaunchTemplatesParams.zod.js +3 -3
- package/dist/compute/v2/generated/validators/listNetworkInterfacesParams.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/listNetworkInterfacesParams.zod.js +1 -1
- package/dist/compute/v2/generated/validators/listOperationLogsParams.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/listOperationLogsParams.zod.js +1 -1
- package/dist/compute/v2/generated/validators/listPrivateImagesParams.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/listPrivateImagesParams.zod.js +3 -3
- package/dist/compute/v2/generated/validators/listPublicImagesParams.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/listPublicImagesParams.zod.js +3 -3
- package/dist/compute/v2/generated/validators/listQuotasParams.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/listQuotasParams.zod.js +1 -1
- package/dist/compute/v2/generated/validators/listRegionsParams.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/listRegionsParams.zod.js +1 -1
- package/dist/compute/v2/generated/validators/listSecurityGroupRulesParams.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/listSecurityGroupRulesParams.zod.js +1 -1
- package/dist/compute/v2/generated/validators/listSecurityGroupsParams.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/listSecurityGroupsParams.zod.js +5 -5
- package/dist/compute/v2/generated/validators/listVirtualPrivateCloudPeeringsParams.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/listVirtualPrivateCloudPeeringsParams.zod.js +1 -1
- package/dist/compute/v2/generated/validators/listVirtualPrivateCloudRoutesParams.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/listVirtualPrivateCloudRoutesParams.zod.js +1 -1
- package/dist/compute/v2/generated/validators/listVirtualPrivateCloudSubnetsParams.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/listVirtualPrivateCloudSubnetsParams.zod.js +1 -1
- package/dist/compute/v2/generated/validators/listVirtualPrivateCloudsParams.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/listVirtualPrivateCloudsParams.zod.js +3 -3
- package/dist/compute/v2/generated/validators/listVolumeBackupsParams.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/listVolumeBackupsParams.zod.js +3 -3
- package/dist/compute/v2/generated/validators/listVolumeSnapshotsParams.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/listVolumeSnapshotsParams.zod.js +3 -3
- package/dist/compute/v2/generated/validators/listVolumeTypesParams.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/listVolumeTypesParams.zod.js +5 -5
- package/dist/compute/v2/generated/validators/listVolumesParams.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/listVolumesParams.zod.js +5 -5
- package/dist/compute/v2/generated/validators/money.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/money.zod.js +1 -1
- package/dist/compute/v2/generated/validators/networkInterface.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/networkInterface.zod.js +7 -7
- package/dist/compute/v2/generated/validators/networkInterfaceAddress.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/networkInterfaceAddress.zod.js +5 -5
- package/dist/compute/v2/generated/validators/networkInterfaceAddressAssociationTarget.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/networkInterfaceAddressAssociationTarget.zod.js +3 -3
- package/dist/compute/v2/generated/validators/{regionID.zod.d.ts → networkInterfaceAddressId.zod.d.ts} +7 -7
- package/dist/compute/v2/generated/validators/networkInterfaceAddressId.zod.js +44 -0
- package/dist/compute/v2/generated/validators/networkInterfaceAttachment.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/networkInterfaceAttachment.zod.js +7 -7
- package/dist/compute/v2/generated/validators/networkInterfaceAttachmentList.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/networkInterfaceAttachmentList.zod.js +1 -1
- package/dist/compute/v2/generated/validators/networkInterfaceId.zod.d.ts +41 -0
- package/dist/compute/v2/generated/validators/{networkInterfaceID.zod.js → networkInterfaceId.zod.js} +8 -8
- package/dist/compute/v2/generated/validators/networkInterfaceListResponseBody.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/networkInterfaceListResponseBody.zod.js +1 -1
- package/dist/compute/v2/generated/validators/newBootVolume.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/newBootVolume.zod.js +5 -5
- package/dist/compute/v2/generated/validators/newCompute.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/newCompute.zod.js +3 -3
- package/dist/compute/v2/generated/validators/newDataVolume.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/newDataVolume.zod.js +3 -3
- package/dist/compute/v2/generated/validators/{newElasticIP.zod.d.ts → newElasticIp.zod.d.ts} +5 -5
- package/dist/compute/v2/generated/validators/{newElasticIP.zod.js → newElasticIp.zod.js} +6 -6
- package/dist/compute/v2/generated/validators/newLaunchTemplateVersion.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/newLaunchTemplateVersion.zod.js +5 -5
- package/dist/compute/v2/generated/validators/newPrimaryNetworkInterface.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/newPrimaryNetworkInterface.zod.js +5 -5
- package/dist/compute/v2/generated/validators/offsetPagination.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/offsetPagination.zod.js +1 -1
- package/dist/compute/v2/generated/validators/operationLogId.zod.d.ts +41 -0
- package/dist/compute/v2/generated/validators/{operationLogID.zod.js → operationLogId.zod.js} +8 -8
- package/dist/compute/v2/generated/validators/operationLogListResponseBody.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/operationLogListResponseBody.zod.js +1 -1
- package/dist/compute/v2/generated/validators/operationLogResource.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/operationLogResource.zod.js +5 -5
- package/dist/compute/v2/generated/validators/passwordChoice.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/passwordChoice.zod.js +1 -1
- package/dist/compute/v2/generated/validators/performanceFormula.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/performanceFormula.zod.js +1 -1
- package/dist/compute/v2/generated/validators/primaryNetworkInterface.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/primaryNetworkInterface.zod.js +1 -1
- package/dist/compute/v2/generated/validators/privateImageListResponseBody.zod.d.ts +3 -1
- package/dist/compute/v2/generated/validators/privateImageListResponseBody.zod.js +1 -1
- package/dist/compute/v2/generated/validators/privateImageReleaseResource.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/privateImageReleaseResource.zod.js +3 -3
- package/dist/compute/v2/generated/validators/privateImageResource.zod.d.ts +3 -1
- package/dist/compute/v2/generated/validators/privateImageResource.zod.js +13 -9
- package/dist/compute/v2/generated/validators/projectQuota.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/projectQuota.zod.js +3 -3
- package/dist/compute/v2/generated/validators/projectQuotaListResponseBody.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/projectQuotaListResponseBody.zod.js +1 -1
- package/dist/compute/v2/generated/validators/publicImageListResponseBody.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/publicImageListResponseBody.zod.js +1 -1
- package/dist/compute/v2/generated/validators/publicImageResource.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/publicImageResource.zod.js +5 -5
- package/dist/compute/v2/generated/validators/quotaResourceType.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/quotaResourceType.zod.js +1 -1
- package/dist/compute/v2/generated/validators/quotaSource.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/quotaSource.zod.js +1 -1
- package/dist/compute/v2/generated/validators/rebootInstanceRequestBody.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/rebootInstanceRequestBody.zod.js +1 -1
- package/dist/compute/v2/generated/validators/rebuildInstanceRequestBody.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/rebuildInstanceRequestBody.zod.js +3 -3
- package/dist/compute/v2/generated/validators/rebuildInstanceResponseBody.zod.d.ts +3 -1
- package/dist/compute/v2/generated/validators/rebuildInstanceResponseBody.zod.js +1 -1
- package/dist/compute/v2/generated/validators/regionId.zod.d.ts +41 -0
- package/dist/compute/v2/generated/validators/{regionID.zod.js → regionId.zod.js} +8 -8
- package/dist/compute/v2/generated/validators/regionListResponseBody.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/regionListResponseBody.zod.js +1 -1
- package/dist/compute/v2/generated/validators/regionResource.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/regionResource.zod.js +3 -3
- package/dist/compute/v2/generated/validators/releaseResource.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/releaseResource.zod.js +3 -3
- package/dist/compute/v2/generated/validators/releaseSetItem.zod.d.ts +2 -1
- package/dist/compute/v2/generated/validators/releaseSetItem.zod.js +4 -3
- package/dist/compute/v2/generated/validators/replaceNetworkInterfaceSecurityGroupsRequestBody.zod.d.ts +41 -0
- package/dist/compute/v2/generated/validators/replaceNetworkInterfaceSecurityGroupsRequestBody.zod.js +44 -0
- package/dist/compute/v2/generated/validators/rescueInstanceResponseBody.zod.d.ts +3 -1
- package/dist/compute/v2/generated/validators/rescueInstanceResponseBody.zod.js +1 -1
- package/dist/compute/v2/generated/validators/resetInstancePasswordResponseBody.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/resetInstancePasswordResponseBody.zod.js +1 -1
- package/dist/compute/v2/generated/validators/resizeInstanceRequestBody.zod.d.ts +50 -0
- package/dist/compute/v2/generated/validators/resizeInstanceRequestBody.zod.js +45 -0
- package/dist/compute/v2/generated/validators/{updateInstanceResponseBody.zod.d.ts → resizeInstanceResponseBody.zod.d.ts} +7 -5
- package/dist/compute/v2/generated/validators/{availabilityZoneID.zod.js → resizeInstanceResponseBody.zod.js} +14 -10
- package/dist/compute/v2/generated/validators/resizeVolumeRequestBody.zod.d.ts +50 -0
- package/dist/compute/v2/generated/validators/resizeVolumeRequestBody.zod.js +44 -0
- package/dist/compute/v2/generated/validators/retypeVolumeRequestBody.zod.d.ts +50 -0
- package/dist/compute/v2/generated/validators/retypeVolumeRequestBody.zod.js +45 -0
- package/dist/compute/v2/generated/validators/revertVolumeRequestBody.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/revertVolumeRequestBody.zod.js +3 -3
- package/dist/compute/v2/generated/validators/runInstanceCommandRequestBody.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/runInstanceCommandRequestBody.zod.js +1 -1
- package/dist/compute/v2/generated/validators/runInstanceCommandResponseBody.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/runInstanceCommandResponseBody.zod.js +1 -1
- package/dist/compute/v2/generated/validators/securityGroup.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/securityGroup.zod.js +5 -5
- package/dist/compute/v2/generated/validators/securityGroupId.zod.d.ts +41 -0
- package/dist/compute/v2/generated/validators/{securityGroupID.zod.js → securityGroupId.zod.js} +8 -8
- package/dist/compute/v2/generated/validators/securityGroupIdOrWildcard.zod.d.ts +39 -0
- package/dist/compute/v2/generated/validators/{securityGroupIDOrWildcard.zod.js → securityGroupIdOrWildcard.zod.js} +4 -4
- package/dist/compute/v2/generated/validators/securityGroupListResponseBody.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/securityGroupListResponseBody.zod.js +1 -1
- package/dist/compute/v2/generated/validators/securityGroupRule.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/securityGroupRule.zod.js +5 -5
- package/dist/compute/v2/generated/validators/securityGroupRuleDirection.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/securityGroupRuleDirection.zod.js +1 -1
- package/dist/compute/v2/generated/validators/securityGroupRuleId.zod.d.ts +41 -0
- package/dist/compute/v2/generated/validators/securityGroupRuleId.zod.js +44 -0
- package/dist/compute/v2/generated/validators/securityGroupRuleListResponseBody.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/securityGroupRuleListResponseBody.zod.js +1 -1
- package/dist/compute/v2/generated/validators/subnetId.zod.d.ts +41 -0
- package/dist/compute/v2/generated/validators/{subnetID.zod.js → subnetId.zod.js} +8 -8
- package/dist/compute/v2/generated/validators/suppliedPassword.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/suppliedPassword.zod.js +1 -1
- package/dist/compute/v2/generated/validators/terminationPolicy.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/terminationPolicy.zod.js +1 -1
- package/dist/compute/v2/generated/validators/trafficUsage.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/trafficUsage.zod.js +1 -1
- package/dist/compute/v2/generated/validators/trafficUsageListResponseBody.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/trafficUsageListResponseBody.zod.js +1 -1
- package/dist/compute/v2/generated/validators/updateInstanceRequestBody.zod.d.ts +1 -11
- package/dist/compute/v2/generated/validators/updateInstanceRequestBody.zod.js +2 -10
- package/dist/compute/v2/generated/validators/updateLaunchTemplateRequestBody.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/updateLaunchTemplateRequestBody.zod.js +1 -1
- package/dist/compute/v2/generated/validators/updateNetworkInterfaceRequestBody.zod.d.ts +1 -3
- package/dist/compute/v2/generated/validators/updateNetworkInterfaceRequestBody.zod.js +2 -10
- package/dist/compute/v2/generated/validators/updatePrivateImageRequestBody.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/updatePrivateImageRequestBody.zod.js +1 -1
- package/dist/compute/v2/generated/validators/updateSecurityGroupRequestBody.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/updateSecurityGroupRequestBody.zod.js +1 -1
- package/dist/compute/v2/generated/validators/updateVirtualPrivateCloudRequestBody.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/updateVirtualPrivateCloudRequestBody.zod.js +1 -1
- package/dist/compute/v2/generated/validators/updateVirtualPrivateCloudSubnetRequestBody.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/updateVirtualPrivateCloudSubnetRequestBody.zod.js +1 -1
- package/dist/compute/v2/generated/validators/updateVolumeBackupRequestBody.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/updateVolumeBackupRequestBody.zod.js +1 -1
- package/dist/compute/v2/generated/validators/updateVolumeRequestBody.zod.d.ts +1 -12
- package/dist/compute/v2/generated/validators/updateVolumeRequestBody.zod.js +2 -15
- package/dist/compute/v2/generated/validators/updateVolumeSnapshotRequestBody.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/updateVolumeSnapshotRequestBody.zod.js +1 -1
- package/dist/compute/v2/generated/validators/virtualPrivateCloud.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/virtualPrivateCloud.zod.js +5 -5
- package/dist/compute/v2/generated/validators/virtualPrivateCloudId.zod.d.ts +41 -0
- package/dist/compute/v2/generated/validators/virtualPrivateCloudId.zod.js +44 -0
- package/dist/compute/v2/generated/validators/virtualPrivateCloudIdOrWildcard.zod.d.ts +39 -0
- package/dist/compute/v2/generated/validators/{virtualPrivateCloudIDOrWildcard.zod.js → virtualPrivateCloudIdOrWildcard.zod.js} +4 -4
- package/dist/compute/v2/generated/validators/virtualPrivateCloudListResponseBody.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/virtualPrivateCloudListResponseBody.zod.js +1 -1
- package/dist/compute/v2/generated/validators/virtualPrivateCloudPeeringId.zod.d.ts +41 -0
- package/dist/compute/v2/generated/validators/virtualPrivateCloudPeeringId.zod.js +44 -0
- package/dist/compute/v2/generated/validators/virtualPrivateCloudPeeringListResponseBody.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/virtualPrivateCloudPeeringListResponseBody.zod.js +1 -1
- package/dist/compute/v2/generated/validators/virtualPrivateCloudPeeringResource.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/virtualPrivateCloudPeeringResource.zod.js +8 -8
- package/dist/compute/v2/generated/validators/virtualPrivateCloudRouteId.zod.d.ts +41 -0
- package/dist/compute/v2/generated/validators/virtualPrivateCloudRouteId.zod.js +44 -0
- package/dist/compute/v2/generated/validators/virtualPrivateCloudRouteListResponseBody.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/virtualPrivateCloudRouteListResponseBody.zod.js +1 -1
- package/dist/compute/v2/generated/validators/virtualPrivateCloudRouteResource.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/virtualPrivateCloudRouteResource.zod.js +7 -7
- package/dist/compute/v2/generated/validators/virtualPrivateCloudRouteType.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/virtualPrivateCloudRouteType.zod.js +1 -1
- package/dist/compute/v2/generated/validators/virtualPrivateCloudSubnet.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/virtualPrivateCloudSubnet.zod.js +5 -5
- package/dist/compute/v2/generated/validators/virtualPrivateCloudSubnetListResponseBody.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/virtualPrivateCloudSubnetListResponseBody.zod.js +1 -1
- package/dist/compute/v2/generated/validators/volumeAttachment.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/volumeAttachment.zod.js +7 -7
- package/dist/compute/v2/generated/validators/volumeAttachmentList.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/volumeAttachmentList.zod.js +1 -1
- package/dist/compute/v2/generated/validators/volumeBackupId.zod.d.ts +41 -0
- package/dist/compute/v2/generated/validators/{volumeBackupID.zod.js → volumeBackupId.zod.js} +8 -8
- package/dist/compute/v2/generated/validators/volumeBackupListResponseBody.zod.d.ts +3 -1
- package/dist/compute/v2/generated/validators/volumeBackupListResponseBody.zod.js +1 -1
- package/dist/compute/v2/generated/validators/volumeBackupReleaseResource.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/volumeBackupReleaseResource.zod.js +3 -3
- package/dist/compute/v2/generated/validators/volumeBackupResource.zod.d.ts +3 -1
- package/dist/compute/v2/generated/validators/volumeBackupResource.zod.js +15 -11
- package/dist/compute/v2/generated/validators/{updateVolumeResponseBody.zod.d.ts → volumeChangeResponseBody.zod.d.ts} +7 -5
- package/dist/compute/v2/generated/validators/{availabilityZoneID.zod.d.ts → volumeChangeResponseBody.zod.js} +14 -7
- package/dist/compute/v2/generated/validators/volumeId.zod.d.ts +41 -0
- package/dist/compute/v2/generated/validators/{volumeID.zod.js → volumeId.zod.js} +8 -8
- package/dist/compute/v2/generated/validators/volumeListResponseBody.zod.d.ts +3 -1
- package/dist/compute/v2/generated/validators/volumeListResponseBody.zod.js +1 -1
- package/dist/compute/v2/generated/validators/volumePerformance.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/volumePerformance.zod.js +1 -1
- package/dist/compute/v2/generated/validators/volumeReleaseResource.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/volumeReleaseResource.zod.js +3 -3
- package/dist/compute/v2/generated/validators/volumeResource.zod.d.ts +3 -1
- package/dist/compute/v2/generated/validators/volumeResource.zod.js +15 -11
- package/dist/compute/v2/generated/validators/volumeSnapshotId.zod.d.ts +41 -0
- package/dist/compute/v2/generated/validators/{volumeSnapshotID.zod.js → volumeSnapshotId.zod.js} +8 -8
- package/dist/compute/v2/generated/validators/volumeSnapshotListResponseBody.zod.d.ts +3 -1
- package/dist/compute/v2/generated/validators/volumeSnapshotListResponseBody.zod.js +1 -1
- package/dist/compute/v2/generated/validators/volumeSnapshotReleaseResource.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/volumeSnapshotReleaseResource.zod.js +3 -3
- package/dist/compute/v2/generated/validators/volumeSnapshotResource.zod.d.ts +3 -1
- package/dist/compute/v2/generated/validators/volumeSnapshotResource.zod.js +15 -11
- package/dist/compute/v2/generated/validators/volumeTypeId.zod.d.ts +41 -0
- package/dist/compute/v2/generated/validators/{volumeTypeID.zod.js → volumeTypeId.zod.js} +8 -8
- package/dist/compute/v2/generated/validators/volumeTypeListResponseBody.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/volumeTypeListResponseBody.zod.js +1 -1
- package/dist/compute/v2/generated/validators/volumeTypePerformance.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/volumeTypePerformance.zod.js +1 -1
- package/dist/compute/v2/generated/validators/volumeTypeResource.zod.d.ts +1 -1
- package/dist/compute/v2/generated/validators/volumeTypeResource.zod.js +7 -7
- package/dist/membership/v1/generated/models.d.ts +5 -0
- package/dist/membership/v1/generated/schemas.zod.d.ts +2 -0
- package/dist/membership/v1/generated/validators/checkoutOptions.zod.d.ts +2 -0
- package/dist/membership/v1/generated/validators/checkoutOptions.zod.js +5 -0
- package/dist/membership/v1/generated/validators/membershipCreate.zod.d.ts +1 -0
- package/dist/membership/v1/generated/validators/membershipUpgrade.zod.d.ts +1 -0
- package/dist/routes.d.ts +59 -19
- package/dist/routes.js +65 -20
- package/package.json +1 -1
- package/dist/compute/v2/generated/validators/elasticIPAssociationID.zod.d.ts +0 -41
- package/dist/compute/v2/generated/validators/elasticIPAssociationID.zod.js +0 -44
- package/dist/compute/v2/generated/validators/elasticIPID.zod.d.ts +0 -41
- package/dist/compute/v2/generated/validators/elasticIPLineID.zod.d.ts +0 -41
- package/dist/compute/v2/generated/validators/elasticIPLineID.zod.js +0 -44
- package/dist/compute/v2/generated/validators/iPv4HostAddress.zod.d.ts +0 -41
- package/dist/compute/v2/generated/validators/instanceFamilyID.zod.d.ts +0 -41
- package/dist/compute/v2/generated/validators/instanceID.zod.d.ts +0 -41
- package/dist/compute/v2/generated/validators/instanceNetworkInterfaceID.zod.d.ts +0 -41
- package/dist/compute/v2/generated/validators/instanceNetworkInterfaceID.zod.js +0 -44
- package/dist/compute/v2/generated/validators/instanceTypeID.zod.d.ts +0 -41
- package/dist/compute/v2/generated/validators/instanceVolumeID.zod.d.ts +0 -41
- package/dist/compute/v2/generated/validators/launchTemplateID.zod.d.ts +0 -41
- package/dist/compute/v2/generated/validators/networkInterfaceAddressID.zod.d.ts +0 -41
- package/dist/compute/v2/generated/validators/networkInterfaceAddressID.zod.js +0 -44
- package/dist/compute/v2/generated/validators/networkInterfaceID.zod.d.ts +0 -41
- package/dist/compute/v2/generated/validators/operationLogID.zod.d.ts +0 -41
- package/dist/compute/v2/generated/validators/securityGroupID.zod.d.ts +0 -41
- package/dist/compute/v2/generated/validators/securityGroupIDOrWildcard.zod.d.ts +0 -39
- package/dist/compute/v2/generated/validators/securityGroupRuleID.zod.d.ts +0 -41
- package/dist/compute/v2/generated/validators/securityGroupRuleID.zod.js +0 -44
- package/dist/compute/v2/generated/validators/subnetID.zod.d.ts +0 -41
- package/dist/compute/v2/generated/validators/updateElasticIPRequestBody.zod.js +0 -48
- package/dist/compute/v2/generated/validators/updateElasticIPResponseBody.zod.js +0 -49
- package/dist/compute/v2/generated/validators/updateInstanceResponseBody.zod.js +0 -49
- package/dist/compute/v2/generated/validators/updateVolumeResponseBody.zod.js +0 -49
- package/dist/compute/v2/generated/validators/virtualPrivateCloudID.zod.d.ts +0 -41
- package/dist/compute/v2/generated/validators/virtualPrivateCloudID.zod.js +0 -44
- package/dist/compute/v2/generated/validators/virtualPrivateCloudIDOrWildcard.zod.d.ts +0 -39
- package/dist/compute/v2/generated/validators/virtualPrivateCloudPeeringID.zod.d.ts +0 -41
- package/dist/compute/v2/generated/validators/virtualPrivateCloudPeeringID.zod.js +0 -44
- package/dist/compute/v2/generated/validators/virtualPrivateCloudRouteID.zod.d.ts +0 -41
- package/dist/compute/v2/generated/validators/virtualPrivateCloudRouteID.zod.js +0 -44
- package/dist/compute/v2/generated/validators/volumeBackupID.zod.d.ts +0 -41
- package/dist/compute/v2/generated/validators/volumeID.zod.d.ts +0 -41
- package/dist/compute/v2/generated/validators/volumeSnapshotID.zod.d.ts +0 -41
- package/dist/compute/v2/generated/validators/volumeTypeID.zod.d.ts +0 -41
|
@@ -50,19 +50,19 @@ export declare const QuoteRenewalInterval: {
|
|
|
50
50
|
readonly year: "year";
|
|
51
51
|
};
|
|
52
52
|
/**
|
|
53
|
-
* Price renewing a licensed
|
|
54
|
-
* `interval_count
|
|
55
|
-
*
|
|
56
|
-
*
|
|
57
|
-
* `
|
|
53
|
+
* Price renewing a whole subscription: every continuing licensed item. Give `interval` with
|
|
54
|
+
* `interval_count` to renew for another term at the price each item currently sells it for, with
|
|
55
|
+
* its own cancellation policy or the only price of that term. Naming the current term, or giving
|
|
56
|
+
* neither, renews every item at its agreed amount. A term an item does not sell is refused with
|
|
57
|
+
* 409 `BILLING_RENEWAL_PRICE_UNAVAILABLE` and `meta.subscription_item_id`; prices the rule cannot
|
|
58
|
+
* choose between, with 409 `BILLING_RENEWAL_OPTION_AMBIGUOUS` unless `cancellation_policy` is given.
|
|
58
59
|
*/
|
|
59
60
|
export interface QuoteRenewal {
|
|
60
61
|
subscription_id: string;
|
|
61
|
-
price_id?: string;
|
|
62
62
|
interval?: QuoteRenewalInterval;
|
|
63
63
|
/** @minimum 1 */
|
|
64
64
|
interval_count?: number;
|
|
65
|
-
/** With `interval` and `interval_count`,
|
|
65
|
+
/** With `interval` and `interval_count`, renews every item at its price of that term with this cancellation policy. */
|
|
66
66
|
cancellation_policy?: CancellationPolicy;
|
|
67
67
|
/**
|
|
68
68
|
* How many consecutive periods to renew for.
|
|
@@ -90,18 +90,30 @@ export declare const QuoteRenewalResultInterval: {
|
|
|
90
90
|
*/
|
|
91
91
|
export type Money = string;
|
|
92
92
|
/**
|
|
93
|
-
*
|
|
93
|
+
* One item of a quoted renewal.
|
|
94
|
+
*/
|
|
95
|
+
export interface QuoteRenewalItem {
|
|
96
|
+
subscription_item_id: string;
|
|
97
|
+
plan_id: string;
|
|
98
|
+
plan_name: string;
|
|
99
|
+
/** The price the item is charged under. */
|
|
100
|
+
price_id: string;
|
|
101
|
+
/** The price of the periods for this item before the account's discounts. */
|
|
102
|
+
amount: Money;
|
|
103
|
+
}
|
|
104
|
+
/**
|
|
105
|
+
* What renewing one subscription would charge as part of the quoted renewal order.
|
|
94
106
|
*/
|
|
95
107
|
export interface QuoteRenewalResult {
|
|
96
108
|
/** Which renewal of the request this answers. */
|
|
97
109
|
index: number;
|
|
98
110
|
subscription_id: string;
|
|
99
|
-
/**
|
|
100
|
-
|
|
111
|
+
/** Each item the renewal covers, with the price it is charged under. */
|
|
112
|
+
items: QuoteRenewalItem[];
|
|
101
113
|
interval: QuoteRenewalResultInterval;
|
|
102
114
|
interval_count: number;
|
|
103
115
|
periods: number;
|
|
104
|
-
/** The price of the periods before the account's discounts, with any discount the
|
|
116
|
+
/** The price of the periods for every item before the account's discounts, with any discount the items carry already reflected; includes tax only where the price does. */
|
|
105
117
|
amount: Money;
|
|
106
118
|
/** The reduction from a discount the account holds. */
|
|
107
119
|
discount_amount: Money;
|
|
@@ -137,7 +149,7 @@ export type QuoteItemDimensions = {
|
|
|
137
149
|
* @maxLength 64
|
|
138
150
|
* @pattern ^[a-z][a-z0-9]*(-[a-z0-9]+)*$
|
|
139
151
|
*/
|
|
140
|
-
export type
|
|
152
|
+
export type ProductId = string;
|
|
141
153
|
/**
|
|
142
154
|
* `one_time` charges once when bought. `recurring` charges again for every period, or for usage as it is settled.
|
|
143
155
|
*/
|
|
@@ -161,7 +173,7 @@ export declare const UsageType: {
|
|
|
161
173
|
export interface QuoteDowngradeRefund {
|
|
162
174
|
/** Returned to the original payment sources, tax paid on it included. */
|
|
163
175
|
refundable_amount: Money;
|
|
164
|
-
/** Before tax, the part of the excess that the
|
|
176
|
+
/** Before tax, the part of the excess that the item's refund terms do not return. */
|
|
165
177
|
forfeited_amount: Money;
|
|
166
178
|
}
|
|
167
179
|
/**
|
|
@@ -176,11 +188,16 @@ export interface QuoteItem {
|
|
|
176
188
|
*/
|
|
177
189
|
index: number;
|
|
178
190
|
/**
|
|
179
|
-
* The subscription
|
|
191
|
+
* The subscription the line belongs to when it changes an item or is added to an existing subscription; null when it opens a new one.
|
|
180
192
|
* @nullable
|
|
181
193
|
*/
|
|
182
194
|
subscription_id: string | null;
|
|
183
|
-
|
|
195
|
+
/**
|
|
196
|
+
* The subscription item changed; null for a new line.
|
|
197
|
+
* @nullable
|
|
198
|
+
*/
|
|
199
|
+
subscription_item_id: string | null;
|
|
200
|
+
product_id: ProductId;
|
|
184
201
|
plan_id: string;
|
|
185
202
|
/** The selected price, also when the request identified it indirectly. */
|
|
186
203
|
price_id: string;
|
|
@@ -306,13 +323,19 @@ export interface Quote {
|
|
|
306
323
|
total: Money;
|
|
307
324
|
currency: string;
|
|
308
325
|
/**
|
|
309
|
-
* Immediate changes only; null otherwise. The instant
|
|
326
|
+
* Immediate changes and items added to an existing subscription only; null otherwise. The instant they are priced from; pass it when confirming the Checkout Session so it is priced from the same instant.
|
|
310
327
|
* @nullable
|
|
311
328
|
*/
|
|
312
329
|
proration_date: string | null;
|
|
313
330
|
/** `complete`: tax is calculated for the billing account's invoice contact, or for `address` without an account. `requires_location_inputs`: a quote without an account or `address`, which leaves out tax that would be added; tax already contained in a price is included. */
|
|
314
331
|
tax_status: QuoteTaxStatus;
|
|
315
332
|
}
|
|
333
|
+
/**
|
|
334
|
+
* One subscription item to end, each at most once.
|
|
335
|
+
*/
|
|
336
|
+
export interface CancellationItemInput {
|
|
337
|
+
subscription_item_id: string;
|
|
338
|
+
}
|
|
316
339
|
/**
|
|
317
340
|
* When subscriptions end. immediate ends them now and refunds the unused value under their refund terms; period_end
|
|
318
341
|
* ends them at the end of their paid period. The cancellation terms fixed when a subscription was bought decide which
|
|
@@ -326,20 +349,20 @@ export declare const CancellationMode: {
|
|
|
326
349
|
readonly period_end: "period_end";
|
|
327
350
|
};
|
|
328
351
|
/**
|
|
329
|
-
* What ending these
|
|
352
|
+
* What ending these items together would return, for one mode; preview `immediate` and `period_end` separately to compare. Refused with 409 `BILLING_SUBSCRIPTION_OPERATION_PENDING` when an item is already being canceled (`meta.cancellation_id`), its subscription is being reclaimed (`meta.reason` `reclaim_requested`) or the item has a paid change waiting to switch (`meta.order_id`).
|
|
330
353
|
*/
|
|
331
354
|
export interface CancellationPreviewRequest {
|
|
332
355
|
/**
|
|
333
|
-
* A billing account you own that currently pays for every
|
|
356
|
+
* A billing account you own that currently pays for every item.
|
|
334
357
|
* @minimum 1
|
|
335
358
|
*/
|
|
336
359
|
billing_account_id: number;
|
|
337
360
|
/**
|
|
338
|
-
* The
|
|
361
|
+
* The items to end together, all of one service, including every item released with a resource.
|
|
339
362
|
* @minItems 1
|
|
340
363
|
* @maxItems 50
|
|
341
364
|
*/
|
|
342
|
-
|
|
365
|
+
items: CancellationItemInput[];
|
|
343
366
|
mode: CancellationMode;
|
|
344
367
|
}
|
|
345
368
|
/**
|
|
@@ -358,9 +381,11 @@ export interface NamedIdentity {
|
|
|
358
381
|
name: string;
|
|
359
382
|
}
|
|
360
383
|
/**
|
|
361
|
-
* One subscription of the previewed cancellation.
|
|
384
|
+
* One subscription item of the previewed cancellation.
|
|
362
385
|
*/
|
|
363
386
|
export interface CancellationPreviewItem {
|
|
387
|
+
subscription_item_id: string;
|
|
388
|
+
/** The subscription the item belongs to. */
|
|
364
389
|
subscription_id: string;
|
|
365
390
|
plan_id: string;
|
|
366
391
|
plan_name: string;
|
|
@@ -368,7 +393,7 @@ export interface CancellationPreviewItem {
|
|
|
368
393
|
project?: NamedIdentity | null;
|
|
369
394
|
type: PriceType;
|
|
370
395
|
usage_type: UsageType;
|
|
371
|
-
/** Whether
|
|
396
|
+
/** Whether the item's subscription renews automatically now. Creating a cancellation of every continuing item of the subscription turns it off; withdrawing it turns it back on for a subscription with only metered items but not for one with licensed items. */
|
|
372
397
|
auto_renew: boolean;
|
|
373
398
|
unused_amount: Money;
|
|
374
399
|
short_rate_surcharge_amount: Money;
|
|
@@ -379,7 +404,7 @@ export interface CancellationPreviewItem {
|
|
|
379
404
|
forfeited_amount: Money;
|
|
380
405
|
}
|
|
381
406
|
/**
|
|
382
|
-
* What the cancellation would return, per
|
|
407
|
+
* What the cancellation would return, per item and in total, as of now. Give `proration_date` and
|
|
383
408
|
* `refundable_amount` when creating the cancellation.
|
|
384
409
|
*
|
|
385
410
|
* - `unused_amount`: before tax, the amount paid for the current periods in proportion to the time remaining.
|
|
@@ -392,11 +417,11 @@ export interface CancellationPreviewItem {
|
|
|
392
417
|
* - `tax_amount`: the tax included in `refundable_amount`.
|
|
393
418
|
* - `forfeited_amount`: before tax, the part of `unused_amount` the refund terms do not return.
|
|
394
419
|
*
|
|
395
|
-
* Metered and one-time
|
|
420
|
+
* Metered and one-time items show zero; their usage until release is charged as usual.
|
|
396
421
|
*/
|
|
397
422
|
export interface CancellationPreview {
|
|
398
423
|
mode: CancellationMode;
|
|
399
|
-
/** For `period_end`, when release begins, the end of the
|
|
424
|
+
/** For `period_end`, when release begins, the end of the subscriptions' current terms. */
|
|
400
425
|
scheduled_at?: string;
|
|
401
426
|
/** For `immediate`, the second the refund is computed as of. Give it when creating the cancellation. */
|
|
402
427
|
proration_date?: string;
|
|
@@ -416,7 +441,7 @@ export interface CancellationCreate {
|
|
|
416
441
|
* @minItems 1
|
|
417
442
|
* @maxItems 50
|
|
418
443
|
*/
|
|
419
|
-
|
|
444
|
+
items: CancellationItemInput[];
|
|
420
445
|
mode: CancellationMode;
|
|
421
446
|
/** For `immediate`, the preview's `proration_date`: a whole second, not in the future and at most ten minutes old; the refund is computed as of it. Now when omitted. */
|
|
422
447
|
proration_date?: string;
|
|
@@ -456,18 +481,21 @@ export declare const CancellationItemStatus: {
|
|
|
456
481
|
readonly failed: "failed";
|
|
457
482
|
};
|
|
458
483
|
/**
|
|
459
|
-
* One subscription of the cancellation.
|
|
484
|
+
* One subscription item of the cancellation.
|
|
460
485
|
*/
|
|
461
486
|
export interface CancellationItem {
|
|
462
|
-
/** The
|
|
487
|
+
/** The item's entry in the cancellation, the same as `SubscriptionItem.cancellation.id`. */
|
|
463
488
|
id: string;
|
|
489
|
+
subscription_item_id: string;
|
|
490
|
+
/** The subscription the item belongs to. */
|
|
464
491
|
subscription_id: string;
|
|
465
492
|
plan_id: string;
|
|
466
493
|
plan_name: string;
|
|
467
494
|
type: PriceType;
|
|
468
495
|
/**
|
|
469
|
-
*
|
|
470
|
-
*
|
|
496
|
+
* When the cancellation covers every continuing item of a subscription, creating it turned the
|
|
497
|
+
* subscription's automatic renewal off; withdrawing it turns renewal back on for a subscription with
|
|
498
|
+
* only `metered` items and leaves it off for one with `licensed` items.
|
|
471
499
|
*/
|
|
472
500
|
usage_type: UsageType;
|
|
473
501
|
status: CancellationItemStatus;
|
|
@@ -484,15 +512,15 @@ export interface CancellationItem {
|
|
|
484
512
|
gateway_amount?: Money;
|
|
485
513
|
}
|
|
486
514
|
/**
|
|
487
|
-
* One cancellation of a set of
|
|
515
|
+
* One cancellation of a set of subscription items of one service, released together at one time.
|
|
488
516
|
*
|
|
489
517
|
* - `requested`: `immediate`, release has not begun.
|
|
490
518
|
* - `scheduled`: `period_end`, waiting for `scheduled_at`.
|
|
491
519
|
* - `releasing`: release has begun; it can no longer be withdrawn.
|
|
492
|
-
* - `completed`: every
|
|
493
|
-
* - `canceled`: withdrawn before release began; the
|
|
520
|
+
* - `completed`: every item has ended and its refund has been made.
|
|
521
|
+
* - `canceled`: withdrawn before release began; the items continue.
|
|
494
522
|
* - `failed`: the service could not carry it out, for the reason in `failure_code`; the
|
|
495
|
-
*
|
|
523
|
+
* items continue and can be canceled again.
|
|
496
524
|
*/
|
|
497
525
|
export interface Cancellation {
|
|
498
526
|
id: string;
|
|
@@ -503,7 +531,7 @@ export interface Cancellation {
|
|
|
503
531
|
proration_date?: string;
|
|
504
532
|
/** Who requested it; `project_deletion` means the project was deleted. */
|
|
505
533
|
origin: CancellationOrigin;
|
|
506
|
-
/** The billing account paying for these
|
|
534
|
+
/** The billing account paying for these items when the cancellation was created: the purchasing account of an account-level purchase, or the project's linked account. */
|
|
507
535
|
billing_account_id: number;
|
|
508
536
|
currency: string;
|
|
509
537
|
/** The refund confirmed when the cancellation was created. Absent when the platform created it. */
|
|
@@ -530,8 +558,8 @@ export interface CancellationList {
|
|
|
530
558
|
items: Cancellation[];
|
|
531
559
|
pagination: OffsetPagination;
|
|
532
560
|
}
|
|
533
|
-
export type
|
|
534
|
-
export declare const
|
|
561
|
+
export type SubscriptionItemCancellationStatus = (typeof SubscriptionItemCancellationStatus)[keyof typeof SubscriptionItemCancellationStatus];
|
|
562
|
+
export declare const SubscriptionItemCancellationStatus: {
|
|
535
563
|
readonly requested: "requested";
|
|
536
564
|
readonly scheduled: "scheduled";
|
|
537
565
|
readonly releasing: "releasing";
|
|
@@ -540,15 +568,15 @@ export declare const SubscriptionCancellationStatus: {
|
|
|
540
568
|
readonly canceled: "canceled";
|
|
541
569
|
};
|
|
542
570
|
/**
|
|
543
|
-
* The latest cancellation including the subscription, with this
|
|
571
|
+
* The latest cancellation including the subscription item, with this item's entry: `id` is the entry and `cancellation_id` the cancellation. scheduled_at is the intended time and effective_at the confirmed end of service.
|
|
544
572
|
*/
|
|
545
|
-
export interface
|
|
573
|
+
export interface SubscriptionItemCancellation {
|
|
546
574
|
reason?: string;
|
|
547
|
-
/** The cancellation this
|
|
575
|
+
/** The cancellation this entry belongs to, with the other items released together. */
|
|
548
576
|
cancellation_id?: string;
|
|
549
577
|
id: string;
|
|
550
|
-
|
|
551
|
-
status:
|
|
578
|
+
subscription_item_id: string;
|
|
579
|
+
status: SubscriptionItemCancellationStatus;
|
|
552
580
|
mode: CancellationMode;
|
|
553
581
|
requested_at: string;
|
|
554
582
|
scheduled_at?: string;
|
|
@@ -620,7 +648,7 @@ export interface Error {
|
|
|
620
648
|
error: ErrorStatus;
|
|
621
649
|
}
|
|
622
650
|
export interface Product {
|
|
623
|
-
id:
|
|
651
|
+
id: ProductId;
|
|
624
652
|
name: string;
|
|
625
653
|
description?: string;
|
|
626
654
|
}
|
|
@@ -1310,7 +1338,7 @@ export type InvoiceItemDimensions = {
|
|
|
1310
1338
|
[key: string]: string;
|
|
1311
1339
|
};
|
|
1312
1340
|
/**
|
|
1313
|
-
* The value of one paid period moved to the new configuration of a subscription.
|
|
1341
|
+
* The value of one paid period moved to the new configuration of a subscription item.
|
|
1314
1342
|
*/
|
|
1315
1343
|
export interface InvoiceItemProration {
|
|
1316
1344
|
/** The earlier invoice line that paid for the period. */
|
|
@@ -1371,7 +1399,7 @@ export interface InvoiceItem {
|
|
|
1371
1399
|
/** For a usage line, the values of its meter's presentation dimensions, such as the model and token kind. Empty for other lines. */
|
|
1372
1400
|
dimensions?: InvoiceItemDimensions;
|
|
1373
1401
|
/**
|
|
1374
|
-
* Present on a line that changes a subscription immediately, one entry for each paid period it
|
|
1402
|
+
* Present on a line that changes a subscription item immediately, one entry for each paid period it
|
|
1375
1403
|
* covers. `amount` is the sum of `remaining_amount` minus `credited_amount` over the entries.
|
|
1376
1404
|
*/
|
|
1377
1405
|
prorations?: InvoiceItemProration[];
|
|
@@ -1508,7 +1536,7 @@ export declare const RefundStatus: {
|
|
|
1508
1536
|
* - `order_canceled`: the order was canceled after part of it was paid.
|
|
1509
1537
|
* - `change_canceled`: a scheduled change was withdrawn after part of it was paid.
|
|
1510
1538
|
* - `change_expired`: a scheduled change could not take effect in time.
|
|
1511
|
-
* - `subscription_canceled`: the unused value of a canceled subscription, under its refund terms.
|
|
1539
|
+
* - `subscription_canceled`: the unused value of a canceled subscription item, under its refund terms.
|
|
1512
1540
|
* - `future_period_canceled`: a renewal that had not started was withdrawn.
|
|
1513
1541
|
* - `downgrade_difference`: after a downgrade, the remaining paid value, valued under each paid period's refund
|
|
1514
1542
|
* policy and as `prorated` where that policy is `none`, minus the new configuration's value for the remaining
|
|
@@ -1580,6 +1608,9 @@ export type UsageChargeDimensions = {
|
|
|
1580
1608
|
[key: string]: string;
|
|
1581
1609
|
};
|
|
1582
1610
|
export interface UsageCharge {
|
|
1611
|
+
/** The subscription item the usage belongs to. */
|
|
1612
|
+
subscription_item_id: string;
|
|
1613
|
+
/** The subscription the item belongs to. */
|
|
1583
1614
|
subscription_id: string;
|
|
1584
1615
|
id: string;
|
|
1585
1616
|
project_id?: string;
|
|
@@ -1623,6 +1654,22 @@ export interface UsageChargeList {
|
|
|
1623
1654
|
items: UsageCharge[];
|
|
1624
1655
|
pagination: OffsetPagination;
|
|
1625
1656
|
}
|
|
1657
|
+
/**
|
|
1658
|
+
* `pending`: the order has not been accepted. `provisioning`: the owning service accepted the order and is delivering. `active`: delivery was confirmed; payment alone does not make a subscription active. `trialing`: in a free trial, in service and not charged until `trial_end`. `suspended`: service is stopped while a lien restricts its use. `canceled`: cancellation of every item completed, or an undelivered purchase was canceled or failed. `terminated`: an operator or the owning service ended it immediately.
|
|
1659
|
+
*/
|
|
1660
|
+
export type SubscriptionStatus = (typeof SubscriptionStatus)[keyof typeof SubscriptionStatus];
|
|
1661
|
+
export declare const SubscriptionStatus: {
|
|
1662
|
+
readonly pending: "pending";
|
|
1663
|
+
readonly provisioning: "provisioning";
|
|
1664
|
+
readonly active: "active";
|
|
1665
|
+
readonly trialing: "trialing";
|
|
1666
|
+
readonly suspended: "suspended";
|
|
1667
|
+
readonly canceled: "canceled";
|
|
1668
|
+
readonly terminated: "terminated";
|
|
1669
|
+
};
|
|
1670
|
+
/**
|
|
1671
|
+
* The renewal term of its licensed items, `interval_count` intervals long; `none` when every item is metered.
|
|
1672
|
+
*/
|
|
1626
1673
|
export type SubscriptionInterval = (typeof SubscriptionInterval)[keyof typeof SubscriptionInterval];
|
|
1627
1674
|
export declare const SubscriptionInterval: {
|
|
1628
1675
|
readonly none: "none";
|
|
@@ -1630,6 +1677,30 @@ export declare const SubscriptionInterval: {
|
|
|
1630
1677
|
readonly month: "month";
|
|
1631
1678
|
readonly year: "year";
|
|
1632
1679
|
};
|
|
1680
|
+
/**
|
|
1681
|
+
* What happens when the trial ends while automatic renewal is off. With it on, the first paid period is charged to the account's funds or saved payment method, and this applies only when that charge fails. `cancel`: the subscription ends and its resources are released. `pause`: service stops, and renewing before the retention period ends restores it, with the first paid period starting at payment. `create_invoice`: as `pause`, and an invoice for the first paid period is issued to pay.
|
|
1682
|
+
*/
|
|
1683
|
+
export type TrialEndBehaviorMissingPaymentMethod = (typeof TrialEndBehaviorMissingPaymentMethod)[keyof typeof TrialEndBehaviorMissingPaymentMethod];
|
|
1684
|
+
export declare const TrialEndBehaviorMissingPaymentMethod: {
|
|
1685
|
+
readonly cancel: "cancel";
|
|
1686
|
+
readonly pause: "pause";
|
|
1687
|
+
readonly create_invoice: "create_invoice";
|
|
1688
|
+
};
|
|
1689
|
+
export interface TrialEndBehavior {
|
|
1690
|
+
/** What happens when the trial ends while automatic renewal is off. With it on, the first paid period is charged to the account's funds or saved payment method, and this applies only when that charge fails. `cancel`: the subscription ends and its resources are released. `pause`: service stops, and renewing before the retention period ends restores it, with the first paid period starting at payment. `create_invoice`: as `pause`, and an invoice for the first paid period is issued to pay. */
|
|
1691
|
+
missing_payment_method: TrialEndBehaviorMissingPaymentMethod;
|
|
1692
|
+
/**
|
|
1693
|
+
* How long a subscription stopped at the end of its trial keeps its resources before they are reclaimed; null for the platform's retention period.
|
|
1694
|
+
* @nullable
|
|
1695
|
+
*/
|
|
1696
|
+
retention_seconds: number | null;
|
|
1697
|
+
}
|
|
1698
|
+
/**
|
|
1699
|
+
* How a free trial ends, as Stripe's trial_settings.
|
|
1700
|
+
*/
|
|
1701
|
+
export interface TrialSettings {
|
|
1702
|
+
end_behavior: TrialEndBehavior;
|
|
1703
|
+
}
|
|
1633
1704
|
/**
|
|
1634
1705
|
* An operation prevented on the subscription. `billing.subscriptions.use` stops the service. `renew` prevents renewal and paying a renewal order. `modify` prevents placing a change order. `cancel` prevents cancellation. `terminate` prevents immediate termination.
|
|
1635
1706
|
*/
|
|
@@ -1660,7 +1731,7 @@ export declare const ScheduledChangeInterval: {
|
|
|
1660
1731
|
readonly year: "year";
|
|
1661
1732
|
};
|
|
1662
1733
|
/**
|
|
1663
|
-
* The next accepted period-end change of the
|
|
1734
|
+
* The next accepted period-end change of the item: the target terms, applied at effective_at.
|
|
1664
1735
|
*/
|
|
1665
1736
|
export interface ScheduledChange {
|
|
1666
1737
|
order_id: string;
|
|
@@ -1678,51 +1749,30 @@ export interface ScheduledChange {
|
|
|
1678
1749
|
/** @minimum 1 */
|
|
1679
1750
|
interval_count: number;
|
|
1680
1751
|
}
|
|
1681
|
-
/**
|
|
1682
|
-
* `pending`: the order has not been accepted. `provisioning`: the owning service accepted the order and is delivering. `active`: delivery was confirmed; payment alone does not make a subscription active. `suspended`: service is stopped while a lien restricts its use. `canceled`: cancellation completed, or an undelivered purchase was canceled or failed. `terminated`: an operator or the owning service ended it immediately.
|
|
1683
|
-
*/
|
|
1684
|
-
export type SubscriptionStatus = (typeof SubscriptionStatus)[keyof typeof SubscriptionStatus];
|
|
1685
|
-
export declare const SubscriptionStatus: {
|
|
1686
|
-
readonly pending: "pending";
|
|
1687
|
-
readonly provisioning: "provisioning";
|
|
1688
|
-
readonly active: "active";
|
|
1689
|
-
readonly suspended: "suspended";
|
|
1690
|
-
readonly canceled: "canceled";
|
|
1691
|
-
readonly terminated: "terminated";
|
|
1692
|
-
};
|
|
1693
1752
|
/**
|
|
1694
1753
|
* The dimension values of what was bought, such as region and instance type. Empty when the purchase gave none.
|
|
1695
1754
|
*/
|
|
1696
|
-
export type
|
|
1755
|
+
export type SubscriptionItemDimensions = {
|
|
1697
1756
|
[key: string]: string;
|
|
1698
1757
|
};
|
|
1699
1758
|
/**
|
|
1700
|
-
*
|
|
1701
|
-
* recurring purchase creates a pending subscription for each order line; its ID is returned on the order item
|
|
1702
|
-
* and stays the same through checkout, delivery, renewals and changes. A one-time purchase may create none.
|
|
1703
|
-
*
|
|
1704
|
-
* Pending and provisioning subscriptions grant no service. A subscription becomes provisioning when the owning
|
|
1705
|
-
* service accepts the order, and active when the service confirms delivery, which sets started_at; payment
|
|
1706
|
-
* changes neither. Licensed service periods start at delivery, and metered usage is charged as the service
|
|
1707
|
-
* reports it. Canceling or failing an undelivered purchase cancels its subscriptions without starting a period.
|
|
1708
|
-
* Renewals use recurring_amount and the agreed interval; paid periods keep their value.
|
|
1709
|
-
*
|
|
1710
|
-
* A shared capacity limit, such as a regional snapshot quota, has one subscription for the purchased quantity
|
|
1711
|
-
* rather than one per item.
|
|
1759
|
+
* One priced part of a subscription, as a Stripe subscription item, such as the instance, a volume or the bandwidth of an elastic IP. It renews with its subscription and can be changed or canceled alone.
|
|
1712
1760
|
*/
|
|
1713
|
-
export interface
|
|
1714
|
-
|
|
1715
|
-
|
|
1716
|
-
|
|
1761
|
+
export interface SubscriptionItem {
|
|
1762
|
+
id: string;
|
|
1763
|
+
subscription_id: string;
|
|
1764
|
+
plan_id: string;
|
|
1765
|
+
plan_name: string;
|
|
1766
|
+
price_id: string;
|
|
1717
1767
|
type: PriceType;
|
|
1718
1768
|
usage_type: UsageType;
|
|
1719
1769
|
/** The dimension values of what was bought, such as region and instance type. Empty when the purchase gave none. */
|
|
1720
|
-
dimensions:
|
|
1721
|
-
|
|
1722
|
-
/**
|
|
1723
|
-
interval_count?: number;
|
|
1724
|
-
/** The whole licensed subscription's renewal amount, after continuing discounts and before tax. A pending subscription shows base terms until paying the order fixes any new discount. Absent for metered and one-time subscriptions. */
|
|
1770
|
+
dimensions: SubscriptionItemDimensions;
|
|
1771
|
+
quantity: string;
|
|
1772
|
+
/** This item's renewal amount, after continuing discounts and before tax. A pending item shows base terms until paying the order fixes any new discount. Absent for metered and one-time items. */
|
|
1725
1773
|
recurring_amount?: string;
|
|
1774
|
+
/** Whether new account discounts may apply to this item in future renewals. A fixed operator renewal agreement disables automatic discounts; catalog repricing or a newly selected purchase agreement enables them. */
|
|
1775
|
+
renewal_discounts_enabled?: boolean;
|
|
1726
1776
|
cancellation_policy?: CancellationPolicy;
|
|
1727
1777
|
refund_policy?: RefundPolicy;
|
|
1728
1778
|
/** Refund policy `short_rate` only, as on the price bought. */
|
|
@@ -1731,28 +1781,46 @@ export interface Subscription {
|
|
|
1731
1781
|
short_rate_threshold_seconds?: number;
|
|
1732
1782
|
/** Licensed recurring only, the `monthly_list_amount` that a renewal at the agreed amount keeps; see the order item. */
|
|
1733
1783
|
monthly_list_amount?: string;
|
|
1734
|
-
order_item_id?: string;
|
|
1735
1784
|
coupon_id?: string;
|
|
1736
1785
|
coupon?: ObjectIdentity;
|
|
1737
1786
|
/** @minimum 0 */
|
|
1738
1787
|
discounted_renewals_remaining?: number;
|
|
1739
|
-
/** The
|
|
1740
|
-
|
|
1741
|
-
|
|
1742
|
-
|
|
1743
|
-
/** The accepted period-end change scheduled for this subscription; null when there is none. */
|
|
1788
|
+
/** The order item that created it. */
|
|
1789
|
+
order_item_id?: string;
|
|
1790
|
+
cancellation?: SubscriptionItemCancellation;
|
|
1791
|
+
/** The accepted period-end change scheduled for this item; null when there is none. */
|
|
1744
1792
|
scheduled_change?: ScheduledChange | null;
|
|
1793
|
+
created_at?: string;
|
|
1745
1794
|
/**
|
|
1746
|
-
*
|
|
1795
|
+
* When the item's service started. Null until its delivery is confirmed.
|
|
1747
1796
|
* @nullable
|
|
1748
1797
|
*/
|
|
1749
|
-
|
|
1750
|
-
|
|
1798
|
+
started_at?: string | null;
|
|
1799
|
+
/**
|
|
1800
|
+
* When the item ended, alone or with its subscription.
|
|
1801
|
+
* @nullable
|
|
1802
|
+
*/
|
|
1803
|
+
ended_at?: string | null;
|
|
1804
|
+
}
|
|
1805
|
+
/**
|
|
1806
|
+
* A billing relationship that renews as a whole, as a Stripe subscription: one term, one renewal date, one
|
|
1807
|
+
* automatic renewal setting and one service state for all of its items. The owning service decides which order
|
|
1808
|
+
* lines form one subscription, such as a machine and the volumes and elastic IP bought with it; a resource bought
|
|
1809
|
+
* on its own has its own. A purchase creates pending subscriptions and items whose IDs are returned on the order
|
|
1810
|
+
* items and stay the same through checkout, delivery, renewals and changes.
|
|
1811
|
+
*
|
|
1812
|
+
* Pending and provisioning subscriptions grant no service. A subscription becomes provisioning when the owning
|
|
1813
|
+
* service accepts the order, and active, or trialing during a free trial, when the service confirms delivery,
|
|
1814
|
+
* which sets started_at; payment changes neither. Renewing buys further periods for every continuing licensed
|
|
1815
|
+
* item at once; items cannot be renewed on their own, but each can be changed or canceled alone.
|
|
1816
|
+
*/
|
|
1817
|
+
export interface Subscription {
|
|
1751
1818
|
id: string;
|
|
1752
1819
|
/** The billing account that made the purchase. Renewals of a project subscription are charged to the project's current billing account. */
|
|
1753
1820
|
billing_account_id: number;
|
|
1754
1821
|
account: AccountIdentity;
|
|
1755
|
-
product_id:
|
|
1822
|
+
product_id: ProductId;
|
|
1823
|
+
product: Product;
|
|
1756
1824
|
/**
|
|
1757
1825
|
* The project it is for. Absent for an account-level purchase, such as a membership.
|
|
1758
1826
|
* @nullable
|
|
@@ -1760,29 +1828,52 @@ export interface Subscription {
|
|
|
1760
1828
|
project_id?: string | null;
|
|
1761
1829
|
/** The project and its current name. Absent for an account-level purchase or when the project cannot be read; `project_id` still identifies it. */
|
|
1762
1830
|
project?: NamedIdentity | null;
|
|
1763
|
-
|
|
1764
|
-
|
|
1765
|
-
|
|
1766
|
-
|
|
1767
|
-
|
|
1831
|
+
currency: string;
|
|
1832
|
+
status: SubscriptionStatus;
|
|
1833
|
+
/** The renewal term of its licensed items, `interval_count` intervals long; `none` when every item is metered. */
|
|
1834
|
+
interval: SubscriptionInterval;
|
|
1835
|
+
/** @minimum 1 */
|
|
1836
|
+
interval_count?: number;
|
|
1768
1837
|
/**
|
|
1769
|
-
* When
|
|
1838
|
+
* When the subscription renews or expires: the end of the free trial or of the last period bought for its licensed items, moved by renewing in advance. Null until the subscription becomes active, even when its purchase has been paid, and when every item is metered.
|
|
1770
1839
|
* @nullable
|
|
1771
1840
|
*/
|
|
1772
1841
|
current_term_end?: string | null;
|
|
1773
1842
|
/**
|
|
1774
|
-
* Start of the service period in effect now. Null when none is, including
|
|
1843
|
+
* Start of the service period in effect now. Null when none is, including when every item is metered.
|
|
1775
1844
|
* @nullable
|
|
1776
1845
|
*/
|
|
1777
1846
|
current_period_start?: string | null;
|
|
1778
1847
|
/**
|
|
1779
|
-
* End of the service period in effect now; renewing in advance moves `current_term_end`, not this. Null when no period is in effect, including
|
|
1848
|
+
* End of the service period in effect now; renewing in advance moves `current_term_end`, not this. Null when no period is in effect, including when every item is metered.
|
|
1780
1849
|
* @nullable
|
|
1781
1850
|
*/
|
|
1782
1851
|
current_period_end?: string | null;
|
|
1783
|
-
|
|
1852
|
+
billing_cycle_anchor?: string;
|
|
1853
|
+
/** Whether the subscription renews automatically, or converts to paid when its free trial ends. Without licensed items it continues until it is canceled; then this is true until a cancellation is requested, and cannot be set. */
|
|
1784
1854
|
auto_renew: boolean;
|
|
1785
|
-
|
|
1855
|
+
/**
|
|
1856
|
+
* Start of the free trial; null without one.
|
|
1857
|
+
* @nullable
|
|
1858
|
+
*/
|
|
1859
|
+
trial_start?: string | null;
|
|
1860
|
+
/**
|
|
1861
|
+
* End of the free trial; null without one. It is `current_term_end` until the first paid period is bought.
|
|
1862
|
+
* @nullable
|
|
1863
|
+
*/
|
|
1864
|
+
trial_end?: string | null;
|
|
1865
|
+
/** How the free trial ends; null without one. */
|
|
1866
|
+
trial_settings?: TrialSettings | null;
|
|
1867
|
+
/** The operations currently prevented on the subscription, sorted; it is suspended while this contains `billing.subscriptions.use`. */
|
|
1868
|
+
restrictions?: SubscriptionRestriction[];
|
|
1869
|
+
/**
|
|
1870
|
+
* The saved payment method automatic renewal charges after balance and credits, before the account's default payment method. Set when a purchase, renewal or change is paid with a saved payment method. Used only while it belongs to the account paying the renewal.
|
|
1871
|
+
* @nullable
|
|
1872
|
+
*/
|
|
1873
|
+
default_payment_method_id?: string | null;
|
|
1874
|
+
/** Every item, ended ones included, oldest first. */
|
|
1875
|
+
items: SubscriptionItem[];
|
|
1876
|
+
created_at?: string;
|
|
1786
1877
|
/**
|
|
1787
1878
|
* When service started. Null until a new subscription becomes active, also after payment.
|
|
1788
1879
|
* @nullable
|
|
@@ -1795,31 +1886,47 @@ export interface SubscriptionList {
|
|
|
1795
1886
|
items: Subscription[];
|
|
1796
1887
|
pagination: OffsetPagination;
|
|
1797
1888
|
}
|
|
1798
|
-
export type
|
|
1799
|
-
export declare const
|
|
1889
|
+
export type RenewalOptionInterval = (typeof RenewalOptionInterval)[keyof typeof RenewalOptionInterval];
|
|
1890
|
+
export declare const RenewalOptionInterval: {
|
|
1800
1891
|
readonly day: "day";
|
|
1801
1892
|
readonly month: "month";
|
|
1802
1893
|
readonly year: "year";
|
|
1803
1894
|
};
|
|
1804
|
-
|
|
1895
|
+
/**
|
|
1896
|
+
* What one item renews at under a renewal option.
|
|
1897
|
+
*/
|
|
1898
|
+
export interface RenewalOptionItem {
|
|
1899
|
+
subscription_item_id: string;
|
|
1900
|
+
/**
|
|
1901
|
+
* The price the item renews at; null on the current option, which keeps the agreed amount.
|
|
1902
|
+
* @nullable
|
|
1903
|
+
*/
|
|
1904
|
+
price_id: string | null;
|
|
1905
|
+
/** One period of this item, before tax and discounts. */
|
|
1906
|
+
amount: Money;
|
|
1805
1907
|
cancellation_policy?: CancellationPolicy;
|
|
1806
1908
|
refund_policy?: RefundPolicy;
|
|
1807
1909
|
/** Refund policy `short_rate` only. */
|
|
1808
1910
|
short_rate_multiplier?: string;
|
|
1809
1911
|
/** Refund policy `short_rate` only. */
|
|
1810
1912
|
short_rate_threshold_seconds?: number;
|
|
1811
|
-
|
|
1812
|
-
|
|
1913
|
+
}
|
|
1914
|
+
/**
|
|
1915
|
+
* One term the whole subscription can renew for. Every continuing licensed item renews at it; items with an open cancellation end with the current term and are left out.
|
|
1916
|
+
*/
|
|
1917
|
+
export interface RenewalOption {
|
|
1918
|
+
interval: RenewalOptionInterval;
|
|
1919
|
+
/** How many intervals one renewal covers. */
|
|
1813
1920
|
interval_count: number;
|
|
1814
|
-
|
|
1815
|
-
/** What renewing for this term costs, for the quantity held. */
|
|
1816
|
-
amount?: Money;
|
|
1817
|
-
currency?: string;
|
|
1818
|
-
/** The term the subscription renews at now; renewing for it keeps the agreed price. */
|
|
1921
|
+
/** The term the subscription renews at now; renewing for it keeps every item's agreed price. */
|
|
1819
1922
|
current: boolean;
|
|
1923
|
+
/** One period for every item, before tax and discounts. */
|
|
1924
|
+
amount: Money;
|
|
1925
|
+
currency: string;
|
|
1926
|
+
items: RenewalOptionItem[];
|
|
1820
1927
|
}
|
|
1821
|
-
export interface
|
|
1822
|
-
items:
|
|
1928
|
+
export interface RenewalOptionList {
|
|
1929
|
+
items: RenewalOption[];
|
|
1823
1930
|
pagination: OffsetPagination;
|
|
1824
1931
|
}
|
|
1825
1932
|
/**
|
|
@@ -1835,7 +1942,7 @@ export interface RenewRequest {
|
|
|
1835
1942
|
/** The order ID, chosen by the caller. Creating it again conflicts; read the order after an unknown outcome. */
|
|
1836
1943
|
order_id: string;
|
|
1837
1944
|
/**
|
|
1838
|
-
* How many further periods to buy, each at the price
|
|
1945
|
+
* How many further periods to buy for every renewed item, each at the price it already renews at. To buy a longer term at its own price, give `interval` and `interval_count` instead.
|
|
1839
1946
|
* @minimum 1
|
|
1840
1947
|
*/
|
|
1841
1948
|
periods?: number;
|
|
@@ -1843,19 +1950,21 @@ export interface RenewRequest {
|
|
|
1843
1950
|
* Renew for a term of this length instead, at the price currently sold for it. Give
|
|
1844
1951
|
* `interval` with it.
|
|
1845
1952
|
*
|
|
1846
|
-
* Leaving both out renews at the price
|
|
1953
|
+
* Leaving both out renews every item at the price it already bills at, which a later price
|
|
1847
1954
|
* change does not affect. Naming a term that differs from the current one is a fresh
|
|
1848
|
-
* choice, so
|
|
1849
|
-
*
|
|
1955
|
+
* choice, so every item is bought at today's price for that term, with its own cancellation
|
|
1956
|
+
* policy or, without one, the only price of that term. Naming the current term changes
|
|
1957
|
+
* nothing. A term an item does not sell is refused with 409 `BILLING_RENEWAL_PRICE_UNAVAILABLE`
|
|
1958
|
+
* and `meta.subscription_item_id`; prices the rule cannot choose between, with 409
|
|
1850
1959
|
* `BILLING_RENEWAL_OPTION_AMBIGUOUS` unless `cancellation_policy` is given.
|
|
1851
1960
|
*
|
|
1852
|
-
* List the terms on offer with the renewal
|
|
1961
|
+
* List the terms on offer with the renewal options operation.
|
|
1853
1962
|
* @minimum 1
|
|
1854
1963
|
*/
|
|
1855
1964
|
interval_count?: number;
|
|
1856
1965
|
/** The unit interval_count counts in. */
|
|
1857
1966
|
interval?: RenewRequestInterval;
|
|
1858
|
-
/** With `interval` and `interval_count`,
|
|
1967
|
+
/** With `interval` and `interval_count`, renews every item at its price of that term with this cancellation policy. */
|
|
1859
1968
|
cancellation_policy?: CancellationPolicy;
|
|
1860
1969
|
payment_method_id?: string;
|
|
1861
1970
|
/** Whether to pay from the balance, with or without `payment_method_id`. */
|
|
@@ -1864,8 +1973,11 @@ export interface RenewRequest {
|
|
|
1864
1973
|
use_credits?: boolean;
|
|
1865
1974
|
return_url?: string;
|
|
1866
1975
|
}
|
|
1867
|
-
|
|
1868
|
-
|
|
1976
|
+
/**
|
|
1977
|
+
* The settings to change; settings left out keep their values.
|
|
1978
|
+
*/
|
|
1979
|
+
export interface SubscriptionUpdate {
|
|
1980
|
+
auto_renew?: boolean;
|
|
1869
1981
|
}
|
|
1870
1982
|
/**
|
|
1871
1983
|
* `open`: waiting for you to complete checkout; nothing is ordered, invoiced or reserved. `complete`: the order and its issued invoice exist; read the order for payment and delivery. `expired`: ended without an order.
|
|
@@ -1877,7 +1989,7 @@ export declare const CheckoutSessionStatus: {
|
|
|
1877
1989
|
readonly expired: "expired";
|
|
1878
1990
|
};
|
|
1879
1991
|
/**
|
|
1880
|
-
* `new` buys, `renew` extends
|
|
1992
|
+
* `new` buys, `renew` extends subscriptions, `modify` changes subscription items' configuration or billing terms.
|
|
1881
1993
|
*/
|
|
1882
1994
|
export type CheckoutSessionType = (typeof CheckoutSessionType)[keyof typeof CheckoutSessionType];
|
|
1883
1995
|
export declare const CheckoutSessionType: {
|
|
@@ -1931,13 +2043,38 @@ export interface CheckoutOptions {
|
|
|
1931
2043
|
* @maxLength 2048
|
|
1932
2044
|
*/
|
|
1933
2045
|
return_url?: string;
|
|
2046
|
+
/**
|
|
2047
|
+
* Turns on automatic renewal of every subscription with licensed items that the purchase opens. Off
|
|
2048
|
+
* when omitted. It must be the customer's own choice.
|
|
2049
|
+
*/
|
|
2050
|
+
auto_renew?: boolean;
|
|
2051
|
+
}
|
|
2052
|
+
/**
|
|
2053
|
+
* One subscription of the session.
|
|
2054
|
+
*/
|
|
2055
|
+
export interface CheckoutSessionSubscription {
|
|
2056
|
+
/**
|
|
2057
|
+
* The existing subscription renewed or changed, or that new items are added to. Null for a subscription the purchase opens.
|
|
2058
|
+
* @nullable
|
|
2059
|
+
*/
|
|
2060
|
+
subscription_id: string | null;
|
|
2061
|
+
/**
|
|
2062
|
+
* The free trial a subscription the purchase opens gets; null without one.
|
|
2063
|
+
* @nullable
|
|
2064
|
+
*/
|
|
2065
|
+
trial_period_days: number | null;
|
|
2066
|
+
/**
|
|
2067
|
+
* The end of the free trial a subscription the purchase opens gets; null without one or when given in days.
|
|
2068
|
+
* @nullable
|
|
2069
|
+
*/
|
|
2070
|
+
trial_end: string | null;
|
|
1934
2071
|
}
|
|
1935
2072
|
/**
|
|
1936
2073
|
* A purchase waiting for you to complete checkout. Completing it applies the discount and creates the order with its invoice issued; the order carries the session's ID.
|
|
1937
2074
|
*/
|
|
1938
2075
|
export interface CheckoutSession {
|
|
1939
2076
|
id: string;
|
|
1940
|
-
product_id:
|
|
2077
|
+
product_id: ProductId;
|
|
1941
2078
|
billing_account_id: number;
|
|
1942
2079
|
account: AccountIdentity;
|
|
1943
2080
|
/**
|
|
@@ -1947,7 +2084,7 @@ export interface CheckoutSession {
|
|
|
1947
2084
|
project_id: string | null;
|
|
1948
2085
|
/** The project and its current name. Null for an account-level purchase or when the project cannot be read; `project_id` still identifies it. */
|
|
1949
2086
|
project: NamedIdentity | null;
|
|
1950
|
-
/** `new` buys, `renew` extends
|
|
2087
|
+
/** `new` buys, `renew` extends subscriptions, `modify` changes subscription items' configuration or billing terms. */
|
|
1951
2088
|
type: CheckoutSessionType;
|
|
1952
2089
|
/** When a change takes effect, as on the order it creates; `none` for anything that is not a change. */
|
|
1953
2090
|
change_effective: CheckoutSessionChangeEffective;
|
|
@@ -1967,6 +2104,8 @@ export interface CheckoutSession {
|
|
|
1967
2104
|
* @nullable
|
|
1968
2105
|
*/
|
|
1969
2106
|
order_id: string | null;
|
|
2107
|
+
/** The subscriptions the session buys, renews or changes, in order; each item names its entry in `subscription_index`. */
|
|
2108
|
+
subscriptions: CheckoutSessionSubscription[];
|
|
1970
2109
|
}
|
|
1971
2110
|
export interface CheckoutSessionList {
|
|
1972
2111
|
items: CheckoutSession[];
|
|
@@ -1995,10 +2134,15 @@ export interface CheckoutSessionItem {
|
|
|
1995
2134
|
/** The dimension values of what is bought, such as region and instance type. */
|
|
1996
2135
|
dimensions: CheckoutSessionItemDimensions;
|
|
1997
2136
|
/**
|
|
1998
|
-
* The subscription
|
|
2137
|
+
* The item's subscription, as its index in the session's `subscriptions`.
|
|
2138
|
+
* @minimum 0
|
|
2139
|
+
*/
|
|
2140
|
+
subscription_index: number;
|
|
2141
|
+
/**
|
|
2142
|
+
* The subscription item changed or renewed. Null for an item the purchase adds.
|
|
1999
2143
|
* @nullable
|
|
2000
2144
|
*/
|
|
2001
|
-
|
|
2145
|
+
subscription_item_id: string | null;
|
|
2002
2146
|
/**
|
|
2003
2147
|
* Renewals only; null otherwise. How many consecutive periods are renewed.
|
|
2004
2148
|
* @minimum 1
|
|
@@ -2020,12 +2164,23 @@ export declare const CheckoutSessionCreateInterval: {
|
|
|
2020
2164
|
readonly year: "year";
|
|
2021
2165
|
};
|
|
2022
2166
|
/**
|
|
2023
|
-
*
|
|
2167
|
+
* One subscription to renew.
|
|
2168
|
+
*/
|
|
2169
|
+
export interface CheckoutSessionSubscriptionInput {
|
|
2170
|
+
subscription_id: string;
|
|
2171
|
+
}
|
|
2172
|
+
/**
|
|
2173
|
+
* The subscriptions to renew together, and the periods and price chosen as in renewing, applied to each.
|
|
2024
2174
|
*/
|
|
2025
2175
|
export interface CheckoutSessionCreate {
|
|
2026
2176
|
/** Chosen by the caller. Creating it again conflicts; read the session after an unknown outcome. */
|
|
2027
2177
|
checkout_session_id: string;
|
|
2028
|
-
|
|
2178
|
+
/**
|
|
2179
|
+
* Each subscription at most once.
|
|
2180
|
+
* @minItems 1
|
|
2181
|
+
* @maxItems 20
|
|
2182
|
+
*/
|
|
2183
|
+
subscriptions: CheckoutSessionSubscriptionInput[];
|
|
2029
2184
|
/**
|
|
2030
2185
|
* As in renewing.
|
|
2031
2186
|
* @minimum 1
|
|
@@ -2101,7 +2256,7 @@ export interface PaidWith {
|
|
|
2101
2256
|
last4?: string;
|
|
2102
2257
|
}
|
|
2103
2258
|
/**
|
|
2104
|
-
* `new` buys, `renew` extends
|
|
2259
|
+
* `new` buys, `renew` extends subscriptions, `modify` changes subscription items' configuration or billing terms.
|
|
2105
2260
|
*/
|
|
2106
2261
|
export type OrderType = (typeof OrderType)[keyof typeof OrderType];
|
|
2107
2262
|
export declare const OrderType: {
|
|
@@ -2110,7 +2265,7 @@ export declare const OrderType: {
|
|
|
2110
2265
|
readonly modify: "modify";
|
|
2111
2266
|
};
|
|
2112
2267
|
/**
|
|
2113
|
-
* When a plan change takes effect; `none` for anything that is not a change. A `period_end` order stays pending until the first period at the new price is paid. That period is invoiced when the order is created and starts when the current paid period ends; if the invoice is unpaid by then, the order is canceled and the
|
|
2268
|
+
* When a plan change takes effect; `none` for anything that is not a change. A `period_end` order stays pending until the first period at the new price is paid. That period is invoiced when the order is created and starts when the current paid period ends; if the invoice is unpaid by then, the order is canceled and the item renews or ends with its subscription as usual.
|
|
2114
2269
|
*/
|
|
2115
2270
|
export type OrderChangeEffective = (typeof OrderChangeEffective)[keyof typeof OrderChangeEffective];
|
|
2116
2271
|
export declare const OrderChangeEffective: {
|
|
@@ -2126,7 +2281,7 @@ export declare const OrderItemInterval: {
|
|
|
2126
2281
|
readonly year: "year";
|
|
2127
2282
|
};
|
|
2128
2283
|
/**
|
|
2129
|
-
* `pending`: waiting to be set up. `completed`: set up, as confirmed by the service. `failed`: not set up; its amount was refunded to the original payment sources. `canceled`: withdrawn without delivery; any collected amount is returned. A completed item ends when its subscription is canceled.
|
|
2284
|
+
* `pending`: waiting to be set up. `completed`: set up, as confirmed by the service. `failed`: not set up; its amount was refunded to the original payment sources. `canceled`: withdrawn without delivery; any collected amount is returned. A completed item ends when its subscription item is canceled.
|
|
2130
2285
|
*/
|
|
2131
2286
|
export type OrderItemStatus = (typeof OrderItemStatus)[keyof typeof OrderItemStatus];
|
|
2132
2287
|
export declare const OrderItemStatus: {
|
|
@@ -2145,7 +2300,7 @@ export type OrderItemDimensions = {
|
|
|
2145
2300
|
[key: string]: string;
|
|
2146
2301
|
};
|
|
2147
2302
|
/**
|
|
2148
|
-
* The purchase terms frozen at placement. Monetary fields come from the order's invoice lines and are zero without an immediate charge, such as for a metered purchase. Later catalog changes do not reprice the line. A new service purchase has its pending subscription from placement.
|
|
2303
|
+
* The purchase terms frozen at placement. Monetary fields come from the order's invoice lines and are zero without an immediate charge, such as for a metered purchase. Later catalog changes do not reprice the line. A new service purchase has its pending subscription and subscription item from placement.
|
|
2149
2304
|
*/
|
|
2150
2305
|
export interface OrderItem {
|
|
2151
2306
|
/** Whether new account discounts may apply to future renewals. A fixed operator renewal agreement disables automatic discounts; catalog repricing or a newly selected purchase agreement enables them. */
|
|
@@ -2155,8 +2310,10 @@ export interface OrderItem {
|
|
|
2155
2310
|
/** @minimum 0 */
|
|
2156
2311
|
position?: number;
|
|
2157
2312
|
configuration?: OrderItemConfiguration;
|
|
2158
|
-
/** The Billing subscription
|
|
2313
|
+
/** The Billing subscription the line belongs to: a new pending one, the existing one an added item joins, or the one renewed or changed, which keeps its ID. Absent for a purchase without a subscription. */
|
|
2159
2314
|
subscription_id?: string;
|
|
2315
|
+
/** The subscription item the line created, renewed or changed, which keeps its ID. Absent for a purchase without a subscription. */
|
|
2316
|
+
subscription_item_id?: string;
|
|
2160
2317
|
interval: OrderItemInterval;
|
|
2161
2318
|
/** @minimum 1 */
|
|
2162
2319
|
interval_count?: number;
|
|
@@ -2190,7 +2347,7 @@ export interface OrderItem {
|
|
|
2190
2347
|
id: string;
|
|
2191
2348
|
order_id?: string;
|
|
2192
2349
|
price_id: string;
|
|
2193
|
-
product_id?:
|
|
2350
|
+
product_id?: ProductId;
|
|
2194
2351
|
product?: Product;
|
|
2195
2352
|
/** Which plan was bought. */
|
|
2196
2353
|
plan_id: string;
|
|
@@ -2253,10 +2410,10 @@ export interface Order {
|
|
|
2253
2410
|
/** The billing account the order was placed with, unchanged when the project is later linked to another account. While it is suspended or closed, the order cannot be accepted, and a period-end change is called off when the current period ends; such requests fail with `BILLING_ACCOUNT_UNAVAILABLE`. */
|
|
2254
2411
|
billing_account_id?: number;
|
|
2255
2412
|
currency: string;
|
|
2256
|
-
/** `new` buys, `renew` extends
|
|
2413
|
+
/** `new` buys, `renew` extends subscriptions, `modify` changes subscription items' configuration or billing terms. */
|
|
2257
2414
|
type: OrderType;
|
|
2258
2415
|
status: OrderStatus;
|
|
2259
|
-
/** When a plan change takes effect; `none` for anything that is not a change. A `period_end` order stays pending until the first period at the new price is paid. That period is invoiced when the order is created and starts when the current paid period ends; if the invoice is unpaid by then, the order is canceled and the
|
|
2416
|
+
/** When a plan change takes effect; `none` for anything that is not a change. A `period_end` order stays pending until the first period at the new price is paid. That period is invoiced when the order is created and starts when the current paid period ends; if the invoice is unpaid by then, the order is canceled and the item renews or ends with its subscription as usual. */
|
|
2260
2417
|
change_effective?: OrderChangeEffective;
|
|
2261
2418
|
/**
|
|
2262
2419
|
* Acceptance deadline; a pending order expires after it.
|
|
@@ -2376,6 +2533,9 @@ export declare const AllowanceStatus: {
|
|
|
2376
2533
|
export interface Allowance {
|
|
2377
2534
|
/** Optional issuance key, unique within this billing account. */
|
|
2378
2535
|
idempotency_key?: string;
|
|
2536
|
+
/** The subscription item whose purchase includes the allowance; absent for an allowance not included in a purchase. */
|
|
2537
|
+
subscription_item_id?: string;
|
|
2538
|
+
/** The subscription that item belongs to. */
|
|
2379
2539
|
subscription_id?: string;
|
|
2380
2540
|
id: string;
|
|
2381
2541
|
billing_account_id?: number;
|
|
@@ -2443,7 +2603,7 @@ export interface Entitlement {
|
|
|
2443
2603
|
name?: string;
|
|
2444
2604
|
enabled: boolean;
|
|
2445
2605
|
/**
|
|
2446
|
-
* When the providing subscription ends. Absent for a metered
|
|
2606
|
+
* When the providing subscription item ends with its current term. Absent for a metered item.
|
|
2447
2607
|
* @nullable
|
|
2448
2608
|
*/
|
|
2449
2609
|
expires_at?: string | null;
|
|
@@ -2467,7 +2627,7 @@ export interface Plan {
|
|
|
2467
2627
|
product: Product;
|
|
2468
2628
|
features: PlanFeature[];
|
|
2469
2629
|
id: string;
|
|
2470
|
-
product_id:
|
|
2630
|
+
product_id: ProductId;
|
|
2471
2631
|
name: string;
|
|
2472
2632
|
description?: string;
|
|
2473
2633
|
}
|
|
@@ -2573,7 +2733,7 @@ export interface Price {
|
|
|
2573
2733
|
short_rate_multiplier?: string;
|
|
2574
2734
|
/** Refund policy `short_rate` only, how long after the period start `short_rate_multiplier` applies. */
|
|
2575
2735
|
short_rate_threshold_seconds?: number;
|
|
2576
|
-
product_id?:
|
|
2736
|
+
product_id?: ProductId;
|
|
2577
2737
|
id: string;
|
|
2578
2738
|
plan_id: string;
|
|
2579
2739
|
currency: string;
|
|
@@ -2630,7 +2790,7 @@ export interface QuoteItemInput {
|
|
|
2630
2790
|
*/
|
|
2631
2791
|
plan_lookup_key?: string;
|
|
2632
2792
|
price_id?: string;
|
|
2633
|
-
product_id?:
|
|
2793
|
+
product_id?: ProductId;
|
|
2634
2794
|
plan_id?: string;
|
|
2635
2795
|
/** Narrows the selection when a plan offers more than one price type. */
|
|
2636
2796
|
price_type?: PriceType;
|
|
@@ -2645,6 +2805,8 @@ export interface QuoteItemInput {
|
|
|
2645
2805
|
quantity: string;
|
|
2646
2806
|
/** The dimension values of what is bought, such as region and instance type. Required whenever the price uses a rate card; prices with their own amounts ignore them. Every key the meter declares must be given. A combination no rate covers is refused with `BILLING_PRICE_UNAVAILABLE` rather than priced at zero. Prices are set per currency, and a currency may not offer some combinations at all, for example in a region it does not sell to. */
|
|
2647
2807
|
dimensions?: QuoteItemInputDimensions;
|
|
2808
|
+
/** Price the line as a new item added to this existing subscription, as the owning service adds it when buying for a resource the subscription pays for. Needs `billing_account_id`, which must currently pay for the subscription. A licensed line is priced up to the subscription's `current_term_end`, the rest of the current period in proportion to the time left from `proration_date`, and must have the subscription's interval and interval count; a metered line has no immediate charge; added to a trialing subscription, the line is free until the trial ends. */
|
|
2809
|
+
subscription_id?: string;
|
|
2648
2810
|
}
|
|
2649
2811
|
/**
|
|
2650
2812
|
* The values of the meter's presentation dimensions, present only when grouped by meter.
|
|
@@ -2694,7 +2856,9 @@ export interface ActiveResource {
|
|
|
2694
2856
|
ended_at?: string;
|
|
2695
2857
|
suspended_at?: string;
|
|
2696
2858
|
state_changed_at?: string;
|
|
2697
|
-
/** The metered subscription charged for this metering record. */
|
|
2859
|
+
/** The metered subscription item charged for this metering record. */
|
|
2860
|
+
subscription_item_id: string;
|
|
2861
|
+
/** The subscription the item belongs to. */
|
|
2698
2862
|
subscription_id: string;
|
|
2699
2863
|
resource_id: string;
|
|
2700
2864
|
product: Product;
|
|
@@ -2735,7 +2899,7 @@ export type UsageEstimateInputDimensions = {
|
|
|
2735
2899
|
* Future usage of one metered price. Give the price, or the plan to use its metered price in the currency, and the meter that measures the usage; give each resource's ID or lookup key, never both, and product_id with lookup keys.
|
|
2736
2900
|
*/
|
|
2737
2901
|
export interface UsageEstimateInput {
|
|
2738
|
-
product_id?:
|
|
2902
|
+
product_id?: ProductId;
|
|
2739
2903
|
plan_id?: string;
|
|
2740
2904
|
/**
|
|
2741
2905
|
* @minLength 1
|
|
@@ -2823,16 +2987,16 @@ export declare const QuoteChangeInputInterval: {
|
|
|
2823
2987
|
readonly year: "year";
|
|
2824
2988
|
};
|
|
2825
2989
|
/**
|
|
2826
|
-
* The dimension values after the change, given in full; omit to keep the
|
|
2990
|
+
* The dimension values after the change, given in full; omit to keep the item's.
|
|
2827
2991
|
*/
|
|
2828
2992
|
export type QuoteChangeInputDimensions = {
|
|
2829
2993
|
[key: string]: string;
|
|
2830
2994
|
};
|
|
2831
2995
|
/**
|
|
2832
|
-
* The new terms of one subscription. Identify the price, or the plan to select one from, as for a proposed item. Without a price or billing terms, the plan's price with the
|
|
2996
|
+
* The new terms of one subscription item. Identify the price, or the plan to select one from, as for a proposed item. Without a price or billing terms, the plan's price with the item's price type, usage type, interval, interval count and cancellation policy is selected. Omitted dimensions keep the item's.
|
|
2833
2997
|
*/
|
|
2834
2998
|
export interface QuoteChangeInput {
|
|
2835
|
-
|
|
2999
|
+
subscription_item_id: string;
|
|
2836
3000
|
/**
|
|
2837
3001
|
* @minLength 1
|
|
2838
3002
|
* @maxLength 128
|
|
@@ -2844,11 +3008,11 @@ export interface QuoteChangeInput {
|
|
|
2844
3008
|
*/
|
|
2845
3009
|
plan_lookup_key?: string;
|
|
2846
3010
|
price_id?: string;
|
|
2847
|
-
product_id?:
|
|
3011
|
+
product_id?: ProductId;
|
|
2848
3012
|
plan_id?: string;
|
|
2849
|
-
/** Selects the price type instead of keeping the
|
|
3013
|
+
/** Selects the price type instead of keeping the item's. */
|
|
2850
3014
|
price_type?: PriceType;
|
|
2851
|
-
/** Selects the usage type instead of keeping the
|
|
3015
|
+
/** Selects the usage type instead of keeping the item's. */
|
|
2852
3016
|
usage_type?: UsageType;
|
|
2853
3017
|
interval?: QuoteChangeInputInterval;
|
|
2854
3018
|
/** @minimum 1 */
|
|
@@ -2860,7 +3024,7 @@ export interface QuoteChangeInput {
|
|
|
2860
3024
|
* @pattern ^(?:(?:[1-9][0-9]{0,27}|0(?:[1-9][0-9]{0,26}|0(?:[1-9][0-9]{0,25}|0(?:[1-9][0-9]{0,24}|0(?:[1-9][0-9]{0,23}|0(?:[1-9][0-9]{0,22}|0(?:[1-9][0-9]{0,21}|0(?:[1-9][0-9]{0,20}|0(?:[1-9][0-9]{0,19}|0(?:[1-9][0-9]{0,18}|0(?:[1-9][0-9]{0,17}|0(?:[1-9][0-9]{0,16}|0(?:[1-9][0-9]{0,15}|0(?:[1-9][0-9]{0,14}|0(?:[1-9][0-9]{0,13}|0(?:[1-9][0-9]{0,12}|0(?:[1-9][0-9]{0,11}|0(?:[1-9][0-9]{0,10}|0(?:[1-9][0-9]{0,9}|0(?:[1-9][0-9]{0,8}|0(?:[1-9][0-9]{0,7}|0(?:[1-9][0-9]{0,6}|0(?:[1-9][0-9]{0,5}|0(?:[1-9][0-9]{0,4}|0(?:[1-9][0-9]{0,3}|0(?:[1-9][0-9]{0,2}|0(?:[1-9][0-9]{0,1}|0[1-9])))))))))))))))))))))))))))([.][0-9]{1,10})?|0{1,28}[.](?:[1-9][0-9]{0,9}|0(?:[1-9][0-9]{0,8}|0(?:[1-9][0-9]{0,7}|0(?:[1-9][0-9]{0,6}|0(?:[1-9][0-9]{0,5}|0(?:[1-9][0-9]{0,4}|0(?:[1-9][0-9]{0,3}|0(?:[1-9][0-9]{0,2}|0(?:[1-9][0-9]{0,1}|0[1-9]))))))))))$
|
|
2861
3025
|
*/
|
|
2862
3026
|
quantity: string;
|
|
2863
|
-
/** The dimension values after the change, given in full; omit to keep the
|
|
3027
|
+
/** The dimension values after the change, given in full; omit to keep the item's. */
|
|
2864
3028
|
dimensions?: QuoteChangeInputDimensions;
|
|
2865
3029
|
}
|
|
2866
3030
|
export interface QuoteAddress {
|
|
@@ -2877,7 +3041,7 @@ export interface QuoteAddress {
|
|
|
2877
3041
|
state?: string;
|
|
2878
3042
|
}
|
|
2879
3043
|
/**
|
|
2880
|
-
* Quote proposed items, changes or renewals: exactly one of them. Give exactly one of `billing_account_id` and `currency`; changes and
|
|
3044
|
+
* Quote proposed items, changes or renewals: exactly one of them. Give exactly one of `billing_account_id` and `currency`; changes, renewals and items added to an existing subscription need the account. Promotion codes apply to proposed items and changes. An invalid combination fails with `BILLING_PURCHASE_INVALID` and the field.
|
|
2881
3045
|
*/
|
|
2882
3046
|
export interface QuoteRequest {
|
|
2883
3047
|
/**
|
|
@@ -2898,13 +3062,13 @@ export interface QuoteRequest {
|
|
|
2898
3062
|
*/
|
|
2899
3063
|
items?: QuoteItemInput[];
|
|
2900
3064
|
/**
|
|
2901
|
-
* Preview renewing these subscriptions, each at most once;
|
|
3065
|
+
* Preview renewing these subscriptions together in one renewal order, as a renewal Checkout Session does, each at most once; `total` is that order's. Each must currently be paid by `billing_account_id`, be yours to read as the owner of that account or a member of the subscription's project, and all must belong to the same project and service. To apply a promotion code, create a renewal Checkout Session and quote it.
|
|
2902
3066
|
* @minItems 1
|
|
2903
3067
|
* @maxItems 100
|
|
2904
3068
|
*/
|
|
2905
3069
|
renewals?: QuoteRenewal[];
|
|
2906
3070
|
/**
|
|
2907
|
-
* Preview changing these
|
|
3071
|
+
* Preview changing these subscription items in one order, each at most once. Each must currently be paid by `billing_account_id` and be yours to read, as the owner of that account or a member of the subscription's project; all must belong to the same project, or all to no project.
|
|
2908
3072
|
* @minItems 1
|
|
2909
3073
|
* @maxItems 100
|
|
2910
3074
|
*/
|
|
@@ -3206,7 +3370,7 @@ export interface PriceSearch {
|
|
|
3206
3370
|
* @maxItems 200
|
|
3207
3371
|
*/
|
|
3208
3372
|
plan_ids?: string[];
|
|
3209
|
-
product_id?:
|
|
3373
|
+
product_id?: ProductId;
|
|
3210
3374
|
/** Narrows to one price type. */
|
|
3211
3375
|
type?: PriceType;
|
|
3212
3376
|
/** Narrows to one usage type. */
|
|
@@ -3778,7 +3942,7 @@ export type ListUsageChargesParams = {
|
|
|
3778
3942
|
* Only this account; all of yours when omitted.
|
|
3779
3943
|
*/
|
|
3780
3944
|
billing_account_id?: AccountIdQueryParameter;
|
|
3781
|
-
product_id?:
|
|
3945
|
+
product_id?: ProductId;
|
|
3782
3946
|
resource_id?: string;
|
|
3783
3947
|
/**
|
|
3784
3948
|
* Only the charges summed into this usage invoice line.
|
|
@@ -3800,6 +3964,12 @@ export type ListUsageChargesParams = {
|
|
|
3800
3964
|
};
|
|
3801
3965
|
export type ListSubscriptionsParams = {
|
|
3802
3966
|
expiring_before?: string;
|
|
3967
|
+
/**
|
|
3968
|
+
* Only these subscriptions, such as those of the resources shown on one page. Comma-separated.
|
|
3969
|
+
* @minItems 1
|
|
3970
|
+
* @maxItems 200
|
|
3971
|
+
*/
|
|
3972
|
+
subscription_ids?: string[];
|
|
3803
3973
|
/**
|
|
3804
3974
|
* 1-based page number. Defaults to 1.
|
|
3805
3975
|
* @minimum 1
|
|
@@ -3825,7 +3995,7 @@ export type ListSubscriptionsParams = {
|
|
|
3825
3995
|
/**
|
|
3826
3996
|
* Only subscriptions in these statuses; omit for every status. Comma-separated, for example `status=active,suspended`.
|
|
3827
3997
|
* @minItems 1
|
|
3828
|
-
* @maxItems
|
|
3998
|
+
* @maxItems 7
|
|
3829
3999
|
*/
|
|
3830
4000
|
status?: SubscriptionStatus[];
|
|
3831
4001
|
};
|
|
@@ -3847,9 +4017,13 @@ export type ListCancellationsParams = {
|
|
|
3847
4017
|
*/
|
|
3848
4018
|
billing_account_id?: AccountIdQueryParameter;
|
|
3849
4019
|
/**
|
|
3850
|
-
* Only cancellations that include this subscription.
|
|
4020
|
+
* Only cancellations that include an item of this subscription.
|
|
3851
4021
|
*/
|
|
3852
4022
|
subscription_id?: string;
|
|
4023
|
+
/**
|
|
4024
|
+
* Only cancellations that include this subscription item.
|
|
4025
|
+
*/
|
|
4026
|
+
subscription_item_id?: string;
|
|
3853
4027
|
/**
|
|
3854
4028
|
* Only cancellations in these statuses; omit for every status. `open` means requested, scheduled or releasing. Comma-separated, for example `status=open,failed`.
|
|
3855
4029
|
* @minItems 1
|
|
@@ -3873,7 +4047,7 @@ export declare const ListCancellationsStatusItem: {
|
|
|
3873
4047
|
readonly canceled: "canceled";
|
|
3874
4048
|
readonly failed: "failed";
|
|
3875
4049
|
};
|
|
3876
|
-
export type
|
|
4050
|
+
export type ListRenewalOptionsParams = {
|
|
3877
4051
|
/**
|
|
3878
4052
|
* 1-based page number. Defaults to 1.
|
|
3879
4053
|
* @minimum 1
|
|
@@ -3914,7 +4088,7 @@ export type ListAllowancesParams = {
|
|
|
3914
4088
|
* @maxItems 4
|
|
3915
4089
|
*/
|
|
3916
4090
|
status?: AllowanceStatus[];
|
|
3917
|
-
product_id?:
|
|
4091
|
+
product_id?: ProductId;
|
|
3918
4092
|
/**
|
|
3919
4093
|
* Only records of these projects. Omit for all projects and account-level records of your billing accounts. Where an operation is open to project members, each project must be assigned to a billing account you own or have you as a member, and a member sees the records of the project that the owner of its current billing account sees.
|
|
3920
4094
|
* @minItems 1
|
|
@@ -4053,7 +4227,7 @@ export type ListEntitlementsParams = {
|
|
|
4053
4227
|
* @maxItems 100
|
|
4054
4228
|
*/
|
|
4055
4229
|
project_ids?: ProjectIdsQueryParameter;
|
|
4056
|
-
product_id?:
|
|
4230
|
+
product_id?: ProductId;
|
|
4057
4231
|
};
|
|
4058
4232
|
export type ListFeatureGrantsParams = {
|
|
4059
4233
|
/**
|
|
@@ -4072,7 +4246,7 @@ export type ListFeatureGrantsParams = {
|
|
|
4072
4246
|
* Only this account; all of yours when omitted.
|
|
4073
4247
|
*/
|
|
4074
4248
|
billing_account_id?: AccountIdQueryParameter;
|
|
4075
|
-
product_id?:
|
|
4249
|
+
product_id?: ProductId;
|
|
4076
4250
|
/**
|
|
4077
4251
|
* Only feature grants in these statuses; omit for every status. Comma-separated, for example `status=scheduled,active`.
|
|
4078
4252
|
* @minItems 1
|
|
@@ -4099,7 +4273,7 @@ export type ListPricesParams = {
|
|
|
4099
4273
|
* @maxLength 3
|
|
4100
4274
|
*/
|
|
4101
4275
|
currency: string;
|
|
4102
|
-
product_id?:
|
|
4276
|
+
product_id?: ProductId;
|
|
4103
4277
|
/**
|
|
4104
4278
|
* Narrows to one price type.
|
|
4105
4279
|
*/
|
|
@@ -4154,7 +4328,7 @@ export type GetPriceHeaders = {
|
|
|
4154
4328
|
"If-None-Match"?: IfNoneMatchParameter;
|
|
4155
4329
|
};
|
|
4156
4330
|
export type ListPlansParams = {
|
|
4157
|
-
product_id:
|
|
4331
|
+
product_id: ProductId;
|
|
4158
4332
|
/**
|
|
4159
4333
|
* 1-based page number. Defaults to 1.
|
|
4160
4334
|
* @minimum 1
|
|
@@ -4228,7 +4402,7 @@ export type ListActiveResourcesParams = {
|
|
|
4228
4402
|
*/
|
|
4229
4403
|
project_ids?: ProjectIdsQueryParameter;
|
|
4230
4404
|
meter_id?: string;
|
|
4231
|
-
product_id?:
|
|
4405
|
+
product_id?: ProductId;
|
|
4232
4406
|
/**
|
|
4233
4407
|
* Only metering in these statuses; omit for every status. Comma-separated, for example `status=active,suspended`.
|
|
4234
4408
|
* @minItems 1
|
|
@@ -4249,7 +4423,7 @@ export type ListSpendParams = {
|
|
|
4249
4423
|
/**
|
|
4250
4424
|
* Filter by the fixed platform service ID.
|
|
4251
4425
|
*/
|
|
4252
|
-
product_id?:
|
|
4426
|
+
product_id?: ProductId;
|
|
4253
4427
|
/**
|
|
4254
4428
|
* 1-based page number. Defaults to 1.
|
|
4255
4429
|
* @minimum 1
|