Plan

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

Identifier of the object used for references; auto-incremented integer value.

Note that plan code can be supplied as identifier when using API. In this case, prefix * is required. For example, planId="*standard_monthly_plan" .
code
References: Plan.Ref Code
XML Representation: attribute
Attributes: CreateOnly
Default Value
Pattern: CODE
See Reference Field Type definition for additional information.
accountId
References: Plan.Merchant Account Code
XML Representation: attribute
Attributes: Required, CreateOnly
Default Value
Identifier of the account within the gateway.
createDate
References: Plan.Create Date
XML Representation: attribute
Attributes:
Default Value
Date when the record was created.

In API request, the date must be submitted in yyyy-MM-dd format.
In API response, the date is returned in yyyy-MM-dd HH:mm:ss format.
name
References: Plan.Name
XML Representation: attribute
Attributes: Required
Default Value
Pattern: NAME
Name of the plan.
billingCycleType
References: Plan.Billing Cycle Cl
XML Representation: attribute
Attributes:
Default Value M
Reference to the entity that represents billing cycle associated with the plan.
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.

isActive
References: Plan.Is Active
XML Representation: attribute
Attributes:
Default Value true
Indicates whether a record is active within the system.

XML Sample:

<planId id=""  code=""  accountId=""  createDate=""  name="John Smith"  billingCycleType=""  amount=""  isActive="" />
"<planId id=\"\" code=\"\" accountId=\"\" createDate=\"\" name=\"John Smith\" billingCycleType=\"\" amount=\"\" isActive=\"\" />"

JSON Sample:

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

XURL Sample:

?id=&code=&accountId=&createDate=&name=John+Smith&billingCycleType=&amount=&isActive=&
id=
code=
accountId=
createDate=
name=John Smith
billingCycleType=
amount=
isActive=
Copyright © MyntPay. 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.