type PaymentPlan
| Field | Type | Description |
|---|---|---|
id | ID! | Unique id of the payment plan (a bare KSUID). |
orgId | ID! | ID of the organization that this payment plan belongs to |
contactId | ID! | ID of the platform contact associated with this payment plan |
amount | Amount! | Payment amount to be charged on the configured frequency. |
currency | Currency! | Currency of the payment |
status | PaymentPlanStatus! | Status of the payment plan |
frequency | PaymentPlanFrequency | Frequency of the payment plan. If this is null, the payment plan will not automatically execute and a call to runPaymentPlan is required to generate a payment against the plan. |
startDate | Date! | Start date of the payment plan |
occurrences | Int! | Number of payment occurrences to be run on the configured frequency from the start date |
remainingOccurrences | Int! | Remaining payments on the plan |
nextRunAt | DateTime | Next scheduled payment run |
paymentPlanSessionId | ID | ID of the payment plan session that generated this payment plan |