Yay.com loading

Loading

Call us on (917) 9001 YAY

0

Login to Yay.com

VoIP Bundle (Subscriptions)

API Access

Build custom apps using our JSON API

1st month FREE
Become a Reseller

Bundle

A VoIP Bundle is a collection of SIP Users and Phone numbers that represent the customers monthly subscription. A VoIP Bundle must be created before any SIP users or numbers can be created

Become a Reseller

Filter:

  • All
  • GET
  • POST
  • PUT
  • DELETE
  • Chargeable *

* You will be charged every time this command is run.

  • Chargeable *

    POST/voip/bundle

    Create a new VoIP Bundle (subscription) for the target customer, the bundle type will change the features available for the customer

    Back to top

    Request Details

    Response Details

    Request Details

    This command has no URL/Query String parameters

    POST body

    • Name

    • Type

    • Required

      • auto_renew

      • Boolean

      • False

      Should this bundle be auto-renewed, will default to false if omitted

      • bundle_type

      • Integer

      • True

      The type of bundle to create, valid values are 1 - Business, 2 - Residential, 3 - Fax Only, 4 - Trunk Only, 5 - Forward Only

    JSON all-fields example:

    {
        "bundle_type" : 1,
        "auto_renew" : true
    }

    Response Details

    201 Response

    {
        "result" : {
            "bundle_type" : 1,
            "uuid" : "0fba8c48-99fc-4727-8ca7-c847376da415",
            "expires_on" : "2018-09-01",
            "auto_renew" : true
        },
        "status_code" : 201,
        "status_message" : "Created"
    }

    400 Response

    {
        "result" : {},
        "status_code" : 400,
        "status_message" : "Bad Request"
    }