Subscription

Type:  
Abstract:  no
Status:  Active
Java Class:  Subscription
Information about the subscription transaction.
Available Fields:
id
References: Payment Plan.Id
XML Representation: attribute
Attributes:
Default Value
Identifier of the object used for references; auto-incremented integer value.
code
References: Payment Plan.Reference Code
XML Representation: attribute
Attributes:
Default Value
Pattern: CODE
See Reference Code definition for additional information.
accountId
References: Payment Plan.Merchant Account Code
XML Representation: attribute
Attributes:
Default Value
Code of Merchant Account to which instance of this object is attributed to.
Depending on the context, Merchant Account Code field may contain either Merchant Code or Merchant Account Code.
The field is primarily used for data partitioning and data management, to make it easy to determine the ownership of a record within the database.
amount
References: Payment Plan.Amount
XML Representation: attribute
Attributes:
Default Value
The amount of money charged every time billing occurs for this payment plan (e.g. amount of the transaction). Value must be submitted in cents without a decimal point.
createDate
References: Payment 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.
customerId
References: Payment Plan.Customer Account FK
XML Representation: attribute
Attributes:
Default Value
Reference to the entity that represents code of the customer account to which instance of this object is attributed to.
firstBillingDate
References: Payment Plan.First Billing Date
XML Representation: attribute
Attributes: Required
Default Value
Date when the first billing occured.
lastBillingDate
References: Payment Plan.Last Invoicing Date
XML Representation: attribute
Attributes:
Default Value
Date when the last invoice 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.
lastUpdateDate
References: Payment Plan.Last Update Date
XML Representation: attribute
Attributes:
Default Value
Date when the payment plan was updated for the last time.

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.
length
References: Payment Plan.Length
XML Representation: attribute
Attributes: CreateOnly
Default Value
Time period when the payment plan is active.

Length parameter is required for Fixed Subscriptions and cannot exceed 3 years.
For subscriptions longer than 3 years, use Perpetual Subscription type, which does not require length parameter.
Length maximum value correlated with the selected billingCycleType:
  • annually - 3,
  • semi-annually - 6,
  • quarterly - 12,
  • monthly - 36,
  • weekly - 153.
nextBillingDate
References: Billing Cycle.Next Billing Date
XML Representation: attribute
Attributes:
Default Value
Date when the next billing will occur.

The date must be submitted in yyyy-MM-dd format.
note
References: Payment Plan.Note
XML Representation: attribute
Attributes:
Default Value
Pattern: TEXT
Any additional notes related to the payment plan within the system.
paymentOptionId
Type: PaymentOption
XML Representation: element
Attributes: Required
Default Value
Reference to the entity that represents payment option used to collect money on the payment plan.
planId
Type: Plan
XML Representation: element
Attributes:
Default Value
Identifier of the associated payment plan.
planName
Type: String
XML Representation: attribute
Attributes:
Default Value
Name of the associated payment plan.
status
References: Payment Plan.Status CL
XML Representation: attribute
Attributes:
Default Value U
Represents current (or selected) status of the payment plan.

type
References: Payment Plan.Payment Plan CL
XML Representation: attribute
Attributes: CreateOnly
Default Value P
Enumeration of possible types of payment plans.
billingCycleType
References: Plan.Billing Cycle Cl
XML Representation: attribute
Attributes:
Default Value
Reference to the entity that represents billing cycle associated with the plan.

Type of the applied billing cycle.
pendingAdjustmentType
References: Payment Plan.Pending Adjustment Cl
XML Representation: attribute
Attributes:
Default Value
Type of the pending payment plan adjustment.
pendingAdjustmentEffectiveDate
References: Payment Plan.Pending Adjustment Effective Date
XML Representation: attribute
Attributes:
Default Value
Effective date of the pending payment plan adjustment. The date must be submitted in yyyy-MM-dd format.
pendingAdjustmentNote
References: Payment Plan.Pending Adjustment Note
XML Representation: attribute
Attributes: Required
Default Value
Pattern: TEXT
Note associated with the pending payment plan adjustment.
pendingAdjustmentLength
References: Payment Plan.Pending Adjustment Length
XML Representation: attribute
Attributes:
Default Value
Length of the pending payment plan adjustment.
nextInvoicingDate
Type: Date
XML Representation: attribute
Attributes:
Default Value
firstInvoicingDate
Type: Date
XML Representation: attribute
Attributes:
Default Value

XML Sample:

<object
    id="" 
    code="" 
    accountId="" 
    amount="" 
    createDate="" 
    customerId="" 
    firstBillingDate="" 
    lastBillingDate="" 
    lastUpdateDate="" 
    length="" 
    nextBillingDate="" 
    note="" >
    <paymentOptionId
        id="" 
        code="" 
        createDate="" 
        type="" 
        accountNumber="" 
        accountAccessory="" 
        tokenCode="" 
        isActive="" 
        holderName="" 
        csc="" 
        street1="" 
        street2="" 
        city="" 
        countryCode="" 
        state="" 
        zipCode="" 
        customerId="" 
        cardType="" 
        accountId="" 
        address="" 
        token="" />
    <planId id=""  code=""  accountId=""  createDate=""  name="John Smith"  billingCycleType=""  amount=""  isActive="" />
    planName="" 
    status="" 
    type="" 
    billingCycleType="" 
    pendingAdjustmentType="" 
    pendingAdjustmentEffectiveDate="" 
    pendingAdjustmentNote="" 
    pendingAdjustmentLength="" 
    nextInvoicingDate="" 
    firstInvoicingDate="" 
