Update plan upgrade path

PUT

https://api.agentpaid.io/api/v2/plans/upgrade-path

PUT

/api/v2/plans/upgrade-path

1 import { PaidClient } from "@paid-ai/paid-node";
2 
3 async function main() {
4     const client = new PaidClient({
5         token: "YOUR_TOKEN_HERE",
6     });
7     await client.plans.updatePlanUpgradePath({
8         productId: "prod_9f8e7d6c5b4a3",
9         groups: [
10             {
11                 frequency: "monthly",
12                 planIds: [
13                     "plan_123abc456def",
14                 ],
15             },
16         ],
17     });
18 }
19 main();

1 {
2   "data": [
3     {
4       "id": "plan_123abc456def",
5       "productId": "prod_9f8e7d6c5b4a3",
6       "name": "Premium Monthly Plan",
7       "externalId": "ext_premium_monthly_001",
8       "supportedCurrencies": [
9         "USD",
10         "EUR"
11       ],
12       "isDefault": false,
13       "status": "active",
14       "upgradePathOrder": 1,
15       "archivedAt": "2024-01-15T09:30:00Z",
16       "createdAt": "2023-11-01T12:00:00Z",
17       "updatedAt": "2024-04-10T15:45:00Z",
18       "attributes": [
19         {
20           "productAttributeId": "attr_789xyz123abc",
21           "name": "Standard Feature Set",
22           "active": true,
23           "pricing": {
24             "pricingType": "RecurringPerUnit",
25             "chargeType": "subscription",
26             "pricingModel": "flat_fee",
27             "pricePoints": [
28               {}
29             ]
30           },
31           "creditBenefits": [
32             {
33               "id": "cb_456def789ghi",
34               "amount": 100,
35               "creditsCurrencyId": "cred_USD",
36               "recipient": "organization",
37               "rolloverAmount": 50,
38               "rolloverDuration": 3,
39               "rolloverDurationUnit": "months",
40               "allocationCadence": "upfront",
41               "creditGrantTiming": "on_payment",
42               "isInfiniteTotal": false
43             }
44           ]
45         }
46       ]
47     }
48   ]
49 }

Updates upgrade path ordering for plans within a product, grouped by billing frequency.

Authentication

AuthorizationBearer

API Key authentication using Bearer token

Request

Body

productIdstringRequired>=1 character

Paid product ID, for example prod_abc123

groupslist of objectsRequired

Response

200

datalist of objects

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error