Create a new plan

POST

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

POST

/api/v2/plans/

import { PaidClient } from "@paid-ai/paid-node";
async function main() {
    const client = new PaidClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.plans.createPlan({
        productId: "string",
        attributes: [
            {
                productAttributeId: "string",
                pricing: {
                    pricingType: "RecurringPerUnit",
                    billingFrequency: "Monthly",
                    pricePoints: [
                        {
                            currency: "string",
                            unitPrice: 1,
                        },
                    ],
                },
            },
        ],
    });
}
main();

{
  "id": "string",
  "productId": "string",
  "name": "string",
  "externalId": "string",
  "supportedCurrencies": [
    "string"
  ],
  "isDefault": true,
  "status": "active",
  "upgradePathOrder": 1.1,
  "archivedAt": "2024-01-15T09:30:00Z",
  "createdAt": "2024-01-15T09:30:00Z",
  "updatedAt": "2024-01-15T09:30:00Z",
  "attributes": [
    {
      "productAttributeId": "string",
      "name": "string",
      "active": true,
      "pricing": {
        "pricingType": "RecurringPerUnit",
        "chargeType": "string",
        "pricingModel": "string",
        "pricePoints": [
          {}
        ]
      },
      "creditBenefits": [
        {
          "id": "string",
          "amount": 1.1,
          "creditsCurrencyId": "string",
          "recipient": "organization",
          "rolloverAmount": 1.1,
          "rolloverDuration": 1.1,
          "rolloverDurationUnit": "days",
          "allocationCadence": "string",
          "creditGrantTiming": "on_payment",
          "isInfiniteTotal": true,
          "overageUnitPrice": 1.1,
          "overageUnitPrices": {}
        }
      ]
    }
  ]
}

Creates a new plan for a product.

Authentication

AuthorizationBearer

API Key authentication using Bearer token

Request

Body

productIdstringRequired>=1 character

Paid product ID, for example prod_abc123

attributeslist of objectsRequired

namestring or nullOptional

externalIdstring or nullOptional

Your stable identifier for this plan

supportedCurrencieslist of stringsOptional

isDefaultbooleanOptional

Response

201

idstring

productIdstring

namestring or null

externalIdstring or null

supportedCurrencieslist of strings

isDefaultboolean

statusenum

Allowed values:

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