Technology Partners

GET Billing Plan Details for a Client Account

Changed on

Use this GET method to return billing plan details for a client's Constant Contact account. If you are not on the latest billing plan, contact the Constant Contact Partner Team. However, older billing plans and plan_type enum values will continue to be supported. Only technology partners can access partner endpoints and partner endpoints cannot be tested using the API reference tester. For more use case information, see Get Billing Plan Details for a Client Account in the API guide.

get/partner/accounts/{encoded_account_id}/plan

Request

  • Base URL
    https://api.cc.email/v3
  • URL
    https://api.cc.email/v3/partner/accounts/{encoded_account_id}/plan
  • Auth
    OAuth 2 and API key in header x-api-key
    Implicit: https://v3api-partner.auth.us-east-1.amazoncognito.com/oauth2/token

Path parameters

encoded_account_idstring required

Specify the client's unique encoded_account_id.

Response

Request successful.

plan_typestring

The billing plan that is associated with a client's Constant Contact account. The billing plan determines which Constant Contact product features that the client account can access. If you are not on the latest billing plan, contact the Constant Contact Partner Team. However, older billing plans and <code>plan_type</code> enum values will continue to be supported. <ul>

<li><code>TRIAL</code>: Provides limited product features for a non-billed account and the account has an expiration date.</li> <li><code>BRONZE</code>: Billable plan that provides basic email and marketing tools.</li> <li><code>SILVER</code>: Billable plan that provides all features available in the <code>BRONZE</code> plan, and adds some additional email campaign to features, such as contact segmentation and social media ads integration.</li> <li><code>GOLD</code>: Billable plan that provides all available product features.</li> </ul>
billing_statusstring

The client's account billing status. When you first create a client account the <code>billing_status</code> defaults to <code>Trial</code>. Billing status values include:

<ul> <li><code>Trial</code> - A non-paying trial client account (default value).</li> <li><code>Open</code> - An active and paying client account.</li> <li><code>Canceled</code> - A canceled client account.</li> <li><code>Trial End</code> - The trial period has ended for this client account.</li> </ul>
billing_day_of_monthinteger

This property is required when an account is not set up to use single billing. For trial accounts, the value is initially set to <code>null</code>. The value can only be changed when changing the <code>plan_type</code> from a trial account to a different type of plan, otherwise the value you enter is ignored. You can choose to enter a specific day of month or except the default value, which is the day that the <code>plan_type</code> value changes from a trial account plan to a different plan. Valid <code>billing_day_of_month</code> values include <code>1</code> through and including <code>31</code>.

Example response

{
  "plan_type": "GOLD",
  "current_tiers": [
    {
      "usage_type": "CONTACTS",
      "current_usage": 10,
      "tier": 1,
      "tier_max": 500,
      "price": 20,
      "currency_code": "USD"
    }
  ],
  "billing_status": "Open",
  "billing_day_of_month": 15
}

Changes

  • 2483585c5d89Revision changes
    • info

      the endpoint scheme security ctctPartnerAuthorizer AND api_key was added to the API

    • info

      the endpoint scheme security api_key was removed from the API

    • info

      the endpoint scheme security ctctPartnerAuthorizer was removed from the API

  • 789fdcc6a174Revision changes
    • info

      endpoint added