Billing

Settle a saved card

Changed on

Called right after stripe.confirmSetup succeeds. Settles the card the SetupIntent saved and reports whether it was saved, refused, or held. Settlement runs once: a card tied to fraud, or a second card the bank did not verify when it was asked to, puts the account on hold (held, ACCOUNT_PENDING_VERIFICATION); a card the bank did not verify is removed (refused, CARD_NOT_VERIFIED); any other card becomes the account's default (saved). Calling it again, or after the Stripe webhook settled the card, answers the same outcome and changes nothing.

Requires the billing.manage permission. See Permissions for the roles and API key permissions that include it.

post/v1/orgs/{orgId}/billing/setup-intent/{setupIntentId}/complete

Request

  • Base URL
    https://api.openrelay.inc
  • URL
    https://api.openrelay.inc/v1/orgs/{orgId}/billing/setup-intent/{setupIntentId}/complete
  • Auth
    HTTP bearer

Path parameters

orgIdstring required
setupIntentIdstring required

Response

How the card was settled

code'CARD_NOT_VERIFIED' | 'ACCOUNT_PENDING_VERIFICATION'

Why the card was not kept. Absent for a saved card.

messagestring required

What to show the customer.

status'saved' | 'refused' | 'held' required

saved: the card is the account's default. refused: the card was removed; add a different one. held: the card was removed and the account is on a verification hold.

Changes

  • 7fe59d94a9f5Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 12b2fcbcc298Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status