Skip to main content
PUT
Update billing details

Authorizations

x-conveyour-token
string
header
required

Your API key token. Contacts endpoints require a Server-only — Full API key — see Authentication.

Query Parameters

teams[]
string[]

Team scope for the request, as one or more team ObjectIds. The brackets are required: PHP keeps only the last value for a repeated plain key, so teams=A&teams=B silently resolves to B alone. On requests with a JSON body you may send teams (no brackets) in the body instead.

Values that are not valid ObjectIds are silently ignored — a mistyped team ID behaves as if no team was sent. See the teams section of the API conventions guide.

Body

application/json
billing_action
string
required

The billing action to perform (e.g. setup, attach, or authenticate a payment method). Determines which other fields are required.

payment_method_id
string

Stripe payment method ID. Required when attaching a payment method.

payment_intent_id
string

Stripe payment intent ID. Used when authenticating a payment intent.

invoice_id
string

Stripe invoice ID to pay after attaching the payment method.

Response

Success.

The common response envelope shared by all ConveYour endpoints.

status
enum<string>

ok on success, failed on error.

Available options:
ok,
failed
message
string

Human-readable description of the result.

data
object

Result of a card update. Each value falls back to an empty string when the billing provider did not return it.