---
title: "Get customer's current plan"
method: GET
path: "/plans/current"
tags: ["plans"]
---

# Get customer's current plan

`GET /plans/current`

## Request

- Base URL: `https://api.agentpaid.io/api/v1`
- URL: `https://api.agentpaid.io/api/v1/plans/current`
- Auth: HTTP bearer

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

## Query parameters

- `customerExternalId` string, required

## Response `200`

Success response

- PlansGetCurrentResponse200
  - `plan` PlansCurrentGetResponsesContentApplicationJsonSchemaPlan, required: The plan details, or null if the customer has no active plan
    - `id` string, uuid, required: The unique identifier of the plan
    - `name` string, required: The name of the plan
    - `description` string, nullable: The description of the plan
    - `type` 'flat' | 'usage' | 'credit', required: The type of plan
    - `pricing` PlanPricing, required: The pricing configuration for a plan. Uses the same PricePoints structure as product pricing.
      - `PricePoints` object, required: Price points keyed by currency code (e.g., "USD", "EUR")
      - `billingFrequency` 'monthly' | 'quarterly' | 'semi-annually' | 'yearly' | 'custom', required: The billing frequency for the plan
      - `billingFrequencyCustomMonths` number, double: Custom billing frequency in months (when billingFrequency is "custom")
    - `planGroupId` string, uuid, required: The plan group ID this plan belongs to
    - `nextPlanId` string, uuid, nullable: The ID of the next plan in the sequence
    - `prevPlanId` string, uuid, nullable: The ID of the previous plan in the sequence
    - `features` PlansCurrentGetResponsesContentApplicationJsonSchemaPlanFeaturesItems[], required: The features (product-attribute pairs) included in this plan with usage and limits
      - `productName` string, required: The name of the product
      - `attributeName` string, required: The name of the product attribute
      - `pricing` object, required: The pricing configuration for this feature
      - `usage` PlansCurrentGetResponsesContentApplicationJsonSchemaPlanFeaturesItemsUsage, required: Current usage and limits for this feature
        - `eventName` string, nullable, required: The event name used to track usage for this feature
        - `currentUsage` integer, required: The current usage quantity for this feature on the order
        - `limit` integer, nullable, required: The usage limit for this feature (null if unlimited)
        - `isUnlimited` boolean, required: Whether this feature has unlimited usage
  - `subscription` PlansCurrentGetResponsesContentApplicationJsonSchemaSubscription, required: The subscription details, or null if the customer has no active plan
    - `orderId` string, uuid, required: The ID of the order
    - `orderDisplayId` string, nullable: The display ID of the order
    - `startDate` string, date-time, required: The start date of the subscription
    - `endDate` string, date-time, nullable, required: The end date of the subscription (null if ongoing)
    - `totalUsage` integer, required: The total usage quantity across all features on this order

## Other responses

- `400`: Bad request - Missing customerExternalId parameter
- `403`: Forbidden - Invalid or missing API key
- `404`: Customer not found

---

[API](https://skmtc.dev/paid/apis/paid-2.md) - [All operations](https://skmtc.dev/paid/apis/paid-2/llms.txt) - [OpenAPI document](https://skmtc.dev/paid/apis/paid-2/revisions/dbdf4a60ed27?raw)