Get plan by ID

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>'

import requests

url = "https://api.paymee.com.br/v1.1/pix-automatic/plans/{planId}"

headers = {
    "x-api-key": "<x-api-key>",
    "x-api-token": "<x-api-token>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'x-api-key': '<x-api-key>', 'x-api-token': '<x-api-token>'}
};

fetch('https://api.paymee.com.br/v1.1/pix-automatic/plans/{planId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.paymee.com.br/v1.1/pix-automatic/plans/{planId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <x-api-key>",
    "x-api-token: <x-api-token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.paymee.com.br/v1.1/pix-automatic/plans/{planId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<x-api-key>")
	req.Header.Add("x-api-token", "<x-api-token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("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>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.paymee.com.br/v1.1/pix-automatic/plans/{planId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<x-api-key>'
request["x-api-token"] = '<x-api-token>'

response = http.request(request)
puts response.read_body

{
  "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"
    }
  ]
}

{
  "errorCount": 1,
  "errors": [
    {
      "error": "Forbidden",
      "message": "Access Denied"
    }
  ],
  "message": "field validation failure",
  "status": -1
}

{
  "status": 998,
  "message": "plan not found",
  "errorCount": 1,
  "errors": [
    {
      "field": "planId",
      "message": "non-existent plan"
    }
  ]
}