Skip to main content
GET
/
v1
/
plans
List all recurring plans
curl --request GET \
  --url https://api.givebutter.com/v1/plans \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "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>"
    }
  ],
  "links": {
    "first": "<string>",
    "last": "<string>",
    "prev": "<string>",
    "next": "<string>"
  },
  "meta": {
    "current_page": 2,
    "from": 2,
    "last_page": 2,
    "links": [
      {
        "url": "<string>",
        "label": "<string>",
        "active": true
      }
    ],
    "path": "<string>",
    "per_page": 1,
    "to": 2,
    "total": 1
  }
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
contacts
string | null

Response

Paginated set of RecurringPlanResource

​
data
RecurringPlanResource · object[]
required
​
links
object
required
​
meta
object
required