Endpoint referenceBilling and Checkouts

Set Default Payment Method

Set a saved payment method as the organization default by payment_method_id. Use this after listing billing overview or adding a new payment method.

Authorization

BearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

payment_method_id*string

Opaque saved payment method reference returned by the billing overview. Do not parse provider details from this value.

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

curl -X POST "https://example.com/api/v1/billing/payment-methods/payment_method_docs_invalid/default"

{  "success": true,  "message": "Default payment method updated."}

Was this page helpful?

Delete Payment Method

Delete Payment Method. Remove a saved payment method by payment_method_id when billing rules allow it. The response confirms removal or explains why the method must remain available.

Create Payment Method Management Session

Create Payment Method Management Session. Create a hosted payment method management session for a saved payment method by payment_method_id when external management is required. The response returns a redirect_url when available.