KYkyshi
Subscriptions

Manage subscription

Changed on

Cancels, reactivates, or schedules cancellation at period end. Prefer cancel_at_period_end for voluntary cancellations: an immediate cancel takes access the customer has already paid for.

patch/v1/subscriptions/{id}/manage

Request

Path parameters

idstring required

Identifier of the resource.

Request body

action'cancel' | 'activate' | 'cancel_at_period_end' required

Example request

{
  "action": "cancel_at_period_end"
}

Response

Success.

statusboolean required

true on success.

messagestring required
codenumber required

Mirrors the HTTP status code.

Example response

{
  "status": true,
  "message": "Success",
  "code": 200,
  "data": {}
}

Changes

  • 4aed77604588Revision changes
    • breaking

      the response's body type changed from object to no type for status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      the endpoint scheme security ApiKeyAuth was added to the API

    • info

      added subschema #2 to the response body allOf list for the response status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status