API reference

Application Manager

Operate retail sub-accounts: provisioning, credit and routing.

24 operationsBase URL https://packetexchange.io/api/v1Postman collection

BrowseApplication Manager

Get reseller analytics across your sub-accounts

GET/api/v1/application/analytics

Access: API key. Scoped keys need application:write.
Rate limit: 100 requests per second (the default)

Headline totals and quality, a daily series, per-sub-account margin and top destinations. Figures are JSON numbers (analytics rollups, not ledger entries).

Parameters

Name	In	Type	Description
`days`	query	integer	Trailing window in days (default 30)

Response 200

Field	Type	Description
`data`required	object	-
`period`requireddata.period	object	-
`days`requireddata.period.days	integer	-
`summary`requireddata.summary	object	-
`calls`requireddata.summary.calls	integer	-
`sms`requireddata.summary.sms	integer	-
`minutes`requireddata.summary.minutes	integer	-
`revenue`requireddata.summary.revenue	number	USD, JSON number (analytics rollup)
`margin`requireddata.summary.margin	number	USD, JSON number (analytics rollup)
`asr`requireddata.summary.asr	number \| null	Answer rate percent over customer sessions; null with no calls
`acd`requireddata.summary.acd	number	-
`carrierCost`requireddata.summary.carrierCost	number	-
`activeSubs`requireddata.summary.activeSubs	integer	-
`timeseries`requireddata.timeseries	object[]	-
`date`requireddata.timeseries[].date	string	YYYY-MM-DD
`calls`requireddata.timeseries[].calls	integer	-
`sms`requireddata.timeseries[].sms	integer	-
`revenue`requireddata.timeseries[].revenue	number	-
`margin`requireddata.timeseries[].margin	number	-
`bySubAccount`requireddata.bySubAccount	object[]	-
`byRoute`requireddata.byRoute	object[]	-

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

Get your Application Manager settings

GET/api/v1/application/settings

Access: API key. Scoped keys need application:write.
Rate limit: 100 requests per second (the default)

Created with defaults on first read.

Response 200

Field	Type	Description
`data`required	object	-
`operatorId`requireddata.operatorId	string (uuid)	-
`defaultMarkupPct`requireddata.defaultMarkupPct	string	-
`defaultBillingIncrement`requireddata.defaultBillingIncrement	string	-
`minMarginPct`requireddata.minMarginPct	string	-
`subLowBalanceThreshold`requireddata.subLowBalanceThreshold	string	"0.00" disables low-balance alerts
`defaultDailySpendCap`requireddata.defaultDailySpendCap	string \| null	US dollars as a decimal string with 2 decimal places, e.g. "50.00"
`defaultMaxConcurrentCalls`requireddata.defaultMaxConcurrentCalls	integer \| null	-
`brandName`requireddata.brandName	string \| null	-
`brandColor`requireddata.brandColor	string \| null	-
`brandLogoUrl`requireddata.brandLogoUrl	string \| null	-
`requireTrunkApproval`requireddata.requireTrunkApproval	boolean	-
`requireTrunkReadiness`requireddata.requireTrunkReadiness	boolean	-

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

Update your Application Manager settings

PUT/api/v1/application/settings

Access: API key. Scoped keys need application:write.
Rate limit: 100 requests per second (the default)

Default markup, low-balance threshold, default fraud caps and portal branding. Send only what changes.

Request body (application/json)

Field	Type	Description
`defaultMarkupPct`	number	-0 to 100000
`subLowBalanceThreshold`	number	-0 to 1000000
`defaultDailySpendCap`	number \| null	-0 to 1000000
`defaultMaxConcurrentCalls`	integer \| null	-0 to 100000
`brandName`	string \| null	-max 120 chars
`brandColor`	string \| null	-max 9 chars
`brandLogoUrl`	string (uri) \| null	-max 500 chars

Response 200

