The plans operation allows you to retrieve the details of payment plans for a single club. These plans must be active and web-enabled, and the current date must be within the start and end date range of the plan.
The current date must be greater than or equal to the plan's start date and less than or equal to the plan's end date for that plan to be returned.
| Service Type | SOAP |
| Service Name | Agreements |
| Operation | plans |
| Required Request Parameters | none |
The request has one required parameter: club number.
| Parameter name | Format | Parent Parameter | Description |
|---|---|---|---|
| club | club number | The ABC-provided club number |
The return data is included inside return parameters in the body of the response. Zero, one, or many plans may be returned.
The data has the following parameter hierarchy:
| Parameter Name | Contents | Parent Parameter | Description |
|---|---|---|---|
| club | club number | return | The ABC-provided club number. |
| paymentPlan | return |
The container parameter for each payment plan returned. Includes the following parameters and their children:
|
|
| planName | string | paymentPlan | Contains a label for the payment plan. Clubs define and maintain payment plans. |
| planID | GUID | paymentPlan | An ABC-generated string to uniquely identify the payment plan. The planID may be used in many other services, such as the create service. |
| promotionCode | string | paymentPlan | The club-assigned promotion code for the plan. |
| promotionName | string | paymentPlan | The club-assigned, descriptive promotion name. |
| membershipType | string | paymentPlan | The club-assigned membership type. |
| agreementTerm | string | paymentPlan |
The agreement term for the payment plan. Allowed values:
|
| scheduleFrequency | string | paymentPlan |
How frequently the plan is billed. Allowed values:
|
| termInMonths | ### | paymentPlan | The number of months to invoice, up to three digits. |
| dueDay | paymentPlan | The method for determining the first due date. A zero indicates that the current date is the first due date. Any other represents indicates a day of the month; for example, "1" indicates that the first day of the month is the first due date. |
|
| firstDueDate | MM/DD/YYYY | paymentPlan | The first invoice due fate for the payment plan, if an agreement were created on the day of the request. |
| expirationDate | MM/DD/YYYY | paymentPlan | The final invoice due date for the payment plan, if an agreement were created on the day of the request. |
| downPayments | paymentPlan |
The down payments associated with the plan. Includes the following parameters and their children:
|
|
| totalDownName | string | downPayments | The club-created name referring to all of the down payments attached to the plan. |
| totalDownAmount | dollar value | downPayments | The combined value of all of the down payment items attached to the plan. |
| paymentBean | downPayments |
The individual down payment items associated with the plan. Includes the following parameters and their children:
|
|
| name | string | paymentBean | The club-created name of the individual down payment item. |
| subtotal | dollar value | paymentBean | the value of the individual down payment item. |
| tax | dollar value | paymentBean | The tax for the down payment item. |
| total | dollar value | paymentBean | The total value of the individual down payment item. |
| schedules | string | paymentPlan | Contains one or more schedule types for the payment plan. |
| schedule | string | schedules | Contains the details of an individual schedule type. There is always at least one schedule attached to a plan. |
| profitCenter | string | schedule | The ABC profit center to which the payments are applied. |
| scheduleDueDate | MM/DD/YYYY | schedule | The first due date for the schedule, if the plan were purchased today. |
| scheduleAmount | dollar value | schedule | The default payment amount for scheduled terms. |
| numberOfPayments | ## | schedule |
The number of invoices made during the schedule. The number must be within the range of 1 - 78. |
| recurring | boolean | schedule | Indicates whether the schedule is for a recurring service. "True" indicates that the schedule is for a recurring service. |