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

# Update subscription payment method

> Updates the payment method for a subscription contract by refreshing payment instrument from Shopify customer. This endpoint syncs the subscription's payment method with the customer's default payment method in Shopify.

**Payment Method Update Process:**
- **Fetch Latest Payment**: Retrieves customer's current default payment method from Shopify
- **Update Contract**: Associates new payment method with subscription contract
- **Validate Payment**: Ensures payment method is valid and active
- **Sync Changes**: Updates payment instrument in subscription billing system

**Key Features:**
- **Automatic Sync**: Pulls latest payment method from Shopify customer record
- **Payment Validation**: Verifies new payment method is usable for billing
- **Contract Update**: Updates Shopify subscription contract with new payment
- **Failed Billing Recovery**: Useful for updating payment after billing failures

**Use Cases:**
- Customer updates credit card and wants to apply to existing subscription
- Recover from failed billing by allowing payment method update
- Sync payment methods in customer portal workflows
- Update expired or invalid payment methods
- Switch between multiple saved payment methods
- Integration with custom payment update flows

**Important Notes:**
- Customer must have a default payment method in Shopify
- Payment method must be valid and not expired
- Updates are reflected immediately for future billing
- Does not retry failed billing attempts automatically

**Authentication:** Requires API key authentication via X-API-Key header or api_key parameter



## OpenAPI

````yaml /memberships/admin-api-swagger.json put /api/external/v2/subscription-contracts-update-payment-method
openapi: 3.0.1
info:
  description: >-
    Comprehensive API documentation for managing memberships, payments, and
    related operations. These APIs allow you to programmatically manage
    membership lifecycles, handle payments, configure products, and integrate
    membership functionality into your applications.
  title: Admin APIs
  version: 0.0.1
servers:
  - url: https://membership-admin.appstle.com
security: []
tags:
  - description: >-
      APIs for managing Shopify delivery profiles, shipping rates, zones, and
      free shipping configuration for subscription memberships
    name: Shipping & Delivery Profiles
  - description: >-
      APIs for retrieving historical discount code usage and redemption
      information for membership contracts
    name: Customer Discount History
  - description: >-
      APIs for managing membership cancellation flow settings including
      retention offers, survey questions, and cancel confirmation screens
    name: Cancellation Flow Configuration
  - description: >-
      APIs for managing membership billing attempts, recurring orders, payment
      retries, order history, and order skipping
    name: Billing & Orders
  - description: >-
      APIs for managing one-time product additions to upcoming subscription
      orders, including adding, retrieving, and removing one-off items
    name: One-Time Add-Ons
  - description: >-
      APIs for managing membership/subscription plan groups, including creating
      plans, configuring discounts, billing intervals, and assigning products to
      plans
    name: Membership Plans
  - description: >-
      APIs for managing subscription product bundles, bundle configurations,
      item grouping, and bundle-specific discount codes
    name: Product Bundles
  - description: >-
      APIs for retrieving custom CSS styles applied to subscription widgets and
      customer portal for theme customization
    name: Custom CSS Styling
  - description: >-
      APIs for managing customer portal settings including UI customization,
      text labels, feature toggles, and branding options for the member
      self-service portal
    name: Customer Portal Configuration
  - description: >-
      APIs for managing membership/subscription contracts including creation,
      updates, status changes, line items, discounts, and billing operations
    name: Membership Contracts
  - description: >-
      APIs for managing subscription bundle configuration settings including
      bundle behavior, pricing rules, and display options
    name: Bundle Settings
  - description: >-
      APIs for managing customer payment methods, payment tokens, and payment
      method retrieval for subscriptions
    name: Customer Payment Methods
  - description: >-
      APIs for retrieving product swap/substitution options allowing members to
      exchange subscription items based on configured swap rules and variant
      groups
    name: Product Swap Rules
  - description: >-
      APIs for retrieving product catalog, variants, pricing, and inventory
      information for subscription memberships.
    name: Product & Inventory Data
  - description: >-
      APIs for managing shop-level membership settings, configuration, and
      general store information.
    name: Shop Settings
  - description: >-
      APIs for performing bulk/mass operations on multiple membership contracts
      including status updates, product replacements, and billing date changes.
    name: Bulk Operations
paths:
  /api/external/v2/subscription-contracts-update-payment-method:
    put:
      tags:
        - Membership Contracts
      summary: Update subscription payment method
      description: >-
        Updates the payment method for a subscription contract by refreshing
        payment instrument from Shopify customer. This endpoint syncs the
        subscription's payment method with the customer's default payment method
        in Shopify.


        **Payment Method Update Process:**

        - **Fetch Latest Payment**: Retrieves customer's current default payment
        method from Shopify

        - **Update Contract**: Associates new payment method with subscription
        contract

        - **Validate Payment**: Ensures payment method is valid and active

        - **Sync Changes**: Updates payment instrument in subscription billing
        system


        **Key Features:**

        - **Automatic Sync**: Pulls latest payment method from Shopify customer
        record

        - **Payment Validation**: Verifies new payment method is usable for
        billing

        - **Contract Update**: Updates Shopify subscription contract with new
        payment

        - **Failed Billing Recovery**: Useful for updating payment after billing
        failures


        **Use Cases:**

        - Customer updates credit card and wants to apply to existing
        subscription

        - Recover from failed billing by allowing payment method update

        - Sync payment methods in customer portal workflows

        - Update expired or invalid payment methods

        - Switch between multiple saved payment methods

        - Integration with custom payment update flows


        **Important Notes:**

        - Customer must have a default payment method in Shopify

        - Payment method must be valid and not expired

        - Updates are reflected immediately for future billing

        - Does not retry failed billing attempts automatically


        **Authentication:** Requires API key authentication via X-API-Key header
        or api_key parameter
      operationId: updatePaymentMethodV2
      parameters:
        - description: Subscription contract ID to update payment method for
          example: 123456789
          in: query
          name: contractId
          required: true
          schema:
            format: int64
            type: integer
        - description: API Key (Deprecated - Use Header X-API-Key instead)
          in: query
          name: api_key
          required: false
          schema:
            type: string
        - in: header
          name: X-API-Key
          required: false
          schema:
            type: string
      responses:
        '200':
          description: Payment method successfully updated for subscription
        '400':
          description: Invalid contract ID or no valid payment method found
        '401':
          description: Authentication required - invalid or missing API key
        '404':
          description: Subscription contract not found
        '500':
          description: Shopify API error during payment method update

````