Get plan by ID | Paid | Documentation

import { PaidClient } from "@paid-ai/paid-node";
async function main() {
    const client = new PaidClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.plans.getById("planId");
}
main();

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "organizationId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "planGroupId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "name": "Premium Business Plan",
  "type": "flat",
  "pricing": {
    "PricePoints": {
      "USD": {
        "unitPrice": 19900,
        "tiers": []
      }
    },
    "billingFrequency": "monthly",
    "billingFrequencyCustomMonths": 1.1
  },
  "createdAt": "2024-01-15T09:30:00Z",
  "updatedAt": "2024-01-15T09:30:00Z",
  "description": "Full access to all premium features with priority support",
  "nextPlanId": "4a1e2f3b-8c9d-4e2a-9f7b-123456789abc",
  "prevPlanId": "2b3c4d5e-6f7a-8b9c-0d1e-23456789abcd",
  "planProducts": [
    {
      "id": "5f6e7d8c-9b0a-4c3d-8e7f-123456789def",
      "organizationId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
      "planId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "productId": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
      "createdAt": "2024-01-15T09:30:00Z",
      "updatedAt": "2024-01-15T09:30:00Z",
      "product": {
        "id": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
        "organizationId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
        "name": "Advanced Analytics Module",
        "type": "agent",
        "active": true,
        "externalId": "EXT-12345",
        "displayId": "PROD-001",
        "description": "Provides detailed analytics and reporting features",
        "productCode": "ANL-ADV-2024",
        "ProductAttribute": [
          {
            "name": "User Seats",
            "active": true,
            "pricing": {
              "taxable": true,
              "chargeType": "recurring",
              "pricingModel": "PerUnit",
              "billingFrequency": "monthly",
              "pricePoints": {
                "USD": {
                  "unitPrice": 1500,
                  "minQuantity": 1,
                  "includedQuantity": 0,
                  "tiers": []
                }
              },
              "eventName": "seat_allocation",
              "creditCost": 0
            }
          }
        ],
        "metadata": {
          "category": "analytics",
          "version": "2.3.1"
        },
        "createdAt": "2023-11-01T08:00:00Z",
        "updatedAt": "2024-01-10T12:00:00Z"
      },
      "planProductAttribute": [
        {
          "id": "9f8e7d6c-5b4a-3c2d-1e0f-123456789abc",
          "organizationId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
          "planProductId": "5f6e7d8c-9b0a-4c3d-8e7f-123456789def",
          "productAttributeId": "a1b2c3d4-e5f6-7a8b-9c0d-1e2f3a4b5c6d",
          "pricing": {
            "unitPrice": 1500,
            "minQuantity": 1,
            "includedQuantity": 0,
            "tiers": []
          },
          "createdAt": "2024-01-15T09:30:00Z",
          "updatedAt": "2024-01-15T09:30:00Z"
        }
      ]
    }
  ]
}

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

planIdstringRequiredformat: "uuid"

The ID of the plan

Response

Success response

idstringformat: "uuid"

The unique identifier of the plan

organizationIdstringformat: "uuid"

The organization ID that owns this plan

planGroupIdstringformat: "uuid"

The plan group ID this plan belongs to

namestring

The name of the plan

typeenum

The type of plan (flat for fixed pricing, usage for usage-based, credit for prepaid credits)

Allowed values:

pricingobject

The pricing configuration for a plan. Uses the same PricePoints structure as product pricing.

createdAtdatetime

When the plan was created

updatedAtdatetime

When the plan was last updated

descriptionstring or null

The description of the plan

nextPlanIdstring or nullformat: "uuid"

The ID of the next plan in the sequence

prevPlanIdstring or nullformat: "uuid"

The ID of the previous plan in the sequence

planProductslist of objects or null

The products included in this plan

Authentication

Path parameters

Response

Errors