Create Cancel Reason

accounts.subscriptions.cancel_reason.create(, ) -> CancelReasonCreateResponse

POST/accounts/{account_id}/subscriptions/{subscription_identifier}/cancel-reason

Records a cancellation reason for an account subscription.

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

Accepted Permissions (at least one required)

Billing Write

ParametersExpand Collapse

account_id: str

Identifier

maxLength32

subscription_identifier: str

Subscription identifier tag.

maxLength32

other: Optional[str]

Additional cancellation details.

reason_code: Optional[Sequence[str]]

The cancellation reason codes.

ReturnsExpand Collapse

class CancelReasonCreateResponse: …

id: Optional[str]

The cancel reason identifier.

other: Optional[str]

Additional cancellation details.

reason_code: Optional[List[str]]

The cancellation reason codes.

submitted: Optional[datetime]

When the cancel reason was submitted.

formatdate-time

subscription_id: Optional[str]

The subscription identifier.

Create Cancel Reason

import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
cancel_reason = client.accounts.subscriptions.cancel_reason.create(
    subscription_identifier="506e3185e9c882d175a2d0cb0093d9f2",
    account_id="023e105f4ecef8ad9ca31a8372d0c353",
)
print(cancel_reason.id)

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "id": "id",
    "other": "other",
    "reason_code": [
      "string"
    ],
    "submitted": "2019-12-27T18:11:19.117Z",
    "subscription_id": "subscription_id"
  },
  "success": true
}

Returns Examples

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "id": "id",
    "other": "other",
    "reason_code": [
      "string"
    ],
    "submitted": "2019-12-27T18:11:19.117Z",
    "subscription_id": "subscription_id"
  },
  "success": true
}