Cancel

post

Authorizations

jwtAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

idstring · uuidRead-onlyRequired

legacy_idstring · nullableOptional

nextgen_legacy_idstring · nullableOptional

created_atstring · date-time · nullableOptional

updated_atstring · date-timeRead-onlyRequired

invoice_idstring · max: 20Required

statusstring · enumOptional

• unpaid - Unpaid
• paid - Paid
• failed - Failed
• overdue - Overdue
• waived - Waived

Possible values:

amountstring · decimalRequiredPattern: ^-?\d{0,8}(?:\.\d{0,2})?$

payment_methodstring · max: 100 · nullableOptional

billing_datestring · date · nullableOptional

paid_atstring · date-time · nullableOptional

is_custombooleanOptional

titlestring · max: 255 · nullableOptional

descriptionstring · nullableOptional

stripe_price_idstring · nullableOptional

due_datestring · date · nullableOptional

service_datestring · date · nullableOptional

waive_reasonstring · max: 255 · nullableOptional

payment_termone ofOptional

string · enumOptional

• one-time - One-time
• installment - Installment

Possible values:

or

undefined · enumOptionalPossible values:

number_of_paymentsinteger · min: -2147483648 · max: 2147483647 · nullableOptional

number_of_installmentsinteger · min: -2147483648 · max: 2147483647 · nullableOptional

frequencystring · nullableOptional

waived_atstring · date-time · nullableOptional

Responses

200Success

application/json

post

/api/church/invoices/cancel

HTTPcURLJavaScriptPython

POST /api/church/invoices/cancel HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 516

{
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2026-02-17T06:59:14.640Z",
  "invoice_id": "text",
  "status": "unpaid",
  "amount": "text",
  "payment_method": "text",
  "billing_date": "2026-02-17",
  "paid_at": "2026-02-17T06:59:14.640Z",
  "is_custom": true,
  "title": "text",
  "description": "text",
  "stripe_price_id": "text",
  "due_date": "2026-02-17",
  "service_date": "2026-02-17",
  "waive_reason": "text",
  "payment_term": "one-time",
  "number_of_payments": 1,
  "number_of_installments": 1,
  "frequency": "text",
  "waived_at": "2026-02-17T06:59:14.640Z"
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

200Success

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "plan": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "monthly_free_credits": 1,
    "perks": null,
    "prices": null
  },
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2026-02-17T06:59:14.640Z",
  "updated_at": "2026-02-17T06:59:14.640Z",
  "invoice_id": "text",
  "status": "unpaid",
  "amount": "text",
  "payment_method": "text",
  "billing_date": "2026-02-17",
  "paid_at": "2026-02-17T06:59:14.640Z",
  "is_custom": true,
  "title": "text",
  "description": "text",
  "stripe_price_id": "text",
  "due_date": "2026-02-17",
  "service_date": "2026-02-17",
  "waive_reason": "text",
  "payment_term": "one-time",
  "number_of_payments": 1,
  "number_of_installments": 1,
  "frequency": "text",
  "waived_at": "2026-02-17T06:59:14.640Z"
}