List plans - Alguna Docs

GET

plans

List plans

curl --request GET \
  --url https://api.alguna.io/plans \
  --header 'Alguna-Version: <alguna-version>' \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "created_at": "2026-04-01T10:00:00Z",
      "currency": "USD",
      "id": "pln_01H1VECT",
      "name": "Enterprise Plan",
      "updated_at": "2026-04-01T12:30:00Z",
      "description": "Full-featured enterprise plan"
    }
  ],
  "pagination": {
    "per_page": 20,
    "total_pages": 5
  }
}

Authorizations

Authorization

string

header

required

API key authentication. Pass your API key as a Bearer token.

Headers

Alguna-Version

enum<string>

required

Available options:

2026-04-01

Query Parameters

limit

integer<int64>

required

Number of items to return per page

Example:

20

offset

integer<int64>

required

Number of items to skip

Example:

0

sort

string

required

Sort field and direction in format field:order

Example:

"created_at:desc"

tag_ids

string[]

Filter by tag IDs (comma-separated to match any)

Example:

"tag_abc123"

Response

Success

data

object[]

required

List of plans

Show child attributes

pagination

object

required

Pagination metadata

Show child attributes

Create a planCreates a new plan with its full pricing template — name, currency, contract configuration, and the items (standalone priced products and/or bundles) that subscriptions will inherit. Optional fields cover plan-level discount, spend thresholds, price escalation, entitlements, tags, and invoice/email behavior.

⌘I

List plans

curl --request GET \
  --url https://api.alguna.io/plans \
  --header 'Alguna-Version: <alguna-version>' \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "created_at": "2026-04-01T10:00:00Z",
      "currency": "USD",
      "id": "pln_01H1VECT",
      "name": "Enterprise Plan",
      "updated_at": "2026-04-01T12:30:00Z",
      "description": "Full-featured enterprise plan"
    }
  ],
  "pagination": {
    "per_page": 20,
    "total_pages": 5
  }
}