Canceling a specific subscription
POST/recurrency/subscriptions/:subscriptionId/cancel
This endpoint is used to cancel a specific subscription based on the ID provided. When sending a cancellation request to this endpoint, the system cancels the specified subscription. If the subscription is successfully canceled, the system returns a response with an empty body.
Requestβ
Path Parameters
subscriptionId uuidrequired
Example: 8086bfd7-6241-4f76-81d8-70460533ce74
Responsesβ
- 204
- 400
- 401
- 415
- 500
- 502
Canceled Successfully
Bad Request
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
message stringrequired
success booleanrequired
errors
object[]
message string
field string
{
"message": "string",
"success": true,
"errors": [
{
"message": "must be a well-formed UUID string",
"field": "merchantChargeId"
}
]
}
Unauthorized
- application/json
- Schema
- Example (from schema)
- Example
Schema
Array [
]
message stringrequired
success booleanrequired
errors
object[]
message string
field string
{
"message": "string",
"success": true,
"errors": [
{
"message": "must be a well-formed UUID string",
"field": "merchantChargeId"
}
]
}
{
"message": "Authorization token not found.",
"success": false,
"errors": {
"message": "Authorization token not found",
"field": "Authorization Token"
}
}
Unsupported Media Type
- application/json
- Schema
- Example (from schema)
- Example
Schema
Array [
]
message stringrequired
success booleanrequired
errors
object[]
message string
field string
{
"message": "string",
"success": true,
"errors": [
{
"message": "must be a well-formed UUID string",
"field": "merchantChargeId"
}
]
}
{
"message": "Request object is invalid or incorrectly formatted",
"success": false,
"errors": null
}
Internal Server Error
- application/json
- Schema
- Example (from schema)
- Example
Schema
Array [
]
message stringrequired
success booleanrequired
errors
object[]
message string
field string
{
"message": "string",
"success": true,
"errors": [
{
"message": "must be a well-formed UUID string",
"field": "merchantChargeId"
}
]
}
{
"message": "Internal Server Error",
"success": false,
"errors": null
}
Bad Gateway
- application/json
- Schema
- Example (from schema)
- Example
Schema
Array [
]
message stringrequired
success booleanrequired
errors
object[]
message string
field string
{
"message": "string",
"success": true,
"errors": [
{
"message": "must be a well-formed UUID string",
"field": "merchantChargeId"
}
]
}
{
"message": "Internal Server Error",
"success": false,
"errors": null
}
Loading...