SMsmokeball
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
  • For a usage subscription that doesn't exist yet, the payment method is kept and set as its default when it is created
put/subscriptions/{subscriptionId}/paymentmethods

Request

  • Base URL
    https://api.smokeball.com
  • URL
    https://api.smokeball.com/subscriptions/{subscriptionId}/paymentmethods
  • Auth
    API key in header x-api-key and API key in header Authorization

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

Changes

No recorded changes to this operation across all 15 revisions of this API.