List plans

GET

https://api.agentpaid.io/api/v2/plans/

GET

/api/v2/plans/

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.listPlans({});
8 }
9 main();

1 {
2   "data": [
3     {
4       "id": "plan_9f8b7c6d5e4a3b2c1d0e",
5       "productId": "prod_1234567890abcdef",
6       "name": "Premium Annual Plan",
7       "externalId": "ext-premium-annual-2024",
8       "supportedCurrencies": [
9         "USD",
10         "EUR",
11         "GBP"
12       ],
13       "isDefault": true,
14       "status": "archived",
15       "upgradePathOrder": 2,
16       "archivedAt": "2024-01-15T09:30:00Z",
17       "createdAt": "2023-06-01T12:00:00Z",
18       "updatedAt": "2024-01-10T15:45:00Z",
19       "attributes": [
20         {
21           "productAttributeId": "attr_abcdef1234567890",
22           "name": "User Seats",
23           "active": true,
24           "pricing": {
25             "pricingType": "RecurringPerUnit",
26             "chargeType": "subscription_fee",
27             "pricingModel": "tiered",
28             "pricePoints": [
29               {
30                 "minQuantity": 1,
31                 "maxQuantity": 10,
32                 "unitPriceCents": 1500
33               },
34               {
35                 "minQuantity": 11,
36                 "maxQuantity": 50,
37                 "unitPriceCents": 1200
38               }
39             ]
40           },
41           "creditBenefits": [
42             {
43               "id": "credit_0011223344556677",
44               "amount": 100,
45               "creditsCurrencyId": "credits_usd",
46               "recipient": "organization",
47               "rolloverAmount": 50,
48               "rolloverDuration": 3,
49               "rolloverDurationUnit": "months",
50               "allocationCadence": "upfront",
51               "creditGrantTiming": "on_payment",
52               "isInfiniteTotal": false
53             }
54           ]
55         }
56       ]
57     }
58   ],
59   "pagination": {
60     "limit": 10,
61     "offset": 0,
62     "total": 25,
63     "hasMore": true
64   }
65 }

Returns plans for your organization, including archived plans by default, optionally filtered to a product.

Authentication

AuthorizationBearer

API Key authentication using Bearer token

Query parameters

limitintegerOptional1-100Defaults to 10

offsetintegerOptional

productIdstringOptional

externalProductIdstringOptional

includeArchivedbooleanOptionalDefaults to true

Whether to include archived plans in the response. Defaults to true.

Response

200

datalist of objects

paginationobject

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error