Skip to content
/Customer Payment Methods

External (0.0.1)

Download OpenAPI description
admin-api-swagger.json
admin-api-swagger.yaml
Languages
Servers
https://membership-admin.appstle.com

Shipping & Delivery Profiles

APIs for managing Shopify delivery profiles, shipping rates, zones, and free shipping configuration for subscription memberships

Operations

Customer Discount History

APIs for retrieving historical discount code usage and redemption information for membership contracts

Operations

Cancellation Flow Configuration

APIs for managing membership cancellation flow settings including retention offers, survey questions, and cancel confirmation screens

Operations

Billing & Orders

APIs for managing membership billing attempts, recurring orders, payment retries, order history, and order skipping

Operations

One-Time Add-Ons

APIs for managing one-time product additions to upcoming subscription orders, including adding, retrieving, and removing one-off items

Operations

Membership Plans

APIs for managing membership/subscription plan groups, including creating plans, configuring discounts, billing intervals, and assigning products to plans

Operations

Product Bundles

APIs for managing subscription product bundles, bundle configurations, item grouping, and bundle-specific discount codes

Operations

Custom CSS Styling

APIs for retrieving custom CSS styles applied to subscription widgets and customer portal for theme customization

Operations

Customer Portal Configuration

APIs for managing customer portal settings including UI customization, text labels, feature toggles, and branding options for the member self-service portal

Operations

Membership Contracts

APIs for managing membership/subscription contracts including creation, updates, status changes, line items, discounts, and billing operations

Operations

Bundle Settings

APIs for managing subscription bundle configuration settings including bundle behavior, pricing rules, and display options

Operations

Customer Payment Methods

APIs for managing customer payment methods, payment tokens, and payment method retrieval for subscriptions

Operations

Get customer payment token information

Request

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

Path
customerIdinteger(int64)required

Shopify customer ID

Example: 123456789
Query
api_keystring

API Key (Deprecated - Use Header X-API-Key instead)

Headers
X-API-Keystring

API Key for authentication (Preferred method - use this instead of api_key parameter)

curl -i -X GET \
  'https://membership-admin.appstle.com/api/external/v2/customer-payments/token/123456789?api_key=string' \
  -H 'X-API-Key: string'

Responses

Customer payment token information successfully retrieved

Bodyapplication/json
customerIdinteger(int64)
tokenstring
Response
application/json
{
  "customerId": 0,
  "token": "string"
}

Product Swap Rules

APIs for retrieving product swap/substitution options allowing members to exchange subscription items based on configured swap rules and variant groups

Operations

Subscription Contract Management

Operations

Subscription Billing

Operations

Billing Attempts

Operations