Field	Type	Description
`data`required	object	Same fields as ApplicationSettings, shown earlier on this page.

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
409CONFLICT (or a code-specific 409): the change clashes with existing state.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

HTTP

curl -X PUT "https://packetexchange.io/api/v1/application/settings" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "defaultMarkupPct": 1,
  "subLowBalanceThreshold": 1
}'

Run it here with a test key.

Get sub-account totals

GET/api/v1/application/overview

Access: API key. Scoped keys need application:write.
Rate limit: 100 requests per second (the default)

Response 200

Field	Type	Description
`data`required	object	-
`subCount`requireddata.subCount	integer	-
`activeSubCount`requireddata.activeSubCount	integer	-
`aggregateBalance`requireddata.aggregateBalance	number	Sum of sub-account balances, USD as a JSON number

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

List your sub-accounts

GET/api/v1/application/sub-accounts

Access: API key. Scoped keys need application:write.
Rate limit: 100 requests per second (the default)

Newest first, cursor-paginated and searchable by label or external reference. total counts every match.

Parameters

Name	In	Type	Description
`cursor`	query	string (uuid)	-
`limit`	query	integer	Default 50
`search`	query	string	-
`status`	query	string	-One of draft, active, suspended, closed
`lowBalanceOnly`	query	string	-One of true, 1

Response 200

Field	Type	Description
`data`required	object[]	-
`id`requireddata[].id	string (uuid)	-
`label`requireddata[].label	string	-
`externalRef`requireddata[].externalRef	string \| null	-
`balance`requireddata[].balance	money	USD as a decimal string with exactly 6 places, e.g. "0.012500".
`status`requireddata[].status	string	-One of `draft`, `active`, `suspended`, `closed`
`markupPct`requireddata[].markupPct	string \| null	Markup percent as a 3-decimal string; null = operator default
`dailySpendCap`requireddata[].dailySpendCap	string \| null	null = operator default; "0.00" = unlimited
`maxConcurrentCalls`requireddata[].maxConcurrentCalls	integer \| null	-
`creditLimit`requireddata[].creditLimit	string	Postpaid credit, "0.00" = strict prepaid
`currency`requireddata[].currency	string	Display currency for statementsmax 3 chars
`portalEmail`requireddata[].portalEmail	string \| null	-
`autoSuspended`requireddata[].autoSuspended	boolean	Suspended automatically by a daily cap, lifts itself
`sipUsername`requireddata[].sipUsername	string \| null	-
`createdAt`requireddata[].createdAt	string (date-time)	ISO-8601 timestamp (UTC)
`updatedAt`requireddata[].updatedAt	string (date-time)	ISO-8601 timestamp (UTC)
`lowBalance`requireddata[].lowBalance	boolean	-
`nextCursor`	string \| null	-
`hasMore`	boolean	-
`total`	integer	-
`lowBalanceThreshold`	number	-

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

Create a sub-account

POST/api/v1/application/sub-accounts

Access: API key. Scoped keys need application:write.
Rate limit: 100 requests per second (the default)

Provisions its SIP credentials and one API key, both returned ONCE. Requires an active route purchase or an active route of your own.

Request body (application/json)

Field	Type	Description
`label`required	string	-max 255 chars
`externalRef`	string \| null	-max 10000 chars
`markupPct`	number \| null	-0 to 100000
`dailySpendCap`	number \| null	-0 to 1000000
`maxConcurrentCalls`	integer \| null	-0 to 100000
`creditLimit`	number \| null	-0 to 10000000
`currency`	string	-max 3 chars

Response 201

