POST
/
v1.1
/
pix-automatic
/
plans
curl --request POST \
  --url https://api.paymee.com.br/v1.1/pix-automatic/plans \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-api-token: <x-api-token>' \
  --data '{
  "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
}'
{
  "status": 0,
  "message": "success",
  "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"
}

Headers

​
x-api-key
string
required
Example:

"your-x-api-key"

​
x-api-token
string
required
Example:

"your-x-api-token"

Body

application/json

Response

201
application/json

Plan created successfully.

The response is of type object.