Signup

Accept terms and/or confirm a prepaid agent-card PaymentIntent

Only available when agent card pay is available for the signup session. Record terms acceptance, confirm the prepaid first-period PaymentIntent with a Stripe payment method id, or both in one call. tos_accepted must be true (here or on the original start_signup call) before this PaymentIntent can be confirmed. A call with tos_accepted and no payment_method records acceptance and returns the confirmable PaymentIntent state without confirming. Never send card numbers to this endpoint. Create the payment method with Stripe, then POST only the pm_ id. Confirm attempts are capped at 3 per signup session in a 24 hour window; exceeding that cancels the PaymentIntent. Browser Checkout remains available at checkout_redirect_url if agent-card pay is not used.

post/api/v1/signup/sessions/{session_id}/pay

Request

  • Base URL: https://www.poster.ly
  • URL: https://www.poster.ly/api/v1/signup/sessions/{session_id}/pay
  • Auth: none required

Path parameters

session_idstring required

Stripe checkout session ID returned by POST /api/v1/signup.

Request body

tos_acceptedboolean

Set true only after the user has explicitly confirmed they accept the posterly terms at https://www.poster.ly/terms. Required (here or on the original start_signup call) before payment_method can be confirmed.

payment_methodstring

Optional Stripe payment method id. Must start with pm_. Omit to record terms acceptance or check status without confirming.

Example request

{
  "payment_method": "pm_test_123"
}

Response

PaymentIntent confirmation or confirmable state

statusstring
payment_intent_idstring
payment_requiredboolean
client_secretstring nullable
publishable_keystring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.