---
title: "Edit Plan Subscription"
method: PATCH
path: "/v3.0/plan-subscriptions/{slug}/"
tags: ["plan-subscriptions"]
---

# Edit Plan Subscription

`PATCH /v3.0/plan-subscriptions/{slug}/`

## Request

- Base URL: `https://api.formaloo.me`
- URL: `https://api.formaloo.me/v3.0/plan-subscriptions/{slug}/`
- Auth: none declared. Required headers: `x-api-key`

## Path parameters

- `slug` string, required

## Query parameters

- `active_business` string, required

## Headers

- `x-api-key` string, required

## Request body

- PatchedPlanSubscriptionRequest
  - `cancel_subscription` boolean: if set as true, the subscription will be cancelled.

## Response `200`

- PlanSubscription
  - `plan_deal` ShortPlanDeal
    - `plan` ShortPlan
      - `title` string, nullable: the title of plan.
      - `plan_type` 'free' | 'plus' | 'pro' | 'advance' | 'enterprise' | 'team' | 'on_premise': * `free` - Free * `plus` - Plus * `pro` - Pro * `advance` - Advanced * `enterprise` - Enterprise * `team` - Team * `on_premise` - On Premise
      - `description` string, nullable
      - `slug` string, nullable
    - `slug` string, nullable
    - `title` string, nullable: the title of the item as shown for the admin.
    - `display_title` string, nullable: the title of the item to show in dashboards.
    - `is_subscription` boolean: is this a subscription or one time purchase?
    - `subscription_period` union: the period of the subscription * `None` - --- * `monthly` - Monthly * `annual` - Annual
      - 'monthly' | 'annual': * `None` - --- * `monthly` - Monthly * `annual` - Annual
      - ''
      - unknown
    - `description` string, nullable
  - `status` 'pending' | 'active' | 'canceling' | 'cancelled': * `pending` - Pending * `active` - Active * `canceling` - canceling * `cancelled` - Cancelled
  - `business_plans` BusinessPlanShort[]
    - `from_date` string, date, nullable: date that the purchase starts
    - `to_date` string
    - `is_active` boolean: is this purchase active or not
    - `status` union
      - 'canceled' | 'completed' | 'pending': * `canceled` - Canceled * `completed` - Completed * `pending` - Pending
      - ''
    - `is_trial` boolean: is this a trial plan?
    - `paid_amount` string, decimal, nullable: paid amount for this purchase?
  - `payments` PaymentRecordShort[]
    - `created_at` string, date-time
    - `amount` string, decimal
    - `successful` boolean
    - `transaction_code` string, nullable
  - `subscription_method` PaymentMethodShort
    - `title` string, required: payment method's display name.
    - `logo` string, uri: payment method's logo.
    - `description` string, nullable: any extra description to show with payment method.
  - `created_at` string, date-time
  - `slug` string, nullable

---

[API](https://skmtc.dev/formaloo/apis/formaloo-api-documentation.md) · [All operations](https://skmtc.dev/formaloo/apis/formaloo-api-documentation/llms.txt) · [OpenAPI document](https://skmtc.dev/formaloo/apis/formaloo-api-documentation/revisions/47b268aeb656?raw)