Recurring Profiles

Actions available on recurring profiles

List

Retrieve a list of matching contributions.

Note: This endpoint use the v3 version of the API.

Request

  • url: /admin/api/v3/recurring-profiles
  • method: GET

  • sorting: (how?)

    • started_on: optional

Response

{
  "data": [
    {
      "id": "PYDVV6DX",
      "profile_id": "PYDVV6DX",
      "status": "Active",
      "payment_description": "$12.00/mth (1st)",
      "started_on": "2024-06-07T14:36:24Z",
      "next_billing_date": "2024-07-01",
      "amount": 12,
      "currency": {
        "name": "US Dollar",
        "code": "USD",
        "iso_code": "USD",
        "symbol": "$",
        "rate": 1
      },
      "cover_costs_enabled": false,
      "cover_costs_amount": 0,
      "billing_period_description": "Monthly",
      "billing_period_day": "1st",
      "aggregate_amount": 12,
      "failed_payments": 0,
      "description": "Capital Campaign - Monthly",
      "gl_code": "ED",
      "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
      },
      "cancel_reason": null,
      "cycles_completed": 1,
      "cycles_remaining": null,
      "supporter": {
        "id": "G2DX56XE",
        "id_deprecated": 8910,
        "active": true,
        "display_name": "Paul McCartney",
        "first_name": "Paul",
        "last_name": "McCartney",
        "email": "paul@example.com",
        "type": "Individual",
        "is_organization": false,
        "email_opt_in": false,
        "vendor_contact_id": 1843,
        "billing_address": {
          "first_name": "Paul",
          "last_name": "McCartney",
          "company": null,
          "email": "paul@example.com",
          "address1": "1517 Robinson Ave",
          "address2": null,
          "city": "Willow Grove",
          "state": "Pennsylvania",
          "zip": "19090",
          "country": "US",
          "phone": null
        },
        "shipping_address": {
          "first_name": null,
          "last_name": null,
          "company": null,
          "email": null,
          "address1": null,
          "address2": null,
          "city": null,
          "state": null,
          "zip": null,
          "country": null,
          "phone": null
        },
        "created_at": "2016-05-09T00:00:00Z",
        "updated_at": "2022-11-15T19:35:33Z",
        "groups": []
      }
    }
  ],
  "links": {
    "first": "https://your-domain.givecloud.co/admin/api/v3/recurring-profiles?page=1",
    "last": "https://your-domain.givecloud.co/admin/api/v3/recurring-profiles?page=4",
    "prev": null,
    "next": "https://your-domain.givecloud.co/admin/api/v3/recurring-profiles?page=2"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 4,
    "links": [
      {
        "url": null,
        "label": "« Previous",
        "active": false
      },
      {
        "url": "https://your-domain.givecloud.co/admin/api/v3/recurring-profiles?page=1",
        "label": "1",
        "active": true
      },
      {
        "url": "https://your-domain.givecloud.co/admin/api/v3/recurring-profiles?page=2",
        "label": "2",
        "active": false
      },
      {
        "url": "https://your-domain.givecloud.co/admin/api/v3/recurring-profiles?page=3",
        "label": "3",
        "active": false
      },
      {
        "url": "https://your-domain.givecloud.co/admin/api/v3/recurring-profiles?page=4",
        "label": "4",
        "active": false
      },
      {
        "url": "https://your-domain.givecloud.co/admin/api/v3/recurring-profiles?page=2",
        "label": "Next »",
        "active": false
      }
    ],
    "path": "https://your-domain.givecloud.co/admin/api/v3/recurring-profiles",
    "per_page": 15,
    "to": 15,
    "total": 50
  }
}

Get

Retrieve the first matching contribution.

This returns a 404 if there is no matching contribution found.

Request

  • url: /admin/api/v3/recurring-profiles/{id}
  • method: GET

  • parameters:

    • id: required, string, exact match

Recurring Profile Response

{
  "data": {
    "id": "PYDVV6DX",
    "profile_id": "PYDVV6DX",
    "status": "Active",
    "payment_description": "$12.00/mth (1st)",
    "started_on": "2024-06-07T14:36:24Z",
    "next_billing_date": "2024-07-01",
    "amount": 12,
    "currency": {
      "name": "US Dollar",
      "code": "USD",
      "iso_code": "USD",
      "symbol": "$",
      "rate": 1
    },
    "cover_costs_enabled": false,
    "cover_costs_amount": 0,
    "billing_period_description": "Monthly",
    "billing_period_day": "1st",
    "aggregate_amount": 12,
    "failed_payments": 0,
    "description": "Capital Campaign - Monthly",
    "gl_code": "ED",
    "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
    },
    "cancel_reason": null,
    "cycles_completed": 1,
    "cycles_remaining": null,
    "supporter": {
      "id": "G2DX56XE",
      "id_deprecated": 8910,
      "active": true,
      "display_name": "Paul McCartney",
      "first_name": "Paul",
      "last_name": "McCartney",
      "email": "paul@example.com",
      "type": "Individual",
      "is_organization": false,
      "email_opt_in": false,
      "vendor_contact_id": 1843,
      "billing_address": {
        "first_name": "Paul",
        "last_name": "McCartney",
        "company": null,
        "email": "paul@example.com",
        "address1": "1517 Robinson Ave",
        "address2": null,
        "city": "Willow Grove",
        "state": "Pennsylvania",
        "zip": "19090",
        "country": "US",
        "phone": null
      },
      "shipping_address": {
        "first_name": null,
        "last_name": null,
        "company": null,
        "email": null,
        "address1": null,
        "address2": null,
        "city": null,
        "state": null,
        "zip": null,
        "country": null,
        "phone": null
      },
      "created_at": "2016-05-09T00:00:00Z",
      "updated_at": "2022-11-15T19:35:33Z",
      "groups": []
    }
  }
}