Sign in

v1

latestOpenAPI 3.0.02026-07-24226294602.4 KB
Payment Plan Template

Update Payment Plan Template

Update a Payment Plan Template for a Membership Template.

put/memberships/templates/{membership_template_id}/payment-plan-templates/{payment_plan_template_id}

Path parameters

membership_template_idinteger required

Id of the Membership Template to get

payment_plan_template_idinteger required

Id of the Payment Plan Template to update

Headers

x-api-keystring required

A valid API key. If you don't have one, please request one through the Web Integrations screen.

Request body

namestring

Name of the Payment Plan Template

is_auto_renewstring

Is Auto Renew

initial_commitment_time_unit_idinteger

TIme Unit Id of the Initial Commitment. Only applicable to Class Plans.

initial_commitment_lengthinteger

Length of the Initial Commitment. Only applicable to Class Plans.

initial_payment_interval_lengthinteger

Length of the Initial Payment Interval. Only applicable for Class Plans whose initial commitment is weekly.

renewal_commitment_time_unit_idinteger

TIme Unit Id of the Renewal Commitment. Only applicable to Class Plans.

renewal_commitment_lengthinteger

Length of the Renewal Commitment. Only applicable to Class Plans.

renewal_payment_interval_lengthinteger

Length of the Renewal Payment Interval. Only applicable for Class Plans whose renewal commitment is weekly.

Example request

{
  "initial_commitment_time_unit_id": 1234567891234567,
  "monthly_initial_payment_option_template": {
    "setup_fee": 0.1,
    "cost": 0.1
  },
  "pay_in_full_initial_payment_option_template": {
    "setup_fee": 0.1,
    "cost": 0.1
  },
  "renewal_commitment_time_unit_id": 1234567891234567,
  "monthly_renewal_payment_option_template": {
    "cost": 0.1
  },
  "pay_in_full_renewal_payment_option_template": {
    "cost": 0.1
  }
}

Response

PaymentScheduleTemplate Data

idinteger

Payment Plan Template Id

namestring

Payment Schedule Template Name

is_auto_renewboolean

Is Auto Renew

initial_payment_interval_time_unit_idinteger

Time Unit Id of the Initial Payment Interval

initial_payment_interval_time_unitstring

Time Unit of the Payment Interval

initial_payment_interval_lengthinteger

Length of the Initial Payment Interval

initial_commitment_time_unit_idinteger

TIme Unit Id of the Initial Commitment

initial_commitment_time_unitstring

TIme Unit of the Initial Commitment

initial_commitment_lengthinteger

Length of the Initial Commitment

renewal_payment_interval_time_unit_idinteger

TIme Unit Id of the Renewal Payment Interval

renewal_payment_interval_time_unitstring

TIme Unit of the Renewal Payment Interval

renewal_payment_interval_lengthinteger

Length of the Renewal Payment Interval

renewal_commitment_time_unit_idinteger

TIme Unit Id of the Renewal Commitment

renewal_commitment_time_unitstring

TIme Unit of the Renewal Commitment

renewal_commitment_lengthinteger

Length of the Renewal Commitment

Example response

{
  "id": 1234567891234567,
  "initial_payment_interval_time_unit_id": 1234567891234567,
  "initial_commitment_time_unit_id": 1234567891234567,
  "monthly_initial_payment_option_template": {
    "monthly_initial_payment_option_template_id": 1234567891234567,
    "monthly_initial_payment_option_template_type_id": 1234567891234567,
    "monthly_initial_payment_option_template_setup_fee": 0.1,
    "monthly_initial_payment_option_template_cost": 0.1
  },
  "pay_in_full_initial_payment_option_template": {
    "pay_in_full_initial_payment_option_template_id": 1234567891234567,
    "pay_in_full_initial_payment_option_template_type_id": 1234567891234567,
    "pay_in_full_initial_payment_option_template_setup_fee": 0.1,
    "pay_in_full_initial_payment_option_template_cost": 0.1
  },
  "renewal_payment_interval_time_unit_id": 1234567891234567,
  "renewal_commitment_time_unit_id": 1234567891234567,
  "monthly_renewal_payment_option_template": {
    "monthly_renewal_payment_option_template_id": 1234567891234567,
    "monthly_renewal_payment_option_template_type_id": 1234567891234567,
    "monthly_renewal_payment_option_template_cost": 0.1
  },
  "pay_in_full_renewal_payment_option_template": {
    "pay_in_full_renewal_payment_option_template_id": 1234567891234567,
    "pay_in_full_renewal_payment_option_template_type_id": 1234567891234567,
    "pay_in_full_renewal_payment_option_template_cost": 0.1
  },
  "payment_plan_template_location_tax_rates": [
    {
      "location_id": 1234567891234567,
      "tax_rate_id": 1234567891234567,
      "tax_rate": 0.1,
      "tax_rate_type_id": 1234567891234567
    }
  ],
  "created": {
    "created_by_id": 1234567891234567,
    "created_on_datetime": "2014-12-31T23:59:59.938Z"
  },
  "updated": {
    "updated_by_id": 1234567891234567,
    "updated_on_datetime": "2014-12-31T23:59:59.938Z"
  }
}