Plan

Type:  
Abstract:  no
Status:  Active
Java Class:  Plan
Represents information about the plan.
Available Fields:
id
References: Plan.Id
XML Representation: attribute
Attributes: ReadOnly
Default Value
Identifier of the object used for references; auto-incremented integer value.

**create Unique plan ID, automatically generated by the system.\n\r\n> **Note:** Do not include this field in the create request.
  • exists Unique identifier for the plan; auto-incremented integer value.\n\r\n> **Note:** This system-generated identifier can be used in subsequent API calls that reference this plan.
  • echo Unique identifier for the plan; auto-incremented integer value.\n\r\n> **Note:** This system-generated identifier can be used in subsequent API calls that reference this plan.
    • code
    References: Plan.Ref Code
    XML Representation: attribute
    Attributes: CreateOnly
    Default Value
    Pattern: CODE
    See Reference Field Type definition for additional information.

    **create Unique plan ID provided by the external system or user.\n\r\n> **Note:** Optional secondary identifier that references an ID in your own system.
  • exists Optional secondary identifier, typically referencing an ID in your external system.\n\r\n> **Note:** If not provided during creation, this value defaults to the plan's id returned in the response.
  • echo Optional secondary identifier, typically referencing an ID in your external system.\n\r\n> **Note:** If not provided during creation, this value defaults to the plan's id returned in the response.
    • accountId
    References: Plan.Merchant Account Code
    XML Representation: attribute
    Attributes: Required, CreateOnly
    Default Value
    Identifier of the account within the gateway.

    **create Specifies the merchant account to associate with the plan. This field is required for all plan operations.\n\r\n> **Note:** If your API user is associated with multiple merchant accounts, you must specify which account this plan belongs to.
  • exists Specifies the merchant account associated with the plan. All customers under this merchant can access and subscribe to the plan. This field is required and cannot be changed after plan creation.
  • echo Specifies the merchant account associated with the plan. All customers under this merchant can access and subscribe to the plan. This field is required and cannot be changed after plan creation.
    • isActive
    References: Plan.Is Active
    XML Representation: attribute
    Attributes: Required
    Default Value true
    Indicates whether a record is active within the system.

    **create Indicates whether the plan is active within the system.\n\r\n> **Note:** Default: `true` (1). Inactive plans (false/0) cannot be subscribed to by customers but existing subscriptions remain unaffected.
  • exists Indicates whether the plan is active within the system.\n\r\n> **Note:** Returned as true (1) or false (0). Default: `true`. Inactive plans cannot be subscribed to but existing subscriptions remain unaffected.
  • echo Indicates whether the plan is active within the system.\n\r\n> **Note:** Returned as true (1) or false (0). Default: `true`. Inactive plans cannot be subscribed to but existing subscriptions remain unaffected.
    • createDate
    References: Plan.Create Date
    XML Representation: attribute
    Attributes: ReadOnly
    Default Value
    Date when the record was created.

    **create Date when the plan was created.\n\r\n> **Note:** Auto-generated by the system; do not include in the create request. Format: yyyy-MM-dd HH:mm:ss.
  • exists Date when the plan was created.\n\r\n> **Note:** In the response, the date is returned with hour, minute, and second values, in the format yyyy-MM-dd HH:mm:ss.
  • echo Date when the plan was created.\n\r\n> **Note:** In the response, the date is returned with hour, minute, and second values, in the format yyyy-MM-dd HH:mm:ss.
    • amount
    References: Plan.Amount
    XML Representation: attribute
    Attributes: Required
    Default Value
    The amount of money charged every time billing occurs for this plan (e.g. amount of the transaction). Value must be submitted in cents without a decimal point.



    **create The amount charged on each billing cycle, specified in cents. This field is required.\n\r\n> **Note:** Specify amount in cents, not dollars. For example: $5.00 = 500 cents.
  • exists The amount charged on each billing cycle, specified in cents.\n\r\n> **Note:** Amount is specified in cents, not dollars. For example: $5.00 = 500 cents.
  • echo The amount charged on each billing cycle, specified in cents.\n\r\n> **Note:** Amount is specified in cents, not dollars. For example: $5.00 = 500 cents.
    • billingCycleType
    References: Plan.Billing Cycle Cl
    XML Representation: attribute
    Attributes: Required
    Default Value M
    Reference to the entity that represents billing cycle associated with the plan.

    **create Billing cycle type applied to the plan. This field is required.\n\r\n> **Note:** Default: `M` (Monthly). Determines how often customers are billed.
  • exists Billing cycle type applied to the plan.\n\r\n> **Note:** Default: `M` (Monthly). This determines how often the customer is billed.
  • echo Billing cycle type applied to the plan.\n\r\n> **Note:** Default: `M` (Monthly). This determines how often the customer is billed.
    • name
    References: Plan.Name
    XML Representation: attribute
    Attributes: Required
    Default Value
    Pattern: NAME
    Name of the plan.

    **create Name of the payment plan. This field is required.\n\r\n> **Note:** This name appears in reports and may be visible to customers depending on your implementation.
  • exists Name of the payment plan.\n\r\n> **Note:** This name appears in reports and may be visible to customers depending on your implementation.
  • echo Name of the payment plan.\n\r\n> **Note:** This name appears in reports and may be visible to customers depending on your implementation.
    • taxAmount
    References: Plan.Tax Amount
    XML Representation: attribute
    Attributes:
    Default Value
  • create Tax amount (in cents) applied to the transaction.\n\r\n> **Note:** If you need to include taxes, specify the amount in cents separate from the base amount.
  • exists Tax amount (in cents) applied to the transaction.\n\r\n> **Note:** This is the tax component specified separately from the base amount.
  • echo Tax amount (in cents) applied to the transaction.\n\r\n> **Note:** This is the tax component specified separately from the base amount.

    • XML Sample:

    <plan accountId=""  isActive=""  amount=""  billingCycleType=""  name="John Smith" />
    "<plan accountId=\"\" isActive=\"\" amount=\"\" billingCycleType=\"\" name=\"John Smith\" />"

    JSON Sample:

    {
  "accountId": "",
  "isActive": "",
  "amount": "",
  "billingCycleType": "",
  "name": "John Smith"
}

    XURL Sample:

    ?accountId=&isActive=&amount=&billingCycleType=&name=John+Smith&
    accountId=
    isActive=
    amount=
    billingCycleType=
    name=John Smith
    Copyright © EON Payments. All Rights Reserved.
    All Logos and Trademarks used or mentioned on this page are copyrighted property of their respective owners and are used for display purposes only.