Manage Billing Plans | Constant Contact Developer

Manage Account Billing

Use this endpoint to view (GET) and update (PUT) a customer's billing information, such as changing an account to a paying account from a trial account. Please note that this endpoint uses basic authentication, and requires the partners username and password be included in each call.

NOTE: This endpoint is available only to approved Constant Contact Technology Platform partners selling Toolkit accounts. Learn more here. It also uses basic authentication as documented on this page.

Methods:

Click a method to view its documentation

GET PUT

DescriptionTOP

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.

name	type	description
PUT: https://api.constantcontact.com/v2/partner/accounts/{accountId}/plan
accountId	path	The Constant Contact ID provided at account creation, specifies the account for which to update billing information
api_key	query	REQUIRED; The API key for the application; API key must have Partner level API Access

Example JSON Request BodyTOP

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

Response CodesTOP

code	description
200	Request was successful
400	Bad Request: either JSON was malformed or there was a data validation error
401	Authentication failure; make sure you are using Basic Authentication
404	Either the partner or account specified was not found
405	Unsupported method, only GET and PUT are supported by this endpoint
406	Unsupported accept header value, must be application/json
415	Unsupported content-type in the header, use application/json
500	Internal server error occurred

StructureTOP

property

type(max length)

description

billing_day_of_month

integer

Sets the day of the month on which the account is billed; not required for accounts set up with single_billing; value is null for Trial accounts; default value is the day of month on which the plan_type is changed from 1 (Trial) to a value other than 1. You can change the billing_day_of_month only when changing the plan_type from 1 (Trial) to a value other than 1, otherwise it is ignored.

+ current_tiers

array

Array containing detailed billing information; current_tiers information is not available for Trial accounts (plan_type = 1) (Read Only)

current_usage	integer	The number of active contacts (default) used within the current `tier` (Read Only)
price	integer	The price that the account is charged each month (Read Only)
tier	integer	Identifies the account's billing tier; valid values are positive integers. By default, tiers are based on the number of active contacts in the account, and defined as follows: level 1 = 0 - 500 contacts level 2 = 501 - 1000 contacts level 3 - 1001 continuing on up to tier 32. Your billing tiers may be different. (Read Only)
tier_max	integer	The maximum number of active contacts (default) for the specified `tier` (Read Only)
tier_min	integer	The minimum number of active contacts (default) for the specified `tier` (Read Only)
usage_type	string	The unit that the tiers are based on, by default tiers are based on the number of active contacts (Read Only)

plan_level

integer

Identifies the account's billing level; valid values are positive integers. By default, plan_levels are based on the number of active contacts in an account; default tiers are:

level 1 = 0 - 500 contacts
level 2 = 501 - 2500 contacts
level 3 - 2501 - 10,000 continuing on up to tier 32.

Your billing levels may be different. (Read Only)

plan_type

integer

REQUIRED. Identifies the account's service plan, default value is 1 when an account is newly provisioned. Valid values are:

1 - TRIAL
2 - EMAIL
3 - EMAIL PLUS
4 - PERSONAL MARKETER
7 - WEBSITE BUILDER

status

string

Identifies the account status, valid values are

Trial - not a paying account
Open - a paying account
Pending Cancellation - account is being considered for cancellation
Cancelled - account has been cancelled

(Read Only)

Example ResponseTOP

{
    "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"
        }
    ]
}