Skip to content
vocapable.Docs

Use a sales offer for this company

POST
/v1/offers/redeem
curl --request POST \
  --url https://api.vocapable.com/v1/offers/redeem \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "token": "example" }'

Bind the offer to this company, once, and return the checkout request that buys it.

Charges nothing and grants nothing: the ordinary production checkout does both. Redeeming again for the same company answers the same request.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
SalesOfferRequest
object
token
required
Token
string
>= 1 characters <= 128 characters
Examplegenerated
{
  "token": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
SalesOfferRedemption
object
offer
required
SalesOfferPreview
object
business_name
required
Business Name
string
prepared_by
required
Prepared By
string
quote_version
required
Quote Version
integer
terms_reference
required
Terms Reference
string
workload_class_name
required
Workload Class Name
string
minimum_term
required
Minimum Term
string
currency
required
Currency
string
lines
required
Lines
Array<object>
SalesOfferLine
object
label
required
Label
string
quantity
required
Quantity
integer
monthly_minor
required
Monthly Minor
integer
monthly_discount_minor
required
Monthly Discount Minor
integer
monthly_total_minor
required
Monthly Total Minor
integer
expires_at
required
Expires At
string format: date-time
accepted
required
Accepted
boolean
redeemed_here
required
Redeemed Here
boolean
subscribed
required
Subscribed
boolean
blocker
required
Any of:
string
checkout
required
Any of:
SalesOfferCheckout

The POST /v1/subscription request that buys exactly this offer.

object
workload_class
required
Workload Class
string
Allowed values: engage workforce sales receptionist
term
required
Term
string
Allowed values: mtm three_year
extra_sessions
required
Extra Sessions
integer
receptionist_connections
required
Receptionist Connections
integer
checkout
required
SalesOfferCheckout

The POST /v1/subscription request that buys exactly this offer.

object
workload_class
required
Workload Class
string
Allowed values: engage workforce sales receptionist
term
required
Term
string
Allowed values: mtm three_year
extra_sessions
required
Extra Sessions
integer
receptionist_connections
required
Receptionist Connections
integer
Example
{
  "offer": {
    "checkout": {
      "workload_class": "engage",
      "term": "mtm"
    }
  },
  "checkout": {
    "workload_class": "engage",
    "term": "mtm"
  }
}

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": {}
    }
  ]
}