Create Service Plan

Service plans include a set of configuration that define the level of service the consumer receives. A service plan may include a certain time window size, operational requirements (e.g. collect signature, photo), or custom notifications and branding.

Response (Output) Params
Parameter Description

success

boolean

Indicates whether the service completed successfully.

  • false - the service failed.
  • true - the service succeeded.

id

Int32

The unique Id of this new service plan.

name

string

The name of this new service plan.

external_id

string

Your ID for the service plan.

tag_id

Int32

The tag id included in this new service plan.

merchant_id

Int32

Bringg’s ID for the merchant.

task_configuration_id

Int32

The task configuration attached to the service plan.

created_at

datetime

The date and time this record was created. This is in UTC and is in the format is "%Y-%m-%dT%H:%M:%S%z".

updated_at

datetime

The date and time of the last update for this record. This is in UTC and is in the format is " %Y-%m-%dT%H:%M:%S%z".

Body Params
string
required

Describes the service plan. E.g. basic, standard, premium. Entity's unique ID.

string

Your ID for the service plan. Must be unique per merchant.

int32

Defines the consumer facing notifications, styling, and cancellation options.

int32

Defines the operational capabilities you want to include in the service plan. For example, includes installation service and require consumer signature.

Responses

Language
LoadingLoading…
Response
Choose an example:
application/json