Active Expansion

GET

/v1/subscription/expansions

const url = 'https://api.vocapable.com/v1/subscription/expansions';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.vocapable.com/v1/subscription/expansions \
  --header 'Authorization: Bearer <token>'

Recover the in-progress purchase when the customer returns on another device.

Authorizations

HTTPBearer

Responses

200

Successful Response

application/json

Any of:

ExpansionQuoteResponse
null

ExpansionQuoteResponse

Customer figures only; provider IDs and commercial evidence stay private.

object

required

string

status

required

Status

string

source_plan_id

required

Source Plan Id

string

target_plan_id

required

Target Plan Id

string

source_class

required

Source Class

string

Allowed values: engage workforce sales receptionist

target_class

required

Target Class

string

Allowed values: engage workforce sales receptionist

term

required

Term

string

Allowed values: mtm three_year

amount_due_minor

required

Amount Due Minor

integer

currency

required

Currency

string

source_monthly_minor

required

Source Monthly Minor

integer

target_monthly_minor

required

Target Monthly Minor

integer

total_inbound_connections

required

Total Inbound Connections

integer

total_outbound_sessions

required

Total Outbound Sessions

integer

minute_rate_minor

required

Minute Rate Minor

string

/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/

attempt_fee_minor

required

Attempt Fee Minor

string

/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/

volume_ladder_applies

required

Volume Ladder Applies

boolean

expires_at

required

Expires At

string format: date-time

checkout_available

Checkout Available

boolean

checkout_url

Any of:

string
null

string

checkout_expires_at

Any of:

string
null

string format: date-time

payment_received

Payment Received

boolean

failure_code

Any of:

string
null

string

Example

{
  "source_class": "engage",
  "target_class": "engage",
  "term": "mtm",
  "checkout_available": false,
  "payment_received": false
}