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 generated by the system.

  • exists
    • Unique Plan ID generated by the system.

  • echo
    • Unique Plan ID used for filtering Plan records.
    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 supplied by external/user's system.
    Note: Optional secondary identifier. Typically this field is a reference to an ID in your own system to cross-reference it within our system. If not provided, the system will use the object 'id' generated at the time of object creation.
    <div class="info legacy"> For more information see Reference Field Type. </div>

  • exists
    • Unique Plan ID supplied by external/user's system.
    Note: Optional secondary identifier. Typically this field is a reference to an ID in your own system to cross-reference it within our system. If not provided, the system will use the object 'id' generated at the time of object creation.
    <div class="info legacy"> For more information see Reference Field Type. </div>

  • echo
    • Unique Plan ID used for filtering Plan records.
    accountId
    References: Plan.Merchant Account Code
    XML Representation: attribute
    Attributes: Required, CreateOnly
    Default Value
    Identifier of the account within the gateway.

    **create Merchant account will be associated with Plan.
    Note: If your API user is associated to more than one merchant account or group of merchant accounts, you can specify the merchant account ID for the ~find operation to reduce the data set in the API response. <br> <br> Your API credentials may be associated with more than one accountId.


  • exists
    • Merchant account associated with Plan.
    Note: If your API user is associated to more than one merchant account or group of merchant accounts, you can specify the merchant account ID for the ~find operation to reduce the data set in the API response. <br> <br> Your API credentials may be associated with more than one accountId.


  • echo
    • Merchant account associated with Plan used for filtering Plan records.
    isActive
    References: Plan.Is Active
    XML Representation: attribute
    Attributes: Required
    Default Value true
    Indicates whether a record is active within the system.

    **create
    Status of the Plan.
    Note: Values: true (active) or false (inactive).


  • exists
    • Status of the Plan.
    Note: Values: true (active) or false (inactive).


  • echo
    • Status of the Plan used as a search criteria to limit results.
    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.

  • exists
    • Date when the Plan was created.

  • echo
    • Date used for filtering Plan records.
    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 Amount (in cents) of the Plan.
    Note: Amount charged every time billing occurs for this plan.


  • exists
    • Amount (in cents) of the Plan.
    Note: Amount charged every time billing occurs for this plan.


  • echo
    • Amount (in cents) used for filtering Plan records.
    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 Type of a billing cycle to be used. <div class="info legacy"> For more information see Billing Cycle Classifier. </div>

  • exists
    • Type of a billing cycle used. <div class="info legacy"> For more information see Billing Cycle Classifier. </div>

  • echo
    • Type of a billing cycle used for filtering Plan records.
    name
    References: Plan.Name
    XML Representation: attribute
    Attributes: Required
    Default Value
    Pattern: NAME
    Name of the plan.

    **create Name of the Plan.

  • exists
    • Name of the Plan.

  • echo
    • Name of the Plan used for filtering Plan records.
    taxAmount
    References: Plan.Tax Amount
    XML Representation: attribute
    Attributes:
    Default Value
  • create
    • Tax amount (in cents) that will be associated with the transaction processing.

  • exists
    • Tax amount (in cents) associated with the transaction processing.

  • echo
    • Tax amount (in cents) used for filtering Plan records.

    XML Sample:

    <planId accountId=""  isActive=""  amount=""  billingCycleType=""  name="John Smith" />
    "<planId 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 © TidyPay. 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.