Updating an existing plan

PUT 
/recurrency/plans/:planId

This endpoint is used to update the details of an existing subscription plan based on the provided ID. Subscription plans may need to be updated to reflect changes in terms, pricing, benefits or other attributes associated with the plan. When submitting an upgrade request to this endpoint, pertinent plan details such as name, description, price, duration, and features must be provided in the body of the request. The ID of the plan to be updated must be specified in the URL. After successful update, the system returns the updated plan details.

Request

Path Parameters

planId uuidrequired
Example: 8086bfd7-6241-4f76-81d8-70460533ce74

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...