Plans

Plans are recurring donations that a supporter has agreed to make.

Attribute

Description

id

The Plan ID.

first_name

The supporter's first name.

last_name

The supporter's last name.

email

The supporter's email address.

phone

The supporter's phone number.

frequency

How often the donation is made. Can be monthly, quarterly or yearly

status

The status of the plan. Can be active, cancelled ,ended,past_dueorpaused

method

The payment method used for this plan.

amount

The amount of the recurring donation.

fee_covered

The portion of the fee the supporter covered.

created_at

A UTC datetime string indicating when the plan was created.

start_at

A UTC datetime string indicating when the plan was started.

next_bill_date

A UTC datetime string indicating when the plan will bill next.

get
Get Plans

https://api.givebutter.com/v1/plans/:id
Retrieve a list of your plans. Include an id to retrieve a specific plan.
Request
Response
Request
Path Parameters
id
optional
string
ID of the plan.
Response
200: OK
Cake successfully retrieved.
{ "name": "Cake's name", "recipe": "Cake's recipe name", "cake": "Binary cake"}
404: Not Found
Could not find a cake matching this query.
{ "message": "Ain't no cake like that."}

‚Äč