@zuplo/runtime 5.1817.0 → 5.1818.0

package/index.d.ts

@@ -2417,11 +2417,39 @@ export declare class MemoryZoneReadThroughCache<T = unknown> {
 
 /* Excluded from this release type: MeteringPlugin */
 
-/* Excluded from this release type: MeteringRegions */
+/**
+ * @beta
+ */
+declare type MeteringRegions = "us-central1" | "europe-west4";
 
-/* Excluded from this release type: MeteringSubscription */
+/**
+ * @beta
+ */
+declare interface MeteringSubscription {
+    status: MeteringSubscriptionStatus;
+    type: "credits" | "periodic";
+    region: MeteringRegions;
+    renewalStrategy: "hourly" | "monthly" | "yearly";
+    customerKey: string;
+    /**
+     * Array of Stripe product ids, they start with "prod_"
+     */
+    planExternalIds: string[];
+    /**
+     * Stripe subscription id, starts with "sub_"
+     */
+    subscriptionExternalId?: string;
+    /**
+     * Stripe customer id, starts with "cus_"
+     */
+    customerExternalId?: string;
+    metadata?: Record<string, string>;
+}
 
-/* Excluded from this release type: MeteringSubscriptionStatus */
+/**
+ * @beta
+ */
+declare type MeteringSubscriptionStatus = "active" | "inactive" | "incomplete" | "incomplete-expired" | "trialing" | "past-due" | "canceled" | "unpaid";
 
 /* Excluded from this release type: MetricsData */
 
@@ -2565,7 +2593,24 @@ declare type MonetizationPolicyMeters = {
     [Key in string]: number;
 };
 
-/* Excluded from this release type: MonetizationSubscription */
+/**
+ * @beta
+ */
+export declare interface MonetizationSubscription extends MeteringSubscription {
+    /**
+     * Metering subscription id, starts with "sbsc_"
+     */
+    id: string;
+    createdOn: string;
+    updatedOn: string;
+    quotaResetAnchor?: Date;
+    meters: {
+        [Key in string]: {
+            consumed: number;
+            max: number;
+        };
+    };
+}
 
 declare interface NotFoundOptions {
     routesMatchedByPathOnly: RouteConfiguration[];
@@ -3659,9 +3704,45 @@ export declare interface SleepInboundPolicyOptions {
 
 /* Excluded from this release type: StandardEnv */
 
-/* Excluded from this release type: StripeMeteringPlugin */
+/**
+ * Adds stripe metering routes and configuration
+ * @beta
+ */
+export declare class StripeMeteringPlugin extends MeteringPlugin {
+    private options;
+    constructor(options: StripeMeteringPluginOptions);
+    registerRoutes(router: Router, gateway: Gateway): void;
+}
 
-/* Excluded from this release type: StripeMeteringPluginOptions */
+/**
+ * @beta
+ */
+export declare interface StripeMeteringPluginOptions {
+    /**
+     * Stripe Webhook settings
+     */
+    webhooks: StripeWebhookVerificationInboundPolicyOptions & {
+        /**
+         * The URL path where the webhook is registered.
+         * Defaults to `/_zuplo/stripe-webhook`
+         */
+        routePath?: string;
+    };
+    /**
+     * The ID of the Zuplo metering bucket.
+     */
+    meteringBucketId?: string;
+    /**
+     * The region of the Zuplo metering bucket.
+     */
+    meteringBucketRegion?: string;
+    apiKeyBucketName?: string;
+    /**
+     * The Stripe account's secret key
+     */
+    stripeSecretKey: string;
+    /* Excluded from this release type: __testMode */
+}
 
 /**
  * The Stripe Webhook policy validates the authenticity of an incoming Stripe webhook.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zuplo/runtime",
-  "version": "5.1817.0",
+  "version": "5.1818.0",
   "repository": "https://github.com/zuplo/zuplo",
   "author": "Zuplo, Inc.",
   "exports": {