Skip to content
Vocapable Developers

Purchase Receptionist Connections

POST
/v1/subscription/receptionist-purchases
curl --request POST \
  --url https://api.vocapable.com/v1/subscription/receptionist-purchases \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "receptionist_connections": 1, "request_key": "example", "amount_due_minor": 1, "currency": "usd", "quote_fingerprint": "example" }'

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
ReceptionistPurchaseInput
object
receptionist_connections
required
Receptionist Connections
integer
request_key
required
Request Key
string
>= 1 characters <= 200 characters /\S/
amount_due_minor
required
Amount Due Minor
integer
currency
required
Currency
string
Allowed value: usd
quote_fingerprint
required
Quote Fingerprint
string
/^[a-f0-9]{64}$/

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
ReceptionistPurchaseResponse
object
id
required
Id
string
status
required
Status
string
receptionist_connections
required
Receptionist Connections
integer
total_inbound_connections
required
Total Inbound Connections
integer
amount_due_minor
required
Amount Due Minor
integer
currency
Currency
string
default: usd
Allowed value: usd
recurring_connections_minor
required
Recurring Connections Minor
integer
renewal_at
required
Any of:
string format: date-time
failure_code
required
Any of:
string
payment_url
Any of:
string
Example
{
  "currency": "usd"
}

202

Section titled “202”

Purchase remains pending

Media typeapplication/json
ReceptionistPurchaseResponse
object
id
required
Id
string
status
required
Status
string
receptionist_connections
required
Receptionist Connections
integer
total_inbound_connections
required
Total Inbound Connections
integer
amount_due_minor
required
Amount Due Minor
integer
currency
Currency
string
default: usd
Allowed value: usd
recurring_connections_minor
required
Recurring Connections Minor
integer
renewal_at
required
Any of:
string format: date-time
failure_code
required
Any of:
string
payment_url
Any of:
string
Example
{
  "currency": "usd"
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}