Subscription Deactivate
Whenever a subscription needs to be deactivated, an API call with the subscription ID, reason and period is made to your fulfill endpoint. The response must indicate whether the subscription was successfully deactivated. Independently of the SDK, you will be interacting with SubscriptionDeactivateRequest and SubscriptionDeactivateResponse.
SubscriptionDeactivateRequest
Field | Description |
---|---|
operation | Always SubscriptionDeactivate. |
subscriptionId | An identifier for the subscription. Always present. |
period | An enumerated value representing the period of a subscription’s life cycle in which this action occurred. Always present: GRACE_PERIOD: action occurred during the risk-free period REGULAR: action occurred during the subscription valid period NOT_STARTED: the subscription was never activated. Used in combination with the UNABLE_TO_FULFILL reason code |
reason | An enumerated value explaining why this action happened. Field always present: NOT_RENEWED: The subscription reached the end of its term USER_REQUEST: The customer manually deactivated the subscription via Amazon.com CUSTOMER_SERVICE_REQUEST: Deactivation initiated by customer service PAYMENT_PROBLEM: Deactivation due to a customer’s payment problem UNABLE_TO_FULFILL: Subscription was canceled due to a problem activating the subscription TESTING: Test request, please ignore |
SubscriptionDeactivateResponse
Field | Description |
---|---|
response | Valid response codes are: OK FAIL_INVALID_SUBSCRIPTION (SubscriptionId not recognized) FAIL_OTHER (Catch all Error code) |