Get all withdrawals [DEPRECATED: Use transaction routes] Deprecated

GET /api/v1/plans/{plan_uuid}/withdrawals/{subAccount}
Personal access token & O auth2

Path parameters

  • plan_uuid string Required
  • subAccount integer Required

    Optional parameter. An optional sub-account to constrain the results by.

Query parameters

  • filter[uuid] string

    Filter by a comma separated list of UUIDs.

  • sort string

    Field to sort by. Valid fields are [created_at, updated_at, withdrawn_at]. Negative sign to denote DESC. Defaults to '-withdrawn_at'.

  • per_page integer

    Number of results to return with pagination (Default 15. Max 500).

Responses

  • 200 application/json
    Hide response attribute Show response attribute object
    • data array[object]
      Hide data attributes Show data attributes object
      • uuid string
      • created_at string
      • updated_at string
      • withdrawn_at string
      • value object
        Hide value attributes Show value attributes object
        • amount object
          Hide amount attributes Show amount attributes object
          • example string
          • description string
        • formatted object
          Hide formatted attributes Show formatted attributes object
          • example string
          • description string
        • currency object
          Hide currency attributes Show currency attributes object
          • example string
          • description string
GET /api/v1/plans/{plan_uuid}/withdrawals/{subAccount} 
curl \
 --request GET 'https://api.plannrcrm.com/api/v1/plans/6ff8f7f6-1eb3-3525-be4a-3932c805afed/withdrawals/{"value"=>"", "summary"=>"When the value is omitted"}' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "data": [
    {
      "uuid": "a3cf1b63-0a24-434a-b515-a355cdb156c4",
      "value": {
        "amount": {
          "example": "4000",
          "description": "Money amount at their lowest denominator (for example: pennies)"
        },
        "currency": {
          "example": "GBP",
          "description": "Currency of the money"
        },
        "formatted": {
          "example": "£40.00",
          "description": "Money amount formatted with currency"
        }
      },
      "created_at": "2025-09-17T15:46:53+01:00",
      "updated_at": "2025-09-17T15:46:53+01:00",
      "withdrawn_at": "2025-09-17T15:46:53+01:00"
    }
  ]
}