> ## 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.

# Get customer payment token information

> Retrieves payment method token information for a specific customer. This endpoint returns the customer's stored payment tokens used for recurring subscription billing.

**Key Information Returned:**
- **Customer ID**: Shopify customer identifier
- **Payment Tokens**: List of stored payment method tokens
- **Payment Method Details**: Last 4 digits, card type, expiration
- **Default Payment Method**: Primary payment method for subscriptions
- **Token Status**: Active, expired, or failed payment methods
- **Payment Gateway**: Stripe, Shopify Payments, etc.

**Payment Token Information:**
- **Token ID**: Unique identifier for the payment method
- **Card Brand**: Visa, Mastercard, Amex, etc.
- **Last 4 Digits**: Masked card number ending
- **Expiry Date**: Card expiration month and year
- **Billing Address**: Associated billing address details
- **Created Date**: When payment method was added

**Use Cases:**
- Display saved payment methods in customer portal
- Validate payment method availability before billing
- Allow customers to select from existing payment methods
- Sync payment data with external CRM or billing systems
- Build custom payment management interfaces
- Trigger payment update reminders for expiring cards

**Security Note:** This endpoint only returns tokenized payment information. Full card numbers are never exposed via the API.

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



## OpenAPI

````yaml /memberships/admin-api-swagger.json get /api/external/v2/customer-payments/token/{customerId}
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/customer-payments/token/{customerId}:
    get:
      tags:
        - Customer Payment Methods
      summary: Get customer payment token information
      description: >-
        Retrieves payment method token information for a specific customer. This
        endpoint returns the customer's stored payment tokens used for recurring
        subscription billing.


        **Key Information Returned:**

        - **Customer ID**: Shopify customer identifier

        - **Payment Tokens**: List of stored payment method tokens

        - **Payment Method Details**: Last 4 digits, card type, expiration

        - **Default Payment Method**: Primary payment method for subscriptions

        - **Token Status**: Active, expired, or failed payment methods

        - **Payment Gateway**: Stripe, Shopify Payments, etc.


        **Payment Token Information:**

        - **Token ID**: Unique identifier for the payment method

        - **Card Brand**: Visa, Mastercard, Amex, etc.

        - **Last 4 Digits**: Masked card number ending

        - **Expiry Date**: Card expiration month and year

        - **Billing Address**: Associated billing address details

        - **Created Date**: When payment method was added


        **Use Cases:**

        - Display saved payment methods in customer portal

        - Validate payment method availability before billing

        - Allow customers to select from existing payment methods

        - Sync payment data with external CRM or billing systems

        - Build custom payment management interfaces

        - Trigger payment update reminders for expiring cards


        **Security Note:** This endpoint only returns tokenized payment
        information. Full card numbers are never exposed via the API.


        **Authentication:** Requires API key authentication via X-API-Key header
        or api_key parameter
      operationId: getCustomerTokenV2
      parameters:
        - description: Shopify customer ID
          example: 123456789
          in: path
          name: customerId
          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
        - description: >-
            API Key for authentication (Preferred method - use this instead of
            api_key parameter)
          in: header
          name: X-API-Key
          required: false
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerTokenInfo'
          description: Customer payment token information successfully retrieved
        '401':
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/CustomerTokenInfo'
          description: Authentication required - invalid or missing API key
        '403':
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/CustomerTokenInfo'
          description: Access forbidden - customer does not belong to authenticated shop
        '404':
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/CustomerTokenInfo'
          description: Customer not found or has no payment methods
components:
  schemas:
    CustomerTokenInfo:
      properties:
        customerId:
          format: int64
          type: integer
        token:
          type: string
      type: object

````