Skip to main content
GET
/
v1
/
plans
/
{plan}
Get a recurring plan
curl --request GET \
  --url https://api.givebutter.com/v1/plans/{plan} \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.givebutter.com/v1/plans/{plan}"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.givebutter.com/v1/plans/{plan}', 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.givebutter.com/v1/plans/{plan}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <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.givebutter.com/v1/plans/{plan}"

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

	req.Header.Add("Authorization", "Bearer <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.givebutter.com/v1/plans/{plan}")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.givebutter.com/v1/plans/{plan}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "id": "<string>",
  "contact_id": "<string>",
  "first_name": "<string>",
  "last_name": "<string>",
  "email": "<string>",
  "phone": "<string>",
  "frequency": "<string>",
  "status": "<string>",
  "method": "<string>",
  "amount": "<string>",
  "fee_covered": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>",
  "start_at": "<string>",
  "canceled_at": "<string>",
  "next_bill_date": "<string>"
}
{
  "message": "<string>"
}
{
  "message": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
plan
string | null
required

The plan uid

Query Parameters

​
first_name
string
Maximum string length: 255
​
last_name
string
Maximum string length: 255
​
email
string
​
amount
string

Response

RecurringPlanResource

​
id
string
required
​
contact_id
string
required
​
first_name
string
required
​
last_name
string
required
​
email
string
required
​
phone
string
required
​
frequency
string
required
​
status
string
required
​
method
string
required
​
amount
string
required
​
fee_covered
string
required
​
created_at
string
required
​
updated_at
string
required
​
start_at
string
required
​
canceled_at
string
required
​
next_bill_date
string
required