One number
https://api.app2email.com/v1/partner/numbers/{number} Status, plan and features, messages used, current subscription.
Path
-
A number of one of your clients: country code first, digits only.
e.g.4976659348270
Responses
Fields
- success boolean
- request_id string
- number object
13 fields
- number string
- display_number string | null
- name string | null
- client_id string
- status string
live: LIVE on a plan with the API. pending_payment: no such plan. not_live: paused, expired or being connected.
livepending_paymentnot_live - service_status string | null
- plan string
- features string[] | null
The plan's features; null: app2email's own rules.
- api_allowed boolean
- plan_messages object
2 fields
- total_sent integer
- limit integer
- billing_period_end string (date-time) | null
- renewal_enabled boolean
- subscription object
17 fields
- id integer
- client_id string
- number string | null
- tier_id string
- tier_name string
- interval string
monthyearnone - messages_per_month integer
- price object
2 fields
- amount_minor integer
- currency string
- status string
Stripe's status: active, trialing, past_due, canceled ...
- source string
stripefreecomp - cancel_at_period_end boolean
- current_period_start string (date-time) | null
- current_period_end string (date-time) | null
- is_current boolean
- canceled_at string (date-time) | null
- ended_reason string | null
- test_mode boolean
Bought through Stripe's test mode (the test site).
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.
- 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.