Change the payment cycle

POST 
/api/v3/package/:package_id/_action/setPayCycle

Valid values for specifying paycycle:

• dly - daily
• 1wk - weekly
• 2wk - 2 weeks
• 4wk - 4 weeks
• 2mn - 2 months
• mon - monthly
• qtr - quarterly
• yrl - yearly
• 2yr - 2 years
• 3yr - 3 years
• 4yr - 4 years
• 5yr - 5 years
• 10y - 10 years
• six - 6 months
• 30d - 30 days
• 8wk - 8 weeks
• 12w - 12 weeks

Request

application/json

Body

paycycle string

Responses

200

Action completed successfully

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable
response boolean

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": true
}

Example 1

{
  "code": 200,
  "status": "OK",
  "message": "",
  "details": {},
  "response": true
}

400

Bad request

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable
response boolean

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": true
}

Example 1

{
  "code": 400,
  "status": "Error",
  "message": "Missing or invalid parameter.",
  "details": {},
  "response": false
}

401

Authentication error

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable
response boolean

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": true
}

Example 1

{
  "code": 401,
  "status": "Error",
  "message": "Invalid or incorrect authorization [Missing (basic) authorization header.]",
  "details": {},
  "response": false
}

Loading...