Field	Type	Description
`data`required	object	-
`id`requireddata.id	string (uuid)	-
`label`requireddata.label	string	-
`externalRef`requireddata.externalRef	string \| null	-
`balance`requireddata.balance	money	USD as a decimal string with exactly 6 places, e.g. "0.012500".
`status`requireddata.status	string	-One of `draft`, `active`, `suspended`, `closed`
`markupPct`requireddata.markupPct	string \| null	Markup percent as a 3-decimal string; null = operator default
`dailySpendCap`requireddata.dailySpendCap	string \| null	null = operator default; "0.00" = unlimited
`maxConcurrentCalls`requireddata.maxConcurrentCalls	integer \| null	-
`creditLimit`requireddata.creditLimit	string	Postpaid credit, "0.00" = strict prepaid
`currency`requireddata.currency	string	Display currency for statementsmax 3 chars
`portalEmail`requireddata.portalEmail	string \| null	-
`autoSuspended`requireddata.autoSuspended	boolean	Suspended automatically by a daily cap, lifts itself
`sipUsername`requireddata.sipUsername	string \| null	-
`createdAt`requireddata.createdAt	string (date-time)	ISO-8601 timestamp (UTC)
`updatedAt`requireddata.updatedAt	string (date-time)	ISO-8601 timestamp (UTC)
`apiKey`requireddata.apiKey	string	The sub-account API key. Returned ONCE.
`apiKeyPrefix`requireddata.apiKeyPrefix	string	-
`sipPassword`requireddata.sipPassword	string	The SIP password. Returned ONCE.

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
409CONFLICT (or a code-specific 409): the change clashes with existing state.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

HTTP

curl -X POST "https://packetexchange.io/api/v1/application/sub-accounts" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "label": "Acme"
}'

Run it here with a test key.

Create up to 100 sub-accounts at once

POST/api/v1/application/sub-accounts/bulk

Access: API key. Scoped keys need application:write.
Rate limit: 100 requests per second (the default)

Each item is created independently, so one bad row does not fail the batch. Each created entry carries its one-time credentials.

Request body (application/json)

Field	Type	Description
`subAccounts`required	object[]	-
`label`requiredsubAccounts[].label	string	-max 255 chars
`externalRef`subAccounts[].externalRef	string \| null	-max 10000 chars
`markupPct`subAccounts[].markupPct	number \| null	-0 to 100000
`dailySpendCap`subAccounts[].dailySpendCap	number \| null	-0 to 1000000
`maxConcurrentCalls`subAccounts[].maxConcurrentCalls	integer \| null	-0 to 100000
`creditLimit`subAccounts[].creditLimit	number \| null	-0 to 10000000
`currency`subAccounts[].currency	string	-max 3 chars

Response 201

Field	Type	Description
`data`required	object	-
`created`requireddata.created	object[]	Same fields as SubAccountCreated, shown earlier on this page.
`failed`requireddata.failed	object[]	-
`label`requireddata.failed[].label	string	-
`error`requireddata.failed[].error	string	-
`requested`requireddata.requested	integer	-
`createdCount`requireddata.createdCount	integer	-

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
409CONFLICT (or a code-specific 409): the change clashes with existing state.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

HTTP

curl -X POST "https://packetexchange.io/api/v1/application/sub-accounts/bulk" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "subAccounts": [
    {
      "label": "Acme"
    }
  ]
}'

Run it here with a test key.

Get a sub-account

GET/api/v1/application/sub-accounts/{id}

Access: API key. Scoped keys need application:write.
Rate limit: 100 requests per second (the default)

Parameters

Name	In	Type	Description
`id`required	path	string	-

Response 200

Field	Type	Description
`data`required	object	-
`id`requireddata.id	string (uuid)	-
`label`requireddata.label	string	-
`externalRef`requireddata.externalRef	string \| null	-
`balance`requireddata.balance	money	USD as a decimal string with exactly 6 places, e.g. "0.012500".
`status`requireddata.status	string	-One of `draft`, `active`, `suspended`, `closed`
`markupPct`requireddata.markupPct	string \| null	Markup percent as a 3-decimal string; null = operator default
`dailySpendCap`requireddata.dailySpendCap	string \| null	null = operator default; "0.00" = unlimited
`maxConcurrentCalls`requireddata.maxConcurrentCalls	integer \| null	-
`creditLimit`requireddata.creditLimit	string	Postpaid credit, "0.00" = strict prepaid
`currency`requireddata.currency	string	Display currency for statementsmax 3 chars
`portalEmail`requireddata.portalEmail	string \| null	-
`autoSuspended`requireddata.autoSuspended	boolean	Suspended automatically by a daily cap, lifts itself
`sipUsername`requireddata.sipUsername	string \| null	-
`createdAt`requireddata.createdAt	string (date-time)	ISO-8601 timestamp (UTC)
`updatedAt`requireddata.updatedAt	string (date-time)	ISO-8601 timestamp (UTC)

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

