givingfuel_list_forms
List donation forms
List the account's GivingFuel forms (donation / fundraising pages): id, name, status (open or closed), created and updated dates. Use the form ids to filter orders, transactions and subscriptions. GET /forms.
Parameterssortlimitcreated_afterupdated_aftercreated_beforestarting_afterupdated_before
givingfuel_get_form
Get donation form
One form by id: name, status, accounting reference, time zone and its field layout. GET /forms/{id}.
Parametersform_idrequired
givingfuel_get_form_inventory
Get form inventory
Inventory items of a form (limited-quantity items): path, name, sold and remaining quantity. GET /forms/{id}/inventory.
Parametersform_idrequired
givingfuel_list_orders
List donation orders
List donation orders (one per checkout): order number, donor billing name and address, form, total, currency and status, newest or oldest first. Filter by form, status, donor email, customer id, order number or dates. GET /search/orders.
Parameterssortemaillimitstatusform_idcustomer_idorder_numbercreated_afterupdated_aftercreated_beforestarting_afterupdated_before
givingfuel_get_order
Get donation order
One order by id with the donor's billing details, form, totals and status. Set include_transactions to embed the payments (charges and refunds) of the order. GET /search/orders/{id}.
Parametersorder_idrequiredinclude_transactions
givingfuel_list_transactions
List transactions
List payment transactions (money movements): amount, deductible amount, currency, type (charge, refund, voucher), payment method, masked card, status, form and donor email. Filter by type, method, form, order, donor or dates. GET /search/transactions.
Parameterssorttypeemaillimitstatusform_idorder_idreferencecustomer_idorder_numbercreated_afterupdated_after+4 more
givingfuel_get_transaction
Get transaction
One transaction by id: amounts, type, payment method, masked card, gateway message and status. GET /search/transactions/{id}.
Parameterstransaction_idrequired
givingfuel_list_subscriptions
List recurring gifts
List recurring donations (subscriptions): amount, schedule, status, last and next payment date, payments remaining, form and donor email. Filter by form, status, donor, or next/last payment date. GET /search/subscriptions.
Parameterssortemaillimitstatusform_idorder_idcustomer_idorder_numbercreated_afterupdated_aftercreated_beforestarting_after+3 more
givingfuel_get_subscription
Get recurring gift
One recurring donation by id: amount, schedule, status, last and next payment, payments remaining. GET /search/subscriptions/{id}.
Parameterssubscription_idrequired
givingfuel_list_customers
List donors
List customer records (donors): id, email, billing name and address, lifetime amount, created and updated dates. Filter by email or dates. New donors can take up to 5 minutes to appear. GET /search/customers.
Parameterssortemaillimitcreated_afterupdated_aftercreated_beforestarting_afterupdated_before
givingfuel_get_customer
Get donor
One donor (customer record) by id: email, billing details and total amount. GET /search/customers/{id}.
Parameterscustomer_idrequired
givingfuel_list_coupons
List coupons
List GivingFuel coupons: account-wide ones, or only those of one form when form_id is given. Shows discounts, codes, availability, redeemed count and expiry. GET /coupons/global or /coupons/forms/{id}.
Parameterscodesortlimitform_idstarting_after
givingfuel_get_coupon
Get coupon
One coupon by id with its discounts, codes, availability and redeemed counts. GET /coupons/{id}.
Parameterscoupon_idrequired
givingfuel_create_coupon
Create coupon
WRITE: create a discount coupon in the live GivingFuel account (it can be redeemed by donors right away). One discount (fixed amount or percent) and one or more codes; optionally limited to one form, to a number of uses, and to an expiry date. Not idempotent: calling it twice creates two coupons. POST /coupons.
Parametersnamerequiredcodesrequiredexpiresform_idcurrencyavailablediscount_typerequireddiscount_valuerequired
givingfuel_delete_coupon
Delete coupon
WRITE: permanently delete a coupon from the live GivingFuel account; its codes stop working immediately and this cannot be undone. Show the coupon (givingfuel_get_coupon) and get the user's approval first, then call with confirm: true. GET /coupons/{id}, then DELETE /coupons/{id}.
Parametersconfirmrequiredcoupon_idrequired