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

Retrieve the current billing information for the account specified by the accountId path parameter. 

NOTE: You must be set up for either single- or partner-billing in order to access and manage account billing plans.

GET: https://api.constantcontact.com/v2/partner/accounts/{accountId}/plan

name

type

default

description

accountId

path

The Constant Contact ID provided at account creation, specifies the account for which to retrieve billing information

api_key

query

REQUIRED; The API key for the application; key must have Partner level API Access

Response CodesTOP

code

description

200

Request was successful

401

Authentication failure

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

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)

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.

plan_type

integer

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

  • 1 - TRIAL
  • 2 - BASIC
  • 3 - ESSENTIAL
  • 4 - ULTIMATE

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

Example ResponseTOP

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