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 .
Click a method to view its documentation
Retrieve a specific partner webhook topic by specifying the
topicId
path parameter. See the available topic ID's
here
.
Retrieves a list of partner webhook topics. Use the
subscription_status
query parameter to filter the list as follows:
subscription_status=ALL
returns all topics (ALL is the default value if query param not included)
subscription_status=SUBSCRIBED
returns only topics to which I am subscribed
subscription_status=NOT_SUBSCRIBED
returns only topics to which I am not subscribed
Currently, two webhook topics are available: billing tier upgrades (topic 1), and billing tier downgrades (topic 2).
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 |
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 |
property |
type (max length) |
description |
---|
- {
- "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"
- }
- ]
- }