Update a sub-account

PATCH/api/v1/application/sub-accounts/{id}

Access: API key. Scoped keys need application:write.
Rate limit: 100 requests per second (the default)

Suspending or closing revokes its API keys and stops its campaigns.

Parameters

Name	In	Type	Description
`id`required	path	string	-

Request body (application/json)

Field	Type	Description
`label`	string	-max 255 chars
`status`	string	-One of `active`, `suspended`, `closed`
`markupPct`	number \| null	-0 to 100000
`dailySpendCap`	number \| null	-0 to 1000000
`maxConcurrentCalls`	integer \| null	-0 to 100000
`creditLimit`	number \| null	-0 to 10000000
`currency`	string	-max 3 chars

Response 200

Field	Type	Description
`data`required	object	Same fields as SubAccount, shown earlier on this page.

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
409CONFLICT (or a code-specific 409): the change clashes with existing state.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

HTTP

curl -X PATCH "https://packetexchange.io/api/v1/application/sub-accounts/<id>" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "label": "Acme",
  "status": "active"
}'

Run it here with a test key.

Fund a sub-account from your balance

POST/api/v1/application/sub-accounts/{id}/credit

Access: API key. Scoped keys need application:write.
Rate limit: 100 requests per second (the default)
Safe retries: Send X-Idempotency-Key; a replay within 24 hours returns the first response.
Moves money: Moves money between your balance and a sub-account.

Moves money from your balance into the sub-account. Only active sub-accounts can be funded.

Parameters

Name	In	Type	Description
`id`required	path	string	-
`X-Idempotency-Key`	header	string	Any unique string (a UUID is ideal). Replays within 24 hours return the first response instead of acting twice.

Request body (application/json)

Field	Type	Description
`amount`required	number	-min 0

Response 200

Field	Type	Description
`data`required	object	-
`operatorBalance`requireddata.operatorBalance	number \| null	Your balance after the transfer, as a JSON number; null when your balance did not move
`subBalance`requireddata.subBalance	number	The sub-account balance after the transfer, as a JSON number

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
409CONFLICT (or a code-specific 409): the change clashes with existing state.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

HTTP

curl -X POST "https://packetexchange.io/api/v1/application/sub-accounts/<id>/credit" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "X-Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "amount": 1
}'

Run it here with a test key.

Return funds from a sub-account to your balance

POST/api/v1/application/sub-accounts/{id}/debit

Access: API key. Scoped keys need application:write.
Rate limit: 100 requests per second (the default)
Safe retries: Send X-Idempotency-Key; a replay within 24 hours returns the first response.
Moves money: Moves money between your balance and a sub-account.

Works on closed sub-accounts too, so a balance can be handed back after closure.

Parameters

Name	In	Type	Description
`id`required	path	string	-
`X-Idempotency-Key`	header	string	Any unique string (a UUID is ideal). Replays within 24 hours return the first response instead of acting twice.

Request body (application/json)

Field	Type	Description
`amount`required	number	-min 0
`reason`required	string	-max 500 chars

Response 200

Field	Type	Description
`data`required	object	-
`operatorBalance`requireddata.operatorBalance	number \| null	Your balance after the transfer, as a JSON number; null when your balance did not move
`subBalance`requireddata.subBalance	number	The sub-account balance after the transfer, as a JSON number

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
409CONFLICT (or a code-specific 409): the change clashes with existing state.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

