SCscanopy
internal

Finalize payment method

Changed on

Sets the card from a client-confirmed SetupIntent as the default.

post/api/billing/finalize-payment-method

Request

  • Base URL
    https://app.scanopy.net
  • URL
    https://app.scanopy.net/api/billing/finalize-payment-method
  • Auth
    • API key in header Authorization
    • or API key in cookie session_id

Request body

setup_intent_idstring required

Stripe SetupIntent to attach as the organization's payment method.

Response

Payment method finalized

dataTupleUnit

No payload. Present only so the envelope keeps its shape.

errorstring nullable

Not sent on a successful response. Failure messages arrive in an ApiErrorResponse.

successboolean required

Always true on a successful response.

Example response

{
  "meta": {
    "api_version": 1,
    "server_version": "0.19.4"
  }
}

Changes