Cancel subscription

Cancel a subscription by ID.

Path Parameters

org_id string required
billing_id string required

ID of the billing account to update the subscription for

id string required

ID of the subscription to cancel

application/json

Request Body required

immediate boolean

Responses

• 200
• 400
• 401
• 403
• 404
• 500
• default

---

A successful response.

application/json

Schema

Example (from schema)

---

Schema

object

{}

Bad Request - The request was malformed or contained invalid parameters.

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Unauthorized - Authentication is required

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Forbidden - User does not have permission to access the resource

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Not Found - The requested resource was not found

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Internal Server Error. Returned when theres is something wrong with Frontier server.

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

An unexpected error response.

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

POST /v1beta1/organizations/:org_id/billing/:billing_id/subscriptions/:id/cancel

Authorization

name: Basic type: httpdescription: use Client ID as username and Client Secret as passwordin: headerscheme: basic

Request

Base URL

http://127.0.0.1:7400

Security Scheme

BasicBearer

Username

Password

org_id — path required

billing_id — path required

id — path required

Body required

{
  "immediate": true
}

curl / cURL

curl -L -X POST 'http://127.0.0.1:7400/v1beta1/organizations/:org_id/billing/:billing_id/subscriptions/:id/cancel' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "immediate": true
}'

python / requests

curl -L -X POST 'http://127.0.0.1:7400/v1beta1/organizations/:org_id/billing/:billing_id/subscriptions/:id/cancel' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "immediate": true
}'

go / native

curl -L -X POST 'http://127.0.0.1:7400/v1beta1/organizations/:org_id/billing/:billing_id/subscriptions/:id/cancel' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "immediate": true
}'

nodejs / axios

curl -L -X POST 'http://127.0.0.1:7400/v1beta1/organizations/:org_id/billing/:billing_id/subscriptions/:id/cancel' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "immediate": true
}'

ruby / Net::HTTP

curl -L -X POST 'http://127.0.0.1:7400/v1beta1/organizations/:org_id/billing/:billing_id/subscriptions/:id/cancel' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "immediate": true
}'

csharp / RestSharp

curl -L -X POST 'http://127.0.0.1:7400/v1beta1/organizations/:org_id/billing/:billing_id/subscriptions/:id/cancel' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "immediate": true
}'

php / cURL

curl -L -X POST 'http://127.0.0.1:7400/v1beta1/organizations/:org_id/billing/:billing_id/subscriptions/:id/cancel' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "immediate": true
}'

java / OkHttp

curl -L -X POST 'http://127.0.0.1:7400/v1beta1/organizations/:org_id/billing/:billing_id/subscriptions/:id/cancel' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "immediate": true
}'

powershell / RestMethod

curl -L -X POST 'http://127.0.0.1:7400/v1beta1/organizations/:org_id/billing/:billing_id/subscriptions/:id/cancel' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "immediate": true
}'