The company's pricing guard rails

GET

/v1/workspace/pricing-policy

const url = 'https://api.vocapable.com/v1/workspace/pricing-policy';
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/workspace/pricing-policy \
  --header 'Authorization: Bearer <token>'

Authorizations

HTTPBearer

Responses

200

Successful Response

application/json

WorkspacePricingPolicy

object

configured

required

Configured

boolean

max_discount_bps

required

Max Discount Bps

integer

min_total_minor

required

Any of:

integer
null

integer

floor_currency

required

Any of:

string
null

string

payment_required_before_delivery

required

Payment Required Before Delivery

boolean

customer_payments

required

Customer Payments

string

Allowed values: off deposit deposit_or_full

default_currency

required

Default Currency

string

revision

required

Revision

integer

updated_by

required

Any of:

WorkspacePersonRef
null

WorkspacePersonRef

A teammate named on a record: the id the server holds and the name to show.

object

user_id

required

User Id

string

name

required

Name

string

updated_at

required

Any of:

string
null

string format: date-time

Example

{
  "customer_payments": "off"
}