Contributions (V3)
Actions available on contributions. Uses V3 endpoints.
List
Retrieve a list of matching contributions.
Note: This endpoint use the
v3version of the API.
Request
- url:
/admin/api/v3/contributions - method:
GET -
filters: (how?)
occurred_before: optional, date or datetime, will only return contributions that were placed before that date (non-inclusive)occurred_after: optional, date or datetime, will only return contributions that were placed after that date (non-inclusive)onetime: optional, boolean, will only return contributions that do not contain any recurring itemsrecurring: optional, boolean, will only return contributions that contain at least one recurring item, without the initial contributioninitial_recurring: optional, boolean, will only return contributions that contain the initial contribution that created a recurring profile/planone_time_and_initial_recurring: optional, boolean, will return contributions that either contains the initial contribution that created a recurring profile/plan or that does not contain any recurring items. The union ofonetimeandinitial_recurring
-
sorting: (how?) (default:
-contribution_date)contribution_date: optionalupdated_at: optional
Response
contributions.json
{
"data": [
{
"id": "11D8C91789",
"is_recurring": true,
"is_test": 1,
"is_fulfillable": false,
"is_fulfilled": null,
"is_refundable": true,
"is_paid": true,
"is_pos_entry": 0,
"is_deleted": false,
"is_spam": 0,
"source": "Web",
"customer_comments": null,
"notes": "<p>Note to customer</p>",
"supporter": {
"id": "P59EKZDK",
"id_deprecated": 2,
"active": true,
"display_name": "Hilma Hill",
"first_name": "Hilma",
"last_name": "Hill",
"email": "hilma.hill@example.com",
"type": "Individual",
"is_organization": false,
"email_opt_in": true,
"vendor_contact_id": 2966,
"billing_address": {
"first_name": "Hilma",
"last_name": "Hill",
"company": null,
"email": "hilma.hill@example.com",
"address1": "31 Douglas Blvd #950",
"address2": null,
"city": "Clovis",
"state": "NM",
"zip": "88101",
"country": "US",
"phone": "815-262-7380 x53749"
},
"shipping_address": {
"first_name": "Hilma",
"last_name": "Hill",
"company": null,
"email": "hilma.hill@example.com",
"address1": "31 Douglas Blvd #950",
"address2": null,
"city": "Clovis",
"state": "NM",
"zip": "88101",
"country": "US",
"phone": "815-262-7380 x53749"
},
"created_at": "2021-04-28T13:38:44Z",
"updated_at": "2024-02-29T23:05:35Z",
"groups": [
{
"id": "XPGE93E4",
"group_id": "7GZEJPE2",
"name": "Sample Annual Membership",
"start_date": "2021-04-29",
"end_date": "2028-05-26",
"is_active": true,
"is_expired": false,
"days_left": 1537,
"related": [
{
"id": "7GZEJPE2",
"name": "Sample Annual Membership",
"start_date": "2021-04-29",
"end_date": "2022-04-29",
"is_active": false,
"is_expired": true,
"source": "manual",
"end_reason": null,
"days_left": 0
},
{
"id": "Z8NER6EK",
"name": "Sample Annual Membership",
"start_date": "2022-04-29",
"end_date": "2023-04-29",
"is_active": false,
"is_expired": true,
"source": "manual",
"end_reason": null,
"days_left": 0
},
]
},
]
},
"billing_address": {
"title": null,
"name": "Hilma Hill",
"first_name": "Hilma",
"last_name": "Hill",
"email": "hilma.hill@example.com",
"first_name": "Hilma",
"last_name": "Hill",
"company": null,
"email": "hilma.hill@example.com",
"address1": "31 Douglas Blvd #950",
"address2": null,
"city": "Clovis",
"state": "NM",
"zip": "88101",
"country": "US",
"phone": "815-262-7380 x53749"
},
"shipping_address": {
"title": null,
"name": "Hilma Hill",
"first_name": "Hilma",
"last_name": "Hill",
"email": "hilma.hill@example.com",
"address1": "31 Douglas Blvd #950",
"address2": null,
"city": "Clovis",
"state": "NM",
"zip": "88101",
"country": "US",
"phone": "815-262-7380 x53749"
},
"shipping_method": null,
"created_at": "2024-02-29T18:50:51Z",
"ordered_at": "2024-02-29T19:23:24Z",
"updated_at": "2024-03-05T21:10:48Z",
"refunded_at": "",
"downloadable_item_count": 0,
"recurring_item_count": 1,
"shippable_item_count": 0,
"line_items": [
{
"id": "59DK9G8D",
"description": "General Fund - Deleniti Velit Repudiandae",
"image_thumb": "",
"is_locked": false,
"is_recurring": true,
"is_price_reduced": false,
"is_fundraising_form_upgrade": false,
"undiscounted_price": 10,
"locked_original_price": "10.0000",
"locked_variants_original_price": 10,
"locked_variants_price": 10,
"locked_variants_total": 10,
"payment_string": "$10.00 USD/mth starting Mar 29th, 2024",
"public_url": "https://your-domain.givecloud.co/product/04FABAF7/cumque-fund",
"recurring_description": "$10.00/mth (29th) starting March 29th, 2024",
"reference": "04FABAF7",
"total": 10,
"dpo_tribute_id": null,
"fields": [],
"gift_aid": false,
"is_tribute": false,
"tribute_name": "",
"public_message": null,
"additional_notes": "Additional contribution asked by supporter.",
"is_anonymous": true,
"price": 10,
"qty": 1,
"upgraded_to_recurring": 0,
"recurring_profile_id": "84D37ZDW",
"recurring_amount": 10,
"recurring_day": 29,
"recurring_day_of_week": null,
"recurring_with_dpo": false,
"recurring_with_initial_charge": true,
"recurring_cycles": null,
"recurring_starts_on": "",
"recurring_ends_on": "",
"sponsorship_is_expired": false,
"is_dcc_eligible": 0,
"dcc_recurring_amount": "0.0000",
"total_tax_amt": null,
"accounting": {
"code": null
},
"recurring_profile": {
"id": "84D37ZDW",
"profile_id": "84D37ZDW",
"status": "Active",
"payment_description": "$10.00/mth (29th)",
"started_on": "2024-02-29T19:23:24Z",
"next_billing_date": "2024-03-29",
"cover_costs_enabled": true,
"cover_costs_amount": 0,
"billing_period_description": "Monthly",
"billing_period_day": "29th",
"aggregate_amount": 10,
"failed_payments": 0,
"description": "General Fund - Deleniti Velit Repudiandae",
"gl_code": null,
"last_payment_due": null,
"payment_method": {
"display_name": "Visa",
"account_type": "Visa",
"account_number": "4*** **** **** 4242",
"expires_on": "2025-02-28T00:00:00.000000Z",
"is_expired": false,
"is_deleted": false
}
},
"sponsee": {
"id": "GZEJRNE2",
"reference_number": "ZDP0001GC",
"first_name": "Zacks",
"last_name": "Burkis",
"gender": "M",
"birth_date": "2010-07-12",
"age": 13,
"enrollment_date": "",
"longitude": null,
"latitude": null,
"biography": "<p style=\"text-align: justify;\">Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nam faucibus id augue at egestas. Aliquam finibus sem lectus, id laoreet quam aliquet id. Vivamus at rutrum nulla. Duis tristique egestas mauris a sodales. Vestibulum volutpat sapien diam. Donec faucibus nec velit sollicitudin hendrerit. Suspendisse elementum enim ut nunc consectetur, eu aliquam tortor finibus. Integer vestibulum turpis quis massa fringilla, in ultricies sem commodo. Duis tellus ante, ultrices at odio ac, eleifend maximus turpis. Donec vulputate tristique ultricies. Duis rhoncus sodales eros, eget hendrerit purus. Mauris pulvinar, nisi non tristique suscipit, tortor est scelerisque urna, non tempor ipsum sem et sapien.</p><p style=\"text-align: justify;\"><br></p><p style=\"text-align: justify;\">Pellentesque ut tincidunt nunc. Suspendisse ac magna ac massa pellentesque tristique. Nullam porttitor efficitur ipsum, et sodales enim. Interdum et malesuada fames ac ante ipsum primis in faucibus. Sed quis enim fermentum, tristique felis nec, posuere lorem. Donec vel est sit amet libero ornare sagittis. Aliquam pretium finibus magna.</p><p style=\"text-align: justify;\"><br></p><p style=\"text-align: justify;\">Integer eget diam enim. In feugiat posuere augue, sit amet sodales diam. Praesent tincidunt imperdiet sem. Ut ultrices arcu velit, a accumsan mi convallis vel. Nunc ornare efficitur auctor. Integer eget ipsum lectus. Vivamus commodo eu magna pellentesque pellentesque. Phasellus id nulla efficitur, semper odio a, consequat libero. Quisque in nulla eget arcu efficitur tincidunt non at ipsum. Aliquam tincidunt orci a rutrum pellentesque. Curabitur imperdiet lectus consequat sem pellentesque consectetur.</p><p style=\"text-align: justify;\"><br></p><p style=\"text-align: justify;\">Donec nisi mauris, sollicitudin eget ante at, convallis ornare neque. Mauris at velit eu dolor consequat malesuada quis id ligula. Suspendisse convallis sodales eleifend. In hac habitasse platea dictumst. Sed scelerisque est ante, eu dapibus ipsum porttitor vel. Morbi auctor nisi eu lacus consectetur congue. Vivamus tempus dolor et ligula interdum, in commodo erat dictum</p><p style=\"text-align: justify;\"><br></p><p style=\"text-align: justify;\"><br></p><p style=\"text-align: justify;\">Integer eget diam enim. In feugiat posuere augue, sit amet sodales diam. Praesent tincidunt imperdiet sem. Ut ultrices arcu velit, a accumsan mi convallis vel. Nunc ornare efficitur auctor. Integer eget ipsum lectus. Vivamus commodo eu magna pellentesque pellentesque. Phasellus id nulla efficitur, semper odio a, consequat libero. Quisque in nulla eget arcu efficitur tincidunt non at ipsum. Aliquam tincidunt orci a rutrum pellentesque. Curabitur imperdiet lectus consequat sem pellentesque consectetur.</p><p style=\"text-align: justify;\"><br></p><p style=\"text-align: justify;\">Donec nisi mauris, sollicitudin eget ante at, convallis ornare neque. Mauris at velit eu dolor consequat malesuada quis id ligula. Suspendisse convallis sodales eleifend. In hac habitasse platea dictumst. Sed scelerisque est ante, eu dapibus ipsum porttitor vel. Morbi auctor nisi eu lacus consectetur congue. Vivamus tempus dolor et ligula interdum, in commodo erat dictum.</p><p style=\"text-align: justify;\"><br></p><p style=\"text-align: justify;\"><span style=\"background-color: rgb(255, 255, 255); color: rgb(68, 68, 68);\">Donec nisi mauris, sollicitudin eget ante at, convallis ornare neque. Mauris at velit eu dolor consequat malesuada quis id ligula. Suspendisse convallis sodales eleifend. In hac habitasse platea dictumst. Sed scelerisque est ante, eu dapibus ipsum porttitor vel. Morbi auctor nisi eu lacus consectetur congue. Vivamus tempus dolor et ligula interdum, in commodo erat dictum.</span></p><p style=\"text-align: justify;\"><br></p>",
"private_notes": null,
"sponsored_status": "Sponsored Automatically (Sponsored)",
"is_enabled": true,
"payment_option_group": "One-Time & Recurring Option",
"sponsor_count": 1,
"image_url": "https://cdn.givecloud.co/s/files/3-dev/0000/0001/sponsorships/ame-1479-copie-3_300x_cropped_top.jpg",
"url": "https://your-domain.givecloud.co/sponsorship/385",
"custom_fields": [
{
"name": "Hobby",
"slug": "hobby",
"value": "I love to play Hockey",
"item": null,
"is_simple": 1,
"is_private": false
},
],
"created_at": "2023-09-27T00:00:00+00:00",
"updated_at": "2023-11-14T00:00:00+00:00"
},
"fundraiser": null,
"variant": {
"id": "P7DNM4EG",
"code": "04FABAF7",
"title": "Deleniti Velit Repudiandae",
"images": [],
"price": {
"amount": 0,
"currency_code": "USD"
},
"price_presets": "10,25,50,100,250,other",
"sale_price": {
"amount": 0,
"currency_code": "USD"
},
"minimum_price": null,
"on_sale": false,
"is_default": true,
"is_shippable": false,
"is_donation": true,
"billing_period": "monthly",
"inventory_management": "givecloud",
"inventory_policy": "continue",
"inventory_quantity": -1,
"inventory_updated_at": "2024-02-29T19:23:24Z",
"shipping_expectation": null,
"fair_market_value": {
"amount": 0,
"currency_code": "USD"
},
"sequence": 8,
"weight": null,
"created_at": "",
"updated_at": ""
},
"product": {
"id": "KYELL8EW",
"code": "04FABAF7",
"name": "General Fund",
"description": "Soluta ad ea et aut consequatur commodi est.",
"feature_image": null,
"url": "https://your-domain.givecloud.co/product/04FABAF7/cumque-fund",
"price": {
"amount": 0,
"currency_code": "USD"
},
"price_min": {
"amount": 0,
"currency_code": "USD"
},
"price_max": {
"amount": 0,
"currency_code": "USD"
},
"donation_min": {
"amount": 0,
"currency_code": "USD"
},
"sale_price": {
"amount": 0,
"currency_code": "USD"
},
"actual_price": {
"amount": 0,
"currency_code": "USD"
},
"qty_available": 99999999,
"recurring_frequency": [
null
],
"recurring_schedule": "natural",
"recurring_with_dpo": false,
"goal_amount": {
"amount": 0,
"currency_code": "USD"
},
"goal_progress": {
"amount": 0,
"currency_code": "USD"
},
"goal_deadline": null,
"is_new": false,
"is_sale": false,
"is_featured": false,
"is_clearance": false,
"is_tax_receiptable": true,
"cover_costs_enabled": false,
"is_tribute": false,
"enable_check_in": false,
"enable_out_of_stock": true,
"enable_social_buttons": true,
"enable_tributes": false,
"tribute_notification_types": [],
"require_tributes": false,
"ach_only": false,
"hide_price": true,
"hide_qty": true,
"page_title": null,
"page_description": null,
"page_keywords": null,
"page_content": "<p>Vel ab maxime repellendus est. Culpa voluptatem et magni animi exercitationem. Et maxime dicta deserunt numquam.</p>\n<p>Et et quis debitis culpa voluptate impedit. Ducimus odit error veniam provident perferendis nostrum voluptas veniam. Nihil impedit a qui. Soluta dolores aut voluptas eum et porro quia. Exercitationem aut et excepturi aut quia sunt corrupti.</p>\n<p>Beatae natus autem est ratione soluta explicabo rerum perferendis. Quibusdam alias expedita voluptate tenetur rerum cupiditate.</p>\n<p>Doloribus consequuntur necessitatibus molestiae iusto hic consectetur in eveniet. Quae et dignissimos laboriosam. Tempora temporibus et ipsum delectus rerum minus alias magni. Placeat quasi qui perferendis dolor alias ad.</p>\n<p>Est quia et ut fugiat incidunt est. Totam earum ut dicta impedit earum eligendi. Facere sit quidem perspiciatis aut voluptates et fugiat. Aut neque aut qui soluta blanditiis.</p>\n<p>Nemo eveniet nesciunt et quam voluptatem non. Sit esse repellendus quia fuga ut. Culpa placeat amet architecto provident harum et qui.</p>\n<p>Pariatur labore rem maiores qui aliquid fugit ut vel. Velit velit nulla inventore quia sequi. Ad ratione iste dolorum esse nihil dolorem.</p>\n<p>Voluptate non quo qui laborum ipsa. Aliquam voluptas cupiditate occaecati id asperiores non praesentium. Beatae rerum doloribus aut et.</p>\n<p>Dolorem provident voluptatem nemo nisi alias et accusantium corporis. Corrupti sunt quae aut perferendis maiores ut. Optio vel rerum deleniti sequi.</p>\n<p>Soluta sunt similique ut distinctio sit. Reprehenderit dolor consectetur quae dolores. Ab iusto id nulla aut quia nihil eligendi.</p>\n",
"out_of_stock_message": null,
"primary_button_label": null,
"alternate_button_label": null,
"alternate_button_url": null,
"created_at": "2023-04-21T17:26:18Z",
"updated_at": "2023-04-21T17:26:18Z",
"published_at": "",
"unpublish_at": "",
"meta": [],
"default_donation_amount": null,
"default_donation_options": null,
"default_recurring_donation_options": null
},
"tribute": null,
"tax_receipts": [
{
"number": "WEB24-000000110",
"amount": 10,
"currency_code": "USD",
"issued_at": "2024-03-05",
"issued_to": "Hilma Hill",
"is_voided": false
}
]
},
{
"id": "KYDLYJRE",
"description": "Capital Campaign - Today Only",
"image_thumb": "",
"is_locked": false,
"is_recurring": false,
"is_price_reduced": false,
"is_fundraising_form_upgrade": false,
"undiscounted_price": 50,
"locked_original_price": "50.0000",
"locked_variants_original_price": 50,
"locked_variants_price": 50,
"locked_variants_total": 50,
"payment_string": "$50.00 USD one time",
"public_url": "https://your-domain.givecloud.co/product/33f3/capital-campaign",
"recurring_description": null,
"reference": "33f3",
"total": 50,
"dpo_tribute_id": null,
"fields": [],
"gift_aid": false,
"is_tribute": false,
"tribute_name": "",
"public_message": null,
"additional_notes": null,
"is_anonymous": true,
"price": 50,
"qty": 1,
"upgraded_to_recurring": 0,
"recurring_profile_id": null,
"recurring_amount": 0,
"recurring_day": null,
"recurring_day_of_week": null,
"recurring_with_dpo": false,
"recurring_with_initial_charge": null,
"recurring_cycles": null,
"recurring_starts_on": "",
"recurring_ends_on": "",
"sponsorship_is_expired": false,
"is_dcc_eligible": 1,
"dcc_recurring_amount": "0.0000",
"total_tax_amt": null,
"accounting": {
"code": "ED"
},
"recurring_profile": null,
"sponsee": null,
"fundraiser": null,
"variant": {
"id": "KJEZ2JE2",
"code": "33f3",
"title": "Today Only",
"images": [],
"price": {
"amount": 0,
"currency_code": "USD"
},
"price_presets": "15,25,50,100,other",
"sale_price": {
"amount": 0,
"currency_code": "USD"
},
"minimum_price": 5,
"on_sale": false,
"is_default": true,
"is_shippable": false,
"is_donation": true,
"billing_period": "onetime",
"inventory_management": "givecloud",
"inventory_policy": "continue",
"inventory_quantity": -26,
"inventory_updated_at": "2024-02-29T19:23:24Z",
"shipping_expectation": null,
"fair_market_value": {
"amount": 0,
"currency_code": "USD"
},
"sequence": 1,
"weight": null,
"created_at": "",
"updated_at": ""
},
"product": {
"id": "P7DNN4DG",
"code": "33f3",
"name": "Capital Campaign",
"description": "Help us reach our goal!",
"feature_image": null,
"url": "https://your-domain.givecloud.co/product/33f3/capital-campaign",
"price": {
"amount": 0,
"currency_code": "USD"
},
"price_min": {
"amount": 0,
"currency_code": "USD"
},
"price_max": {
"amount": 0,
"currency_code": "USD"
},
"donation_min": {
"amount": 0,
"currency_code": "USD"
},
"sale_price": {
"amount": 0,
"currency_code": "USD"
},
"actual_price": {
"amount": 0,
"currency_code": "USD"
},
"qty_available": 99999999,
"recurring_frequency": [
null
],
"recurring_schedule": "natural",
"recurring_with_dpo": false,
"goal_amount": {
"amount": 50000,
"currency_code": "USD"
},
"goal_progress": {
"amount": 1978,
"currency_code": "USD"
},
"goal_deadline": "2022-12-31T00:00:00.000000Z",
"is_new": false,
"is_sale": false,
"is_featured": false,
"is_clearance": false,
"is_tax_receiptable": false,
"cover_costs_enabled": true,
"is_tribute": false,
"enable_check_in": false,
"enable_out_of_stock": true,
"enable_social_buttons": false,
"enable_tributes": false,
"tribute_notification_types": [],
"require_tributes": false,
"ach_only": false,
"hide_price": true,
"hide_qty": true,
"page_title": null,
"page_description": null,
"page_keywords": null,
"page_content": "<section class=\"mceNonEditable mceBackground bg-primary text-white py-3\">\r\n<div class=\"container\">\r\n<div class=\"row\">\r\n<div class=\"col mceEditable wow fadeIn\" data-wow-delay=\"0.0s\">\r\n<h2 class=\"text-white\">Headline<br /><small>With a short description.</small></h2>\r\n</div>\r\n<div class=\"col mceEditable wow fadeIn\" data-wow-delay=\"0.1s\">\r\n<h2 class=\"text-white\">Headline<br /><small>With a short description.</small></h2>\r\n</div>\r\n<div class=\"col mceEditable wow fadeIn\" data-wow-delay=\"0.2s\">\r\n<h2 class=\"text-white\">Headline<br /><small>With a short description.</small></h2>\r\n</div>\r\n</div>\r\n</div>\r\n</section>",
"out_of_stock_message": null,
"primary_button_label": null,
"alternate_button_label": null,
"alternate_button_url": null,
"created_at": "2019-12-10T21:39:11Z",
"updated_at": "2022-11-29T17:18:56Z",
"published_at": "2021-11-30T00:00:00Z",
"unpublish_at": "",
"meta": [
"ED",
],
"default_donation_amount": null,
"default_donation_options": null,
"default_recurring_donation_options": null
},
"tribute": null
}
],
"currency": {
"name": "US Dollar",
"code": "USD",
"iso_code": "USD",
"symbol": "$",
"rate": 1
},
"cover_costs_enabled": 1,
"cover_costs_amount": 4.98,
"discounts_amount": null,
"subtotal_amount": 60,
"tax_amount": 0,
"shipping_amount": 0,
"total_amount": "64.9800",
"refunded_amount": "0.0000",
"balance_amount": 64.98,
"referral_source": "Website",
"http_referer": "https://your-domain.givecloud.co/account/profile",
"tracking_source": null,
"tracking_medium": null,
"tracking_campaign": null,
"tracking_term": null,
"tracking_content": null,
"discounts": [],
"payments": [
{
"id": "G2EX5KD6",
"type": "card",
"status": "succeeded",
"amount": 64.98,
"amount_refunded": 0,
"currency": {
"name": "US Dollar",
"code": "USD",
"iso_code": "USD",
"symbol": "$",
"rate": 1
},
"paid": true,
"captured": true,
"captured_at": "2024-02-29T19:23:24.000000Z",
"created_at": "2024-02-29T19:23:24.000000Z",
"refunded": false,
"gateway": "givecloudtest",
"reference_number": "ch_LfA8Dmzo3n0p",
"description": "Payment for Order #11D8C91789",
"failure_code": null,
"failure_message": null,
"outcome": "authorized",
"card": {
"brand": "Visa",
"last4": "4242",
"exp_month": 2,
"exp_year": 2025,
"cvc_check": "unchecked",
"address_line1_check": "pass",
"address_zip_check": "pass",
"wallet": null
}
}
],
"refunds": [],
"tax_lines": [],
"tax_receipts": [
{
"number": "WEB24-000000110",
"amount": 10,
"currency_code": "USD",
"issued_at": "2024-03-05",
"issued_to": "Hilma Hill",
"is_voided": false
}
],
"warnings": []
},
],
"links": {
"first": "https://your-domain.givecloud.co/admin/api/v3/contributions?page=1",
"last": "https://your-domain.givecloud.co/admin/api/v3/contributions?page=198",
"prev": null,
"next": "https://your-domain.givecloud.co/admin/api/v3/contributions?page=2"
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 198,
"links": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "https://your-domain.givecloud.co/admin/api/v3/contributions?page=1",
"label": "1",
"active": true
},
{
"url": "https://your-domain.givecloud.co/admin/api/v3/contributions?page=2",
"label": "2",
"active": false
},
{
"url": null,
"label": "...",
"active": false
},
{
"url": "https://your-domain.givecloud.co/admin/api/v3/contributions?page=197",
"label": "197",
"active": false
},
{
"url": "https://your-domain.givecloud.co/admin/api/v3/contributions?page=198",
"label": "198",
"active": false
},
{
"url": "https://your-domain.givecloud.co/admin/api/v3/contributions?page=2",
"label": "Next »",
"active": false
}
],
"path": "https://your-domain.givecloud.co/admin/api/v3/contributions",
"per_page": 25,
"to": 2,
"total": 396
}
}Get
Retrieve the first matching contribution.
This returns a 404 if there is no matching contribution found.
Request
- url:
/admin/api/v3/contributions/{id} - method:
GET -
parameters:
id: required, string, exact match
Contribution Response
contribution.json
{
"data": {
"id": "11D8C91789",
"is_recurring": true,
"is_test": 1,
"is_fulfillable": false,
"is_fulfilled": null,
"is_refundable": true,
"is_paid": true,
"is_pos_entry": 0,
"is_deleted": false,
"is_spam": 0,
"source": "Web",
"customer_comments": null,
"notes": "<p>Note to customer</p>",
"supporter": {
"id": "P59EKZDK",
"id_deprecated": 2,
"active": true,
"display_name": "Hilma Hill",
"first_name": "Hilma",
"last_name": "Hill",
"email": "hilma.hill@example.com",
"type": "Individual",
"is_organization": false,
"email_opt_in": true,
"vendor_contact_id": 2966,
"billing_address": {
"first_name": "Hilma",
"last_name": "Hill",
"company": null,
"email": "hilma.hill@example.com",
"address1": "31 Douglas Blvd #950",
"address2": null,
"city": "Clovis",
"state": "NM",
"zip": "88101",
"country": "US",
"phone": "815-262-7380 x53749"
},
"shipping_address": {
"first_name": "Hilma",
"last_name": "Hill",
"company": null,
"email": "hilma.hill@example.com",
"address1": "31 Douglas Blvd #950",
"address2": null,
"city": "Clovis",
"state": "NM",
"zip": "88101",
"country": "US",
"phone": "815-262-7380 x53749"
},
"created_at": "2021-04-28T13:38:44Z",
"updated_at": "2024-02-29T23:05:35Z",
"groups": [
{
"id": "XPGE93E4",
"group_id": "7GZEJPE2",
"name": "Sample Annual Membership",
"start_date": "2021-04-29",
"end_date": "2028-05-26",
"is_active": true,
"is_expired": false,
"days_left": 1537,
"related": [
{
"id": "7GZEJPE2",
"name": "Sample Annual Membership",
"start_date": "2021-04-29",
"end_date": "2022-04-29",
"is_active": false,
"is_expired": true,
"source": "manual",
"end_reason": null,
"days_left": 0
},
{
"id": "Z8NER6EK",
"name": "Sample Annual Membership",
"start_date": "2022-04-29",
"end_date": "2023-04-29",
"is_active": false,
"is_expired": true,
"source": "manual",
"end_reason": null,
"days_left": 0
},
]
},
]
},
"billing_address": {
"title": null,
"name": "Hilma Hill",
"first_name": "Hilma",
"last_name": "Hill",
"email": "hilma.hill@example.com",
"first_name": "Hilma",
"last_name": "Hill",
"company": null,
"email": "hilma.hill@example.com",
"address1": "31 Douglas Blvd #950",
"address2": null,
"city": "Clovis",
"state": "NM",
"zip": "88101",
"country": "US",
"phone": "815-262-7380 x53749"
},
"shipping_address": {
"title": null,
"name": "Hilma Hill",
"first_name": "Hilma",
"last_name": "Hill",
"email": "hilma.hill@example.com",
"address1": "31 Douglas Blvd #950",
"address2": null,
"city": "Clovis",
"state": "NM",
"zip": "88101",
"country": "US",
"phone": "815-262-7380 x53749"
},
"shipping_method": null,
"created_at": "2024-02-29T18:50:51Z",
"ordered_at": "2024-02-29T19:23:24Z",
"updated_at": "2024-03-05T21:10:48Z",
"refunded_at": "",
"downloadable_item_count": 0,
"recurring_item_count": 1,
"shippable_item_count": 0,
"line_items": [
{
"id": "59DK9G8D",
"description": "General Fund - Deleniti Velit Repudiandae",
"image_thumb": "",
"is_locked": false,
"is_recurring": true,
"is_price_reduced": false,
"is_fundraising_form_upgrade": false,
"undiscounted_price": 10,
"locked_original_price": "10.0000",
"locked_variants_original_price": 10,
"locked_variants_price": 10,
"locked_variants_total": 10,
"payment_string": "$10.00 USD/mth starting Mar 29th, 2024",
"public_url": "https://your-domain.givecloud.co/product/04FABAF7/cumque-fund",
"recurring_description": "$10.00/mth (29th) starting March 29th, 2024",
"reference": "04FABAF7",
"total": 10,
"dpo_tribute_id": null,
"fields": [],
"gift_aid": false,
"is_tribute": false,
"tribute_name": "",
"public_message": null,
"additional_notes": null,
"is_anonymous": true,
"price": 10,
"qty": 1,
"upgraded_to_recurring": 0,
"recurring_profile_id": "84D37ZDW",
"recurring_amount": 10,
"recurring_day": 29,
"recurring_day_of_week": null,
"recurring_with_dpo": false,
"recurring_with_initial_charge": true,
"recurring_cycles": null,
"recurring_starts_on": "",
"recurring_ends_on": "",
"sponsorship_is_expired": false,
"is_dcc_eligible": 0,
"dcc_recurring_amount": "0.0000",
"total_tax_amt": null,
"accounting": {
"code": null
},
"recurring_profile": {
"id": "84D37ZDW",
"profile_id": "84D37ZDW",
"status": "Active",
"payment_description": "$10.00/mth (29th)",
"started_on": "2024-02-29T19:23:24Z",
"next_billing_date": "2024-03-29",
"cover_costs_enabled": true,
"cover_costs_amount": 0,
"billing_period_description": "Monthly",
"billing_period_day": "29th",
"aggregate_amount": 10,
"failed_payments": 0,
"description": "General Fund - Deleniti Velit Repudiandae",
"gl_code": null,
"last_payment_due": null,
"payment_method": {
"display_name": "Visa",
"account_type": "Visa",
"account_number": "4*** **** **** 4242",
"expires_on": "2025-02-28T00:00:00.000000Z",
"is_expired": false,
"is_deleted": false
}
},
"sponsee": {
"id": "GZEJRNE2",
"reference_number": "ZDP0001GC",
"first_name": "Zacks",
"last_name": "Burkis",
"gender": "M",
"birth_date": "2010-07-12",
"age": 13,
"enrollment_date": "",
"longitude": null,
"latitude": null,
"biography": "<p style=\"text-align: justify;\">Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nam faucibus id augue at egestas. Aliquam finibus sem lectus, id laoreet quam aliquet id. Vivamus at rutrum nulla. Duis tristique egestas mauris a sodales. Vestibulum volutpat sapien diam. Donec faucibus nec velit sollicitudin hendrerit. Suspendisse elementum enim ut nunc consectetur, eu aliquam tortor finibus. Integer vestibulum turpis quis massa fringilla, in ultricies sem commodo. Duis tellus ante, ultrices at odio ac, eleifend maximus turpis. Donec vulputate tristique ultricies. Duis rhoncus sodales eros, eget hendrerit purus. Mauris pulvinar, nisi non tristique suscipit, tortor est scelerisque urna, non tempor ipsum sem et sapien.</p><p style=\"text-align: justify;\"><br></p><p style=\"text-align: justify;\">Pellentesque ut tincidunt nunc. Suspendisse ac magna ac massa pellentesque tristique. Nullam porttitor efficitur ipsum, et sodales enim. Interdum et malesuada fames ac ante ipsum primis in faucibus. Sed quis enim fermentum, tristique felis nec, posuere lorem. Donec vel est sit amet libero ornare sagittis. Aliquam pretium finibus magna.</p><p style=\"text-align: justify;\"><br></p><p style=\"text-align: justify;\">Integer eget diam enim. In feugiat posuere augue, sit amet sodales diam. Praesent tincidunt imperdiet sem. Ut ultrices arcu velit, a accumsan mi convallis vel. Nunc ornare efficitur auctor. Integer eget ipsum lectus. Vivamus commodo eu magna pellentesque pellentesque. Phasellus id nulla efficitur, semper odio a, consequat libero. Quisque in nulla eget arcu efficitur tincidunt non at ipsum. Aliquam tincidunt orci a rutrum pellentesque. Curabitur imperdiet lectus consequat sem pellentesque consectetur.</p><p style=\"text-align: justify;\"><br></p><p style=\"text-align: justify;\">Donec nisi mauris, sollicitudin eget ante at, convallis ornare neque. Mauris at velit eu dolor consequat malesuada quis id ligula. Suspendisse convallis sodales eleifend. In hac habitasse platea dictumst. Sed scelerisque est ante, eu dapibus ipsum porttitor vel. Morbi auctor nisi eu lacus consectetur congue. Vivamus tempus dolor et ligula interdum, in commodo erat dictum</p><p style=\"text-align: justify;\"><br></p><p style=\"text-align: justify;\"><br></p><p style=\"text-align: justify;\">Integer eget diam enim. In feugiat posuere augue, sit amet sodales diam. Praesent tincidunt imperdiet sem. Ut ultrices arcu velit, a accumsan mi convallis vel. Nunc ornare efficitur auctor. Integer eget ipsum lectus. Vivamus commodo eu magna pellentesque pellentesque. Phasellus id nulla efficitur, semper odio a, consequat libero. Quisque in nulla eget arcu efficitur tincidunt non at ipsum. Aliquam tincidunt orci a rutrum pellentesque. Curabitur imperdiet lectus consequat sem pellentesque consectetur.</p><p style=\"text-align: justify;\"><br></p><p style=\"text-align: justify;\">Donec nisi mauris, sollicitudin eget ante at, convallis ornare neque. Mauris at velit eu dolor consequat malesuada quis id ligula. Suspendisse convallis sodales eleifend. In hac habitasse platea dictumst. Sed scelerisque est ante, eu dapibus ipsum porttitor vel. Morbi auctor nisi eu lacus consectetur congue. Vivamus tempus dolor et ligula interdum, in commodo erat dictum.</p><p style=\"text-align: justify;\"><br></p><p style=\"text-align: justify;\"><span style=\"background-color: rgb(255, 255, 255); color: rgb(68, 68, 68);\">Donec nisi mauris, sollicitudin eget ante at, convallis ornare neque. Mauris at velit eu dolor consequat malesuada quis id ligula. Suspendisse convallis sodales eleifend. In hac habitasse platea dictumst. Sed scelerisque est ante, eu dapibus ipsum porttitor vel. Morbi auctor nisi eu lacus consectetur congue. Vivamus tempus dolor et ligula interdum, in commodo erat dictum.</span></p><p style=\"text-align: justify;\"><br></p>",
"private_notes": null,
"sponsored_status": "Sponsored Automatically (Sponsored)",
"is_enabled": true,
"payment_option_group": "One-Time & Recurring Option",
"sponsor_count": 1,
"image_url": "https://cdn.givecloud.co/s/files/3-dev/0000/0001/sponsorships/ame-1479-copie-3_300x_cropped_top.jpg",
"url": "https://your-domain.givecloud.co/sponsorship/385",
"custom_fields": [
{
"name": "Hobby",
"slug": "hobby",
"value": "I love to play Hockey",
"item": null,
"is_simple": 1,
"is_private": false
},
],
"created_at": "2023-09-27T00:00:00+00:00",
"updated_at": "2023-11-14T00:00:00+00:00"
},
"fundraiser": null,
"variant": {
"id": "P7DNM4EG",
"code": "04FABAF7",
"title": "Deleniti Velit Repudiandae",
"images": [],
"price": {
"amount": 0,
"currency_code": "USD"
},
"price_presets": "10,25,50,100,250,other",
"sale_price": {
"amount": 0,
"currency_code": "USD"
},
"minimum_price": null,
"on_sale": false,
"is_default": true,
"is_shippable": false,
"is_donation": true,
"billing_period": "monthly",
"inventory_management": "givecloud",
"inventory_policy": "continue",
"inventory_quantity": -1,
"inventory_updated_at": "2024-02-29T19:23:24Z",
"shipping_expectation": null,
"fair_market_value": {
"amount": 0,
"currency_code": "USD"
},
"sequence": 8,
"weight": null,
"created_at": "",
"updated_at": ""
},
"product": {
"id": "KYELL8EW",
"code": "04FABAF7",
"name": "General Fund",
"description": "Soluta ad ea et aut consequatur commodi est.",
"feature_image": null,
"url": "https://your-domain.givecloud.co/product/04FABAF7/cumque-fund",
"price": {
"amount": 0,
"currency_code": "USD"
},
"price_min": {
"amount": 0,
"currency_code": "USD"
},
"price_max": {
"amount": 0,
"currency_code": "USD"
},
"donation_min": {
"amount": 0,
"currency_code": "USD"
},
"sale_price": {
"amount": 0,
"currency_code": "USD"
},
"actual_price": {
"amount": 0,
"currency_code": "USD"
},
"qty_available": 99999999,
"recurring_frequency": [
null
],
"recurring_schedule": "natural",
"recurring_with_dpo": false,
"goal_amount": {
"amount": 0,
"currency_code": "USD"
},
"goal_progress": {
"amount": 0,
"currency_code": "USD"
},
"goal_deadline": null,
"is_new": false,
"is_sale": false,
"is_featured": false,
"is_clearance": false,
"is_tax_receiptable": true,
"cover_costs_enabled": false,
"is_tribute": false,
"enable_check_in": false,
"enable_out_of_stock": true,
"enable_social_buttons": true,
"enable_tributes": false,
"tribute_notification_types": [],
"require_tributes": false,
"ach_only": false,
"hide_price": true,
"hide_qty": true,
"page_title": null,
"page_description": null,
"page_keywords": null,
"page_content": "<p>Vel ab maxime repellendus est. Culpa voluptatem et magni animi exercitationem. Et maxime dicta deserunt numquam.</p>\n<p>Et et quis debitis culpa voluptate impedit. Ducimus odit error veniam provident perferendis nostrum voluptas veniam. Nihil impedit a qui. Soluta dolores aut voluptas eum et porro quia. Exercitationem aut et excepturi aut quia sunt corrupti.</p>\n<p>Beatae natus autem est ratione soluta explicabo rerum perferendis. Quibusdam alias expedita voluptate tenetur rerum cupiditate.</p>\n<p>Doloribus consequuntur necessitatibus molestiae iusto hic consectetur in eveniet. Quae et dignissimos laboriosam. Tempora temporibus et ipsum delectus rerum minus alias magni. Placeat quasi qui perferendis dolor alias ad.</p>\n<p>Est quia et ut fugiat incidunt est. Totam earum ut dicta impedit earum eligendi. Facere sit quidem perspiciatis aut voluptates et fugiat. Aut neque aut qui soluta blanditiis.</p>\n<p>Nemo eveniet nesciunt et quam voluptatem non. Sit esse repellendus quia fuga ut. Culpa placeat amet architecto provident harum et qui.</p>\n<p>Pariatur labore rem maiores qui aliquid fugit ut vel. Velit velit nulla inventore quia sequi. Ad ratione iste dolorum esse nihil dolorem.</p>\n<p>Voluptate non quo qui laborum ipsa. Aliquam voluptas cupiditate occaecati id asperiores non praesentium. Beatae rerum doloribus aut et.</p>\n<p>Dolorem provident voluptatem nemo nisi alias et accusantium corporis. Corrupti sunt quae aut perferendis maiores ut. Optio vel rerum deleniti sequi.</p>\n<p>Soluta sunt similique ut distinctio sit. Reprehenderit dolor consectetur quae dolores. Ab iusto id nulla aut quia nihil eligendi.</p>\n",
"out_of_stock_message": null,
"primary_button_label": null,
"alternate_button_label": null,
"alternate_button_url": null,
"created_at": "2023-04-21T17:26:18Z",
"updated_at": "2023-04-21T17:26:18Z",
"published_at": "",
"unpublish_at": "",
"meta": [],
"default_donation_amount": null,
"default_donation_options": null,
"default_recurring_donation_options": null
},
"tribute": null,
"tax_receipts": [
{
"number": "WEB24-000000110",
"amount": 10,
"currency_code": "USD",
"issued_at": "2024-03-05",
"issued_to": "Hilma Hill",
"is_voided": false
}
]
},
{
"id": "KYDLYJRE",
"description": "Capital Campaign - Today Only",
"image_thumb": "",
"is_locked": false,
"is_recurring": false,
"is_price_reduced": false,
"is_fundraising_form_upgrade": false,
"undiscounted_price": 50,
"locked_original_price": "50.0000",
"locked_variants_original_price": 50,
"locked_variants_price": 50,
"locked_variants_total": 50,
"payment_string": "$50.00 USD one time",
"public_url": "https://your-domain.givecloud.co/product/33f3/capital-campaign",
"recurring_description": null,
"reference": "33f3",
"total": 50,
"dpo_tribute_id": null,
"fields": [],
"gift_aid": false,
"is_tribute": false,
"tribute_name": "",
"public_message": null,
"additional_notes": null,
"is_anonymous": true,
"price": 50,
"qty": 1,
"upgraded_to_recurring": 0,
"recurring_profile_id": null,
"recurring_amount": 0,
"recurring_day": null,
"recurring_day_of_week": null,
"recurring_with_dpo": false,
"recurring_with_initial_charge": null,
"recurring_cycles": null,
"recurring_starts_on": "",
"recurring_ends_on": "",
"sponsorship_is_expired": false,
"is_dcc_eligible": 1,
"dcc_recurring_amount": "0.0000",
"total_tax_amt": null,
"accounting": {
"code": "ED"
},
"recurring_profile": null,
"sponsee": null,
"fundraiser": null,
"variant": {
"id": "KJEZ2JE2",
"code": "33f3",
"title": "Today Only",
"images": [],
"price": {
"amount": 0,
"currency_code": "USD"
},
"price_presets": "15,25,50,100,other",
"sale_price": {
"amount": 0,
"currency_code": "USD"
},
"minimum_price": 5,
"on_sale": false,
"is_default": true,
"is_shippable": false,
"is_donation": true,
"billing_period": "onetime",
"inventory_management": "givecloud",
"inventory_policy": "continue",
"inventory_quantity": -26,
"inventory_updated_at": "2024-02-29T19:23:24Z",
"shipping_expectation": null,
"fair_market_value": {
"amount": 0,
"currency_code": "USD"
},
"sequence": 1,
"weight": null,
"created_at": "",
"updated_at": ""
},
"product": {
"id": "P7DNN4DG",
"code": "33f3",
"name": "Capital Campaign",
"description": "Help us reach our goal!",
"feature_image": null,
"url": "https://your-domain.givecloud.co/product/33f3/capital-campaign",
"price": {
"amount": 0,
"currency_code": "USD"
},
"price_min": {
"amount": 0,
"currency_code": "USD"
},
"price_max": {
"amount": 0,
"currency_code": "USD"
},
"donation_min": {
"amount": 0,
"currency_code": "USD"
},
"sale_price": {
"amount": 0,
"currency_code": "USD"
},
"actual_price": {
"amount": 0,
"currency_code": "USD"
},
"qty_available": 99999999,
"recurring_frequency": [
null
],
"recurring_schedule": "natural",
"recurring_with_dpo": false,
"goal_amount": {
"amount": 50000,
"currency_code": "USD"
},
"goal_progress": {
"amount": 1978,
"currency_code": "USD"
},
"goal_deadline": "2022-12-31T00:00:00.000000Z",
"is_new": false,
"is_sale": false,
"is_featured": false,
"is_clearance": false,
"is_tax_receiptable": false,
"cover_costs_enabled": true,
"is_tribute": false,
"enable_check_in": false,
"enable_out_of_stock": true,
"enable_social_buttons": false,
"enable_tributes": false,
"tribute_notification_types": [],
"require_tributes": false,
"ach_only": false,
"hide_price": true,
"hide_qty": true,
"page_title": null,
"page_description": null,
"page_keywords": null,
"page_content": "<section class=\"mceNonEditable mceBackground bg-primary text-white py-3\">\r\n<div class=\"container\">\r\n<div class=\"row\">\r\n<div class=\"col mceEditable wow fadeIn\" data-wow-delay=\"0.0s\">\r\n<h2 class=\"text-white\">Headline<br /><small>With a short description.</small></h2>\r\n</div>\r\n<div class=\"col mceEditable wow fadeIn\" data-wow-delay=\"0.1s\">\r\n<h2 class=\"text-white\">Headline<br /><small>With a short description.</small></h2>\r\n</div>\r\n<div class=\"col mceEditable wow fadeIn\" data-wow-delay=\"0.2s\">\r\n<h2 class=\"text-white\">Headline<br /><small>With a short description.</small></h2>\r\n</div>\r\n</div>\r\n</div>\r\n</section>",
"out_of_stock_message": null,
"primary_button_label": null,
"alternate_button_label": null,
"alternate_button_url": null,
"created_at": "2019-12-10T21:39:11Z",
"updated_at": "2022-11-29T17:18:56Z",
"published_at": "2021-11-30T00:00:00Z",
"unpublish_at": "",
"meta": [
"ED",
],
"default_donation_amount": null,
"default_donation_options": null,
"default_recurring_donation_options": null
},
"tribute": null
}
],
"currency": {
"name": "US Dollar",
"code": "USD",
"iso_code": "USD",
"symbol": "$",
"rate": 1
},
"cover_costs_enabled": 1,
"cover_costs_amount": 4.98,
"discounts_amount": null,
"subtotal_amount": 60,
"tax_amount": 0,
"shipping_amount": 0,
"total_amount": "64.9800",
"refunded_amount": "0.0000",
"balance_amount": 64.98,
"referral_source": "Website",
"http_referer": "https://your-domain.givecloud.co/account/profile",
"tracking_source": null,
"tracking_medium": null,
"tracking_campaign": null,
"tracking_term": null,
"tracking_content": null,
"discounts": [],
"payments": [
{
"id": "G2EX5KD6",
"type": "card",
"status": "succeeded",
"amount": 64.98,
"amount_refunded": 0,
"currency": {
"name": "US Dollar",
"code": "USD",
"iso_code": "USD",
"symbol": "$",
"rate": 1
},
"paid": true,
"captured": true,
"captured_at": "2024-02-29T19:23:24.000000Z",
"created_at": "2024-02-29T19:23:24.000000Z",
"refunded": false,
"gateway": "givecloudtest",
"reference_number": "ch_LfA8Dmzo3n0p",
"description": "Payment for Order #11D8C91789",
"failure_code": null,
"failure_message": null,
"outcome": "authorized",
"card": {
"brand": "Visa",
"last4": "4242",
"exp_month": 2,
"exp_year": 2025,
"cvc_check": "unchecked",
"address_line1_check": "pass",
"address_zip_check": "pass",
"wallet": null
}
}
],
"refunds": [],
"tax_lines": [],
"tax_receipts": [
{
"number": "WEB24-000000110",
"amount": 10,
"currency_code": "USD",
"issued_at": "2024-03-05",
"issued_to": "Hilma Hill",
"is_voided": false
}
],
"warnings": []
}
}