Payment link for a plan of a number
https://api.app2email.com/v1/account/numbers/{number}/checkout A Stripe Checkout link for the person. Nothing is charged until they pay; the plan starts when Stripe confirms it. 409 plan_already_active for the plan the number has.
Path
-
A WhatsApp number of the account: country code first, digits only.
e.g.4976659348270
Body application/json required
-
A plan id from GET /v1/account/plans.
Responses
Fields
- success boolean
- request_id string
- number string
- plan object
- checkout_url string (uri)
Stripe Checkout. Give it to the person.
- expires_at string (date-time) | null
- test_mode boolean
true on app2email's test site (Stripe test mode).
- message string
Errors
- 400 The request is malformed (missing or invalid fields, query parameters or times).
- 401 Missing, invalid, revoked or expired API key.
- 403 The key is valid but this call is not allowed: the key lacks the scope the call needs (insufficient_scope), the address is not allowed for the key (ip_not_allowed), the number or plan does not allow it, a recipient opted out or is not opted in, or a problem with the WhatsApp account.
- 404 The number, template, message, broadcast, webhook, delivery, opt-in, logged request, booking or Flow was not found.
- 409 Idempotency-Key: the first request with this key is still running, or did not finish. Or a conflict: the template name exists, the webhook URL is used by another webhook, the broadcast cannot be cancelled, the booking slot is taken or the booking is already cancelled, or the Flow is not published.
- 415 The body is not JSON.
- 429 A monthly plan limit, the number's own monthly cap, the key's daily cap, a WhatsApp rate limit, the API rate limit (rate_limited), or the webhook test limit (too_many_tests) was reached. Retry-After and error.retry_after_seconds say how long to wait.
- 500 Unexpected error on app2email's side.
- 502 WhatsApp (Meta) returned an error or could not be reached.
- 503 app2email's connection to the WhatsApp account needs attention, or the request log is not available right now.