Sign in

v2

latestOpenAPI 3.0.12026-07-262352981007.0 KB
Subscription Payments

Set default payment method

Sets or clears the default payment method on a subscription. The update is processed asynchronously.

Important considerations:

  • Omitting the payment method id clears the subscription's default payment method
  • Usage subscriptions must always have a default payment method, so clearing is not allowed for them
put/subscriptions/{subscriptionId}/paymentmethods

Path parameters

subscriptionIdstring required

The unique identifier of the subscription

Request body

paymentMethodIdstring uuid nullable

Public payment method id. Null clears the subscription override which reverts behavior to the Customer's default.

subscriptionType0 | 1

Response

When request is accepted. Returns a 'Link' object to the payment method, or to the subscription when clearing.

idstring nullable
hrefstring nullable
relationstring nullable
methodstring nullable