Create a contribution [DEPRECATED: Use transaction routes]

POST /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/contributions
Personal access token & O auth2

Path parameters

  • plan_uuid string Required
  • subAccount_uuid string Required
application/json

Body Required

  • type string Required

    The type of contribution. Available options: recurring and adhoc

  • contributor_type string

    The type of contributor. Available options: self, employer, family, government, salary_sacrifice and other

  • frequency string

    The frequency of the contribution. Required if the contribution type is "recurring". Available options: daily, weekly, fortnightly, four_weekly, monthly, bimonthly, quarterly, biannually, annually, adhoc and one_off

  • started_at date

    The start date of a recurring contribution. Required if the contribution type is "recurring".

  • ended_at date

    The end date of a recurring contribution. Required if the contribution type is "recurring".

  • paid_at date

    The date the adhoc contribution was paid. Required if the contribution type is "adhoc".

  • value integer

    The value of the contribution in pennies. For example, £40.00 would be 4000.

  • notes string

    Optional notes to add to the contribution.

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
    • uuid string

      uuid of the contribution

    • created_at string

      datetime the contribution was created

    • updated_at string

      datetime the contribution was updated

    • paid_at string

      datetime the money was paid

    • value object

      contribution value

      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
POST /api/v1/plans/{plan_uuid}/sub-accounts/{subAccount_uuid}/contributions 
curl \
 --request POST 'https://api.plannrcrm.com/api/v1/plans/6ff8f7f6-1eb3-3525-be4a-3932c805afed/sub-accounts/6ff8f7f6-1eb3-3525-be4a-3932c805afed/contributions' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"type":"recurring","contributor_type":"self","frequency":"monthly","started_at":"2025-05-26","ended_at":"2025-06-26","paid_at":"2025-06-26","value":4000,"notes":"Example Notes"}'
Request examples 
{
  "type": "recurring",
  "contributor_type": "self",
  "frequency": "monthly",
  "started_at": "2025-05-26",
  "ended_at": "2025-06-26",
  "paid_at": "2025-06-26",
  "value": 4000,
  "notes": "Example Notes"
}
Response examples (200) 
{
  "uuid": "c446b920-060a-40fe-8d30-5c9f0e0ab7e8",
  "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"
    }
  },
  "paid_at": "2025-06-26T11:37:08+01:00",
  "created_at": "2025-06-26T11:37:08+01:00",
  "updated_at": "2025-06-26T11:37:08+01:00"
}