Create an new plan

POST 
/recurrency/plans

This endpoint is used to create new subscription plans. Subscription plans define the terms, prices and benefits associated with different levels of service offered to customers. When creating a new plan, pertinent details such as the plan name, description, price, duration, and any other relevant attributes must be provided in the body of the request. Upon successful creation, the system returns the complete details of the newly created plan, including a unique identifier for future reference.

Request

application/json

Body

required

billingCycle stringrequired

Possible values: [DAILY, WEEKLY, MONTHLY, QUARTERLY, BIANNUAL, ANNUAL]

amount int32required

Possible values: >= 1

totalBillingCycles int32required

Possible values: >= 1

initialGraceCycles int32

initialFee

object

description stringrequired

amount int32required

cycles int32required

Possible values: >= 1

tag stringrequired

Possible values: non-empty

Responses

200

OK

application/json

Schema

Schema

id string
billingCycle string
totalBillingCycles int32
initialGraceCycles int32

initialFee

object

description string

amount int32

cycles int32
tag string
paymentType string
amount int32
enabled boolean

Indicates if the plan is enabled or not.

Example (from schema)

{
  "id": "string",
  "billingCycle": "string",
  "totalBillingCycles": 0,
  "initialGraceCycles": 0,
  "initialFee": {
    "description": "Fee test description",
    "amount": 25,
    "cycles": 10
  },
  "tag": "string",
  "paymentType": "string",
  "amount": 15,
  "enabled": false
}

400

Bad Request

application/json

Schema

Schema

message stringrequired
success booleanrequired

errors

object[]

Array [

message string

field string

]

Example (from schema)

{
  "message": "string",
  "success": true,
  "errors": [
    {
      "message": "must be a well-formed UUID string",
      "field": "merchantChargeId"
    }
  ]
}

401

Unauthorized

application/json

Schema

Schema

message stringrequired
success booleanrequired

errors

object[]

Array [

message string

field string

]

Example (from schema)

{
  "message": "string",
  "success": true,
  "errors": [
    {
      "message": "must be a well-formed UUID string",
      "field": "merchantChargeId"
    }
  ]
}

Example

{
  "message": "Authorization token not found.",
  "success": false,
  "errors": {
    "message": "Authorization token not found",
    "field": "Authorization Token"
  }
}

415

Unsupported Media Type

application/json

Schema

Schema

message stringrequired
success booleanrequired

errors

object[]

Array [

message string

field string

]

Example (from schema)

{
  "message": "string",
  "success": true,
  "errors": [
    {
      "message": "must be a well-formed UUID string",
      "field": "merchantChargeId"
    }
  ]
}

Example

{
  "message": "Request object is invalid or incorrectly formatted",
  "success": false,
  "errors": null
}

500

Internal Server Error

application/json

Schema

Schema

message stringrequired
success booleanrequired

errors

object[]

Array [

message string

field string

]

Example (from schema)

{
  "message": "string",
  "success": true,
  "errors": [
    {
      "message": "must be a well-formed UUID string",
      "field": "merchantChargeId"
    }
  ]
}

Example

{
  "message": "Internal Server Error",
  "success": false,
  "errors": null
}

Loading...