API ReferenceSubscriptions

Update payment method

Send the customer to update the payment method behind a subscription.

A payment method belongs to the customer, and a store token requests the update on their behalf. Capabilities report update_payment_method as customer_only, but the request is still accepted from a store token. The customer enters the new card themselves, so the recorded action stays pending and redirect_url points to the page where they do it:

Payment methodWhere the customer updates the cardreturn_url
StripeStripe's hosted pageWhere Stripe sends the customer afterwards. Defaults to the store's customer portal page for the subscription.
RazorpayA SellApp page for the subscriptionIgnored.
PayPalNot supported. Returns 422.—
Billed in house (internal)Not supported. Returns 422.—

Read update_payment_method in the capabilities response before calling. While a payment is still owed, only a Razorpay subscription accepts the update; see Failed payments.

POST
/v2/subscriptions/{productSubscription}/actions/update-payment-method

Authorization

AuthorizationBearer <token>

Provide your SellApp API key as a bearer token.

In: header

Path Parameters

productSubscription*integer

The productSubscription path parameter.

Header Parameters

Idempotency-Key?string

A caller-generated key, unique per store and subscription lifecycle request. Sending it here is the same as sending idempotency_key in the body.

Lengthlength <= 128
Idempotency-Key?string

Caller-generated key for safely retrying this operation. The JSON idempotency_key field is also accepted; when both are sent, the header takes precedence.

Lengthlength <= 128
X-STORE?string

Store slug. Required for OAuth access tokens. API keys may omit it to use their current store, or the first accessible store when no current store is selected.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://sell.app/api/v2/subscriptions/55/actions/update-payment-method" \  -H "X-STORE: launch-lab" \  -H "Content-Type: application/json" \  -d '{    "return_url": "https://store.example.com/billing/updated"  }'
{
  "data": {
    "id": 101,
    "product_subscription_id": 55,
    "subscription_id": "sub_1QwertyExample",
    "action": "update_payment_method",
    "status": "pending",
    "provider": "stripe",
    "proration_order_id": null,
    "error": null,
    "customer_message": null,
    "confirmed_at": null,
    "failed_at": null,
    "created_at": "2026-07-03T12:00:00.000000Z",
    "updated_at": "2026-07-03T12:00:00.000000Z"
  },
  "message": "Subscription payment method update requested.",
  "redirect_url": "https://billing.stripe.com/p/session/live_YWNjdF9FeGFtcGxl"
}
{
  "type": "invalid_request_error",
  "code": "bad_request",
  "message": "The request could not be understood.",
  "status": 400,
  "param": null,
  "request_id": "01992a65-e064-71ba-b38f-902b7966a6be",
  "docs_url": "https://sell.app/docs/api/errors#bad-request"
}
{
  "type": "authentication_error",
  "code": "unauthenticated",
  "message": "Unauthenticated.",
  "status": 401,
  "param": null,
  "request_id": "01992a65-e064-71ba-b38f-902b7966a6be",
  "docs_url": "https://sell.app/docs/api/errors#unauthenticated"
}
{
  "type": "authorization_error",
  "code": "forbidden",
  "message": "This action is unauthorized.",
  "status": 403,
  "param": null,
  "request_id": "01992a65-e064-71ba-b38f-902b7966a6be",
  "docs_url": "https://sell.app/docs/api/errors#forbidden"
}
{
  "type": "not_found_error",
  "code": "resource_not_found",
  "message": "Not Found.",
  "status": 404,
  "param": null,
  "request_id": "01992a65-e064-71ba-b38f-902b7966a6be",
  "docs_url": "https://sell.app/docs/api/errors#resource-not-found"
}
{
  "type": "validation_error",
  "code": "validation_failed",
  "message": "The selected product variant id is invalid.",
  "status": 422,
  "param": "product_variant_id",
  "request_id": "01992a65-e064-71ba-b38f-902b7966a6be",
  "docs_url": "https://sell.app/docs/api/errors#validation-failed",
  "errors": {
    "product_variant_id": [
      "The selected product variant id is invalid."
    ]
  }
}
{
  "type": "rate_limit_error",
  "code": "rate_limit_exceeded",
  "message": "Too Many Attempts.",
  "status": 429,
  "param": null,
  "request_id": "01992a65-e064-71ba-b38f-902b7966a6be",
  "docs_url": "https://sell.app/docs/api/errors#rate-limit-exceeded"
}
{
  "type": "api_error",
  "code": "api_error",
  "message": "Server Error",
  "status": 500,
  "param": null,
  "request_id": "01992a65-e064-71ba-b38f-902b7966a6be",
  "docs_url": "https://sell.app/docs/api/errors#api-error"
}