public __construct(PHPFUI\ConstantContact\Client $client)
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\AccountCancellation $body = NULL) : array

PUT Cancel the Billing Plan for a Client Account

Use this PUT method to cancel a client's Constant Contact account. If the specified client account or technology partner account does not exist, the system returns a 404 error response. If the client account exists under a different technology partner account, the system returns a 400 error response.

To get a list of all canceled client accounts ("billing_status": "Canceled"), make a GET call to the /partner/accounts endpoint.

Only technology partners can access partner endpoints and partner endpoints cannot be tested using the API reference tester.

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

  • param string $encoded_account_id The system generated ID that uniquely identifies the client account.
  • param \PHPFUI\ConstantContact\Definition\AccountCancellation $body By default, the current date and time is automatically used as the cancellation date. However, you can specify a future date and time to cancel the account (effective_date) in the request body in ISO format. You can also enter the client's cancellation reason (reason_id).
public PHPFUI\ConstantContact\Base::success() : bool
protected PHPFUI\ConstantContact\Client PHPFUI\ConstantContact\Base::$client
protected string PHPFUI\ConstantContact\Base::$urlPath
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
© 2024 Bruce Wells
Search Namespaces \ Classes