Strictly / PayWithZero Public API

Plans

Endpointhttps://api.paywithzero.net/v1

Download schema

Get all plans

GET

https://api.paywithzero.net/v1

/v1/public/plan

Returns a paginated list of recurring billing plans.

Get all plans › query Parameters

page

number

Page number for paginating

limit

number

Limit items per page

Get all plans › Responses

200

Paginated plans list.

No data returned

Add Plan

POST

https://api.paywithzero.net/v1

/v1/public/plan

Create a new recurring billing plan. Plans are reusable templates linked to subscriptions.

Add Plan › Headers

authorization

string · required

Add Plan › Request Body

payments

number · required

Number of Payments

amount

number · required

Plan amount

name

string · required

Plan name

dayFrequency

number

Plan day frequency

monthFrequency

number

Plan month frequency

dayOfMonth

number

Plan day of month

createdBy

string

From what application was created

updatedBy

string

From what application was updated

Add Plan › Responses

Plan created.

No data returned

POST/v1/public/plan

curl --request POST \
  --url https://api.paywithzero.net/v1/v1/public/plan \
  --header 'Content-Type: application/json' \
  --header 'authorization: <string>' \
  --data '
{
  "payments": 3,
  "amount": 30,
  "name": "API Plan 79",
  "dayFrequency": 5
}
'

shell

Example Request Body

{
  "payments": 3,
  "amount": 30,
  "name": "API Plan 79",
  "dayFrequency": 5
}

json

application/json

Example Responses

{
  "data": {
    "id": "64b04738618428a3bd3e74e8",
    "payments": 3,
    "amount": 30,
    "untilTerminated": false,
    "name": "API Plan 45",
    "dayFrequency": 5,
    "createdBy": "[email protected]",
    "updatedBy": "[email protected]",
    "deletedAt": null
  }
}

json

application/json

Get a plan

GET

https://api.paywithzero.net/v1

/v1/public/plan/{id}

Retrieve a single billing plan by ID.

Get a plan › path Parameters

id

string · required

Plan ID

Get a plan › Responses

Plan returned.

No data returned

Delete a Plan

DELETE

https://api.paywithzero.net/v1

/v1/public/plan/{id}

Delete a billing plan. Cannot delete plans with active subscriptions.

Delete a Plan › path Parameters

id

string · required

Plan ID

Delete a Plan › Responses

Plan deleted.

No data returned

Payment Requests Reports

Strictly / PayWithZero Public API

Plans

Endpointhttps://api.paywithzero.net/v1

Download schema

Get all plans

GET

https://api.paywithzero.net/v1

/v1/public/plan

Returns a paginated list of recurring billing plans.

Get all plans › query Parameters

page

number

Page number for paginating

limit

number

Limit items per page

Get all plans › Responses

200

Paginated plans list.

No data returned

Add Plan

POST

https://api.paywithzero.net/v1

/v1/public/plan

Create a new recurring billing plan. Plans are reusable templates linked to subscriptions.

Add Plan › Headers

authorization

string · required

Add Plan › Request Body

payments

number · required

Number of Payments

amount

number · required

Plan amount

name

string · required

Plan name

dayFrequency

number

Plan day frequency

monthFrequency

number

Plan month frequency

dayOfMonth

number

Plan day of month

createdBy

string

From what application was created

updatedBy

string

From what application was updated

Add Plan › Responses

Plan created.

No data returned

POST/v1/public/plan

curl --request POST \
  --url https://api.paywithzero.net/v1/v1/public/plan \
  --header 'Content-Type: application/json' \
  --header 'authorization: <string>' \
  --data '
{
  "payments": 3,
  "amount": 30,
  "name": "API Plan 79",
  "dayFrequency": 5
}
'

shell

Example Request Body

{
  "payments": 3,
  "amount": 30,
  "name": "API Plan 79",
  "dayFrequency": 5
}

json

application/json

Example Responses

{
  "data": {
    "id": "64b04738618428a3bd3e74e8",
    "payments": 3,
    "amount": 30,
    "untilTerminated": false,
    "name": "API Plan 45",
    "dayFrequency": 5,
    "createdBy": "[email protected]",
    "updatedBy": "[email protected]",
    "deletedAt": null
  }
}

json

application/json

Get a plan

GET

https://api.paywithzero.net/v1

/v1/public/plan/{id}

Retrieve a single billing plan by ID.

Get a plan › path Parameters

id

string · required

Plan ID

Get a plan › Responses

Plan returned.

No data returned

Delete a Plan

DELETE

https://api.paywithzero.net/v1

/v1/public/plan/{id}

Delete a billing plan. Cannot delete plans with active subscriptions.

Delete a Plan › path Parameters

id

string · required

Plan ID

Delete a Plan › Responses

Plan deleted.

No data returned

Payment Requests Reports