Invoices

get
Authorizations
Query parameters
limitintegerOptional

Number of results to return per page.

offsetintegerOptional

The initial index from which to return the results.

Responses
200Success
application/json
get
GET /api/church/invoices HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer JWT
Accept: */*
200Success
{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "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": "2025-07-23T12:41:22.389Z",
      "updated_at": "2025-07-23T12:41:22.389Z",
      "invoice_id": "text",
      "status": "unpaid",
      "amount": "text",
      "payment_method": "text",
      "billing_date": "2025-07-23",
      "paid_at": "2025-07-23T12:41:22.389Z",
      "is_custom": true,
      "title": "text",
      "description": "text",
      "stripe_price_id": "text",
      "due_date": "2025-07-23",
      "service_date": "2025-07-23",
      "waive_reason": "text",
      "payment_term": "one-time",
      "number_of_payments": 1,
      "number_of_installments": 1,
      "frequency": "text",
      "waived_at": "2025-07-23T12:41:22.389Z"
    }
  ]
}
post
Authorizations
Body
idstring · uuidRead-onlyRequired
planall ofRead-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 | nullableOptional
billing_datestring · date | nullableOptional
paid_atstring · date-time | nullableOptional
is_custombooleanOptional
titlestring | nullableOptional
descriptionstring | nullableOptional
stripe_price_idstring | nullableOptional
due_datestring · date | nullableOptional
service_datestring · date | nullableOptional
waive_reasonstring | nullableOptional
payment_termone ofOptional
string · enumOptional
  • one-time - One-time
  • installment - Installment
Possible values:
or
undefined · enumOptionalPossible values:
number_of_paymentsinteger | nullableOptional
number_of_installmentsinteger | nullableOptional
frequencystring | nullableOptional
waived_atstring · date-time | nullableOptional
Responses
201Success
application/json
post
POST /api/church/invoices HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 516

{
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2025-07-23T12:41:22.389Z",
  "invoice_id": "text",
  "status": "unpaid",
  "amount": "text",
  "payment_method": "text",
  "billing_date": "2025-07-23",
  "paid_at": "2025-07-23T12:41:22.389Z",
  "is_custom": true,
  "title": "text",
  "description": "text",
  "stripe_price_id": "text",
  "due_date": "2025-07-23",
  "service_date": "2025-07-23",
  "waive_reason": "text",
  "payment_term": "one-time",
  "number_of_payments": 1,
  "number_of_installments": 1,
  "frequency": "text",
  "waived_at": "2025-07-23T12:41:22.389Z"
}
201Success
{
  "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": "2025-07-23T12:41:22.389Z",
  "updated_at": "2025-07-23T12:41:22.389Z",
  "invoice_id": "text",
  "status": "unpaid",
  "amount": "text",
  "payment_method": "text",
  "billing_date": "2025-07-23",
  "paid_at": "2025-07-23T12:41:22.389Z",
  "is_custom": true,
  "title": "text",
  "description": "text",
  "stripe_price_id": "text",
  "due_date": "2025-07-23",
  "service_date": "2025-07-23",
  "waive_reason": "text",
  "payment_term": "one-time",
  "number_of_payments": 1,
  "number_of_installments": 1,
  "frequency": "text",
  "waived_at": "2025-07-23T12:41:22.389Z"
}
get
Authorizations
Path parameters
idstring · uuidRequired

A UUID string identifying this invoice.

Responses
200Success
application/json
get
GET /api/church/invoices/{id} HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer JWT
Accept: */*
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": "2025-07-23T12:41:22.389Z",
  "updated_at": "2025-07-23T12:41:22.389Z",
  "invoice_id": "text",
  "status": "unpaid",
  "amount": "text",
  "payment_method": "text",
  "billing_date": "2025-07-23",
  "paid_at": "2025-07-23T12:41:22.389Z",
  "is_custom": true,
  "title": "text",
  "description": "text",
  "stripe_price_id": "text",
  "due_date": "2025-07-23",
  "service_date": "2025-07-23",
  "waive_reason": "text",
  "payment_term": "one-time",
  "number_of_payments": 1,
  "number_of_installments": 1,
  "frequency": "text",
  "waived_at": "2025-07-23T12:41:22.389Z"
}
put
Authorizations
Path parameters
idstring · uuidRequired

A UUID string identifying this invoice.

Body
idstring · uuidRead-onlyRequired
planall ofRead-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 | nullableOptional
billing_datestring · date | nullableOptional
paid_atstring · date-time | nullableOptional
is_custombooleanOptional
titlestring | nullableOptional
descriptionstring | nullableOptional
stripe_price_idstring | nullableOptional
due_datestring · date | nullableOptional
service_datestring · date | nullableOptional
waive_reasonstring | nullableOptional
payment_termone ofOptional
string · enumOptional
  • one-time - One-time
  • installment - Installment