HTTP

curl -X POST "https://packetexchange.io/api/v1/application/sub-accounts/<id>/debit" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "X-Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "amount": 1,
  "reason": "Example"
}'

Run it here with a test key.

Record a payment a sub-account made to you

POST/api/v1/application/sub-accounts/{id}/payment

Access: API key. Scoped keys need application:write.
Rate limit: 100 requests per second (the default)
Safe retries: Send X-Idempotency-Key; a replay within 24 hours returns the first response.
Moves money: Moves money between your balance and a sub-account.

Credits the sub-account for money it paid you outside the platform. Your own balance does not move.

Parameters

Name	In	Type	Description
`id`required	path	string	-
`X-Idempotency-Key`	header	string	Any unique string (a UUID is ideal). Replays within 24 hours return the first response instead of acting twice.

Request body (application/json)

Field	Type	Description
`amount`required	number	-min 0
`reason`	string	-max 500 chars

Response 200

Field	Type	Description
`data`required	object	-
`operatorBalance`requireddata.operatorBalance	number \| null	Your balance after the transfer, as a JSON number; null when your balance did not move
`subBalance`requireddata.subBalance	number	The sub-account balance after the transfer, as a JSON number

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
409CONFLICT (or a code-specific 409): the change clashes with existing state.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

HTTP

curl -X POST "https://packetexchange.io/api/v1/application/sub-accounts/<id>/payment" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "X-Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "amount": 1
}'

Run it here with a test key.

Reverse a recorded sub-account payment

POST/api/v1/application/sub-accounts/{id}/payment-correction

Access: API key. Scoped keys need application:write.
Rate limit: 100 requests per second (the default)
Safe retries: Send X-Idempotency-Key; a replay within 24 hours returns the first response.
Moves money: Moves money between your balance and a sub-account.

Debits the sub-account to correct a payment recorded in error. Your own balance does not move.

Parameters

Name	In	Type	Description
`id`required	path	string	-
`X-Idempotency-Key`	header	string	Any unique string (a UUID is ideal). Replays within 24 hours return the first response instead of acting twice.

Request body (application/json)

Field	Type	Description
`amount`required	number	-min 0
`reason`required	string	-max 500 chars

Response 200

Field	Type	Description
`data`required	object	-
`operatorBalance`requireddata.operatorBalance	number \| null	Your balance after the transfer, as a JSON number; null when your balance did not move
`subBalance`requireddata.subBalance	number	The sub-account balance after the transfer, as a JSON number

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
409CONFLICT (or a code-specific 409): the change clashes with existing state.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

HTTP

curl -X POST "https://packetexchange.io/api/v1/application/sub-accounts/<id>/payment-correction" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "X-Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "amount": 1,
  "reason": "Example"
}'

Run it here with a test key.

List a sub-account's API keys

GET/api/v1/application/sub-accounts/{id}/api-keys

Access: API key. Scoped keys need application:write.
Rate limit: 100 requests per second (the default)

Parameters

Name	In	Type	Description
`id`required	path	string	-

Response 200

Field	Type	Description
`data`required	object[]	-
`id`requireddata[].id	string (uuid)	-
`keyPrefix`requireddata[].keyPrefix	string	-
`label`requireddata[].label	string	-
`lastUsedAt`requireddata[].lastUsedAt	string (date-time) \| null	ISO-8601 timestamp (UTC)
`createdAt`requireddata[].createdAt	string (date-time)	ISO-8601 timestamp (UTC)
`expiresAt`requireddata[].expiresAt	string (date-time) \| null	ISO-8601 timestamp (UTC)

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

Issue an API key for a sub-account

POST/api/v1/application/sub-accounts/{id}/api-keys

Access: API key. Scoped keys need application:write.
Rate limit: 100 requests per second (the default)

The key is returned ONCE. It can reach only the sub-account traffic endpoints.

Parameters

Name	In	Type	Description
`id`required	path	string	-

Response 201

