Skip to main content
PUT
/
api
/
external
/
v2
/
subscription-contracts-update-existing-payment-method
Update subscription payment method
curl --request PUT \
  --url https://subscription-admin.appstle.com/api/external/v2/subscription-contracts-update-existing-payment-method \
  --header 'X-API-Key: <x-api-key>'
{
  "message": "Payment method updated successfully"
}

Documentation Index

Fetch the complete documentation index at: https://appstleinc-aeca3e0a.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
X-API-Key
string
required

API Key for authentication

Query Parameters

​
contractId
integer<int64>
required

Subscription contract ID to update payment method for. Must be a valid contract ID that belongs to the authenticated shop.

Required range: x >= 1
​
paymentMethodId
string
required

ID of the existing customer payment method to use. Must be a valid Shopify GraphQL payment method ID in the format 'gid://shopify/CustomerPaymentMethod/{id}'. The payment method must:

  • Already exist in the customer's Shopify account
  • Be in a valid state (not expired or revoked)
  • Be authorized for subscription use

You can retrieve available payment methods using the customer payment methods endpoint.

Pattern: ^gid://shopify/CustomerPaymentMethod/[a-zA-Z0-9]+$

Response

Payment method updated successfully