List Plans

GET

plans

curl "https://api.alguna.io/plans/?page=1&limit=25" \
  -H "Authorization: Bearer YOUR_API_KEY"

const plans = await alguna.plans.list({
  page: 1,
  limit: 25
});

{
  "items": [
    {
      "id": "pln_02y7zjb1GksJMrB3NfrPhA",
      "name": "Plan 1",
      "description": "asd",
      "currency": "USD",
      "createdAt": "2024-11-01T14:38:36Z",
      "updatedAt": "2024-11-01T14:38:36Z"
    }
  ],
  "pageCount": 1,
  "limit": 250
}

Retrieves a paginated list of all plans.

Query Parameters

integer

default:"1"

The page number to retrieve (1-indexed).

integer

default:"10"

The number of plans to return per page. Must be one of: 5, 10, 25, 50, or 100. Values exceeding 100 are capped automatically.

curl "https://api.alguna.io/plans/?page=1&limit=25" \
  -H "Authorization: Bearer YOUR_API_KEY"

const plans = await alguna.plans.list({
  page: 1,
  limit: 25
});

Response

{
  "items": [
    {
      "id": "pln_02y7zjb1GksJMrB3NfrPhA",
      "name": "Plan 1",
      "description": "asd",
      "currency": "USD",
      "createdAt": "2024-11-01T14:38:36Z",
      "updatedAt": "2024-11-01T14:38:36Z"
    }
  ],
  "pageCount": 1,
  "limit": 250
}

[]Plan

An array of plan objects.

Show Plan Properties

string

The unique identifier for the plan.

string

The name of the plan.

string

A brief description of the plan.

string

The currency in which the plan is billed.

datetime

The timestamp when the plan was created.

datetime

The timestamp when the plan was last updated.

number

The total number of pages available.

number

The maximum number of plans returned per page.

⌘I

curl "https://api.alguna.io/plans/?page=1&limit=25" \
  -H "Authorization: Bearer YOUR_API_KEY"

const plans = await alguna.plans.list({
  page: 1,
  limit: 25
});

{
  "items": [
    {
      "id": "pln_02y7zjb1GksJMrB3NfrPhA",
      "name": "Plan 1",
      "description": "asd",
      "currency": "USD",
      "createdAt": "2024-11-01T14:38:36Z",
      "updatedAt": "2024-11-01T14:38:36Z"
    }
  ],
  "pageCount": 1,
  "limit": 250
}

API Reference

Billing Events & Usage Metering

Bundles

Credit Grants

Credit Notes

Customers

Invoices

Plans

Products

Refunds

Subscriptions

Subscription Versions

Wallets

Query Parameters

Response

​Query Parameters

​Response

Query Parameters

Response