Field	Type	Description
`data`required	object	-
`id`requireddata.id	string (uuid)	-
`apiKey`requireddata.apiKey	string	-
`prefix`requireddata.prefix	string	-

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
409CONFLICT (or a code-specific 409): the change clashes with existing state.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

Revoke a sub-account API key

DELETE/api/v1/application/sub-accounts/{id}/api-keys/{keyId}

Access: API key. Scoped keys need application:write.
Rate limit: 100 requests per second (the default)

Parameters

Name	In	Type	Description
`id`required	path	string	-
`keyId`required	path	string	-

Response 200

Field	Type	Description
`data`required	object	-
`revoked`requireddata.revoked	boolean	-One of `true`

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
409CONFLICT (or a code-specific 409): the change clashes with existing state.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

HTTP

curl -X DELETE "https://packetexchange.io/api/v1/application/sub-accounts/<id>/api-keys/<keyId>" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY"

Run it here with a test key.

Set a sub-account's portal email and send a sign-in link

POST/api/v1/application/sub-accounts/{id}/portal-invite

Access: API key. Scoped keys need application:write.
Rate limit: 100 requests per second (the default)
Sends email: Sends an email to a third party.

Send email: null to clear it. The link is only emailed to active sub-accounts.

Parameters

Name	In	Type	Description
`id`required	path	string	-

Request body (application/json)

Field	Type	Description
`email`required	string (email) \| null	-max 255 chars
`sendInvite`	boolean	-default true

Response 200

Field	Type	Description
`data`required	object	Same fields as SubAccount, shown earlier on this page.

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
409CONFLICT (or a code-specific 409): the change clashes with existing state.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

HTTP

curl -X POST "https://packetexchange.io/api/v1/application/sub-accounts/<id>/portal-invite" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "email": "you@example.com"
}'

Run it here with a test key.

Close a sub-account

POST/api/v1/application/sub-accounts/{id}/close

Access: API key. Scoped keys need application:write.
Rate limit: 100 requests per second (the default)

Ends service: revokes its keys and stops its campaigns. No money moves; return any balance separately with the debit endpoint. Idempotent.

Parameters

Name	In	Type	Description
`id`required	path	string	-

Response 200

Field	Type	Description
`data`required	object	Same fields as SubAccount, shown earlier on this page.

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
409CONFLICT (or a code-specific 409): the change clashes with existing state.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

Regenerate a sub-account SIP password

POST/api/v1/application/sub-accounts/{id}/sip-password

Access: API key. Scoped keys need application:write.
Rate limit: 100 requests per second (the default)

The new password is returned ONCE; the old one stops working immediately.

Parameters

Name	In	Type	Description
`id`required	path	string	-

Response 201

Field	Type	Description
`data`required	object	-
`sipUsername`requireddata.sipUsername	string \| null	-
`sipPassword`requireddata.sipPassword	string	-

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
409CONFLICT (or a code-specific 409): the change clashes with existing state.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

HTTP

curl -X POST "https://packetexchange.io/api/v1/application/sub-accounts/<id>/sip-password" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY"

Run it here with a test key.

Get lifetime usage for a sub-account

GET/api/v1/application/sub-accounts/{id}/usage

Access: API key. Scoped keys need application:write.
Rate limit: 100 requests per second (the default)

Parameters

Name	In	Type	Description
`id`required	path	string	-

Response 200

Field	Type	Description
`data`required	object	-
`records`requireddata.records	integer	-
`totalCost`requireddata.totalCost	number	USD as a JSON number
`totalSeconds`requireddata.totalSeconds	integer	-
`totalSegments`requireddata.totalSegments	integer	-

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

Get analytics for one sub-account

GET/api/v1/application/sub-accounts/{id}/analytics

Access: API key. Scoped keys need application:write.
Rate limit: 100 requests per second (the default)

Parameters

Name	In	Type	Description
`id`required	path	string	-
`days`	query	integer	Trailing window in days (default 30)

