SMsmokeball
Subscription Payments

Remove payment method

Removes a payment method from a subscription.

Important notes:

  • Can optionally specify a new default payment method
  • Removing default without replacement may cause subscription to go OVERDUE
  • For a usage subscription that doesn't exist yet, a payment method kept for it is no longer used when it is created
delete/subscriptions/{subscriptionId}/paymentmethods/{id}

Request

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

Path parameters

subscriptionIdstring required

The unique identifier of the subscription

idstring uuid required

The ID of the payment method to remove

Request body

newDefaultPaymentMethodIdstring nullable

Optional ID of payment method to set as new default.

Response

When request is accepted. Returns a 'Link' object.

idstring nullable
hrefstring nullable
relationstring nullable
methodstring nullable

Changes

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