Update plan by external ID

PUT

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

PUT

/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.updatePlanByExternalId("externalId", {
8         body: {},
9     });
10 }
11 main();

1 {
2   "id": "string",
3   "productId": "string",
4   "name": "string",
5   "externalId": "string",
6   "supportedCurrencies": [
7     "string"
8   ],
9   "isDefault": true,
10   "status": "active",
11   "upgradePathOrder": 1.1,
12   "archivedAt": "2024-01-15T09:30:00Z",
13   "createdAt": "2024-01-15T09:30:00Z",
14   "updatedAt": "2024-01-15T09:30:00Z",
15   "attributes": [
16     {
17       "productAttributeId": "string",
18       "name": "string",
19       "active": true,
20       "pricing": {
21         "pricingType": "RecurringPerUnit",
22         "chargeType": "string",
23         "pricingModel": "string",
24         "pricePoints": [
25           {}
26         ]
27       },
28       "creditBenefits": [
29         {
30           "id": "string",
31           "amount": 1.1,
32           "creditsCurrencyId": "string",
33           "recipient": "organization",
34           "rolloverAmount": 1.1,
35           "rolloverDuration": 1.1,
36           "rolloverDurationUnit": "days",
37           "allocationCadence": "upfront",
38           "creditGrantTiming": "on_payment",
39           "isInfiniteTotal": true
40         }
41       ]
42     }
43   ]
44 }

Update a plan by your external plan ID. If attributes are provided, they replace the plan's existing attributes. Set status to archive or restore the plan.

Authentication

AuthorizationBearer

API Key authentication using Bearer token

Path parameters

externalIdstringRequired

Request

Body

namestring or nullOptional

externalIdstring or nullOptional

supportedCurrencieslist of stringsOptional

isDefaultbooleanOptional

statusenumOptional

Set to archived to archive this plan, or active to restore it.

attributeslist of objectsOptional

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

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error