CloneableInstantiable
Methods
public __construct(PHPFUI\ConstantContact\Client $client)
public get(string $encoded_account_id) : array
 

GET Billing Plan Details for a Client Account

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.

  • param string $encoded_account_id Specify the client's unique encoded_account_id.
public PHPFUI\ConstantContact\Base::getLastError() : string
public PHPFUI\ConstantContact\Base::getResponseText() : string
public PHPFUI\ConstantContact\Base::getStatusCode() : int
public PHPFUI\ConstantContact\Base::next() : array
 

If the endpoint is paginated, you can call next() to retrieve the next set of data. If no next is provided, an empty array is returned.

  • return array filled with next part of the response from the endpoint, or empty if no next.
public put(string $encoded_account_id, ?PHPFUI\ConstantContact\Definition\PlanInfo $body = NULL) : array
 

PUT (update) Billing Plan Details for a Client Account

Use this PUT method to update the type of billing plan to assign to the Constant Contact client account. The type of billing plan determines which Constant Contact product features that the client account can access. The billing plan type (plan_type) that you enter must already exist in the plan group. Attempting to change to a plan that is currently not available within your partner plan group results in a 400 error response code.

When you create a new client account, the plan_type defaults to TRIAL and the billing_day_of_month defaults to null. The billing_day_of_month property is required if a client account is not set up to use single billing. You can change the day of month (billing_day_of_month) in which to bill a client account only when changing the plan_type value from TRIAL to a different plan_type, otherwise the billing_day_of_month value you enter is ignored. You can choose to enter a specific day of the month or accept the default value, which is the day on which the plan_type value changes from a TRIAL plan to a different plan_type. Changing the plan_type from TRIAL to another plan_type automatically changes the billing_status from Trial to Open.

Only technology partners can access partner endpoints and partner endpoints cannot be tested using the API reference tester. 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.

For more use case information, see PUT Billing Plan Details for a Client Account in the API guide.

  • param string $encoded_account_id Specify the client's unique encoded_account_id.
  • param \PHPFUI\ConstantContact\Definition\PlanInfo $body Update the billing plan (plan_type) for an existing Constant Contact client account. Options include:
    • TRIAL: A non-billed account with an expiration date that allows clients to try Constant Contact product features.
    • GOLD: A billable plan that provides all available product features.
    • SILVER: A billable plan that provides all features available in the BRONZE plan, and adds some additional email campaign feature such as contact segmentation and social media advertisements.
    • BRONZE: A billable plan that provides basic email and marketing tools.
    If updating from a TRIAL plan (plan_type) to another type of billing plan, you have the option to update the day of month (billing_day_of_month) in which to bill the client account. Valid values include 1 through to and including 31. Any additional billing plan properties and values that you include in the request body are ignored. 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.
public PHPFUI\ConstantContact\Base::success() : bool
Properties
protected PHPFUI\ConstantContact\Client PHPFUI\ConstantContact\Base::$client
protected string PHPFUI\ConstantContact\Base::$urlPath
Methods
protected PHPFUI\ConstantContact\Base::doDelete(array $parameters) : bool
protected PHPFUI\ConstantContact\Base::doGet(array $parameters) : array
protected PHPFUI\ConstantContact\Base::doPatch(array $parameters) : array
protected PHPFUI\ConstantContact\Base::doPost(array $parameters) : array
protected PHPFUI\ConstantContact\Base::doPut(array $parameters) : array
© 2025 Bruce Wells
Search Namespaces \ Classes
Configuration