Skip to main content
GET
/
v1.1
/
pix-automatic
/
plans
List recurrence plans
curl --request GET \
  --url https://api.paymee.com.br/v1.1/pix-automatic/plans \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-api-token: <x-api-token>'
{
  "status": 0,
  "message": "success",
  "totalElements": 1,
  "totalPages": 1,
  "resultSize": 1,
  "result": [
    {
      "id": "6851c0842bf40769ead1fde5",
      "title": "Plano Premium Mensal",
      "description": "Acesso completo a todas as funcionalidades da plataforma.",
      "frequency": "MONTHLY",
      "period": 1,
      "imediateAmount": 49.9,
      "recurrenceAmount": 29.9,
      "minimumRecurrenceAmount": 29.9,
      "retryPolicy": "ACCEPT_3R_7D",
      "enabled": true,
      "creation": "2025-06-17 19:22:44",
      "totalAuthorizations": 0
    }
  ]
}

Headers

​
x-api-key
string
required
Example:

"your-x-api-key"

​
x-api-token
string
required
Example:

"your-x-api-token"

Query Parameters

​
title
string

Filter by plan title.

​
enabled
boolean

Filter by plan status (active/inactive).

​
frequency
string

Filter by frequency.

​
page
integer
default:0

Page number for the query.

​
maxPageResults
integer
default:20

Maximum number of results per page.

Response

List of plans returned successfully.

​
status
integer
Example:

0

​
message
string
Example:

"success"

​
totalElements
integer

Total number of plans found.

Example:

1

​
totalPages
integer

Total number of pages.

Example:

1

​
resultSize
integer

Number of plans returned in the current page.

Example:

1

​
result
object[]