Skip to main content
POST
/
v1
/
billing
/
recurring
/
create
Create Recurring Schedule
curl --request POST \
  --url https://api.peere.network/v1/billing/recurring/create \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customerId": "<string>",
  "agreementPhrase": "<string>",
  "amount": 123,
  "currency": "<string>",
  "frequency": "daily",
  "interval": 123,
  "startDate": "2023-11-07T05:31:56Z",
  "endDate": "2023-11-07T05:31:56Z",
  "maxBillings": 123,
  "description": "<string>",
  "metadata": {}
}
'
{
  "statusCode": 201,
  "success": true,
  "message": "Recurring schedule created successfully",
  "data": {
    "scheduleId": "<string>",
    "customerId": "<string>",
    "amount": 123,
    "frequency": "<string>",
    "status": "<string>",
    "nextBillingDate": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
customerId
string
required
agreementPhrase
string
required
amount
number
required
currency
string
required
frequency
enum<string>
required
Available options:
daily,
weekly,
monthly,
yearly
interval
integer
startDate
string<date-time>
endDate
string<date-time>
maxBillings
integer
description
string
metadata
object

Response

Recurring schedule created successfully

statusCode
integer
Example:

201

success
boolean
Example:

true

message
string
Example:

"Recurring schedule created successfully"

data
object