> ## Documentation Index
> Fetch the complete documentation index at: https://docs.subotiz.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 取消订阅

> 取消订阅



## OpenAPI

````yaml openapi/v1-zh.yaml POST /api/v1/subscription/{subscription_id}/cancel
openapi: 3.0.3
info:
  title: Subotiz API
  description: Subotiz OpenAPI
  version: 1.0.0
servers:
  - url: https://{api}.subotiz.com
    variables:
      api:
        default: api
security:
  - sec0: []
tags:
  - name: 折扣
    description: 折扣
  - name: 发票
    description: 发票
  - name: 退款
    description: 退款
  - name: 商品管理
    description: 商品管理
  - name: 订阅
    description: 订阅
  - name: 商品定价
    description: 商品定价方案
  - name: 交易单
    description: 交易单
  - name: 支付流水
    description: 支付流水
  - name: 结账会话
    description: 结账会话
  - name: 顾客
    description: 顾客
  - name: 顾客门户
    description: 顾客门户
  - name: Webhook
    description: Webhook
  - name: 争议
    description: 争议订单
paths:
  /api/v1/subscription/{subscription_id}/cancel:
    post:
      tags:
        - 订阅
      summary: 取消订阅
      description: 取消订阅
      operationId: v1-subscription-cancel-subscription
      parameters:
        - name: subscription_id
          in: path
          description: 订阅ID
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/HeaderRequestID'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CancelSubscriptionRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CancelSubscriptionResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
              example:
                code: system_error
                message: Internal server error.
components:
  parameters:
    HeaderRequestID:
      name: Request-Id
      in: header
      description: 请求的唯一标识符
      required: true
      schema:
        type: string
        default: 008e3967-a1b5-48bb-be14-d5bff5092e61
  schemas:
    CancelSubscriptionRequest:
      required:
        - cancel_type
        - refund_type
      type: object
      properties:
        merchant_id:
          type: string
          description: 商户唯一标识
        cancel_type:
          type: string
          description: |-
            取消订阅的类型：
             - end_of_period： 下周期终止
             - immediate：立即终止
        refund_type:
          type: string
          description: 必填，退款类型：none-不退款，full-全额退款，partial-按使用时间比例退款，仅immediate终止时必填
        cancel_reason:
          type: string
          description: 终止订阅原因
      description: 终止订阅请求
    CancelSubscriptionResponse:
      type: object
      properties:
        code:
          type: string
          description: error code
        message:
          type: string
          description: error message
        data:
          $ref: '#/components/schemas/CancelSubscriptionResponse_Data'
      description: 终止订阅响应
    BaseResponse:
      type: object
      properties:
        code:
          type: string
          description: 错误码
        message:
          type: string
          description: 错误详细信息
    CancelSubscriptionResponse_Data:
      type: object
      properties:
        subscription_id:
          type: string
          description: 订阅唯一标识
        biz_status:
          type: string
          description: 订阅业务状态
        expected_cancel_at:
          type: string
          description: 当以 下周期终止 方式取消订阅时，返回订阅结束时间
        refund_amount:
          type: string
          description: 退款金额，当产生退款时返回
        refund_currency:
          type: string
          description: 退款币种，当产生退款时返回
      description: 终止订阅响应
  securitySchemes:
    sec0:
      type: http
      description: 'Bearer API Key 鉴权。格式：Authorization: Bearer {your_api_key}'
      scheme: bearer

````