Get Started

Sections

Theme switcher

Update Enrollment Plans

Header Parameters

Content-Typestring
Api-Keystring Required

Path Parameters

idstring

Body Parameters

ep_templatenumber Required

plan template ID for a valid plan template in the account available to the company the api key is tied to

first_payment_datestring

A valid start date to the program such as '2021-02-15'

recurring_start_datestring

sets recurring start date for the plan such as '2021-02-15'

payment_methodstring Required

Accept ACH, CC, and DC for ACH Debit, Credit Card, and Debit Card transaction type

split_templatenumber

A valid compensation split template ID available to the enrollment plan

gateway_idstring

Default to account default gateway if no ID is passed. Default to plan-default if the plan ID passed has a default gateway selected for the plan itself on the plan template.

est_settlementnumber

Sets the estimated settlement/savings percentage for the plan with 0-100 being accepted values

frequencyobject

Show child attributes

feesobject

Show child attributes

Response

200
Object

Response Attributes

statusobject

Show child attributes

responseobject

Show child attributes

400
Object

Response Attributes

statusobject

Show child attributes

Was this section helpful?

What made this section unhelpful for you?

PUT

/

Select
1

Response

Was this section helpful?

What made this section unhelpful for you?