v2

latestOpenAPI 3.0.12026-07-262352981007.0 KB
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
delete/subscriptions/{subscriptionId}/paymentmethods/{id}

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