Find plans - Documentation

GET

plans

Find plans

curl --request GET \
  --url https://sandbox-api.paynext.com/plans \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "price_1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
      "interval_count": 1,
      "name": "Pro Plan",
      "price": {
        "countries": [
          {
            "countries": [],
            "price": {
              "amount": 1999,
              "currency": "AED"
            }
          }
        ],
        "default": {
          "amount": 1999,
          "currency": "AED"
        }
      },
      "tax": {
        "collect_tax": "<unknown>"
      },
      "trial_interval_count": 14,
      "trial_price": {
        "countries": [
          {
            "countries": [],
            "price": {
              "amount": 1999,
              "currency": "AED"
            }
          }
        ],
        "default": {
          "amount": 1999,
          "currency": "AED"
        }
      },
      "type": "recurring",
      "updated_at": "2025-05-27T10:00:00Z"
    }
  ],
  "meta": {
    "limit": 100,
    "page": 1,
    "pages": 1,
    "snapshot_at": "2026-01-01T00:00:00Z",
    "total": 1
  }
}

Authorizations

Authorization

string

header

required

Authentication header of the form api key, where api key is your organization api key.

Headers

X-API-Version

enum<string>

Specifies the version of the API to use

Available options:

1.0.0

Query Parameters

from

string

include

string

limit

integer

default:100

Number of items per page

Required range: 1 <= x <= 1000

order

enum<string>

default:desc

Sort order

Available options:

asc,

desc

page

integer

default:1

Page number for paginated results

Required range: x >= 1

string

Keyword to search across fields

snapshot_at

string

Timestamp of the data snapshot

sort

string

default:created_at

Field to sort by

string

Response

data

object[]

Show child attributes

meta

object

Show child attributes

Find a planFind a plan by id

⌘I

Find plans

curl --request GET \
  --url https://sandbox-api.paynext.com/plans \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "price_1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
      "interval_count": 1,
      "name": "Pro Plan",
      "price": {
        "countries": [
          {
            "countries": [],
            "price": {
              "amount": 1999,
              "currency": "AED"
            }
          }
        ],
        "default": {
          "amount": 1999,
          "currency": "AED"
        }
      },
      "tax": {
        "collect_tax": "<unknown>"
      },
      "trial_interval_count": 14,
      "trial_price": {
        "countries": [
          {
            "countries": [],
            "price": {
              "amount": 1999,
              "currency": "AED"
            }
          }
        ],
        "default": {
          "amount": 1999,
          "currency": "AED"
        }
      },
      "type": "recurring",
      "updated_at": "2025-05-27T10:00:00Z"
    }
  ],
  "meta": {
    "limit": 100,
    "page": 1,
    "pages": 1,
    "snapshot_at": "2026-01-01T00:00:00Z",
    "total": 1
  }
}