The packages customers hold
https://api.app2email.com/v1/{number}/bookings/packages/purchases Scope: bookings:manage (or messages:read). Purchases and grants, newest first. status=live = active with sessions left.
Path
-
Your app2email WhatsApp number - the number the message is sent FROM. Full number with country code, digits only.
e.g.4976659348270
Query
- contact string
Only this customer's.
e.g.61412345678 - status string
live, or one status.
livependingactiveused_upexpiredrefundedcancelled -
How many (1 to 200, default 50).
Responses
Fields
- success boolean
- request_id string
- purchases object[]
13 item fields
- id integere.g.
5 - contact string
- contact_name string
- package_id string
- package_name string
- services string[]
- sessions_total integer
- sessions_used integer
- sessions_left integer
- expires string (date-time) | null
- status string
pendingactiveused_upexpiredrefundedcancelled - payment_id integer | null
- created string (date-time)
- count integer
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.
- 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.