Phone Provisioning
Phone Provisioning

Checkout Number

Create a Paddle checkout session for buying a phone number.

Flow for trial users (no paid top-up yet):

  1. Validate the number is still available on Telnyx.
  2. Create a pending_number_purchases row (soft lock, 30 min TTL).
  3. Open Paddle checkout with custom_data = {intent: 'BUY_NUMBER', pending_id}.
  4. Webhook fires on payment → we order from Telnyx & bind to the user.

Paid users should just use /purchase directly — this endpoint is explicitly for the first-time/no-balance path.

post/v1/numbers/checkout

Request

  • Base URL: https://api.call2me.app
  • URL: https://api.call2me.app/v1/numbers/checkout
  • Auth: HTTP bearer

Request body

phone_numberstring required

E.164 format

agent_idstring nullable

Agent to bind after purchase

providerstring nullable

telnyx | twilio (auto by country if omitted)

Response

Successful Response

pending_idstring required
paddle_transaction_idstring required
upfront_usdnumber required
monthly_usdnumber required
expires_atstring required

Changes

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