Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: Telnyx Auto Recharge Preferences API
version: 2.0.0
contact:
email: support@telnyx.com
x-endpoint-cost: light
x-refined-note:
- x-latency-category differs across the merged source definitions and was not carried
description: 'Operations tagged AutoRechargePreferences across 3 of this provider''s published API definitions: telnyx-openapi.json, telnyx-openapi.yml, telnyx-openapi_2.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.telnyx.com/v2
description: Version 2.0.0 of the Telnyx API
security:
- bearerAuth: []
tags:
- name: AutoRechargePreferences
description: V2 Auto Recharge Preferences API
paths:
/payment/auto_recharge_prefs:
get:
description: Returns the payment auto recharge preferences.
summary: List auto recharge preferences
operationId: GetAutoRechargePrefs
tags:
- AutoRechargePreferences
x-endpoint-cost: medium
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/AutoRechargePref'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Resource not found
patch:
description: Update payment auto recharge preferences.
summary: Update auto recharge preferences
operationId: UpdateAutoRechargePrefs
tags:
- AutoRechargePreferences
x-endpoint-cost: medium
requestBody:
description: Details to update auto recharge preferences
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AutoRechargePrefRequest'
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/AutoRechargePref'
'401':
description: Unauthorized
'404':
description: Resource not found
'422':
description: Bad request
servers:
- url: https://api.telnyx.com/v2
description: Version 2.0.0 of the Telnyx API
components:
schemas:
AutoRechargePref:
type: object
properties:
id:
type: string
example: '1524126400473204723'
description: The unique identifier for the auto recharge preference.
record_type:
type: string
example: auto_recharge_pref
description: The record type.
threshold_amount:
type: string
example: '104.00'
description: The threshold amount at which the account will be recharged.
x-format: decimal
recharge_amount:
type: string
example: '104.00'
description: The amount to recharge the account, the actual recharge amount will be the amount necessary to reach the threshold amount plus the recharge amount.
x-format: decimal
enabled:
type: boolean
example: true
description: Whether auto recharge is enabled.
invoice_enabled:
type: boolean
example: true
preference:
type: string
enum:
- credit_paypal
- ach
example: credit_paypal
description: The payment preference for auto recharge.
AutoRechargePrefRequest:
type: object
properties:
threshold_amount:
type: string
example: '104.00'
description: The threshold amount at which the account will be recharged.
x-format: decimal
recharge_amount:
type: string
example: '104.00'
description: The amount to recharge the account, the actual recharge amount will be the amount necessary to reach the threshold amount plus the recharge amount.
x-format: decimal
enabled:
type: boolean
example: true
description: Whether auto recharge is enabled.
invoice_enabled:
type: boolean
example: true
preference:
type: string
enum:
- credit_paypal
- ach
example: credit_paypal
description: The payment preference for auto recharge.
responses:
AutoRechargePrefResponse:
content:
application/json:
schema:
properties:
data:
$ref: '#/components/schemas/AutoRechargePref'
type: object
description: Successful response
securitySchemes:
BearerAuth:
type: http
scheme: bearer
bearerFormat: API key
description: 'Telnyx API key supplied as `Authorization: Bearer <token>`. In production, auth may be validated by the API gateway and forwarded via Telnyx auth headers.'
Payment:
type: apiKey
in: header
name: Authorization
description: 'Machine Payment Protocol credential used on paid retries, sent as `Authorization: Payment ...`. Obtained by paying a challenge returned in the `WWW-Authenticate` header of a 402 response. This is not a Telnyx API key; initial challenge requests use standard bearer authentication instead.'
agent-memory_bearerAuth:
type: http
scheme: bearer
description: Telnyx API key
bearerAuth:
type: http
scheme: bearer
branded-calling_bearerAuth:
type: http
scheme: bearer
description: Telnyx API key. Generate one at https://portal.telnyx.com/#/app/api-keys.
collections_bearerAuth:
type: http
scheme: bearer
description: Telnyx API key. Collections and results are automatically scoped to the authenticated user's organization.
number-reputation_bearerAuth:
type: http
scheme: bearer
description: Telnyx API key. Generate one at https://portal.telnyx.com/#/app/api-keys.
oauthClientAuth:
type: oauth2
flows:
clientCredentials:
tokenUrl: https://api.telnyx.com/v2/oauth/token
scopes:
admin: Administrative access to Telnyx resources
authorizationCode:
authorizationUrl: https://api.telnyx.com/v2/oauth/authorize
tokenUrl: https://api.telnyx.com/v2/oauth/token
refreshUrl: https://api.telnyx.com/v2/oauth/token
scopes:
admin: Administrative access to Telnyx resources
description: OAuth 2.0 authentication for Telnyx API and MCP integrations
outbound-voice-profiles_bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
pronunciation-dicts_bearerAuth:
type: http
scheme: bearer
description: Telnyx API v2 key. Obtain from https://portal.telnyx.com
rcs-registration_bearerAuth:
type: http
scheme: bearer
bearerFormat: API key
stored-payment-transactions_bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
transcriptions-search_bearerAuth:
type: http
scheme: bearer
description: Telnyx API key. Results are automatically scoped to the authenticated user's organization.
web-search_bearerAuth:
type: http
scheme: bearer
description: Telnyx API key
pay-connectors_bearerAuth:
type: http
scheme: bearer
description: Telnyx API key, not the processor bearer token.
telnyxApiKey:
type: http
scheme: bearer
description: Management-only Telnyx account credential.
x-refined-from:
- telnyx-openapi.json
- telnyx-openapi.yml
- telnyx-openapi_2.json
x-service-info:
categories:
- communication
- developer-tools
docs:
apiReference: https://developers.telnyx.com
homepage: https://telnyx.com
llms: https://telnyx.com/llms.txt