# Cancel a subscription

Cancels a subscription. Once cancelled, the subscription will stop processing future payments. This action cannot be undone, but you can create a new subscription if needed.

Endpoint: PATCH /subscriptions/{id}/cancel
Version: 1.0.0
Security: JWT

## Path parameters:

  - `id` (string, required)
    Unique identifier of the subscription to cancel
    Example: "sub_5JU9yv0lGSUP"

## Response 200 fields (application/json):

  - `id` (string, required)
    Unique identifier for the subscription.
    Example: "sub_5JU9yv0lGSUP"

  - `customer_id` (string, required)
    Unique identifier of the customer associated with this subscription.
    Example: "cust_5JU9yv0lGSUP"

  - `product_name` (string, required)
    Name of the product being subscribed to.
    Example: "ShieldGuard Insurance"

  - `product_description` (string, required)
    Description of the product.
    Example: "Flexible, monthly insurance for belongings, travel, and digital assets, easy to manage"

  - `plan_name` (string)
    Name of the subscription plan.
    Example: "ShieldGuard Lite"

  - `plan_description` (string)
    Description of the subscription plan.
    Example: "Simple, monthly insurance plan that covers your basic belongings and key digital assets"

  - `reference_number` (string)
    optional identifier to be sent for reconciliations
    Example: "R0001"

  - `status` (string, required)
    Current status of the subscription.
    Enum: "created", "active", "paused", "expired", "failed", "halted", "cancelled", "completed", "authorized"

  - `amount` (number, required)
    The amount in the smallest currency unit. For example, if the amount is $299.00, then 29900 is passed in  this field. In the case of three decimal currencies, such as KWD, BHD and OMR, to represent an amount of 295.991, pass the value as 295990. And in the case of zero decimal currencies such as JPY, for amount ￥295, pass the value as 295.

  - `currency` (string, required)
    The currency code in [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) format.

  - `interval_type` (string, required)
    Used in combination with interval_count to define the billing cycle frequency.
    Enum: "month", "year"

  - `interval_count` (integer, required)
    Number of intervals between a billing cycle, used in combination with interval_type.
Valid combinations:
- Monthly: interval_type='month', interval_count=1
- Quarterly: interval_type='month', interval_count=3
- Half-yearly: interval_type='month', interval_count=6
- Yearly: interval_type='year', interval_count=1
    Enum: 1, 3, 6

  - `billing_cycles` (integer, required)
    Total number of billing cycles for the subscription.
    Example: 12

  - `start_date` (string, required)
    Start date of the subscription in UTC timezone and ISO 8601 format (YYYY-MM-DD).
    Example: "2025-01-01"

  - `end_date` (string, required)
    The date on which the subscription ends in UTC timezone and ISO 8601 format (YYYY-MM-DD).
    Example: "2025-12-01"

  - `expires_at` (string, required)
    Expiration date for the subscription payment link in UTC timezone and ISO 8601 format (YYYY-MM-DD).
    Example: "2025-01-07"

  - `next_payment_date` (string,null)
    Date of the next scheduled payment in UTC timezone and ISO 8601 format (YYYY-MM-DD).

  - `subscription_link_url` (string, required)
    URL for the subscription payment page. Your customer can use this URL to make the first payment and activate the subscription.
    Example: "https://checkout.glomopay.com/subscription/sub_5JU9yv0lGSUP"

  - `cancelled_at` (string,null)
    Date when the subscription was cancelled in UTC timezone and ISO 8601 format (YYYY-MM-DD). This field is null unless the subscription status is 'cancelled'.
    Example: "2025-01-15"

  - `notes` (object)
    Any additional notes for the order
    Example: {"key1":"value1","key2":"value2"}

## Response 400 fields (application/json):

  - `error` (string)
    Enum: "Bad Request"

  - `message` (string)
    Example: "Subscription cannot be cancelled from current state: completed"

## Response 404 fields (application/json):

  - `error` (string)
    Enum: "Not Found"

  - `message` (string)
    Example: "Subscription not found"