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

# Update Subscription Payment Method

> Update the payment method for a subscription using a saved payment token

<Warning>
  This endpoint is currently shown as a preview of what's currently in development and is subject to change.
</Warning>

<Info>
  This endpoint supports only the official [WooCommerce Subscriptions](https://woocommerce.com/products/woocommerce-subscriptions/) extension.
</Info>


## OpenAPI

````yaml api-reference/pre-release/openapi-spec-preview.yaml post /my-account/subscriptions/{id}/payment-method
openapi: 3.0.3
info:
  title: CoCart Preview API
  description: >
    CoCart Preview provides enhanced REST API endpoints for WooCommerce headless
    e-commerce solutions.

    This API extends CoCart with additional functionality for checkout, customer
    account management, and order handling.


    ## Authentication


    The API supports multiple authentication methods:

    - **Cart Key**: For guest customers, pass the cart key via `Cart-Key` header
    or `cart_key` parameter

    - **Basic Auth**: For registered customers using username/password

    - **JWT**: For registered customers using JWT tokens (requires JWT plugin)

    - **Session**: For logged-in WordPress users


    ## Base URL


    All API endpoints are prefixed with `/wp-json/cocart/preview/`


    ## Response Format


    All responses follow the CoCart standard format with consistent error
    handling and data structure.
  termsOfService: http://cocartapi.com/terms-of-conditions-polar/
  contact:
    email: support@cocartapi.com
  license:
    name: GNU General Public License v3.0
    url: http://www.gnu.org/licenses/gpl-3.0.html
  version: 0.0.1
servers:
  - url: '{protocol}://{host}/wp-json/cocart/preview'
    description: API Preview
    variables:
      protocol:
        enum:
          - http
          - https
        default: https
      host:
        default: example-store.com
        description: Your store domain
security: []
tags:
  - name: Checkout
    description: Complete checkout process including payment and order creation
  - name: My Account
    description: Customer account information and profile management
  - name: My Orders
    description: Customer order history and details
  - name: My Downloads
    description: Customer digital downloads
  - name: My Subscriptions
    description: Customer subscription management
externalDocs:
  description: Find out more about CoCart API
  url: https://docs.cocartapi.com
paths:
  /my-account/subscriptions/{id}/payment-method:
    post:
      tags:
        - Subscriptions
      summary: Update subscription payment method
      description: Update the payment method for a subscription using a saved payment token
      operationId: updateSubscriptionPaymentMethod
      parameters:
        - name: id
          in: path
          description: Subscription ID
          required: true
          schema:
            type: integer
      requestBody:
        required: true
        description: Payment method details
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubscriptionPaymentMethodRequest'
      responses:
        '200':
          description: Payment method updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionActionResponse'
        '400':
          description: Bad request - invalid payment method or token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden - cannot update payment method
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Subscription not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - basicAuth: []
        - bearerAuth: []
components:
  schemas:
    SubscriptionPaymentMethodRequest:
      type: object
      required:
        - payment_method
      properties:
        payment_method:
          type: string
          description: Payment gateway ID
          example: stripe
        token_id:
          type: integer
          description: Payment token ID (for saved payment methods)
    SubscriptionActionResponse:
      type: object
      properties:
        subscription_id:
          type: integer
          description: Subscription ID
        subscription_status:
          type: string
          description: Current subscription status
        requires_payment:
          type: boolean
          description: Whether payment is required
        payment_processed:
          type: boolean
          description: Whether payment was processed
        payment_method:
          type: string
          description: Payment method display name
        is_manual:
          type: string
          enum:
            - 'true'
            - 'false'
          description: Whether subscription is manual renewal
        payment_token:
          $ref: '#/components/schemas/PaymentToken'
        available_tokens:
          type: array
          items:
            $ref: '#/components/schemas/PaymentToken'
          description: Available payment tokens for the customer
        can_use_token:
          type: boolean
          description: Whether saved tokens can be used
        checkout_url:
          type: string
          format: uri
          description: Checkout API URL for payment
        order_id:
          type: integer
          description: Order ID requiring payment
        order_key:
          type: string
          description: Order key for payment
        order_total:
          type: string
          description: Order total amount
        message:
          type: string
          description: Action result message
    Error:
      type: object
      required:
        - code
        - message
      properties:
        code:
          type: string
          description: Error code identifier
        message:
          type: string
          description: Human-readable error message
        data:
          type: object
          description: Additional error data
          properties:
            status:
              type: integer
              description: HTTP status code
    PaymentToken:
      type: object
      properties:
        id:
          type: integer
          description: Payment token ID
        token:
          type: string
          description: Token display name (e.g., "Visa ending in 4242")
        type:
          type: string
          enum:
            - cc
            - echeck
          description: Token type
        gateway_id:
          type: string
          description: Payment gateway ID
        is_default:
          type: boolean
          description: Whether this is the default payment method
        expires:
          type: string
          nullable: true
          description: Expiration date (MM/YYYY format)
          example: 12/2025
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: WordPress username and password
    bearerAuth:
      type: http
      scheme: bearer
      description: Bearer authentication with JWT token
      bearerFormat: JWT

````