Sign in

v1

latestOpenAPI 3.0.02026-07-24226294602.4 KB
Payment Plan Template

Search Payment Plan Templates by Membership Template Id

Search Payment Plan Template records given a Membership Template Id and a query.

get/memberships/templates/{membership_template_id}/payment-plan-templates/search

Path parameters

membership_template_idinteger required

Id of the Membership Template to get

Query parameters

sortstring

Specifies the order in which the list will be returned. Default order is ascending. Default sort attribute is Id. Specify desc_ to sort descending format: "sort=desc_snake_cased_attribute_name" OR "sort=snake_cased_attribute_name" ex. sort=desc_updated_on

pageinteger

Specifies the page of records to be returned. Defaults to 1.

page_sizeinteger

Number of records to return per page. Maximum and default are 100 records.

qstring required

Search query. See the Search section for guidance on how to build a query.

Headers

x-api-keystring required

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

Response

Payment Plan Template Data

Example response

{
  "payment_plan_templates": [
    {
      "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
      },
      "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"
      }
    }
  ]
}