Terminates a subscription

Request

PUT {{baseURL}}/sub-api/v1/subscriptions/{{subscriptionId}}/terminate

This endpoint terminates, or cancels, an active subscription.

This action occurs immediately and cannot be undone.

Security

Bearer

Path

subscriptionIdstring, (uuid)required

Specifies the subscription identifier.

Example:79c0d1e2-3f4a-4b5c-6d7e-8f9a0b1c2d58

curl -i -X PUT \
  https://developer.flute.com/_mock/api-reference/sub-api/v1/subscriptions/79c0d1e2-3f4a-4b5c-6d7e-8f9a0b1c2d58/terminate \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json

idstring, (uuid)

Indicates the subscription identifier.

Example: 79c0d1e2-3f4a-4b5c-6d7e-8f9a0b1c2d58

statusIdinteger, (int32)

Indicates the subscription status identifier.

Possible values:

Value	Meaning
1	Active
2	Completed
3	Suspended
4	Delinquent
5	Terminated
6	Deleted

Example: 2

Example:2

statusstring or null

Indicates the subscription status.

Possible values:

Value	Meaning
Active	1
Completed	2
Suspended	3
Delinquent	4
Terminated	5
Deleted	6

Example: Completed

Example:"Completed"

messagestring or null

Indicates a message with additional details.

Example: Subscription is terminated. Future payments will no longer be processed. This action is permanent.

Example:"Subscription is terminated. Future payments will no longer be processed. This action is permanent"

Response

{
  "id": "055422f6-93a0-4872-9134-76153da2a0b9",
  "statusId": 5,
  "status": "Terminated",
  "message": "Subscription is terminated.\n\nFuture payments will no longer be processed. This action is permanent.\n"
}