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

# 取消订阅

使用此接口取消现有订阅。此操作将阻止与该订阅关联的任何未来定期付款。

**重要提示：**

* 取消订阅可能不会退还剩余订阅期的费用。有关退款详情，请参阅您的订阅条款。
* 请务必在下一个账单日之前取消订阅，以免产生不必要的费用。
* 您可以使用[获取订阅状态](https://docs.localpayment.com/zh/reference/transaction-status-error-codes)endpoint 来验证取消操作。

此接口需要有效的 `subscriptionId`。订阅一旦取消，便无法恢复。如果您想重新激活服务，则需要创建新的订阅。


## OpenAPI

````yaml openapi/zh/localpayment.json PATCH /api/payin/subscriptions/{subscriptionId}/status
openapi: 3.1.0
info:
  version: '1.0'
  title: Localpayment
  contact:
    name: Support
    url: mailto:support@localpayment.com
servers:
  - url: https://api.stage.localpayment.com
    description: Stage
security:
  - token: []
paths:
  /api/payin/subscriptions/{subscriptionId}/status:
    patch:
      summary: 取消订阅
      operationId: cancel-subscription
      parameters:
        - name: Authorization
          in: header
          description: >-
            用于身份验证的 Bearer
            访问令牌。该令牌可从[获取访问令牌](/zh/reference/get-token)或[刷新访问令牌](/zh/reference/refresh-token)endpoint
            获取。
          required: true
          schema:
            type: string
        - name: subscriptionId
          in: path
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                status:
                  const: CANCEL
                  description: 更改状态为`CANCELLED`。
              required:
                - status
              x-examples:
                Example 1:
                  status: CANCELLED
            examples:
              CANCELLED:
                value:
                  status: CANCELLED
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  externalId:
                    type: string
                    description: 系统生成的唯一标识符，用于跟踪交易（包含字母、数字和连字符）。我们建议使用 UUID4 以确保唯一性。
                  subscriptionId:
                    type: string
                    description: 订阅的唯一标识符。
                  status:
                    type: object
                    title: 状态
                    description: 操作状态。
                    properties:
                      code:
                        type: string
                        description: '[状态码](/zh/reference/transaction-status-error-codes)。'
                      description:
                        type: string
                        description: '[状态描述](/zh/reference/transaction-status-error-codes)。'
                      detail:
                        type: string
                        description: 更多状态信息。
                  totalPayments:
                    type: integer
                    description: 订阅相关的付款总数。
                  pendingPayments:
                    type: integer
                    description: 订阅中仍待处理的付款数量。
                  creationDate:
                    type: string
                    description: 订阅创建日期和时间。格式应符合有效的日期时间字符串（例如，ISO 8601）。
                  payments:
                    type: array
                    description: 表示与订阅相关的付款的对象数组。
                    items:
                      type: object
                  retries:
                    type: integer
                    description: 订阅付款处理过程中的重试次数。
                x-examples:
                  Example 1:
                    externalId: '1623451995'
                    subscriptionId: 498e4a08-13a8-405e-96a5-eccb44345ada
                    status:
                      code: '903'
                      description: CANCELLED
                      detail: The subscription was canceled - merchant request
                    totalPayments: 2
                    pendingPayments: 2
                    creationDate: '2021-06-11T22:53:15.622+00:00'
                    payments: []
                    retries: 0
              examples:
                903 - The subscription was canceled:
                  value:
                    externalId: '1623451995'
                    subscriptionId: 498e4a08-13a8-405e-96a5-eccb44345ada
                    status:
                      code: '903'
                      description: CANCELLED
                      detail: The subscription was canceled - merchant request
        '400':
          description: 错误的请求。
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: object
                    title: 状态
                    description: 操作状态。
                    properties:
                      code:
                        type: string
                        description: '[状态码](/zh/reference/transaction-status-error-codes)。'
                      description:
                        type: string
                        description: '[状态描述](/zh/reference/transaction-status-error-codes)。'
                      detail:
                        type: string
                        description: 更多状态信息。
                x-examples:
                  Example 1:
                    status:
                      code: '400'
                      description: ERROR
                      detail: Invalid operation
              examples:
                400 - Invalid operation:
                  value:
                    status:
                      code: '400'
                      description: ERROR
                      detail: Invalid operation
        '401':
          description: 未经授权。
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                    description: 回复的补充信息。
                  code:
                    type: string
                    description: 状态码。
                  messages:
                    type: array
                    description: 消息列表。
                    items:
                      type: object
                      properties:
                        token_class:
                          type: string
                          description: Token 类。
                        token_type:
                          type: string
                          description: 令牌类型。
                        message:
                          type: string
                          description: 包含补充信息的消息。
                x-examples:
                  Example 1:
                    detail: Given token not valid for any token type
                    code: token_not_valid
                    messages:
                      - token_class: AccessToken
                        token_type: access
                        message: Token is invalid or expired
              examples:
                401 - Token is invalid or expired:
                  value:
                    detail: Given token not valid for any token type
                    code: token_not_valid
                    messages:
                      - token_class: AccessToken
                        token_type: access
                        message: Token is invalid or expired
        '404':
          description: 未找到
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: object
                    title: 状态
                    description: 操作状态。
                    properties:
                      code:
                        type: string
                        description: '[状态码](/zh/reference/transaction-status-error-codes)。'
                      description:
                        type: string
                        description: '[状态描述](/zh/reference/transaction-status-error-codes)。'
                      detail:
                        type: string
                        description: 更多状态信息。
                x-examples:
                  Example 1:
                    status:
                      code: '404'
                      description: ERROR
                      detail: Subscription not found
              examples:
                404 - Subscription not found:
                  value:
                    status:
                      code: '404'
                      description: ERROR
                      detail: Subscription not found
      security:
        - token: []
      servers:
        - url: https://api.stage.localpayment.com
          description: Stage
components:
  securitySchemes:
    token:
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.