zuplo 6.70.30 → 6.70.31

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -73,8 +73,8 @@ Plans move through a defined lifecycle:
73
73
  This example creates a Pro plan with:
74
74
 
75
75
  - A 1-week free trial phase with 1,000 API calls
76
- - A `monthly_fee` flat-fee rate card on the default phase that charges $99 in
77
- advance at the start of each billing period
76
+ - A `subscription_fee` flat-fee rate card on the default phase that charges $99
77
+ in advance at the start of each billing period
78
78
  - A `usage_based` rate card with 10,000 included API requests per billing period
79
79
  and $0.01 per request overage in arrears
80
80
  - A `priority_support` static feature granted on both phases
@@ -136,8 +136,8 @@ curl \
136
136
  "rateCards": [
137
137
  {
138
138
  "type": "flat_fee",
139
- "key": "monthly_fee",
140
- "name": "Monthly Fee",
139
+ "key": "subscription_fee",
140
+ "name": "Subscription Fee",
141
141
  "billingCadence": "P1M",
142
142
  "price": {
143
143
  "type": "flat",
@@ -201,8 +201,8 @@ EOF
201
201
 
202
202
  After the trial ends, customers automatically move to the default phase. The $99
203
203
  monthly subscription fee is charged in advance at the start of each billing
204
- period via the `monthly_fee` flat-fee rate card. The plan includes 10,000 API
205
- requests per period; additional requests are billed at $0.01 each in arrears
204
+ period via the `subscription_fee` flat-fee rate card. The plan includes 10,000
205
+ API requests per period; additional requests are billed at $0.01 each in arrears
206
206
  (soft limit allows overage).
207
207
 
208
208
  ## Plan Properties
@@ -54,8 +54,8 @@ curl -X POST "https://dev.zuplo.com/v3/metering/${ZUPLO_BUCKET_ID}/plans" \
54
54
  "rateCards": [
55
55
  {
56
56
  "billingCadence": "P1M",
57
- "key": "monthly_fee",
58
- "name": "Monthly Fee",
57
+ "key": "subscription_fee",
58
+ "name": "Subscription Fee",
59
59
  "price": {
60
60
  "amount": "9.99",
61
61
  "paymentTerm": "in_advance",
@@ -119,7 +119,6 @@ Feature** for each of the following:
119
119
  | Name | Key | Linked Meter | Purpose |
120
120
  | ---------------- | ------------------ | ------------ | ----------------------------- |
121
121
  | API Requests | `api_requests` | API Requests | Usage-based (linked to meter) |
122
- | Monthly Fee | `monthly_fee` | — | Flat-rate billing |
123
122
  | Metadata Support | `metadata_support` | — | Boolean on/off feature |
124
123
 
125
124
  :::tip{title="Key Naming Conventions"}
@@ -145,25 +144,29 @@ plans to give your customers options.
145
144
  - **Plan Name**: `Developer`
146
145
  - **Key**: `developer`
147
146
  3. Click **Create Draft**.
148
- 4. Configure the rate cards by selecting features from the **Add feature**
149
- dropdown in the **Features & Rate Cards**:
147
+ 4. Configure the rate cards from the **Add rate card** dropdown in the
148
+ **Features & Rate Cards** section. The dropdown groups rate cards by whether
149
+ they're tied to a feature; the **Billing-only** section at the bottom lets
150
+ you add a flat-rate line item that isn't tied to any feature.
150
151
 
151
- ![The add feature dropdown showing the location of the Monthly Fee feature](/media/monetization/add-feature-dropdown.png)
152
+ ![The Add rate card dropdown with the New billing-only fee option](/media/monetization/add-feature-dropdown.png)
152
153
 
153
- Click on the **Monthly Fee** feature and set it up as shown below:
154
+ Under **Billing-only**, click **New billing-only fee**. The Portal pre-fills
155
+ the name as `Subscription Fee` and the key as `subscription_fee`. Leave those
156
+ as-is and set the rest as shown below:
154
157
 
155
- **Monthly Fee**:
158
+ **Subscription Fee**:
156
159
 
157
- | Setting | Value |
158
- | --------------- | -------------- |
159
- | Pricing Model | Flat fee |
160
- | Billing Cadence | Monthly |
161
- | Payment Term | In advance |
162
- | Price | $9.99 |
163
- | Entitlement | No entitlement |
160
+ | Setting | Value |
161
+ | --------------- | ------------------- |
162
+ | Feature | None (billing-only) |
163
+ | Pricing Model | Flat fee |
164
+ | Billing Cadence | Monthly |
165
+ | Payment Term | In advance |
166
+ | Price | $9.99 |
164
167
 
165
- Next, click **Add feature** again and choose the **API Requests** feature and
166
- set it up as shown below:
168
+ Next, click **Add rate card** again. Under **Existing Features**, choose
169
+ **API Requests** and set it up as shown below:
167
170
 
168
171
  **API Requests**:
169
172
 
@@ -202,10 +205,10 @@ The only structural differences are the pricing, request amounts, and the
202
205
  addition of a **Metadata Support** rate card (set **Pricing Model** to `Free`
203
206
  and **Entitlement** to `Boolean (on/off)`).
204
207
 
205
- | Plan | Key | Monthly Fee | Included Requests | Overage Rate | Metadata Support |
206
- | --------- | ----------- | ----------- | ----------------- | ------------ | ---------------- |
207
- | Developer | `developer` | $9.99 | 1,000 | $0.10/req | No |
208
- | Pro | `pro` | $19.99 | 5,000 | $0.05/req | Yes |
208
+ | Plan | Key | Subscription Fee | Included Requests | Overage Rate | Metadata Support |
209
+ | --------- | ----------- | ---------------- | ----------------- | ------------ | ---------------- |
210
+ | Developer | `developer` | $9.99 | 1,000 | $0.10/req | No |
211
+ | Pro | `pro` | $19.99 | 5,000 | $0.05/req | Yes |
209
212
 
210
213
  For the **API Requests** rate card on each plan, set **Tier 1** Last Unit to the
211
214
  "Included Requests" value and **Tier 2** Unit Price to the "Overage Rate" value.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "zuplo",
3
- "version": "6.70.30",
3
+ "version": "6.70.31",
4
4
  "type": "module",
5
5
  "description": "The programmable API Gateway",
6
6
  "author": "Zuplo, Inc.",
@@ -19,9 +19,9 @@
19
19
  "zuplo": "zuplo.js"
20
20
  },
21
21
  "dependencies": {
22
- "@zuplo/cli": "6.70.30",
23
- "@zuplo/core": "6.70.30",
24
- "@zuplo/runtime": "6.70.30",
22
+ "@zuplo/cli": "6.70.31",
23
+ "@zuplo/core": "6.70.31",
24
+ "@zuplo/runtime": "6.70.31",
25
25
  "@zuplo/test": "1.4.0"
26
26
  }
27
27
  }