Create businesses subscriptions

POST 
/api/v2/businesses/:business_id/subscriptions

This endpoint lets you subscribe a business to one or several products

Request

Path Parameters

business_id stringrequired

application/json

Body

required

subscription_date number

Date of subscription (UNIX timestamp)

products string[]required

Possible values: [presence_management, review_management, review_booster, messages]

List of products being subscribed to

plan string

Plan name

Responses

201

application/json

Schema

Schema

presence_management

object

required

status stringrequired

Possible values: [active, inactive]

Status of the management

review_management

object

required

status stringrequired

Possible values: [active, inactive]

Status of the management

review_booster

object

required

status stringrequired

Possible values: [active, inactive]

Status of the management

messages

object

required

status stringrequired

Possible values: [active, inactive]

Status of the management

Example (from schema)

{
  "presence_management": {
    "status": "inactive"
  },
  "review_management": {
    "status": "inactive"
  },
  "review_booster": {
    "status": "inactive"
  },
  "messages": {
    "status": "inactive"
  }
}

400

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

error string

Error name

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "error": "Not Found"
}

401

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

error string

Error name

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "error": "Not Found"
}

403

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

error string

Error name

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "error": "Not Found"
}

404

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

error string

Error name

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "error": "Not Found"
}

422

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

location stringrequired

Possible values: [query, body, response, param]

Where in the request the error occurred

errors

object[]

required

Array [

path stringrequired

Possible values: non-empty

Path to the property with the error

constraints

object

required

property name* string

Error message

]

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "location": "query",
  "errors": [
    {
      "path": "business.id",
      "constraints": {
        "object_required_property": "Required property"
      }
    }
  ]
}

500

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

error string

Error name

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "error": "Not Found"
}

Loading...