API ReferencePayment Methods

Update Payment Method

View as Markdown

Update a payment method (name, active flag, or meta).

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

payment_method_idstringRequired
Payment method ID
account_idstringRequired

Request

This endpoint expects an object.
namestring or nullOptional
is_activeboolean or nullOptional
metadatamap from strings to any or nullOptional

Response

Successful Response
idstring
account_idstring
customer_idstring or null
provider_typeenum
Type of payment method.
Allowed values:
namestring
is_activeboolean
metadatamap from strings to any or null
created_atdatetime
updated_atdatetime
used_in_subscriptionboolean or nullDefaults to false

Errors