Skip to main content
POST
Set default payment method

Authorizations

Authorization
string
header
required

OAuth 2.1 authorization code + PKCE (S256). Tokens are tenant-bound (company_id) and scoped. Discover endpoints via /.well-known/oauth-authorization-server.

Body

application/json

Request body for setting the company's default payment method. The route reads only paymentMethodId; companyId is overwritten with the token tenant before reaching the use-case.

paymentMethodId
string
required

Stripe PaymentMethod id (pm_...) to set as the company's default. Must belong to the token tenant's Stripe customer. The companyId is taken from the token and may not be set by the client.

Response

Default payment method set; subscriptions and open auto-charge invoices synced to it.

data
object
required

Result of setting the default payment method and syncing subscriptions + open invoices.