v1

latestOpenAPI 3.1.02026-07-24170121.2 MB

List All Plans

This API provides a list of plans that are created.

get/v1/plans

Request body

limitinteger

Number of plans to be listed per page.

pageinteger

A number that represents a current page number.

Response

200

Example response

{
  "data": [
    {
      "object": "Plan",
      "plan_id": "plan_7012f470",
      "amount": 99,
      "interval": "day",
      "interval_count": 1,
      "name": "Test",
      "statement_descriptor": "dfghdfhg",
      "trial_period_days": "0",
      "currency": "usd",
      "created_at": 1724503328,
      "updated_at": 1724503328
    }
  ],
  "meta": {
    "pagination": {
      "total": 6,
      "count": 6,
      "per_page": 10,
      "current_page": 1,
      "total_pages": 1
    }
  }
}