Description TOP

Cancel an existing account using the PUT method to change the account status to Cancelled. You must include the cancel_date in ISO-8601 format. You can also specify a cancel_reason for your records.

Here's the list of cancel_reason codes to use, along with their meanings:

Description TOP

Use the PUT method to update an account's billing plan. The account is specified using the account_id path parameter. You can modify the following billing plan properties using this endpoint:

• day of the month on which the account is billed
• the type of plan assigned to the account, for example from Trial > Basic > Essential > Ultimate

NOTES :

• Your partnership needs to be set up for either single- or partner-billing in order to access and manage account billing plans.
• For trial accounts (plan_type=1), PUT can be used only to modify the plan_type to a value other than 1  (Trial). The API rejects a PUT call where plan_type=1 is in the request payload.
• You can change the billing_day_of_month only when upgrading the plan_type from 1 (Trial) to a value other than 1; otherwise it is ignored.

Description TOP

Subscribe to or unsubscribe from a partner webhook topic by making a PUT call to this endpoint with a properly constructed request payload, as shown here. Specify the topic using the topicId path parameter.

Example JSON Request Body TOP

{
    "plan_type": 2,
    "billing_day_of_month": 20
}

Response Codes TOP

Structure TOP

Example Response TOP

{
    "status": "Open",
    "plan_type": 2,
    "billing_day_of_month": 20,
    "current_tiers": [
        {
            "price": 45,
            "tier": 1,
            "tier_min": 0,
            "tier_max": 500,
            "current_usage": 0,
            "usage_type": "Contacts"
        }
    ]
}