Response 200

Field	Type	Description
`data`required	object	-
`period`requireddata.period	object	-
`days`requireddata.period.days	integer	-
`summary`requireddata.summary	object	-
`calls`requireddata.summary.calls	integer	-
`sms`requireddata.summary.sms	integer	-
`minutes`requireddata.summary.minutes	integer	-
`revenue`requireddata.summary.revenue	number	USD, JSON number (analytics rollup)
`margin`requireddata.summary.margin	number	USD, JSON number (analytics rollup)
`asr`requireddata.summary.asr	number \| null	Answer rate percent over customer sessions; null with no calls
`acd`requireddata.summary.acd	number	-
`timeseries`requireddata.timeseries	object[]	-
`date`requireddata.timeseries[].date	string	YYYY-MM-DD
`calls`requireddata.timeseries[].calls	integer	-
`sms`requireddata.timeseries[].sms	integer	-
`revenue`requireddata.timeseries[].revenue	number	-
`margin`requireddata.timeseries[].margin	number	-

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

List call records for a sub-account

GET/api/v1/application/sub-accounts/{id}/cdrs

Access: API key. Scoped keys need application:write.
Rate limit: 100 requests per second (the default)

Newest first, offset-paginated.

Parameters

Name	In	Type	Description
`id`required	path	string	-
`limit`	query	integer	-Default 50
`offset`	query	integer	-Default 0
`kind`	query	string	-One of voice, sms

Response 200

Field	Type	Description
`data`required	object[]	-

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

Get a monthly statement for a sub-account

GET/api/v1/application/sub-accounts/{id}/statement

Access: API key. Scoped keys need application:write.
Rate limit: 100 requests per second (the default)

Spend in USD and in the sub-account's display currency, split by voice and SMS, with a resale-tax block. Derived, not stored.

Parameters

Name	In	Type	Description
`id`required	path	string	-
`month`required	query	string	YYYY-MM

Response 200

Field	Type	Description
`data`required	object	-
`subAccountId`requireddata.subAccountId	string (uuid)	-
`label`requireddata.label	string	-
`month`requireddata.month	string	-
`periodStart`requireddata.periodStart	string (date-time)	ISO-8601 timestamp (UTC)
`periodEnd`requireddata.periodEnd	string (date-time)	ISO-8601 timestamp (UTC)
`currency`requireddata.currency	string	-
`fxRate`requireddata.fxRate	number	-
`records`requireddata.records	integer	-
`spend`requireddata.spend	object	-
`usd`requireddata.spend.usd	number	-
`inCurrency`requireddata.spend.inCurrency	number	-
`byKind`requireddata.byKind	object	-
`voice`requireddata.byKind.voice	object	-
`usd`requireddata.byKind.voice.usd	number	-
`inCurrency`requireddata.byKind.voice.inCurrency	number	-
`sms`requireddata.byKind.sms	object	-
`usd`requireddata.byKind.sms.usd	number	-
`inCurrency`requireddata.byKind.sms.inCurrency	number	-
`tax`requireddata.tax	object	base, ratePct, taxAmount, total, treatment, label, note

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

HTTP

curl "https://packetexchange.io/api/v1/application/sub-accounts/<id>/statement?month=%3Cmonth%3E" \
  -H "Authorization: Bearer $PACKETEXCHANGE_API_KEY"

Run it here with a test key.

Export a sub-account's call records as CSV

GET/api/v1/application/sub-accounts/{id}/cdrs/export

Access: API key. Scoped keys need application:write.
Rate limit: 100 requests per second (the default)

Parameters

Name	In	Type	Description
`id`required	path	string	-

Response 200 (text/csv)

Every call record for the sub-account, as CSV.

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
401UNAUTHORIZED: missing, invalid, expired or revoked credential.
403FORBIDDEN: not allowed - a scoped key lacks the scope, or the endpoint is session-only.
404NOT_FOUND: no such resource on your account.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.