Plans

get

Authorizations

jwtAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200Success

application/json

get

/api/church/plans

HTTPcURLJavaScriptPython

GET /api/church/plans HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "monthly_free_credits": 1,
    "perks": null,
    "prices": null
  }
]

post

Authorizations

jwtAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

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

idstring · uuidRead-onlyRequired

namestring · max: 100Required

descriptionstringRequired

monthly_free_creditsinteger · min: -2147483648 · max: 2147483647Optional

perksanyOptional

pricesanyOptional

Responses

201Success

application/json

post

/api/church/plans

HTTPcURLJavaScriptPython

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

{
  "name": "text",
  "description": "text",
  "monthly_free_credits": 1,
  "perks": null,
  "prices": null
}

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

201Success

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "monthly_free_credits": 1,
  "perks": null,
  "prices": null
}

get

Authorizations

jwtAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstring · uuidRequired

A UUID string identifying this plan.

Responses

200Success

application/json

get

/api/church/plans/{id}

HTTPcURLJavaScriptPython

GET /api/church/plans/{id} HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "monthly_free_credits": 1,
  "perks": null,
  "prices": null
}

put

Authorizations

jwtAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstring · uuidRequired

A UUID string identifying this plan.

Body

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

idstring · uuidRead-onlyRequired

namestring · max: 100Required

descriptionstringRequired

monthly_free_creditsinteger · min: -2147483648 · max: 2147483647Optional

perksanyOptional

pricesanyOptional

Responses

200Success

application/json

put

/api/church/plans/{id}

HTTPcURLJavaScriptPython

PUT /api/church/plans/{id} HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 88

{
  "name": "text",
  "description": "text",
  "monthly_free_credits": 1,
  "perks": null,
  "prices": null
}

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

200Success

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "monthly_free_credits": 1,
  "perks": null,
  "prices": null
}

delete

Authorizations

jwtAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstring · uuidRequired

A UUID string identifying this plan.

Responses

204

No response body

delete

/api/church/plans/{id}

HTTPcURLJavaScriptPython

DELETE /api/church/plans/{id} HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

204

No response body

No content

patch

Authorizations

jwtAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstring · uuidRequired

A UUID string identifying this plan.

Body

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

idstring · uuidRead-onlyOptional

namestring · max: 100Optional

descriptionstringOptional

monthly_free_creditsinteger · min: -2147483648 · max: 2147483647Optional

perksanyOptional

pricesanyOptional

Responses

200Success

application/json

patch

/api/church/plans/{id}

HTTPcURLJavaScriptPython

PATCH /api/church/plans/{id} HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 88

{
  "name": "text",
  "description": "text",
  "monthly_free_credits": 1,
  "perks": null,
  "prices": null
}

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

200Success

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "monthly_free_credits": 1,
  "perks": null,
  "prices": null
}