Retrieves a specific plan by its ID.
cURL
curl --request GET \ --url https://api.paymee.com.br/v1.1/pix-automatic/plans/{planId} \ --header 'x-api-key: <x-api-key>' \ --header 'x-api-token: <x-api-token>'
{ "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", "totalAuthorizations": 7, "authorizations": [ { "id": 21, "idRec": "RR286838922025061602541904516", "status": "APPROVED", "payer": { "document": "00000000000", "name": "JOHN DOE", "ispb": "99999919" }, "nextRecurrenceDate": "2025-07-19" }, { "id": 25, "idRec": "RR286838922025061603533095545", "status": "CANCELLED", "payer": { "document": "00000000000", "name": "JOHN DOE", "ispb": "99999919" }, "nextRecurrenceDate": "2025-07-19" } ] }
"your-x-api-key"
"your-x-api-token"
ID of the plan to be retrieved.
Plan data returned successfully.
Show child attributes