</object>
"<object id=\"\" code=\"\" accountId=\"\" amount=\"\" createDate=\"\" customerId=\"\" firstBillingDate=\"\" lastBillingDate=\"\" lastUpdateDate=\"\" length=\"\" nextBillingDate=\"\" note=\"\" > <paymentOptionId id=\"\" code=\"\" createDate=\"\" type=\"\" accountNumber=\"\" accountAccessory=\"\" tokenCode=\"\" isActive=\"\" holderName=\"\" csc=\"\" street1=\"\" street2=\"\" city=\"\" countryCode=\"\" state=\"\" zipCode=\"\" customerId=\"\" cardType=\"\" accountId=\"\" address=\"\" token=\"\" /> <planId id=\"\" code=\"\" accountId=\"\" createDate=\"\" name=\"John Smith\" billingCycleType=\"\" amount=\"\" isActive=\"\" /> planName=\"\" status=\"\" type=\"\" billingCycleType=\"\" pendingAdjustmentType=\"\" pendingAdjustmentEffectiveDate=\"\" pendingAdjustmentNote=\"\" pendingAdjustmentLength=\"\" nextInvoicingDate=\"\" firstInvoicingDate=\"\" </object>"

JSON Sample:

{
  "id": "",
  "code": "",
  "accountId": "",
  "amount": "",
  "createDate": "",
  "customerId": "",
  "firstBillingDate": "",
  "lastBillingDate": "",
  "lastUpdateDate": "",
  "length": "",
  "nextBillingDate": "",
  "note": "",
  "paymentOptionId": {
    "id": "",
    "code": "",
    "createDate": "",
    "type": "",
    "accountNumber": "",
    "accountAccessory": "",
    "tokenCode": "",
    "isActive": "",
    "holderName": "",
    "csc": "",
    "street1": "",
    "street2": "",
    "city": "",
    "countryCode": "",
    "state": "",
    "zipCode": "",
    "customerId": "",
    "cardType": "",
    "accountId": "",
    "address": "",
    "token": ""
  },
  "planId": {
    "id": "",
    "code": "",
    "accountId": "",
    "createDate": "",
    "name": "John Smith",
    "billingCycleType": "",
    "amount": "",
    "isActive": ""
  },
  "planName": "",
  "status": "",
  "type": "",
  "billingCycleType": "",
  "pendingAdjustmentType": "",
  "pendingAdjustmentEffectiveDate": "",
  "pendingAdjustmentNote": "",
  "pendingAdjustmentLength": "",
  "nextInvoicingDate": "",
  "firstInvoicingDate": ""
}

XURL Sample:

?id=&code=&accountId=&amount=&createDate=&customerId=&firstBillingDate=&lastBillingDate=&lastUpdateDate=&length=&nextBillingDate=&note=&paymentOptionId.id=&paymentOptionId.code=&paymentOptionId.createDate=&paymentOptionId.type=&paymentOptionId.accountNumber=&paymentOptionId.accountAccessory=&paymentOptionId.tokenCode=&paymentOptionId.isActive=&paymentOptionId.holderName=&paymentOptionId.csc=&paymentOptionId.street1=&paymentOptionId.street2=&paymentOptionId.city=&paymentOptionId.countryCode=&paymentOptionId.state=&paymentOptionId.zipCode=&paymentOptionId.customerId=&paymentOptionId.cardType=&paymentOptionId.accountId=&paymentOptionId.address=&paymentOptionId.token=&planId.id=&planId.code=&planId.accountId=&planId.createDate=&planId.name=John+Smith&planId.billingCycleType=&planId.amount=&planId.isActive=&planName=&status=&type=&billingCycleType=&pendingAdjustmentType=&pendingAdjustmentEffectiveDate=&pendingAdjustmentNote=&pendingAdjustmentLength=&nextInvoicingDate=&firstInvoicingDate=&
id=
code=
accountId=
amount=
createDate=
customerId=
firstBillingDate=
lastBillingDate=
lastUpdateDate=
length=
nextBillingDate=
note=
paymentOptionId.id=
paymentOptionId.code=
paymentOptionId.createDate=
paymentOptionId.type=
paymentOptionId.accountNumber=
paymentOptionId.accountAccessory=
paymentOptionId.tokenCode=
paymentOptionId.isActive=
paymentOptionId.holderName=
paymentOptionId.csc=
paymentOptionId.street1=
paymentOptionId.street2=
paymentOptionId.city=
paymentOptionId.countryCode=
paymentOptionId.state=
paymentOptionId.zipCode=
paymentOptionId.customerId=
paymentOptionId.cardType=
paymentOptionId.accountId=
paymentOptionId.address=
paymentOptionId.token=
planId.id=
planId.code=
planId.accountId=
planId.createDate=
planId.name=John Smith
planId.billingCycleType=
planId.amount=
planId.isActive=
planName=
status=
type=
billingCycleType=
pendingAdjustmentType=
pendingAdjustmentEffectiveDate=
pendingAdjustmentNote=
pendingAdjustmentLength=
nextInvoicingDate=
firstInvoicingDate=
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.