Get plan by external ID

GET

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

GET

/api/v2/plans/external/:externalId

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.getPlanByExternalId("externalId");
8 }
9 main();

1 {
2   "id": "plan_9f8b7c6d5e4a3b2c1d0e",
3   "productId": "prod_1234567890abcdef",
4   "name": "Premium Business Plan",
5   "externalId": "ext-premium-2024",
6   "supportedCurrencies": [
7     "USD",
8     "EUR",
9     "GBP"
10   ],
11   "isDefault": false,
12   "status": "active",
13   "upgradePathOrder": 2,
14   "archivedAt": null,
15   "createdAt": "2024-04-01T12:00:00Z",
16   "updatedAt": "2024-05-10T15:45:00Z",
17   "attributes": [
18     {
19       "productAttributeId": "attr_9876543210fedcba",
20       "name": "User Seats",
21       "active": true,
22       "pricing": {
23         "pricingType": "RecurringPerUnit",
24         "chargeType": "subscription",
25         "pricingModel": "tiered",
26         "pricePoints": [
27           {
28             "minQuantity": 1,
29             "maxQuantity": 10,
30             "unitPriceCents": 1500
31           },
32           {
33             "minQuantity": 11,
34             "maxQuantity": 50,
35             "unitPriceCents": 1200
36           }
37         ]
38       },
39       "creditBenefits": [
40         {
41           "id": "cb_0011223344556677",
42           "amount": 100,
43           "creditsCurrencyId": "credits_usd",
44           "recipient": "organization",
45           "rolloverAmount": 50,
46           "rolloverDuration": 3,
47           "rolloverDurationUnit": "months",
48           "allocationCadence": "monthly",
49           "creditGrantTiming": "on_payment",
50           "isInfiniteTotal": false
51         }
52       ]
53     }
54   ]
55 }

Get a plan by your external plan ID.

Authentication

AuthorizationBearer

API Key authentication using Bearer token

Path parameters

externalIdstringRequired

Response

200

idstring

productIdstring

namestring or null

externalIdstring or null

supportedCurrencieslist of strings

isDefaultboolean

statusenum

upgradePathOrderdouble or null

archivedAtdatetime or null

createdAtdatetime

updatedAtdatetime

attributeslist of objects

Errors

403

Forbidden Error

404

Not Found Error

500

Internal Server Error