# CancelSubscription
<a name="API_CancelSubscription"></a>

Cancels a flat-rate pricing subscription.

**Note**  
For active subscriptions, the cancellation is scheduled to take effect at the end of the current billing period. The subscription remains active until that date. To revert a pending cancellation, use `CancelSubscriptionChange`.  
For subscriptions in `PENDING_APPROVAL` status, the subscription is deleted immediately without scheduling.

## Request Syntax
<a name="API_CancelSubscription_RequestSyntax"></a>

```
POST /v1/CancelSubscription HTTP/1.1
If-Match: {{ifMatch}}
Content-type: application/json

{
   "arn": "{{string}}",
   "clientToken": "{{string}}"
}
```

## URI Request Parameters
<a name="API_CancelSubscription_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ifMatch](#API_CancelSubscription_RequestSyntax) **   <a name="pricingplanmanager-CancelSubscription-request-ifMatch"></a>
The `ETag` value from a previous `GetSubscription` or `ListSubscriptions` response.  
Required: Yes

## Request Body
<a name="API_CancelSubscription_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [arn](#API_CancelSubscription_RequestSyntax) **   <a name="pricingplanmanager-CancelSubscription-request-arn"></a>
The ARN of the subscription to cancel.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: Yes

 ** [clientToken](#API_CancelSubscription_RequestSyntax) **   <a name="pricingplanmanager-CancelSubscription-request-clientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the request is handled only once.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Required: No

## Response Syntax
<a name="API_CancelSubscription_ResponseSyntax"></a>

```
HTTP/1.1 200
ETag: {{eTag}}
Content-type: application/json

{
   "arn": "string",
   "createdAt": "string",
   "planFamily": "string",
   "planTier": "string",
   "resourceArns": [ "string" ],
   "scheduledChange": { 
      "changeType": "string",
      "effectiveDate": "string",
      "planTier": "string",
      "usageLevel": "string"
   },
   "status": "string",
   "statusReason": "string",
   "updatedAt": "string",
   "usageLevel": "string"
}
```

## Response Elements
<a name="API_CancelSubscription_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The response returns the following HTTP headers.

 ** [eTag](#API_CancelSubscription_ResponseSyntax) **   <a name="pricingplanmanager-CancelSubscription-response-eTag"></a>
The updated entity tag for concurrency control.

The following data is returned in JSON format by the service.

 ** [arn](#API_CancelSubscription_ResponseSyntax) **   <a name="pricingplanmanager-CancelSubscription-response-arn"></a>
The Amazon Resource Name (ARN) that uniquely identifies this subscription.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.

 ** [createdAt](#API_CancelSubscription_ResponseSyntax) **   <a name="pricingplanmanager-CancelSubscription-response-createdAt"></a>
The date and time when the subscription was created, in ISO 8601 format.  
Type: Timestamp

 ** [planFamily](#API_CancelSubscription_ResponseSyntax) **   <a name="pricingplanmanager-CancelSubscription-response-planFamily"></a>
The pricing plan family for the subscription, such as `CloudFront`.  
Type: String

 ** [planTier](#API_CancelSubscription_ResponseSyntax) **   <a name="pricingplanmanager-CancelSubscription-response-planTier"></a>
The current tier level of the pricing plan, such as `FREE`, `PRO`, `BUSINESS`, or `PREMIUM`.  
Type: String

 ** [resourceArns](#API_CancelSubscription_ResponseSyntax) **   <a name="pricingplanmanager-CancelSubscription-response-resourceArns"></a>
The ARNs of the Amazon resources covered by this subscription.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 10 items.

 ** [status](#API_CancelSubscription_ResponseSyntax) **   <a name="pricingplanmanager-CancelSubscription-response-status"></a>
The current status of the subscription. For the list of possible values, see the `Status` type.  
Type: String  
Valid Values: `PENDING_APPROVAL | ACTIVE | SYNC_IN_PROGRESS | FAILED` 

 ** [updatedAt](#API_CancelSubscription_ResponseSyntax) **   <a name="pricingplanmanager-CancelSubscription-response-updatedAt"></a>
The date and time when the subscription was last modified, in ISO 8601 format.  
Type: Timestamp

 ** [scheduledChange](#API_CancelSubscription_ResponseSyntax) **   <a name="pricingplanmanager-CancelSubscription-response-scheduledChange"></a>
A pending change that will take effect at the end of the current billing period. This field is present only when a downgrade or cancellation is scheduled.  
Type: [ScheduledChange](API_ScheduledChange.md) object

 ** [statusReason](#API_CancelSubscription_ResponseSyntax) **   <a name="pricingplanmanager-CancelSubscription-response-statusReason"></a>
A human-readable explanation of the current status, present when additional context is available.  
Type: String

 ** [usageLevel](#API_CancelSubscription_ResponseSyntax) **   <a name="pricingplanmanager-CancelSubscription-response-usageLevel"></a>
The usage level within the plan tier. When present, indicates a specific capacity configuration beyond the base tier.  
Type: String

## Errors
<a name="API_CancelSubscription_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have the required permissions to perform this operation. Verify that your IAM policy grants access to this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request conflicts with the current state of the resource. This typically occurs when the `ETag` value in the `If-Match` header does not match the current version of the subscription. Retrieve the latest version and retry.    
 ** resourceId **   
The identifier of the resource that has a conflicting state.
HTTP Status Code: 409

 ** InternalServerException **   
An unexpected error occurred on the server. Retry the request.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified subscription was not found. Verify that the ARN is correct and that the subscription belongs to your account.    
 ** resourceId **   
The identifier of the resource that was not found.
HTTP Status Code: 404

 ** ThrottlingException **   
The request rate exceeds the allowed limit. Wait briefly and retry the request.  
HTTP Status Code: 429

 ** ValidationException **   
The request failed a business rule validation. For example, the specified resource might already be associated with another subscription, or the subscription might not be in the required state for this operation.    
 ** resourceId **   
The identifier of the resource that failed validation.
HTTP Status Code: 400

## See Also
<a name="API_CancelSubscription_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/pricing-plan-manager-2025-08-05/CancelSubscription) 
+  [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/pricing-plan-manager-2025-08-05/CancelSubscription) 
+  [Amazon SDK for C\+\+](https://docs.amazonaws.cn/goto/SdkForCpp/pricing-plan-manager-2025-08-05/CancelSubscription) 
+  [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/pricing-plan-manager-2025-08-05/CancelSubscription) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/pricing-plan-manager-2025-08-05/CancelSubscription) 
+  [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/pricing-plan-manager-2025-08-05/CancelSubscription) 
+  [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/pricing-plan-manager-2025-08-05/CancelSubscription) 
+  [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/pricing-plan-manager-2025-08-05/CancelSubscription) 
+  [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/pricing-plan-manager-2025-08-05/CancelSubscription) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/pricing-plan-manager-2025-08-05/CancelSubscription)