billing
POST /v1/payment-methods/form-closures
Report that the customer closed the add-a-payment-method form.
Authentication
Send an API key as a bearer token. The key must carry the billing.payment.manage permission; a key without it is refused with 403, not 404.
Where your organisation id goes
This endpoint takes org_id as a field in the JSON body.
Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X POST https://api.zinndigital.com/v1/payment-methods/form-closures \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "submitted": <boolean> }'Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
The customer closed the payment form, and whether they ever pressed Save. A form closed with nothing submitted leaves the gateway's setup in the same state as a form that silently broke, so only the browser can tell the two apart. When a card-required trial funnel is open for the organization it is told, and a close with nothing submitted is recorded as the outcome closed_card_form instead of alerting the operator with "card stuck". A form that broke in the browser is reported separately (reportPaymentFormFailure). Requires billing.payment.manage in the target organization. Nothing is charged or stored.
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
org_id | string | No | Organization the form was adding a method to. Defaults to the caller's own; the caller must hold billing.payment.manage there. |
submitted | boolean | Yes | Whether the customer pressed Save (or started a PayPal approval) at least once before closing the form. |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
recorded | boolean | Yes | Always true — the close was logged. |
funnel_signalled | boolean | Yes | Whether a card-required trial funnel was open for this organization and was told. |
Errors this endpoint can return
401 · 403 · 422 · 429