Get customer's current plan | Paid

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

{
  "plan": {
    "id": "63fd642c-569d-44f9-8d67-5cf4944a16cc",
    "name": "Pro Plan",
    "type": "flat",
    "pricing": {
      "PricePoints": {
        "USD": {
          "unitPrice": 9900,
          "tiers": []
        }
      },
      "billingFrequency": "monthly"
    },
    "planGroupId": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
    "features": [
      {
        "productName": "API Service",
        "attributeName": "api_calls",
        "pricing": {
          "eventName": "api_calls",
          "chargeType": "usage",
          "pricingModel": "flat",
          "billingFrequency": "monthly"
        },
        "usage": {
          "eventName": "api_calls",
          "currentUsage": 450,
          "limit": 1000,
          "isUnlimited": false
        }
      },
      {
        "productName": "API Service",
        "attributeName": "data_transfer",
        "pricing": {
          "eventName": "data_transfer",
          "chargeType": "usage",
          "pricingModel": "flat",
          "billingFrequency": "monthly"
        },
        "usage": {
          "eventName": "data_transfer",
          "currentUsage": 0,
          "limit": null,
          "isUnlimited": true
        }
      }
    ],
    "description": "Professional plan with advanced features",
    "nextPlanId": "b2c3d4e5-6789-01bc-def0-2345678901bc",
    "prevPlanId": null
  },
  "subscription": {
    "orderId": "8e1c7fdf-e93b-52e5-b827-557766661111",
    "startDate": "2024-01-01T00:00:00Z",
    "endDate": "2024-12-31T23:59:59Z",
    "totalUsage": 450,
    "orderDisplayId": "ORD-12345"
  }
}

Retrieves the currently active plan subscription for a customer by their external ID. Returns the plan details and subscription information.

Authentication

AuthorizationBearer

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

Query parameters

customerExternalIdstringRequired

The external ID of the customer

Response

Success response

planobject or null

The plan details, or null if the customer has no active plan

subscriptionobject or null

The subscription details, or null if the customer has no active plan

Authentication

Query parameters

Response

Errors