Possible values:
or
undefined · enumOptionalPossible values:
number_of_paymentsinteger | nullableOptional
number_of_installmentsinteger | nullableOptional
frequencystring | nullableOptional
waived_atstring · date-time | nullableOptional
Responses
200Success
application/json
put
PUT /api/church/invoices/{id} HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 516

{
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2025-07-23T12:41:22.389Z",
  "invoice_id": "text",
  "status": "unpaid",
  "amount": "text",
  "payment_method": "text",
  "billing_date": "2025-07-23",
  "paid_at": "2025-07-23T12:41:22.389Z",
  "is_custom": true,
  "title": "text",
  "description": "text",
  "stripe_price_id": "text",
  "due_date": "2025-07-23",
  "service_date": "2025-07-23",
  "waive_reason": "text",
  "payment_term": "one-time",
  "number_of_payments": 1,
  "number_of_installments": 1,
  "frequency": "text",
  "waived_at": "2025-07-23T12:41:22.389Z"
}
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": "2025-07-23T12:41:22.389Z",
  "updated_at": "2025-07-23T12:41:22.389Z",
  "invoice_id": "text",
  "status": "unpaid",
  "amount": "text",
  "payment_method": "text",
  "billing_date": "2025-07-23",
  "paid_at": "2025-07-23T12:41:22.389Z",
  "is_custom": true,
  "title": "text",
  "description": "text",
  "stripe_price_id": "text",
  "due_date": "2025-07-23",
  "service_date": "2025-07-23",
  "waive_reason": "text",
  "payment_term": "one-time",
  "number_of_payments": 1,
  "number_of_installments": 1,
  "frequency": "text",
  "waived_at": "2025-07-23T12:41:22.389Z"
}
delete
Authorizations
Path parameters
idstring · uuidRequired

A UUID string identifying this invoice.

Responses
204
No response body
delete
DELETE /api/church/invoices/{id} HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer JWT
Accept: */*
204

No response body

No content
patch
Authorizations
Path parameters
idstring · uuidRequired

A UUID string identifying this invoice.

Body
idstring · uuidRead-onlyOptional
planall ofRead-onlyOptional
legacy_idstring | nullableOptional
nextgen_legacy_idstring | nullableOptional
created_atstring · date-time | nullableOptional
updated_atstring · date-timeRead-onlyOptional
invoice_idstring · max: 20Optional
statusstring · enumOptional
  • unpaid - Unpaid
  • paid - Paid
  • failed - Failed
  • overdue - Overdue
  • waived - Waived
Possible values:
amountstring · decimalOptionalPattern: ^-?\d{0,8}(?:\.\d{0,2})?$
payment_methodstring | nullableOptional
billing_datestring · date | nullableOptional
paid_atstring · date-time | nullableOptional
is_custombooleanOptional
titlestring | nullableOptional
descriptionstring | nullableOptional
stripe_price_idstring | nullableOptional
due_datestring · date | nullableOptional
service_datestring · date | nullableOptional
waive_reasonstring | nullableOptional
payment_termone ofOptional
string · enumOptional
  • one-time - One-time
  • installment - Installment
Possible values:
or
undefined · enumOptionalPossible values:
number_of_paymentsinteger | nullableOptional
number_of_installmentsinteger | nullableOptional
frequencystring | nullableOptional
waived_atstring · date-time | nullableOptional
Responses
200Success
application/json
patch
PATCH /api/church/invoices/{id} HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 516

{
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2025-07-23T12:41:22.389Z",
  "invoice_id": "text",
  "status": "unpaid",
  "amount": "text",
  "payment_method": "text",
  "billing_date": "2025-07-23",
  "paid_at": "2025-07-23T12:41:22.389Z",
  "is_custom": true,
  "title": "text",
  "description": "text",
  "stripe_price_id": "text",
  "due_date": "2025-07-23",
  "service_date": "2025-07-23",
  "waive_reason": "text",
  "payment_term": "one-time",
  "number_of_payments": 1,
  "number_of_installments": 1,
  "frequency": "text",
  "waived_at": "2025-07-23T12:41:22.389Z"
}
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": "2025-07-23T12:41:22.389Z",
  "updated_at": "2025-07-23T12:41:22.389Z",
  "invoice_id": "text",
  "status": "unpaid",
  "amount": "text",
  "payment_method": "text",
  "billing_date": "2025-07-23",
  "paid_at": "2025-07-23T12:41:22.389Z",
  "is_custom": true,
  "title": "text",
  "description": "text",
  "stripe_price_id": "text",
  "due_date": "2025-07-23",
  "service_date": "2025-07-23",
  "waive_reason": "text",
  "payment_term": "one-time",
  "number_of_payments": 1,
  "number_of_installments": 1,
  "frequency": "text",
  "waived_at": "2025-07-23T12:41:22.389Z"
}
PreviousGive methodsNextPay